Function getDeploymentGatingStatusByKey

getDeploymentGatingStatusByKey(
    client: Client,
    parameters: {
        deploymentSequenceNumber: number;
        environmentId: string;
        pipelineId: string;
    },
    options?: RequestOptions,
): Promise<
    {
        deploymentSequenceNumber?: number;
        details?: {
            issueKey: string;
            issueLink: string;
            type: string & {}
            | "issue";
            [key: string]: unknown;
        }[];
        environmentId?: string;
        gatingStatus?: | "invalid"
        | string & {}
        | "allowed"
        | "prevented"
        | "awaiting";
        pipelineId?: string;
        updatedTimestamp?: Date;
        [key: string]: unknown;
    },
>
Retrieve the Deployment gating status for the given pipelineId + environmentId + deploymentSequenceNumber combination. Only apps that define the jiraDeploymentInfoProvider module can access this resource. This resource requires the 'READ' scope.
Parameters
- client: Client
- parameters: { deploymentSequenceNumber: number; environmentId: string; pipelineId: string }
  - deploymentSequenceNumber: number
    
    The Deployment's deploymentSequenceNumber.
  - environmentId: string
    
    The ID of the Deployment's environment.
  - pipelineId: string
    
    The ID of the Deployment's pipeline.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        deploymentSequenceNumber?: number;
        details?: {
            issueKey: string;
            issueLink: string;
            type: string & {}
            | "issue";
            [key: string]: unknown;
        }[];
        environmentId?: string;
        gatingStatus?: | "invalid"
        | string & {}
        | "allowed"
        | "prevented"
        | "awaiting";
        pipelineId?: string;
        updatedTimestamp?: Date;
        [key: string]: unknown;
    },
>
- Defined in src/agile/api/deployments.ts:126

Function getDeploymentGatingStatusByKey

Parameters

deploymentSequenceNumber: number

environmentId: string

pipelineId: string

Settings