v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB

Deployments

Get deployment gating status by key

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.

get/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}/gating-status

Path parameters

pipelineIdstring required

The ID of the Deployment's pipeline.

environmentIdstring required

The ID of the Deployment's environment.

deploymentSequenceNumberinteger required

The Deployment's deploymentSequenceNumber.

Response

The current gating status for the given Deployment

deploymentSequenceNumberinteger

This is the identifier for the Deployment.

pipelineIdstring

The ID of the Deployment's pipeline.

environmentIdstring

The ID of the Deployment's environment.

updatedTimestampstring date-time

Time the deployment gating status was updated.

gatingStatus'allowed' | 'prevented' | 'awaiting' | 'invalid'

The gating status

Example response

{
  "deploymentSequenceNumber": 100,
  "pipelineId": "e9c906a7-451f-4fa6-ae1a-c389e2e2d87c",
  "environmentId": "8ec94d72-a4fc-4ac0-b31d-c5a595f373ba",
  "updatedTimestamp": "2020-08-25T06:04:50.239Z",
  "gatingStatus": "allowed",
  "details": [
    {
      "type": "issue",
      "issueKey": "ABC-123",
      "issueLink": "https://your-domain.atlassian.net/servicedesk/customer/portal/1/ZAINA-123"
    }
  ]
}