The Jira Software Cloud REST API

POST

submit deployment datum

update / insert deployment datum .

Deployments are identified by the combination of pipelineid, environmentId and deploymentsequencenumber, and existing deployment data for the same deployment will be replaced if it exists and the updatesequencenumber of existing data is less than the incoming data.

Submissions are processed asynchronously. Submitted data will eventually be available in Jira. Most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getDeploymentByKey operation can be used to confirm that data has been stored successfully (if needed).

In the case of multiple deployments being submitted in one request, each is validated individually prior to submission. Details of which deployments failed submission (if any) are available in the response object.

Only Connect apps that define the jiraDeploymentInfoProvider module, and on-premise integrations, can access this resource.
This resource requires the ‘WRITE’ scope for Connect apps.

Scopes

Connect app scope required: WRITE

request

Authorization

string

require

request bodyapplication / json

deployment datum to submit .

deployments

array<DeploymentData>

requireproviderMetadata

ProviderMetadata

response

Submission accepted. Each submitted deployment that is of a valid format will eventually be available in Jira.

detail of which deployment were submit and which fail submission ( due to data format problem etc . ) are available in the response object .

application / json

SubmitDeploymentsResponse

The result of a successful submitDeployments request.

POST/rest/deployments/0.1/bulk

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
curl --request POST \
--url 'https://your-domain.atlassian.net/rest/deployments/0.1/bulk' \
--header 'Accept: application / json' \
--header 'Content-Type: application / json' \
--data '{
"properties": {
"accountId": "account-234",
"projectId": "project-123"
},
"deployments": [
{
"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"
}
],
"providerMetadata": {
"product": "Bamboo 6.10.2"
}
}'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
"acceptedDeployments": [
{
"pipelineid": "e9c906a7-451f-4fa6-ae1a-c389e2e2d87c",
"environmentId": "8ec94d72-a4fc-4ac0-b31d-c5a595f373ba",
"deploymentsequencenumber": 100
}
],
"rejectedDeployments": [
{
"key": {
"pipelineid": "e9c906a7-451f-4fa6-ae1a-c389e2e2d87c",
"environmentId": "8ec94d72-a4fc-4ac0-b31d-c5a595f373ba",
"deploymentsequencenumber": 100
},
"errors": [
{
"message": "<string>",
"errorTraceId": "<string>"
}
]
}
],
"unknownIssueKeys": [
"ABC-123"
],
"unknownAssociations": [
{
"associationType": "issueIdOrKeys",
"values": [
"ABC-123",
"ABC-456"
]
}
]
}