Deployment

The Deployment object type represents a deployment object. atlassian:deployment should be used to ingest deployment-specific fields.

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Required]
  ├─ url (string) [Required]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ createdBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ containerKey (EntityKey) [Optional]
      ├─ type (string) [Required]
      └─ value (jsonNode) [Required]
  └─ permissions [] [Required]
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []
      
  atlassian:deployment
  ├─ deploymentSequenceNumber (integer) [Required]
  ├─ label (string) [Optional]
  ├─ state (string) [Required] — Allowed values: PENDING, IN_PROGRESS, SUCCESSFUL, CANCELLED, FAILED, ROLLED_BACK, UNKNOWN
  ├─ duration (integer) [Optional]
  ├─ pipeline (PipelineDetails) [Required]
      ├─ id (string) [Required]
      ├─ displayName (string) [Required]
      └─ url (string) [Required]
  ├─ environment (EnvironmentDetails) [Required]
      ├─ id (string) [Required]
      ├─ displayName (string) [Required]
      └─ type (string) [Required] — Allowed values: PRODUCTION, STAGING, TESTING, DEVELOPMENT, UNMAPPED
  ├─ commands (List<Command>) [Optional] — Only valid when state is PENDING
      └─ command (string) [Required] — Allowed values: initiate_deployment_gating
  ├─ triggeredBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ region (string) [Optional]

Common properties

Deployment properties

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "pipelineId/e9c906a7-451f-4fa6-ae1a-c389e2e2d87c/environmentId/8ec94d72-a4fc-4ac0-b31d-c5a595f373ba/deploymentSequenceNumber/100",
    "updateSequenceNumber" : 1,
    "displayName" : "Test Deployment",
    "description" : "A test deployment to staging",
    "url" : "https://entity.example.com/1",
    "createdAt" : "2024-07-01T05:00:45Z",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "lastUpdatedBy" : {
      "externalId" : "external-id-1"
    },
    "containerKey" : {
      "type" : "atlassian:repository",
      "value" : {
        "repositoryId" : "my-repo-1"
      }
    },
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:deployment" : {
      "deploymentSequenceNumber" : 100,
      "pipeline" : {
        "id" : "e9c906a7-451f-4fa6-ae1a-c389e2e2d87c",
        "displayName" : "Test Deployment",
        "url" : "http://mydeployer.com/project1"
      },
      "environment" : {
        "id" : "8ec94d72-a4fc-4ac0-b31d-c5a595f373ba",
        "displayName" : "US East",
        "type" : "STAGING"
      },
      "label" : "Release 2018-01-20_08-47-bc2421a",
      "state" : "IN_PROGRESS",
      "duration" : 47,
      "triggeredBy" : {
        "accountId" : "5b10ac8d82e05b22cc7d4ef5",
        "email" : "author@example.com",
        "externalId" : "external-user-123"
      }
    }
  } ]
}