Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
Deployments

Get a deployment by key

Retrieve the currently stored deployment data for the given pipelineId, environmentId and deploymentSequenceNumber combination.

The result will be what is currently stored, ignoring any pending updates or deletes.

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

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 deployment data currently stored for the given ID.

deploymentSequenceNumberinteger required

This is the identifier for the deployment. It must be unique for the specified pipeline and environment. It must be a monotonically increasing number, as this is used to sequence the deployments.

updateSequenceNumberinteger required

A number used to apply an order to the updates to the deployment, as identified by the deploymentSequenceNumber, in the case of out-of-order receipt of update requests. It must be a monotonically increasing number. For example, epoch time could be one way to generate the updateSequenceNumber.

issueKeysstring[]

Deprecated. The Jira issue keys to associate the Deployment information with. Should replace this field with the "associations" field to associate Deployment information with issueKeys or other types of associations.

displayNamestring required

The human-readable name for the deployment. Will be shown in the UI.

urlstring uri required

A URL users can use to link to this deployment, in this environment.

descriptionstring required

A short description of the deployment

lastUpdatedstring date-time required

The last-updated timestamp to present to the user as a summary of the state of the deployment.

labelstring

An (optional) additional label that may be displayed with deployment information. Can be used to display version information etc. for the deployment.

durationinteger

The duration of the deployment (in seconds).

state'unknown' | 'pending' | 'in_progress' | 'cancelled' | 'failed' | 'rolled_back' | 'successful' required

The state of the deployment

schemaVersion'1.0'

The DeploymentData schema version used for this deployment data.

Placeholder to support potential schema changes in the future.

Example response

{
  "deploymentSequenceNumber": 100,
  "updateSequenceNumber": 1,
  "issueKeys": [
    "ABC-123"
  ],
  "associations": [
    {
      "associationType": "issueIdOrKeys",
      "values": [
        "ABC-123",
        "ABC-456"
      ]
    }
  ],
  "displayName": "Deployment number 16 of Data Depot",
  "url": "http://mydeployer.com/project1/1111-222-333/prod-east",
  "description": "The bits are being transferred",
  "lastUpdated": "2018-01-20T23:27:25.000Z",
  "label": "Release 2018-01-20_08-47-bc2421a",
  "duration": 47,
  "state": "in_progress",
  "pipeline": {
    "id": "e9c906a7-451f-4fa6-ae1a-c389e2e2d87c",
    "displayName": "Data Depot Deployment",
    "url": "http://mydeployer.com/project1"
  },
  "environment": {
    "id": "8ec94d72-a4fc-4ac0-b31d-c5a595f373ba",
    "displayName": "US East",
    "type": "production"
  },
  "commands": [
    {
      "command": "initiate_deployment_gating"
    }
  ],
  "schemaVersion": "1.0"
}