Provides list of available REST resources in Bamboo
This request has no parameters.
List of available REST resources
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"link": {
"href": "<string>",
"rel": "<string>"
},
"resources": {
"allElements": [
{
"link": {},
"name": "<string>"
}
],
"maxResult": 2154,
"resources": [
{
"link": {},
"name": "<string>"
}
],
"size": 2154,
"startIndex": 2154
}
}Retrieve a page of user's access tokens.
integer
integer
A page of access tokens.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/access-token' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"creationDate": "<string>",
"daysUntilExpiry": 2154,
"name": "<string>",
"permissions": [
"<string>"
],
"rawToken": "<string>",
"self": "<string>",
"tokenId": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Create a new access token for the current user.
request for a token - name is a required field
integer
string
array<string>
New access tokens with rawToken field value.
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/access-token' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"daysUntilExpiry": 2154,
"name": "token name",
"permissions": [
"<string>"
]
}'1
2
3
4
5
6
7
8
9
10
11
{
"creationDate": "<string>",
"daysUntilExpiry": 2154,
"name": "<string>",
"permissions": [
"<string>"
],
"rawToken": "<string>",
"self": "<string>",
"tokenId": "<string>"
}Revoke current user's access token.
string
RequiredWhen token has been successfully revoked.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/access-token/{tokenId}'Get list of all plans where user has admin permission and which override global expiry settings. If global expiry is not enabled it returns empty response.
integer
integer
List of plans with custom expiry settings sorted by project name and plan name
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/expiry/custom/plan' \
--header 'Accept: application/json'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
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"configLink": {
"href": "<string>",
"rel": "<string>"
},
"expiryConfig": {
"buildsToKeep": 2154,
"duration": 2154,
"expiryBuildLog": true,
"expiryTypeArtifact": true,
"expiryTypeNothing": true,
"expiryTypeResult": true,
"labelsList": "<string>",
"maximumBuildsToKeep": 2154,
"period": "<string>"
},
"planKey": "<string>",
"planName": "<string>",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Delete custom plan expiry settings.
string
RequiredWhen plan expiry settings were disabled
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/admin/expiry/custom/plan/{planKey}'Retrieve a paginated list of groups. The authenticated user must have restricted administrative permission or higher to use this resource.
string
integer
integer
A page of groups
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Create a new group. The authenticated user must have restricted administrative permission or higher to use this resource.
Group to create
string
When group has been created
1
2
3
4
5
6
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/admin/groups' \
--header 'Content-Type: application/json' \
--data '{
"name": "bamboo-admin"
}'Deletes the specified group, removing it from the system. The authenticated user must have restricted administrative permission or higher to use this resource.
string
RequiredWhen group was deleted successfully
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/admin/groups/{name}'Add multiple users to a group. The list of usernames should be passed as request body. The authenticated user must have restricted administrative permission or higher to use this resource.
string
RequiredUsernames of users to add
array<string>
All the users were added to the group
1
2
3
4
5
6
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/admin/groups/{name}/add-users' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieves a list of users that are members of a specified group. The authenticated user must have restricted administrative permission or higher to use this resource.
string
Requiredstring
integer
integer
A page of users
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/groups/{name}/more-members' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieves a list of users that are not members of a specified group. The authenticated user must have restricted administrative permission or higher to use this resource.
string
Requiredstring
integer
integer
A page of users
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/groups/{name}/more-non-members' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Remove multiple users from a group. The list of usernames should be passed as request body. The authenticated user must have restricted administrative permission or higher to use this resource.
string
RequiredUsernames of users to remove
array<string>
All the users were removed from the group
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/admin/groups/{name}/remove-users' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a page of users. The authenticated user must have restricted administrative permission or higher to use this resource.
string
integer
integer
A page of users
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Create a new user. The authenticated user must have restricted administrative permission or higher to use this resource.
User to create
string
string
string
string
string
string
When user has been created
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/admin/users' \
--header 'Content-Type: application/json' \
--data '{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"password": "new_Passw0rd",
"passwordConfirm": "new_Passw0rd",
"sanitizedName": "admin"
}'Change password of specified user. The authenticated user must have restricted administrative permission or higher to use this resource.
User password change request
string
string
string
Users password has been changed
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/admin/users/credentials' \
--header 'Content-Type: application/json' \
--data '{
"name": "username",
"password": "new-password",
"passwordConfirm": "new-password"
}'Renames specified user. The authenticated user must have restricted administrative permission or higher to use this resource.
User rename request
string
string
When user has been renamed successfully
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/admin/users/rename' \
--header 'Content-Type: application/json' \
--data '{
"name": "newUsername",
"oldName": "oldUsername"
}'Deletes the specified user, removing them from the system. The authenticated user must have restricted administrative permission or higher to use this resource.
string
RequiredWhen user has been deleted successfully or user does not exist
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}'Retrieve a page of user's access tokens. The authenticated user must have restricted administrative permission or higher to use this resource.
string
Requiredinteger
integer
A page of access tokens
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/access-token' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"creationDate": "<string>",
"daysUntilExpiry": 2154,
"name": "<string>",
"permissions": [
"<string>"
],
"rawToken": "<string>",
"self": "<string>",
"tokenId": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Revoke user's access token. The authenticated user must have restricted administrative permission or higher to use this resource.
string
Requiredstring
RequiredWhen token has been successfully revoked
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/access-token/{tokenId}'Retrieve a page of aliases. The authenticated user must have restricted administrative permission or higher to use this resource.
string
Requiredinteger
integer
A page of aliases
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/alias' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"name": "user1-alias@atlassian.com",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Link existing unlined alias or create the new one. The authenticated user must have restricted administrative permission or higher to use this resource.
string
RequiredAliases array
array<string>
When alias has been created
1
2
3
4
5
6
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/alias' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Unlink the specified alias from user, removing them from the system. The authenticated user must have restricted administrative permission or higher to use this resource.
string
RequiredAlias to unlink
string
When alias has been unlinked successfully or given user doesn't have this alias
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/alias' \
--header 'Content-Type: application/json' \
--data '{
"name": "user1-alias@atlassian.com"
}'Retrieves a list of groups to which the user belongs. The authenticated user must have restricted administrative permission or higher to use this resource.
string
Requiredstring
integer
integer
A page of users
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/assigned-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Add a user to multiple groups. The authenticated user must have restricted administrative permission or higher to use this resource.
string
RequiredGroup names
array<string>
The user has been added to all specified groups
1
2
3
4
5
6
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/groups' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Remove a user from multiple groups. The authenticated user must have restricted administrative permission or higher to use this resource.
string
RequiredUser groups to unassign from
array<string>
The user has been removed from all specified groups
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/groups' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieves a list of unlinked aliases to which the user does not belong. The authenticated user must have restricted administrative permission or higher to use this resource.
string
Requiredstring
integer
integer
A page of aliases
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/unassigned-aliases' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"name": "user1-alias@atlassian.com",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieves a list of groups to which the user does not belong. The authenticated user must have restricted administrative permission or higher to use this resource.
string
Requiredstring
integer
integer
A page of users
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/users/{name}/unassigned-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Provides a list of agents.
boolean
Complete (non-paginated) list of agents
array<RestBuildAgent>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/agent' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
[
{
"active": true,
"busy": true,
"enabled": true,
"id": 2154,
"name": "agent-name",
"type": "LOCAL"
}
]Get agent's assignment.
string
integer
List of agent's assignments.
array<RestDedicatedAgent>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/agent/assignment' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
[
{
"executableId": 2154,
"executableType": "Build project",
"executorId": 2154,
"executorType": "AGENT"
}
]Dedicate agent, elastic image or ephemeral template.
string
integer
integer
string
List of agent's assignments.
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/agent/assignment' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"executableId": 2154,
"executableType": "Build project",
"executorId": 2154,
"executorType": "AGENT"
}Remove agent's assignment.
string
integer
integer
string
successful removal of agent assignment
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/agent/assignment'Search for assignments in specified entity's agents
integer
string
string
integer
string
integer
string
List of search results
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/agent/assignment/search' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}Provides a list of all agent authentication statuses.
boolean
A successful call will return a complete (non-paginated) list of agent
array<RestRemoteAgentAuthentication>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/agent/authentication' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
[
{
"approved": true,
"ip": "<string>",
"ipPatterns": [
"<string>"
],
"uuid": "<string>"
}
]Authenticates a pending agent with the given UUID. If the agent has already been authenticated, the call will not * change it's state.
string
Requiredsuccessful authentication of an agent
1
2
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/agent/authentication/{agentUuid}'Provides a list of all remote agent authentication statuses.
boolean
Complete (non-paginated) array of remote agents
array<RestBuildAgent>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/agent/remote' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
[
{
"active": true,
"busy": true,
"enabled": true,
"id": 2154,
"name": "agent-name",
"type": "LOCAL"
}
]Provides details of an agent.
integer
Requiredinteger
string
boolean
integer
Details of an agent
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
{
"capabilities": {
"allElements": [
{
"key": "capability.key",
"self": "<string>",
"value": "/usr/local/path"
}
],
"capabilities": [
{
"key": "capability.key",
"self": "<string>",
"value": "/usr/local/path"
}
],
"expand": "<string>",
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"executableEnvironments": {
"allElements": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"operations": {},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{}
],
"triggerDefinitions": [
{}
]
}
],
"executableEnvironments": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"operations": {},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{}
],
"triggerDefinitions": [
{}
]
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"executableJobs": {
"allElements": [
{
"agentSummary": {},
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"self": "<string>",
"sourceJobKey": {},
"stage": {},
"stageId": 2154,
"suspended": true
}
],
"executableJobs": [
{
"agentSummary": {},
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"self": "<string>",
"sourceJobKey": {},
"stage": {},
"stageId": 2154,
"suspended": true
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"expand": "<string>",
"general": {
"active": true,
"busy": true,
"enabled": true,
"id": 2154,
"name": "agent-name",
"type": "LOCAL"
},
"link": {
"href": "<string>",
"rel": "<string>"
},
"restAgentExecutableEnvironments": {
"allElements": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"operations": {},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{}
],
"triggerDefinitions": [
{}
]
}
],
"executableEnvironments": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"operations": {},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{}
],
"triggerDefinitions": [
{}
]
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"restAgentExecutableJobs": {
"allElements": [
{
"agentSummary": {},
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"self": "<string>",
"sourceJobKey": {},
"stage": {},
"stageId": 2154,
"suspended": true
}
],
"executableJobs": [
{
"agentSummary": {},
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"self": "<string>",
"sourceJobKey": {},
"stage": {},
"stageId": 2154,
"suspended": true
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
}
}Remove build agent.
integer
RequiredAgent removed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}'List agent's capabilities.
integer
Requiredboolean
array of agent's capabilities
array<RestCapability>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}/capability' \
--header 'Accept: application/json'1
2
3
4
5
6
7
[
{
"key": "capability.key",
"self": "<string>",
"value": "/usr/local/path"
}
]Create new agent capability.
integer
RequiredAgent capability
string
string
capability created successfully
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}/capability' \
--header 'Content-Type: application/json' \
--data '{
"key": "capability.key",
"value": "/usr/local/path"
}'Remove all capabilities of build agent.
integer
RequiredAgent's capabilities removed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}/capability'Update existing agent capability. It's allowed to skip capability key at request payload.
integer
Requiredstring
RequiredAgent capability
string
string
string
capability updated successfully
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}/capability/{capabilityKey}' \
--header 'Content-Type: application/json' \
--data '{
"key": "capability.key",
"source": "<string>",
"value": "/usr/local/path"
}'Remove build agent capability.
integer
Requiredstring
Requiredcapability removed successfully
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}/capability/{capabilityKey}'Disable an agent.
integer
RequiredAgent has been disabled
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}/disable' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
{
"description": "This is a description",
"enabled": true,
"id": 131073,
"link": "https://bamboo/rest/admin/latest/agent/131073",
"name": "Default Agent",
"type": "local"
}Enable an agent.
integer
RequiredAgent has been enabled
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}/enable' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
{
"description": "This is a description",
"enabled": true,
"id": 131073,
"link": "https://bamboo/rest/admin/latest/agent/131073",
"name": "Default Agent",
"type": "local"
}Provides information about status of agent, if it's online or offline.
integer
RequiredComplete (non-paginated) array of remote agents
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/agent/{agentId}/status' \
--header 'Accept: application/json'Updated the avatar for the currently authenticated user.
Avatar file to upload
string
boolean
object
string
integer
string
The avatar got updated successfully
any
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/avatar/user/avatar.png' \
--header 'Accept: application/json'Deletes the current avatar for the currently authenticated user.
This request has no parameters.
The avatar get deleted successfully
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/avatar/user/avatar.png'Returns either the avatar file for a specified user or the gravatar URL. The priority order: custom user avatar as a file, gravatar URL, default avatar as a file. The endpoint supports Last-Modified/If-Modified-Since headers and sets cache policy with expiration equal by default to 90 seconds.
string
Requiredinteger
Either the avatar file or gravatar URL
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/avatar/user/{userName}/avatar.png' \
--header 'Accept: application/json'Retrieve the next build number for a given plan or plan branch.
string
Requiredstring
RequiredNext build number retrieved successfully
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/buildNumber/{projectKey}-{buildKey}' \
--header 'Accept: application/json'1
2
3
{
"nextBuildNumber": 2154
}Bump the next build number for a given plan or plan branch to the specified value.
string
Requiredstring
RequiredNext build number
integer
Build number bumped successfully
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/buildNumber/{projectKey}-{buildKey}/bump' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"nextBuildNumber": 2154
}'Provides a list of capabilities for a select list in the UI. Filterable and paginable.
integer
string
string
integer
Server capabilities
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/capability/groupedListing' \
--header 'Accept: application/json'Chart url.
string
string
Chart
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/chart' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"height": 2154,
"imageMap": "<string>",
"imageMapName": "<string>",
"location": "<string>",
"width": 2154
}Get plan summary.
string
Chart
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/chart/planSummary' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"height": 2154,
"imageMap": "<string>",
"imageMapName": "<string>",
"location": "<string>",
"width": 2154
}Fetch available reports list.
integer
string
integer
Chart
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/chart/reports' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"reports": {
"allElements": [
{
"key": "<string>",
"name": "<string>"
}
],
"maxResult": 2154,
"reports": [
{
"key": "<string>",
"name": "<string>"
}
],
"size": 2154,
"startIndex": 2154
}
}Clone an existing Plan into a new one, possibly into different project.
string
Requiredstring
Requiredstring
Requiredstring
RequiredCloned plan
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/clone/{projectKey}-{buildKey}:{toProjectKey}-{toBuildKey}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
{
"actions": {
"allElements": [
{
"name": "<string>"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {
"allElements": [
{
"branchKey": "<string>",
"branchName": "<string>"
}
],
"branches": [
{
"branchKey": "<string>",
"branchName": "<string>"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"buildName": "<string>",
"building": true,
"currentRestUser": {
"email": "<string>",
"enabled": true,
"fullName": "<string>",
"name": "<string>"
},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {
"href": "<string>",
"rel": "<string>"
},
"parentKey": "<string>",
"parentLink": {
"href": "<string>",
"rel": "<string>"
},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"project": {
"description": "<string>",
"expand": "<string>",
"id": 2154,
"key": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"name": "<string>",
"plans": {
"allElements": [],
"maxResult": 2154,
"plans": [],
"size": 2154,
"startIndex": 2154
},
"project": {
"description": "<string>",
"entityType": "CHAIN",
"id": 2154,
"key": "<string>",
"labellings": [
{}
],
"markedForDeletion": true,
"name": "<string>",
"oid": {},
"relatedLabellings": [
{}
],
"vcsBambooSpecsSource": {}
},
"uriInfo": {
"absolutePath": "<string>",
"absolutePathBuilder": {},
"baseUri": "<string>",
"baseUriBuilder": {},
"matchedResources": [
{}
],
"matchedURIs": [
"<string>"
],
"path": "<string>",
"pathParameters": {},
"pathSegments": [
{
"matrixParameters": {},
"path": "<string>"
}
],
"queryParameters": {},
"requestUri": "<string>",
"requestUriBuilder": {}
},
"user": {
"email": "<string>",
"enabled": true,
"fullName": "<string>",
"name": "<string>"
}
},
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {
"key": "<string>"
},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {
"allElements": [
{
"plans": {}
}
],
"maxResult": 2154,
"size": 2154,
"stages": [
{
"plans": {}
}
],
"startIndex": 2154
},
"type": "<string>",
"variableContext": {
"maxResults": 2154,
"size": 2154,
"startIndex": 2154
}
}Get a list of agents/images assigned to given job.
string
RequiredReturns list of assigned agents
array<RestAgentAssignmentExecutorDetails>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/config/job/{jobKey}/agent-assignment' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
[
{
"agentType": "LOCAL",
"capabilitiesMatch": true,
"disabled": true,
"id": 2154,
"key": "<string>",
"name": "<string>",
"removable": true,
"type": "AGENT"
}
]Add agent assignment for job. agentAssignmentKey is a map with one key-value: name - agentAssignmentKey. agentAssignmentKey is parsed by ExecutorKey.
string
RequiredA map with 'name' key which reference agent assignment key as 'value'
string
Returns new agent assignments for the given job.
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/config/job/{jobKey}/agent-assignment' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '"<string>"'1
2
3
4
5
6
7
8
9
10
{
"agentType": "LOCAL",
"capabilitiesMatch": true,
"disabled": true,
"id": 2154,
"key": "<string>",
"name": "<string>",
"removable": true,
"type": "AGENT"
}Get a list of agents/images/templates which can be dedicated for given job.
string
Requiredinteger
string
integer
Returns possible agents for job.
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/config/job/{jobKey}/agent-assignment/possible-agent-assignment' \
--header 'Accept: application/json'Remove agent/image from list of dedicated executors for given job.
string
Requiredstring
RequiredAgent assignment has been removed successfully.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/config/job/{jobKey}/agent-assignment/{executorKey}'Fetch current user details
This request has no parameters.
User details
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/currentUser' \
--header 'Accept: application/json'1
2
3
4
5
{
"email": "<string>",
"fullName": "<string>",
"name": "<string>"
}Search for available plan child dependencies
string
Requiredstring
Requiredinteger
string
Requiredinteger
Plan dependencies
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/dependency/search/{projectKey}-{buildKey}/child?searchTerm={searchTerm}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
{
"dependencies": {
"allElements": [
{
"actions": {},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {},
"buildName": "<string>",
"building": true,
"currentRestUser": {},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {},
"parentKey": "<string>",
"parentLink": {},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"project": {},
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {},
"type": "<string>",
"variableContext": {}
}
],
"maxResult": 2154,
"plans": [
{
"actions": {},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {},
"buildName": "<string>",
"building": true,
"currentRestUser": {},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {},
"parentKey": "<string>",
"parentLink": {},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"project": {},
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {},
"type": "<string>",
"variableContext": {}
}
],
"size": 2154,
"startIndex": 2154
},
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
}
}Search for available plan parent dependencies
string
Requiredstring
Requiredinteger
string
Requiredinteger
Plan parent dependencies
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/dependency/search/{projectKey}-{buildKey}/parent?searchTerm={searchTerm}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
{
"dependencies": {
"allElements": [
{
"actions": {},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {},
"buildName": "<string>",
"building": true,
"currentRestUser": {},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {},
"parentKey": "<string>",
"parentLink": {},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"project": {},
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {},
"type": "<string>",
"variableContext": {}
}
],
"maxResult": 2154,
"plans": [
{
"actions": {},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {},
"buildName": "<string>",
"building": true,
"currentRestUser": {},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {},
"parentKey": "<string>",
"parentLink": {},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"project": {},
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {},
"type": "<string>",
"variableContext": {}
}
],
"size": 2154,
"startIndex": 2154
},
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
}
}Get all deployment projects. This method fetch all deployment projects visible to user. It's not optimized for instances with large count of deployment projects and environments, use paged versions instead.
This request has no parameters.
Deployment projects with environments
array<DashboardProjectWithEnvironmentStatus>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/dashboard' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
[
{
"deploymentProject": {
"description": "<string>",
"environments": [
{}
],
"id": 2154,
"key": {},
"name": "<string>",
"oid": {},
"operations": {},
"planKey": {},
"repositorySpecsManaged": true,
"vcsBambooSpecsSource": {}
},
"environmentStatuses": [
{
"deploymentResult": {},
"environment": {}
}
],
"futureVersion": {
"ageZeroPoint": "<string>",
"creationDate": "<string>",
"creatorDisplayName": "<string>",
"creatorUserName": "<string>",
"deploymentProjectId": 2154,
"id": 2154,
"items": [
{}
],
"name": "<string>",
"operations": {},
"planBranchName": "<string>",
"variableContext": [
{}
],
"versionStatus": {},
"versionStatuses": [
{}
]
},
"relatedVersion": {
"ageZeroPoint": "<string>",
"creationDate": "<string>",
"creatorDisplayName": "<string>",
"creatorUserName": "<string>",
"deploymentProjectId": 2154,
"id": 2154,
"items": [
{}
],
"name": "<string>",
"operations": {},
"planBranchName": "<string>",
"variableContext": [
{}
],
"versionStatus": {},
"versionStatuses": [
{}
]
}
}
]Get paginated deployment projects with environments list.
string
integer
integer
Paged response
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/dashboard/paginate' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"description": "<string>",
"environments": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"operations": {},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{}
],
"triggerDefinitions": [
{}
]
}
],
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"oid": {
"entityOid": 2154,
"entityType": "CHAIN",
"serverKey": 2154,
"value": 2154
},
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"repositorySpecsManaged": true,
"vcsBambooSpecsSource": {
"id": 2154,
"sourceLocation": "<string>",
"vcsLocationBambooSpecsState": {},
"yamlConfiguration": true
}
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Get deployment project environments.
string
Requiredstring
integer
string
Deployment project with paged environments
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/dashboard/paginate/{projectId}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"description": "<string>",
"environments": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"operations": {},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{}
],
"triggerDefinitions": [
{}
]
}
],
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"oid": {
"entityOid": 2154,
"entityType": "CHAIN",
"serverKey": 2154,
"value": 2154
},
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"repositorySpecsManaged": true,
"vcsBambooSpecsSource": {
"id": 2154,
"sourceLocation": "<string>",
"vcsLocationBambooSpecsState": {},
"yamlConfiguration": true
}
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Get environment latest release info.
identifiers of environments
array<integer>
Environments latest deployment results
array<RestEnvironmentStatusForDashboard>
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/deploy/dashboard/status' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"ids": [
2154
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
[
{
"deploymentResultId": 2154,
"deploymentState": "Unknown",
"deploymentVersionId": 2154,
"deploymentVersionName": "<string>",
"deploymentVersionRelatedBranchName": "<string>",
"deploymentVersionStatuses": [
{
"deploymentVersionState": "Unknown",
"versionStatusSanitizedUserName": "<string>",
"versionStatusUserDisplayName": "<string>",
"versionStatusUserName": "<string>"
}
],
"environmentId": 2154,
"executedDate": "<string>",
"finishedDate": "<string>",
"lifeCycleState": "Pending",
"queuedDate": "<string>",
"startedDate": "<string>"
}
]Get deployment project environments with deployment status. It's not optimized for instances with large count of deployment projects and environments, use paged versions instead.
string
RequiredDeployment project with environments
array<DashboardProjectWithEnvironmentStatus>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/dashboard/{projectId}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
[
{
"deploymentProject": {
"description": "<string>",
"environments": [
{}
],
"id": 2154,
"key": {},
"name": "<string>",
"oid": {},
"operations": {},
"planKey": {},
"repositorySpecsManaged": true,
"vcsBambooSpecsSource": {}
},
"environmentStatuses": [
{
"deploymentResult": {},
"environment": {}
}
],
"futureVersion": {
"ageZeroPoint": "<string>",
"creationDate": "<string>",
"creatorDisplayName": "<string>",
"creatorUserName": "<string>",
"deploymentProjectId": 2154,
"id": 2154,
"items": [
{}
],
"name": "<string>",
"operations": {},
"planBranchName": "<string>",
"variableContext": [
{}
],
"versionStatus": {},
"versionStatuses": [
{}
]
},
"relatedVersion": {
"ageZeroPoint": "<string>",
"creationDate": "<string>",
"creatorDisplayName": "<string>",
"creatorUserName": "<string>",
"deploymentProjectId": 2154,
"id": 2154,
"items": [
{}
],
"name": "<string>",
"operations": {},
"planBranchName": "<string>",
"variableContext": [
{}
],
"versionStatus": {},
"versionStatuses": [
{}
]
}
}
]Provide a paginated list of minimal information about environments executable by a given agent.
string
Requiredstring
integer
integer
Paginated deployment project's and environment's ids and names
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/agent/{agentId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"environmentId": 2154,
"environmentName": "<string>",
"projectId": 2154,
"projectName": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Provide a paginated list of minimal information about environments executable by a given elastic image configuration.
string
Requiredstring
integer
integer
Paginated deployment project's and environment's ids and names
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/elasticImageConfiguration/{configurationId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"environmentId": 2154,
"environmentName": "<string>",
"projectId": 2154,
"projectName": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Provide a paginated list of minimal information about environments executable by a given ephemeral agent template.
string
Requiredstring
integer
integer
Paginated deployment project's and environment's ids and names
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/ephemeral/{templateId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"environmentId": 2154,
"environmentName": "<string>",
"projectId": 2154,
"projectName": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Get a summary of a single environment.
string
RequiredEnvironment with the given id
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
"compatibleAgentsCount": 2154,
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"notificationsCount": 2154,
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{
"conditions": [
{
"conditionPluginKey": "<string>",
"configuration": {}
}
],
"configuration": {},
"enabled": true,
"entityType": "CHAIN",
"finalising": true,
"id": 2154,
"oid": {
"entityOid": 2154,
"entityType": "CHAIN",
"serverKey": 2154,
"value": 2154
},
"pluginKey": "<string>",
"rootDirectorySelector": {
"repositoryDefiningWorkingDirectory": 2154,
"taskRootDirectoryType": "INHERITED"
},
"userDescription": "<string>"
}
],
"triggerDefinitions": [
{
"configuration": {},
"enabled": true,
"id": 2154,
"name": "<string>",
"pluginKey": "<string>",
"triggerConditionsConfiguration": {},
"triggeringRepositories": [
2154
],
"userDescription": "<string>"
}
],
"triggersCount": 2154,
"variablesCount": 2154
}Get a list of agents/images assigned to given environment.
string
RequiredReturns list of assigned agents
array<RestAgentAssignmentExecutorDetails>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/agent-assignment' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
[
{
"agentType": "LOCAL",
"capabilitiesMatch": true,
"disabled": true,
"id": 2154,
"key": "<string>",
"name": "<string>",
"removable": true,
"type": "AGENT"
}
]Add agent assignment for environment. agentAssignmentKey is a map with one key-value: name - agentAssignmentKey. agentAssignmentKey is parsed by ExecutorKey.
string
RequiredA map with 'name' key which reference agent assignment key as 'value'
string
Returns new agent assignments for the given environment.
1
2
3
4
5
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/agent-assignment' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '"<string>"'1
2
3
4
5
6
7
8
9
10
{
"agentType": "LOCAL",
"capabilitiesMatch": true,
"disabled": true,
"id": 2154,
"key": "<string>",
"name": "<string>",
"removable": true,
"type": "AGENT"
}Remove agent/image from list of dedicated executors for given environment.
string
Requiredstring
RequiredAgent assignment has been removed successfully.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/agent-assignment/{executorKey}'Get Docker configuration for given environment.
string
RequiredReturns Docker Pipeline configuration for given environment
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/docker' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"additionalArguments": [
"<string>"
],
"dataVolumes": [
{
"containerDirectory": "<string>",
"hostDirectory": "<string>"
}
],
"dockerImage": "<string>",
"enabled": true
}Save Docker configuration for given environment.
string
RequiredDocker pipelines configuration
array<string>
array<RestDataVolume>
string
boolean
Docker Pipeline configuration saved
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/docker' \
--header 'Content-Type: application/json' \
--data '{
"additionalArguments": [
"<string>"
],
"dataVolumes": [
{
"containerDirectory": "<string>",
"hostDirectory": "<string>"
}
],
"dockerImage": "<string>",
"enabled": true
}'Change environment position within deployment project.
string
Requiredstring
Requiredstring
RequiredEnvironment position has been changed.
1
2
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/move/{position}/{relativeEnvironmentId}'Get a list of agents/images/templates which can be dedicated for given environment.
string
Requiredinteger
string
integer
Returns possible agents for environment.
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/possible-agent-assignment' \
--header 'Accept: application/json'Updates the environment prerequisites.
string
RequiredThe new environment prerequisites.
string
boolean
Environment prerequisites has been updated successfully
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/prerequisites' \
--header 'Content-Type: application/json' \
--data '{
"releaseApprovalPrerequisite": "NONE",
"releaseApprovalPrerequisitePresent": true
}'Gets all the requirements of an environment.
string
RequiredA list of a requirements
array<RestRequirement>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/requirement' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[
{
"id": 2154,
"key": "<string>",
"matchValue": "<string>",
"operations": {
"canDelete": true
},
"readonlyData": {
"matchingAgents": 2154,
"matchingImages": 2154,
"matchingTemplates": 2154
},
"self": "<string>",
"typeOfMatch": "EXISTS"
}
]Adds a requirement for a given environment.
string
RequiredA representation of the requirement
string
string
RequirementOperations
RequirementReadonlyData
string
The created requirement
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/requirement' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"matchValue": "<string>",
"operations": {
"canDelete": true
},
"readonlyData": {
"matchingAgents": 2154,
"matchingImages": 2154,
"matchingTemplates": 2154
},
"typeOfMatch": "EXISTS"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"id": 2154,
"key": "<string>",
"matchValue": "<string>",
"operations": {
"canDelete": true
},
"readonlyData": {
"matchingAgents": 2154,
"matchingImages": 2154,
"matchingTemplates": 2154
},
"self": "<string>",
"typeOfMatch": "EXISTS"
}Gets a detailed summary of the agents that are capable of running an environment, based of its requirements.
string
RequiredA summary of the agents that can run an environment
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/requirement/detailedSummary' \
--header 'Accept: application/json'1
2
3
{
"self": "<string>"
}Gets a summary of the agents that are capable of running an environment, based of its requirements.
string
RequiredA summary of the agents that can run an environment
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/requirement/summary' \
--header 'Accept: application/json'1
2
3
{
"self": "<string>"
}Gets the details of a requirement for a given environment.
string
Requiredstring
RequiredA list of a requirements
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/requirement/{requirementId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"id": 2154,
"key": "<string>",
"matchValue": "<string>",
"operations": {
"canDelete": true
},
"readonlyData": {
"matchingAgents": 2154,
"matchingImages": 2154,
"matchingTemplates": 2154
},
"self": "<string>",
"typeOfMatch": "EXISTS"
}Updates a requirement for a given environment.
string
Requiredstring
RequiredA representation of the requirement
string
string
RequirementOperations
RequirementReadonlyData
string
The updated requirement
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/requirement/{requirementId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"matchValue": "<string>",
"operations": {
"canDelete": true
},
"readonlyData": {
"matchingAgents": 2154,
"matchingImages": 2154,
"matchingTemplates": 2154
},
"typeOfMatch": "EXISTS"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"id": 2154,
"key": "<string>",
"matchValue": "<string>",
"operations": {
"canDelete": true
},
"readonlyData": {
"matchingAgents": 2154,
"matchingImages": 2154,
"matchingTemplates": 2154
},
"self": "<string>",
"typeOfMatch": "EXISTS"
}Removes a requirement for an environment.
string
Requiredstring
RequiredThe environment's requirement has been deleted successfully
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/requirement/{requirementId}'Get a list of versions deployed to the environment. Sorted by started date: newest first.
string
Requiredstring
Returns list of deployment results.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/results' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
{
"results": [
{
"agent": {
"active": true,
"agentStatus": {},
"busy": true,
"dedicated": true,
"definition": {},
"enabled": true,
"id": 2154,
"name": "<string>",
"requestedToBeStopped": true,
"type": "LOCAL",
"unresponsive": true
},
"agentId": 2154,
"agentType": "LOCAL",
"customData": {},
"deploymentState": "Unknown",
"deploymentVersion": {
"ageZeroPoint": "<string>",
"creationDate": "<string>",
"creatorDisplayName": "<string>",
"creatorUserName": "<string>",
"deploymentProjectId": 2154,
"id": 2154,
"items": [
{}
],
"name": "<string>",
"operations": {},
"planBranchName": "<string>",
"variableContext": [
{}
],
"versionStatus": {},
"versionStatuses": [
{}
]
},
"deploymentVersionName": "<string>",
"environment": {
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"operations": {},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"requirementSet": {},
"requirementSetSupplier": {},
"suspended": true,
"taskDefinitions": [
{}
],
"taskDefinitionsSupplier": {},
"triggerDefinitions": [
{}
],
"triggerDefinitionsSupplier": {}
},
"environmentId": 2154,
"executedDate": "<string>",
"finishedDate": "<string>",
"id": 2154,
"key": {
"deploymentResultId": 2154,
"entityKey": {},
"key": "<string>",
"resultNumber": 2154,
"resultNumberLong": 2154
},
"lifeCycleState": "Pending",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"queuedDate": "<string>",
"reasonSummary": "<string>",
"startedDate": "<string>",
"triggerReason": {
"key": "<string>",
"name": "<string>",
"nameForSentence": "<string>"
}
}
]
}Create the environment variable.
string
RequiredThe new variable.
string
string
Variable has been created successfully
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/variable' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "my_variable",
"value": "variable value"
}'1
2
3
4
5
6
{
"key": "<string>",
"password": true,
"value": "<string>",
"variableType": "<string>"
}Get the environment variable by its name.
string
Requiredstring
RequiredEnvironment variable with the given name
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/variable/{variableName}' \
--header 'Accept: application/json'1
2
3
4
{
"name": "my_variable",
"value": "variable value"
}Update the environment variable.
string
Requiredstring
RequiredThe updated variable.
string
string
Variable has been updated successfully
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/variable/{variableName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "my_variable",
"value": "variable value"
}'1
2
3
4
5
6
{
"key": "<string>",
"password": true,
"value": "<string>",
"variableType": "<string>"
}Delete the environment variable.
string
Requiredstring
RequiredVariable has been deleted successfully
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/variable/{variableName}'Get a list of environment variables.
string
RequiredList of variables for the given environment id
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/environment/{environmentId}/variables' \
--header 'Accept: application/json'Get all deployment projects associated with Jira issue key
string
RequiredDeployment projectes associated with Jira issue
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/issue-status/{issueKey}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
{
"deploymentProjects": [
{
"environmentCount": 2154,
"id": 2154,
"name": "<string>",
"upToDateEnvironmentCount": 2154,
"url": "<string>"
}
]
}Get deployment project environments and versions associated with Jira issue
string
Requiredstring
RequiredEnvironments and versions associated with Jira issue
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/issue-status/{issueKey}/{deploymentProjectId}' \
--header 'Accept: application/json'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
{
"deploymentProject": {
"environmentCount": 2154,
"id": 2154,
"name": "<string>",
"upToDateEnvironmentCount": 2154,
"url": "<string>"
},
"environments": [
{
"id": 2154,
"issueStatus": "NOT_AVAILABLE",
"name": "<string>",
"statusOk": true,
"url": "<string>",
"version": {
"id": 2154,
"name": "<string>",
"url": "<string>"
}
}
],
"versions": [
{
"id": 2154,
"name": "<string>",
"url": "<string>"
}
]
}Get possible deployment results.
string
string
RequiredPossible results.
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/preview/possibleResults?planKey={planKey}' \
--header 'Accept: application/json'Get a preview of the deployment version.
string
string
string
string
string
Preview of the deployment version
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/preview/result' \
--header 'Accept: application/json'Get a preview of the deployment version.
string
string
string
string
Deployment version preview.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/preview/version' \
--header 'Accept: application/json'Get version name.
string
integer
RequiredVersion name
VersionName
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/preview/versionName?deploymentProjectId={deploymentProjectId}' \
--header 'Accept: application/json'Create deployment project.
deployment project to be created
string
string
PlanKey
boolean
Created deployment project
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/deploy/project' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"name": "<string>",
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"publicAccess": true
}'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
{
"description": "<string>",
"environments": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{
"conditions": [
{}
],
"configuration": {},
"enabled": true,
"entityType": "CHAIN",
"finalising": true,
"id": 2154,
"oid": {},
"pluginKey": "<string>",
"rootDirectorySelector": {},
"userDescription": "<string>"
}
],
"triggerDefinitions": [
{
"configuration": {},
"enabled": true,
"id": 2154,
"name": "<string>",
"pluginKey": "<string>",
"triggerConditionsConfiguration": {},
"triggeringRepositories": [
2154
],
"userDescription": "<string>"
}
]
}
],
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"oid": {
"entityOid": 2154,
"entityType": "CHAIN",
"serverKey": 2154,
"value": 2154
},
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"repositorySpecsManaged": true,
"vcsBambooSpecsSource": {
"id": 2154,
"sourceLocation": "<string>",
"vcsLocationBambooSpecsState": {
"branch": "<string>",
"id": 2154,
"logFilename": "<string>",
"revision": "<string>",
"specImportState": "SUCCESS",
"specsExecutionDate": "<string>",
"specsNotFound": true,
"vcsLocationId": 2154
},
"yamlConfiguration": true
}
}Find all deployment projects with environments. Returns only deployment projects and environments visible for user.
This request has no parameters.
List of deployment projects with environments
array<RestDeploymentProject>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/project/all' \
--header 'Accept: application/json'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
55
56
57
58
59
60
[
{
"description": "<string>",
"environments": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {},
"name": "<string>",
"operations": {},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{}
],
"triggerDefinitions": [
{}
]
}
],
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"oid": {
"entityOid": 2154,
"entityType": "CHAIN",
"serverKey": 2154,
"value": 2154
},
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"repositorySpecsManaged": true,
"vcsBambooSpecsSource": {
"id": 2154,
"sourceLocation": "<string>",
"vcsLocationBambooSpecsState": {},
"yamlConfiguration": true
}
}
]Get list of deployment projects for a build plan.
string
Requiredlist of linked deployment projects
array<RestLinkedDeploymentProject>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/project/forPlan?planKey={planKey}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
[
{
"description": "<string>",
"id": 2154,
"name": "<string>"
}
]Get deployment project by id.
string
RequiredDeployment project details
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
{
"description": "<string>",
"environments": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{
"conditions": [
{}
],
"configuration": {},
"enabled": true,
"entityType": "CHAIN",
"finalising": true,
"id": 2154,
"oid": {},
"pluginKey": "<string>",
"rootDirectorySelector": {},
"userDescription": "<string>"
}
],
"triggerDefinitions": [
{
"configuration": {},
"enabled": true,
"id": 2154,
"name": "<string>",
"pluginKey": "<string>",
"triggerConditionsConfiguration": {},
"triggeringRepositories": [
2154
],
"userDescription": "<string>"
}
]
}
],
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"oid": {
"entityOid": 2154,
"entityType": "CHAIN",
"serverKey": 2154,
"value": 2154
},
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"repositorySpecsManaged": true,
"vcsBambooSpecsSource": {
"id": 2154,
"sourceLocation": "<string>",
"vcsLocationBambooSpecsState": {
"branch": "<string>",
"id": 2154,
"logFilename": "<string>",
"revision": "<string>",
"specImportState": "SUCCESS",
"specsExecutionDate": "<string>",
"specsNotFound": true,
"vcsLocationId": 2154
},
"yamlConfiguration": true
}
}Update deployment project.
string
Requireddeployment project to be updated
string
string
PlanKey
Deployment project details
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"name": "<string>",
"planKey": {
"key": "<string>",
"partialKey": "<string>"
}
}'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
{
"description": "<string>",
"environments": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{
"conditions": [
{}
],
"configuration": {},
"enabled": true,
"entityType": "CHAIN",
"finalising": true,
"id": 2154,
"oid": {},
"pluginKey": "<string>",
"rootDirectorySelector": {},
"userDescription": "<string>"
}
],
"triggerDefinitions": [
{
"configuration": {},
"enabled": true,
"id": 2154,
"name": "<string>",
"pluginKey": "<string>",
"triggerConditionsConfiguration": {},
"triggeringRepositories": [
2154
],
"userDescription": "<string>"
}
]
}
],
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"oid": {
"entityOid": 2154,
"entityType": "CHAIN",
"serverKey": 2154,
"value": 2154
},
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"repositorySpecsManaged": true,
"vcsBambooSpecsSource": {
"id": 2154,
"sourceLocation": "<string>",
"vcsLocationBambooSpecsState": {
"branch": "<string>",
"id": 2154,
"logFilename": "<string>",
"revision": "<string>",
"specImportState": "SUCCESS",
"specsExecutionDate": "<string>",
"specsNotFound": true,
"vcsLocationId": 2154
},
"yamlConfiguration": true
}
}Delete deployment project.
string
RequiredDeployment project removed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}'List of repositories which granted to create/edit environment in given deployment project by Repository stored Bamboo Specs.
string
RequiredArray of repositories granted to create/edit environment in given deployment project by Repository stored Bamboo Specs.
array<RestRepository>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}/repository' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
[
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
]Grant permission to create/edit plan in given deployment project by Bamboo Specs from given repository.
string
Requiredrepository id
integer
added repository
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}/repository' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"id": 2154
}'1
2
3
4
5
{
"id": 123,
"name": "linked repository 1",
"url": "http://localhost:8085/admin/configureLinkedRepositories.action?repositoryId=123"
}Search for linked repositories which can be granted to create/modify environment by Repository stored Bamboo Specs in given deployment project.
string
Requiredinteger
string
integer
Page container with linked repositories which have RSS enabled
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}/repository/search' \
--header 'Accept: application/json'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
{
"allElements": [
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
],
"maxResult": 2154,
"searchResults": [
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
],
"size": 2154,
"startIndex": 2154
}Remove approval to create plans in given deployment project by given repository.
string
Requiredstring
Requiredremoved repository
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}/repository/{repositoryId}'Export a deployment project to Bamboo Specs.
string
Requiredstring
string
A JSON object with a code field containing the spec
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}/specs' \
--header 'Accept: application/json'Create deployment version for given deployment project.
string
Requireddeployment version to be created
string
string
string
Deployment project version
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}/version' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"nextVersionName": "<string>",
"planResultKey": "<string>"
}'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
55
{
"ageZeroPoint": "<string>",
"creationDate": "<string>",
"creatorDisplayName": "<string>",
"creatorUserName": "<string>",
"deploymentProjectId": 2154,
"id": 2154,
"items": [
{
"id": 2154,
"name": "<string>",
"type": "BAM_ARTIFACT"
}
],
"name": "<string>",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"planBranchName": "<string>",
"variableContext": [
{
"key": "<string>",
"value": "<string>",
"variableType": "GLOBAL"
}
],
"versionStatus": {
"creationDate": "<string>",
"displayName": "Admin",
"id": 2154,
"sanitizedUserName": "admin",
"userName": "admin",
"versionState": "APPROVED"
},
"versionStatuses": [
{
"creationDate": "<string>",
"displayName": "<string>",
"id": 2154,
"sanitizedUserName": "<string>",
"userName": "<string>",
"versionState": "Unknown"
}
]
}Get list of deployment versions.
string
Requiredstring
Deployment project versions
RestDeploymentVersionList
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/project/{deploymentProjectId}/versions' \
--header 'Accept: application/json'Get deployment version name preview.
string
Requiredstring
Requiredstring
string
Version name preview
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/projectVersioning/{deploymentProjectId}/namingPreview?nextVersionName={nextVersionName}' \
--header 'Accept: application/json'1
2
3
4
5
{
"errorMessage": "<string>",
"nextVersionName": "<string>",
"subsequentVersionName": "<string>"
}Get next deployment version name.
string
Requiredstring
Version name preview
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/projectVersioning/{deploymentProjectId}/nextVersion' \
--header 'Accept: application/json'1
2
3
4
5
{
"errorMessage": "<string>",
"nextVersionName": "<string>",
"subsequentVersionName": "<string>"
}Extract variables value from version name.
string
Requiredstring
RequiredCollection of variable values
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/projectVersioning/{deploymentProjectId}/parseVariables?nextVersionName={nextVersionName}' \
--header 'Accept: application/json'Get variables associated with deployment project.
string
RequiredVersion variables
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/projectVersioning/{deploymentProjectId}/variables' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"buildVariables": [
{
"key": "<string>",
"password": true,
"value": "<string>",
"variableType": "<string>"
}
],
"incrementableVariables": [
{
"key": "<string>",
"password": true,
"value": "<string>",
"variableType": "<string>"
}
]
}Get result of version deployment to environment.
string
Requiredstring
Deployment result
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/result/{deploymentResultId}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
{
"agent": {
"active": true,
"agentStatus": {
"allowDelete": true,
"displayName": "<string>",
"icon": "<string>",
"idle": true,
"label": "<string>",
"orderIndex": 2154,
"url": "<string>"
},
"busy": true,
"dedicated": true,
"definition": {
"creationDate": "<string>",
"dedicated": true,
"description": "<string>",
"enabled": true,
"ephemeralAgentDedication": {},
"ephemeralAgentDedicationUntyped": "<string>",
"id": 2154,
"lastModificationDate": "<string>",
"name": "<string>",
"type": "LOCAL"
},
"enabled": true,
"id": 2154,
"name": "<string>",
"requestedToBeStopped": true,
"type": "LOCAL",
"unresponsive": true
},
"agentId": 2154,
"agentType": "LOCAL",
"customData": {},
"deploymentState": "Unknown",
"deploymentVersion": {
"ageZeroPoint": "<string>",
"creationDate": "<string>",
"creatorDisplayName": "<string>",
"creatorUserName": "<string>",
"deploymentProjectId": 2154,
"id": 2154,
"items": [
{
"id": 2154,
"name": "<string>",
"type": "BAM_ARTIFACT"
}
],
"name": "<string>",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"planBranchName": "<string>",
"variableContext": [
{
"key": "<string>",
"value": "<string>",
"variableType": "GLOBAL"
}
],
"versionStatus": {
"creationDate": "<string>",
"displayName": "<string>",
"id": 2154,
"sanitizedUserName": "<string>",
"userName": "<string>",
"versionState": "Unknown"
},
"versionStatuses": [
{
"creationDate": "<string>",
"displayName": "<string>",
"id": 2154,
"sanitizedUserName": "<string>",
"userName": "<string>",
"versionState": "Unknown"
}
]
},
"deploymentVersionName": "<string>",
"environment": {
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"requirementSet": {
"requirements": [
{}
]
},
"requirementSetSupplier": {},
"suspended": true,
"taskDefinitions": [
{
"conditions": [
{}
],
"configuration": {},
"enabled": true,
"entityType": "CHAIN",
"finalising": true,
"id": 2154,
"oid": {},
"pluginKey": "<string>",
"rootDirectorySelector": {},
"userDescription": "<string>"
}
],
"taskDefinitionsSupplier": {},
"triggerDefinitions": [
{
"configuration": {},
"enabled": true,
"id": 2154,
"name": "<string>",
"pluginKey": "<string>",
"triggerConditionsConfiguration": {},
"triggeringRepositories": [
2154
],
"userDescription": "<string>"
}
],
"triggerDefinitionsSupplier": {}
},
"environmentId": 2154,
"executedDate": "<string>",
"finishedDate": "<string>",
"id": 2154,
"key": {
"deploymentResultId": 2154,
"entityKey": {
"key": "<string>"
},
"key": "<string>",
"resultNumber": 2154,
"resultNumberLong": 2154
},
"lifeCycleState": "Pending",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"queuedDate": "<string>",
"reasonSummary": "<string>",
"startedDate": "<string>",
"triggerReason": {
"key": "<string>",
"name": "<string>",
"nameForSentence": "<string>"
}
}Get associated build result of deployment version.
string
RequiredDeployment version and build result associated
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/version/{deploymentVersionId}/build-result' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
"deploymentVersion": {
"ageZeroPoint": "<string>",
"creationDate": "<string>",
"creatorDisplayName": "<string>",
"creatorUserName": "<string>",
"deploymentProjectId": 2154,
"id": 2154,
"items": [
{
"id": 2154,
"name": "<string>",
"type": "BAM_ARTIFACT"
}
],
"name": "<string>",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"planBranchName": "<string>",
"variableContext": [
{
"key": "<string>",
"value": "<string>",
"variableType": "GLOBAL"
}
],
"versionStatus": {
"creationDate": "<string>",
"displayName": "Admin",
"id": 2154,
"sanitizedUserName": "admin",
"userName": "admin",
"versionState": "APPROVED"
},
"versionStatuses": [
{
"creationDate": "<string>",
"displayName": "<string>",
"id": 2154,
"sanitizedUserName": "<string>",
"userName": "<string>",
"versionState": "Unknown"
}
]
},
"planResultKey": {
"buildNumber": 2154,
"entityKey": {
"key": "<string>"
},
"key": "<string>",
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"resultNumber": 2154,
"resultNumberLong": 2154
}
}Get the all users' latest statuses of deployment version.
string
RequiredLatest version status
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/deploy/version/{deploymentVersionId}/status' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"currentUserState": "APPROVED",
"statuses": [
{
"creationDate": "<string>",
"displayName": "Admin",
"id": 2154,
"sanitizedUserName": "admin",
"userName": "admin",
"versionState": "APPROVED"
}
],
"versionGeneralState": "APPROVED"
}Update deployment version status.
string
Requiredstring
RequiredLatest version status
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/deploy/version/{deploymentVersionId}/status/{newStatus}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"currentUserState": "APPROVED",
"statuses": [
{
"creationDate": "<string>",
"displayName": "Admin",
"id": 2154,
"sanitizedUserName": "admin",
"userName": "admin",
"versionState": "APPROVED"
}
],
"versionGeneralState": "APPROVED"
}Fetch all elastic image configurations.
This request has no parameters.
Array of elastic image configurations
array<RestElasticImageConfig>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/elasticConfiguration' \
--header 'Accept: application/json'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
[
{
"architecture": "<string>",
"availabilityZone": "ap-southeast-2a",
"configurationDescription": "<string>",
"configurationId": 2154,
"configurationName": "<string>",
"ebsEnabled": true,
"ebsOptimised": true,
"ebsSnapshotId": "<string>",
"iamInstanceProfileArnOrName": "<string>",
"imageFilesVersion": "<string>",
"imageId": "<string>",
"instanceType": "<string>",
"legacyEbsHandlingEnabled": true,
"perSecondBillingEnabled": true,
"platform": "<string>",
"product": "<string>",
"region": "<string>",
"rootDeviceType": "<string>",
"rootFsSizeOverride": 2154,
"startupScripts": [
"<string>"
],
"subnetId": "subnet-123,subnet-456"
}
]Create elastic image configuration.
Elastic image configuration
string
string
string
integer
string
boolean
boolean
string
string
string
Elastic image created
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
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/elasticConfiguration' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"architecture": "<string>",
"availabilityZone": "ap-southeast-2a",
"configurationDescription": "<string>",
"configurationId": 2154,
"configurationName": "<string>",
"ebsEnabled": true,
"ebsOptimised": true,
"ebsSnapshotId": "<string>",
"iamInstanceProfileArnOrName": "<string>",
"imageFilesVersion": "<string>",
"imageId": "<string>",
"instanceType": "<string>",
"legacyEbsHandlingEnabled": true,
"perSecondBillingEnabled": true,
"platform": "<string>",
"product": "<string>",
"region": "<string>",
"rootDeviceType": "<string>",
"rootFsSizeOverride": 2154,
"startupScripts": [
"<string>"
],
"subnetId": "subnet-123,subnet-456",
"useLegacyEbsHandling": true
}'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
{
"architecture": "<string>",
"availabilityZone": "ap-southeast-2a",
"configurationDescription": "<string>",
"configurationId": 2154,
"configurationName": "<string>",
"ebsEnabled": true,
"ebsOptimised": true,
"ebsSnapshotId": "<string>",
"iamInstanceProfileArnOrName": "<string>",
"imageFilesVersion": "<string>",
"imageId": "<string>",
"instanceType": "<string>",
"legacyEbsHandlingEnabled": true,
"perSecondBillingEnabled": true,
"platform": "<string>",
"product": "<string>",
"region": "<string>",
"rootDeviceType": "<string>",
"rootFsSizeOverride": 2154,
"startupScripts": [
"<string>"
],
"subnetId": "subnet-123,subnet-456"
}Bulk update of all images AMI id.
string
Requiredstring
RequiredCount of update images
any
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/elasticConfiguration/image-id/{imageId}?newImageId={newImageId}' \
--header 'Accept: application/json'Elastic image configuration details.
integer
RequiredElastic image configuration
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/elasticConfiguration/{configurationId}' \
--header 'Accept: application/json'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
{
"architecture": "<string>",
"availabilityZone": "ap-southeast-2a",
"configurationDescription": "<string>",
"configurationId": 2154,
"configurationName": "<string>",
"ebsEnabled": true,
"ebsOptimised": true,
"ebsSnapshotId": "<string>",
"iamInstanceProfileArnOrName": "<string>",
"imageFilesVersion": "<string>",
"imageId": "<string>",
"instanceType": "<string>",
"legacyEbsHandlingEnabled": true,
"perSecondBillingEnabled": true,
"platform": "<string>",
"product": "<string>",
"region": "<string>",
"rootDeviceType": "<string>",
"rootFsSizeOverride": 2154,
"startupScripts": [
"<string>"
],
"subnetId": "subnet-123,subnet-456"
}Update elastic image configuration.
integer
RequiredElastic image configuration
string
string
string
integer
string
boolean
boolean
string
string
string
Elastic image updated
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
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/elasticConfiguration/{configurationId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"architecture": "<string>",
"availabilityZone": "ap-southeast-2a",
"configurationDescription": "<string>",
"configurationId": 2154,
"configurationName": "<string>",
"ebsEnabled": true,
"ebsOptimised": true,
"ebsSnapshotId": "<string>",
"iamInstanceProfileArnOrName": "<string>",
"imageFilesVersion": "<string>",
"imageId": "<string>",
"instanceType": "<string>",
"legacyEbsHandlingEnabled": true,
"perSecondBillingEnabled": true,
"platform": "<string>",
"product": "<string>",
"region": "<string>",
"rootDeviceType": "<string>",
"rootFsSizeOverride": 2154,
"startupScripts": [
"<string>"
],
"subnetId": "subnet-123,subnet-456",
"useLegacyEbsHandling": true
}'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
{
"architecture": "<string>",
"availabilityZone": "ap-southeast-2a",
"configurationDescription": "<string>",
"configurationId": 2154,
"configurationName": "<string>",
"ebsEnabled": true,
"ebsOptimised": true,
"ebsSnapshotId": "<string>",
"iamInstanceProfileArnOrName": "<string>",
"imageFilesVersion": "<string>",
"imageId": "<string>",
"instanceType": "<string>",
"legacyEbsHandlingEnabled": true,
"perSecondBillingEnabled": true,
"platform": "<string>",
"product": "<string>",
"region": "<string>",
"rootDeviceType": "<string>",
"rootFsSizeOverride": 2154,
"startupScripts": [
"<string>"
],
"subnetId": "subnet-123,subnet-456"
}Delete elastic image configuration.
integer
RequiredElastic image removed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/elasticConfiguration/{configurationId}'Obtain logs from an EC2 instance. Note that this method will return the console output of the instance, not Bamboo agent logs.
string
RequiredInstance id and it's console output
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/elasticInstances/instance/{instanceId}/logs' \
--header 'Accept: application/json'1
2
3
4
{
"instanceId": "<string>",
"log": "<string>"
}Encrypts a given text based on the instance specific cipher. Encrypted data can be used i.a. in Repository-stored Specs. Feature can be enabled or disabled in Bamboo security configuration. Number of allowed requests per user is limited and can be modified in Bamboo security configuration.
The request containing the details of manual encryption
string
Encrypted text
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/encrypt' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"text": "Password123"
}'1
2
3
{
"encryptedText": "BAMSCRT@0@0@6WC1Z7Vl7tYo+w6Kx4Oasw=="
}Gets either pod or container related logs.
string
Requiredstring
string
string
List of log entries
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/ephemeral/pod/{pod}/logs' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"containerName": "<string>",
"lastTimeStamp": "<string>",
"logs": [
"<string>"
],
"podName": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Gets either pod or container all logs in the raw, plain text form.
string
Requiredstring
Raw logs
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/ephemeral/pod/{pod}/logs/raw' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
"<string>"
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Fetch page of ephemeral templates.
string
integer
integer
Page of ephemeral templates
array<RestEphemeralAgentTemplate>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/ephemeral/templateConfiguration' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
[
{
"configurationId": 2154,
"configurationName": "<string>",
"dedicated": true,
"enabled": true,
"self": "<string>",
"template": "<string>"
}
]Create ephemeral template configuration.
Ephemeral template configuration
integer
string
boolean
boolean
string
Ephemeral template configuration created
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/ephemeral/templateConfiguration' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"configurationId": 2154,
"configurationName": "<string>",
"dedicated": true,
"enabled": true,
"template": "<string>"
}'1
2
3
4
5
6
7
8
{
"configurationId": 2154,
"configurationName": "<string>",
"dedicated": true,
"enabled": true,
"self": "<string>",
"template": "<string>"
}Gets ephemeral template configuration details.
integer
RequiredEphemeral template configuration
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/ephemeral/templateConfiguration/{configurationId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
{
"configurationId": 2154,
"configurationName": "<string>",
"dedicated": true,
"enabled": true,
"self": "<string>",
"template": "<string>"
}Update ephemeral agent template.
integer
RequiredEphemeral agent template
integer
string
boolean
boolean
string
Ephemeral agent template updated
1
2
3
4
5
6
7
8
9
10
11
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/ephemeral/templateConfiguration/{configurationId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"configurationId": 2154,
"configurationName": "<string>",
"dedicated": true,
"enabled": true,
"template": "<string>"
}'1
2
3
4
5
6
7
8
{
"configurationId": 2154,
"configurationName": "<string>",
"dedicated": true,
"enabled": true,
"self": "<string>",
"template": "<string>"
}Delete ephemeral template configuration.
integer
RequiredEphemeral template configuration removed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/ephemeral/templateConfiguration/{configurationId}'Fetch page of ephemeral agent template capabilities.
integer
Requiredinteger
integer
Page of ephemeral agent template capabilities
array<RestEphemeralAgentTemplate>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/ephemeral/templateConfiguration/{configurationId}/capability' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
[
{
"configurationId": 2154,
"configurationName": "<string>",
"dedicated": true,
"enabled": true,
"self": "<string>",
"template": "<string>"
}
]Update ephemeral agent template capability.
integer
RequiredEphemeral agent template capability
string
string
Ephemeral agent template capability updated
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/ephemeral/templateConfiguration/{configurationId}/capability' \
--header 'Content-Type: application/json' \
--data '{
"key": "capability.key",
"value": "/usr/local/path"
}'Add ephemeral agent template capability.
integer
RequiredEphemeral agent template capability
string
string
Ephemeral agent template capability updated
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/ephemeral/templateConfiguration/{configurationId}/capability' \
--header 'Content-Type: application/json' \
--data '{
"key": "capability.key",
"value": "/usr/local/path"
}'Remove ephemeral agent template capability.
string
Requiredinteger
RequiredEphemeral agent template capability removed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/ephemeral/templateConfiguration/{configurationId}/capability/{name}'Bamboo instance details.
This request has no parameters.
Instance details
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/info' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"buildDate": "<string>",
"buildNumber": "80204",
"edition": "<string>",
"state": "SETUP",
"version": "8.2.0"
}Retrieves Docker configuration for given job.
string
RequiredReturns Docker Pipeline configuration for given environment
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/job/{jobKey}/docker' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"additionalArguments": [
"<string>"
],
"dataVolumes": [
{
"containerDirectory": "<string>",
"hostDirectory": "<string>"
}
],
"dockerImage": "<string>",
"enabled": true
}Updates Docker configuration for given job.
string
RequiredThe request containing the details of the docker pipeline configuration
array<string>
array<RestDataVolume>
string
boolean
If configuration is updated properly
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/job/{jobKey}/docker' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"additionalArguments": [
"<string>"
],
"dataVolumes": [
{
"containerDirectory": "<string>",
"hostDirectory": "<string>"
}
],
"dockerImage": "<string>",
"enabled": true
}'Returns list of groups which weren't granted explicitly any deployment project permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of groups which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/available-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Returns list of users which weren't granted explicitly any deployment project permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of users which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/available-users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieve a list of groups with their deployment project permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results.
string
Requiredinteger
integer
string
Return single page of groups with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants deployment project permissions to a given group.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/groups/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes deployment project permissions from a given group.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/groups/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of roles with their deployment project permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users.
string
Requiredinteger
integer
Return single page of roles with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/roles' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"name": "<string>",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants deployment project permissions to a given role.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/roles/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes deployment project permissions from a given role.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/roles/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results.
string
Requiredinteger
integer
string
Return single page of users with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"permissions": [
"<string>"
],
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants deployment project permissions to a given user.
string
Requiredstring
RequiredNames to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/users/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes deployment project permissions from a given user.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/deployment/{id}/users/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Returns list of groups which weren't granted explicitly any deployment environment permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of groups which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/available-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Returns list of users which weren't granted explicitly any deployment environment permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of users which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/available-users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieve a list of groups with their deployment environment permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results.
string
Requiredinteger
integer
string
Return single page of groups with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants deployment environment permissions to a given group.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/groups/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes deployment environment permissions from a given group.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/groups/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of roles with their deployment environment permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users
string
Requiredinteger
integer
Return single page of roles with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/roles' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"name": "<string>",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants deployment environment permissions to a given role.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/roles/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes deployment environment permissions from a given role.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/roles/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results.
string
Requiredinteger
integer
string
Return single page of users with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"permissions": [
"<string>"
],
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants deployment environment permissions to a given user.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/users/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes deployment environment permissions from a given user.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/environment/{id}/users/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Returns list of groups which weren't granted explicitly any permissions. Resource is paged, returns single page of resources.
integer
integer
string
string
Return single page of groups which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/global/available-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Returns list of users which weren't granted explicitly any permissions. Resource is paged, returns single page of resources.
integer
integer
string
string
Return single page of users which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/global/available-users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieve a list of groups with their global permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results.
integer
integer
string
string
Return single page of groups with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/global/groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants global permissions to a given group.
string
Requiredstring
Permission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/global/groups/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes global permissions from a given group.
string
Requiredstring
Permission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/global/groups/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of roles with their global permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users
integer
integer
string
Return single page of roles with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/global/roles' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"name": "<string>",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants global permissions to a given role.
string
Requiredstring
Permission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/global/roles/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes global permissions from a given role.
string
Requiredstring
Permission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/global/roles/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of users with their global permissions. The list can be filtered by some attributes. This resource is paged and returns a single page of results.
integer
integer
string
string
Return single page of users with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/global/users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"permissions": [
"<string>"
],
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants global permissions to a given user.
string
Requiredstring
Permission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/global/users/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes global permissions from a given user.
string
Requiredstring
Permission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/global/users/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Returns list of groups which weren't granted explicitly any plan permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of groups which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/available-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Returns list of users which weren't granted explicitly any plan permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of users which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/available-users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieve a list of groups with their plan permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results.
string
Requiredinteger
integer
string
Return single page of groups with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants plan permissions to a given group.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/groups/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes plan permissions from a given group.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/groups/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of roles with their plan permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users.
string
Requiredinteger
integer
Return single page of roles with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/roles' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"name": "<string>",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants plan permissions to a given role.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/roles/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes plan permissions from a given role.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/roles/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results.
string
Requiredinteger
integer
string
Return single page of users with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"permissions": [
"<string>"
],
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants plan permissions to a given user.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/users/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes plan permissions from a given user.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/users/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Returns list of groups which weren't granted explicitly any project permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of groups which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/available-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Returns list of users which weren't granted explicitly any project permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of users which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/available-users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieve a list of groups with their project permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results.
string
Requiredinteger
integer
string
Return single page of groups with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants project permissions to a given group.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/groups/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes project permissions from a given group.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/groups/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of roles with their project permissions. This resource is paged returns a single page of results, although only LOGGED IN users role is supported
string
Requiredinteger
integer
Return single page of roles with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/roles' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"name": "<string>",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants project permissions to a given role.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/roles/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes project permissions from a given role.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/roles/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results.
string
Requiredinteger
integer
string
Return single page of users with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"permissions": [
"<string>"
],
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants project permissions to a given user.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/users/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes project permissions from a given user.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/project/{key}/users/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Returns list of groups which weren't granted explicitly any project plan permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of groups which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/available-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Returns list of users which weren't granted explicitly any project plan permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of users which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/available-users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieve a list of groups with their project plan permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results.
string
Requiredinteger
integer
string
Return single page of groups with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants project plan permissions to a given group.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/groups/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes project plan permissions from a given group.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/groups/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of roles with their project plan permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users.
string
Requiredinteger
integer
Return single page of roles with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/roles' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"name": "<string>",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants project plan permissions to a given role.
string
Requiredstring
RequiredPermission names to grant
array<string>
IIf permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/roles/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes project plan permissions from a given role.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/roles/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results.
string
Requiredinteger
integer
string
Return single page of users with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"permissions": [
"<string>"
],
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants project plan permissions to a given user.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/users/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes project plan permissions from a given user.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/projectplan/{key}/users/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Returns list of groups which weren't granted explicitly any repository permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of groups which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/available-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Returns list of users which weren't granted explicitly any repository permissions. Resource is paged, returns single page of resources.
string
Requiredinteger
integer
string
Return single page of users which don't have any explicit permissions granted
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/available-users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieve a list of groups with their repository permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results.
string
Requiredinteger
integer
string
Return single page of groups with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"editable": false,
"name": "bamboo-admin",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants repository permissions to a given group.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/groups/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes repository permissions from a given group.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/groups/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of roles with their repository permissions. This resource is paged returns a single page of results, although only LOGGED IN users role is supported.
string
Requiredinteger
integer
Return single page of roles with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/roles' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"name": "<string>",
"permissions": [
"<string>"
],
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants repository permissions to a given role.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/roles/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes repository permissions from a given role.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/roles/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results.
string
Requiredinteger
integer
string
Return single page of users with their permissions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/users' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"email": "admin@example.com",
"fullName": "Administrator",
"name": "admin",
"permissions": [
"<string>"
],
"sanitizedName": "admin",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Grants repository permissions to a given user.
string
Requiredstring
RequiredPermission names to grant
array<string>
If permissions were granted
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/users/{name}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'Revokes repository permissions from a given user.
string
Requiredstring
RequiredPermission names to be revoked
array<string>
If permissions were revoked
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/permissions/repository/{id}/users/{name}' \
--header 'Content-Type: application/json' \
--data '[
"<string>"
]'List all plans that user has READ permission for and allowed to see.
Possible expand parameters:
plans - list of plans
plans.plan - list of plans with plan details
plans.plan.actions - list of plans with actions details
string
list of plans
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
"link": {
"href": "<string>",
"rel": "<string>"
},
"plans": {
"allElements": [
{
"actions": {},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {},
"buildName": "<string>",
"building": true,
"currentRestUser": {},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {},
"parentKey": "<string>",
"parentLink": {},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"project": {},
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {},
"type": "<string>",
"variableContext": {}
}
],
"maxResult": 2154,
"plans": [
{
"actions": {},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {},
"buildName": "<string>",
"building": true,
"currentRestUser": {},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {},
"parentKey": "<string>",
"parentLink": {},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"project": {},
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {},
"type": "<string>",
"variableContext": {}
}
],
"size": 2154,
"startIndex": 2154
}
}Plan's favicon which depends on last build result.
string
RequiredPlan's favicon
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/favicon/{planKey}' \
--header 'Accept: application/json'1
2
3
4
{
"faviconType": "<string>",
"faviconUrl": "<string>"
}Fetch plan details.
string
Requiredstring
Requiredstring
Plan details
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
{
"actions": {
"allElements": [
{
"name": "<string>"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {
"allElements": [
{
"branchKey": "<string>",
"branchName": "<string>"
}
],
"branches": [
{
"branchKey": "<string>",
"branchName": "<string>"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"buildName": "<string>",
"building": true,
"currentRestUser": {
"email": "<string>",
"enabled": true,
"fullName": "<string>",
"name": "<string>"
},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {
"href": "<string>",
"rel": "<string>"
},
"parentKey": "<string>",
"parentLink": {
"href": "<string>",
"rel": "<string>"
},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"project": {
"description": "<string>",
"expand": "<string>",
"id": 2154,
"key": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"name": "<string>",
"plans": {
"allElements": [],
"maxResult": 2154,
"plans": [],
"size": 2154,
"startIndex": 2154
},
"project": {
"description": "<string>",
"entityType": "CHAIN",
"id": 2154,
"key": "<string>",
"labellings": [
{}
],
"markedForDeletion": true,
"name": "<string>",
"oid": {},
"relatedLabellings": [
{}
],
"vcsBambooSpecsSource": {}
},
"uriInfo": {
"absolutePath": "<string>",
"absolutePathBuilder": {},
"baseUri": "<string>",
"baseUriBuilder": {},
"matchedResources": [
{}
],
"matchedURIs": [
"<string>"
],
"path": "<string>",
"pathParameters": {},
"pathSegments": [
{
"matrixParameters": {},
"path": "<string>"
}
],
"queryParameters": {},
"requestUri": "<string>",
"requestUriBuilder": {}
},
"user": {
"email": "<string>",
"enabled": true,
"fullName": "<string>",
"name": "<string>"
}
},
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {
"key": "<string>"
},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {
"allElements": [
{
"plans": {}
}
],
"maxResult": 2154,
"size": 2154,
"stages": [
{
"plans": {}
}
],
"startIndex": 2154
},
"type": "<string>",
"variableContext": {
"maxResults": 2154,
"size": 2154,
"startIndex": 2154
}
}Marks plan for deletion. Plan will be deleted by a batch job.
string
Requiredstring
RequiredPlan was marked for removal
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}'Fetch plan's shared artifact definitions.
string
Requiredstring
Requiredinteger
integer
Plan artifact definitions
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/artifact' \
--header 'Accept: application/json'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
{
"artifacts": {
"allElements": [
{
"copyPatterns": [
"<string>"
],
"exclusionPatterns": [
"<string>"
],
"httpCompressionOn": true,
"id": 2154,
"location": "<string>",
"name": "<string>",
"required": true,
"shared": true
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"link": {
"href": "<string>",
"rel": "<string>"
}
}Fetch list of branches for specified plan.
string
Requiredstring
Requiredstring
string
string
string
List of branches in the VCS of the plan's default repository
RestBranches
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/branch' \
--header 'Accept: application/json'Enable specs scanning for all branches.
string
Requiredstring
RequiredBamboo Specs scan enabled for all branches
1
2
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/branch/enableSpecsForBranches'Provide details for specified branch of a specified plan.
string
Requiredstring
Requiredstring
RequiredDetails of specified branch of the plan
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/branch/{branchName}' \
--header 'Accept: application/json'1
2
3
4
{
"branchKey": "<string>",
"branchName": "<string>"
}Create branch for a plan. You can use vcsBranch query param to define which vcsBranch should newly created branch use. If not specified it will not override vcsBranch from the plan.
string
Requiredstring
Requiredstring
Requiredstring
string
string
The newly created branch
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/branch/{branchName}' \
--header 'Accept: application/json'1
2
3
4
{
"branchKey": "<string>",
"branchName": "<string>"
}Enable plan.
string
Requiredstring
RequiredPlan successfully enabled
1
2
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/enable'Disable plan.
string
Requiredstring
RequiredPlan successfully disabled
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/enable'Add plan to favourite.
string
Requiredstring
RequiredAdded plan to favourite
1
2
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/favourite'Remove plan from favorites.
string
Requiredstring
RequiredSuccessful removal of plan from favorites
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/favourite'Fetch linked Jira issue details.
string
Requiredstring
Requiredstring
RequiredJira issue details
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/issue/{issueKey}' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"url": {
"href": "<string>",
"rel": "<string>"
}
}List of labels for plan.
string
Requiredstring
RequiredList of labels for plan
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/label' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"labels": {
"allElements": [
{
"name": "someLabel"
}
],
"label": [
{
"name": "someLabel"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"link": {
"href": "<string>",
"rel": "<string>"
}
}Add new label to plan.
string
Requiredstring
Requiredlabel content to add to build result
string
On success
1
2
3
4
5
6
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/label' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>"
}'Remove label from plan.
string
Requiredstring
Requiredstring
RequiredOn success
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/label/{labelName}'Export plan as Bamboo Specs code.
string
Requiredstring
Requiredstring
string
Bamboo Specs code for plan
RestPlanSpec
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/specs' \
--header 'Accept: application/json'Quarantine plan's test.
string
Requiredstring
Requiredstring
RequiredTest quarantined successfully
1
2
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/test/{testId}/quarantine'Unleash plan's test from quarantine.
string
Requiredstring
Requiredstring
RequiredTest unleashed successfully
1
2
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/test/{testId}/unleash'Retrieve the list of all variables for a plan.
string
Requiredstring
RequiredList of variables for the given plan
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/variables' \
--header 'Accept: application/json'Add a new plan variable.
string
Requiredstring
RequiredPlan variable
string
string
Plan variable successfully created
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/variables' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "my_variable",
"value": "variable value"
}'1
2
3
4
{
"name": "my_variable",
"value": "variable value"
}Retrieve the plan variable by given name.
string
Requiredstring
Requiredstring
RequiredA plan variable with the given id
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/variables/{variableName}' \
--header 'Accept: application/json'1
2
3
4
{
"name": "my_variable",
"value": "variable value"
}Update the plan variable.
string
Requiredstring
Requiredstring
RequiredVariable to be updated
string
string
Plan variable successfully updated
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/variables/{variableName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "my_variable",
"value": "variable value"
}'1
2
3
4
{
"name": "my_variable",
"value": "variable value"
}Delete the plan variable.
string
Requiredstring
Requiredstring
RequiredPlan variable successfully deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/variables/{variableName}'List of vcs branch names for branches that exist on the default repository of this plan.
string
Requiredstring
Requiredinteger
string
integer
List of branches in the vcs of the default repository for the given plan
RestVcsBranches
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}-{buildKey}/vcsBranches' \
--header 'Accept: application/json'Fetch plan details.
string
Requiredstring
Requiredstring
Plan details
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/plan/{projectKey}/{buildKey}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
{
"actions": {
"allElements": [
{
"name": "<string>"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {
"allElements": [
{
"branchKey": "<string>",
"branchName": "<string>"
}
],
"branches": [
{
"branchKey": "<string>",
"branchName": "<string>"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"buildName": "<string>",
"building": true,
"currentRestUser": {
"email": "<string>",
"enabled": true,
"fullName": "<string>",
"name": "<string>"
},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {
"href": "<string>",
"rel": "<string>"
},
"parentKey": "<string>",
"parentLink": {
"href": "<string>",
"rel": "<string>"
},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"project": {
"description": "<string>",
"expand": "<string>",
"id": 2154,
"key": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"name": "<string>",
"plans": {
"allElements": [],
"maxResult": 2154,
"plans": [],
"size": 2154,
"startIndex": 2154
},
"project": {
"description": "<string>",
"entityType": "CHAIN",
"id": 2154,
"key": "<string>",
"labellings": [
{}
],
"markedForDeletion": true,
"name": "<string>",
"oid": {},
"relatedLabellings": [
{}
],
"vcsBambooSpecsSource": {}
},
"uriInfo": {
"absolutePath": "<string>",
"absolutePathBuilder": {},
"baseUri": "<string>",
"baseUriBuilder": {},
"matchedResources": [
{}
],
"matchedURIs": [
"<string>"
],
"path": "<string>",
"pathParameters": {},
"pathSegments": [
{
"matrixParameters": {},
"path": "<string>"
}
],
"queryParameters": {},
"requestUri": "<string>",
"requestUriBuilder": {}
},
"user": {
"email": "<string>",
"enabled": true,
"fullName": "<string>",
"name": "<string>"
}
},
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {
"key": "<string>"
},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {
"allElements": [
{
"plans": {}
}
],
"maxResult": 2154,
"size": 2154,
"stages": [
{
"plans": {}
}
],
"startIndex": 2154
},
"type": "<string>",
"variableContext": {
"maxResults": 2154,
"size": 2154,
"startIndex": 2154
}
}Provides the directories where artifacts and build logs can be found for a given plan key. Disabled by default. See https://confluence.atlassian.com/display/BAMBOO/Plan+directory+information+REST+API for more information.
string
RequiredDirectories which may contain artifacts and log fiels for a given plan
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/planDirectoryInfo/{planKey}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"results": [
{
"artifactPlanRoots": [
"<string>"
],
"buildLogJobRoots": {},
"isBranchBuild": true,
"planName": "<string>",
"storageTag": "<string>"
}
]
}List all projects defined in Bamboo. Projects without any plan are not listed by default, unless showEmpty query param is set to true.
projects - list of projects projects.project - list of projects with project details
projects.project.plans - list of project details and plans for project
projects.project.plans.plan - list of project details and plans for project with plan details
string
boolean
List of Bamboo projects
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project' \
--header 'Accept: application/json'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
{
"link": {
"href": "<string>",
"rel": "<string>"
},
"projects": {
"allElements": [
{
"description": "<string>",
"expand": "<string>",
"id": 2154,
"key": "<string>",
"link": {},
"name": "<string>",
"plans": {},
"project": {},
"uriInfo": {
"absolutePath": "<string>",
"absolutePathBuilder": {},
"baseUri": "<string>",
"baseUriBuilder": {},
"matchedResources": [
{}
],
"matchedURIs": [
"<string>"
],
"path": "<string>",
"pathParameters": {},
"pathSegments": [
{
"matrixParameters": {},
"path": "<string>"
}
],
"queryParameters": {},
"requestUri": "<string>",
"requestUriBuilder": {}
},
"user": {}
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
}
}Create project.
Project
string
string
string
boolean
Created project
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/project' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"key": "PROJ",
"name": "My first project",
"publicAccess": true
}'1
2
3
4
5
6
{
"description": "<string>",
"key": "PROJ",
"name": "My first project",
"publicAccess": true
}Get information for project specified as project key.
plans - list of plans for project
plans.plan - list of plans with plan details (only plans visible - READ permission for user)
plans.plan.actions - list of plans with plan details and actions available for user for plan
string
Requiredstring
boolean
Project details
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
{
"description": "<string>",
"expand": "<string>",
"id": 2154,
"key": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"name": "<string>",
"plans": {
"allElements": [
{
"actions": {},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {},
"buildName": "<string>",
"building": true,
"currentRestUser": {},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {},
"parentKey": "<string>",
"parentLink": {},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {},
"type": "<string>",
"variableContext": {}
}
],
"maxResult": 2154,
"plans": [
{
"actions": {},
"active": true,
"averageBuildTimeInSeconds": 2154,
"branches": {},
"buildName": "<string>",
"building": true,
"currentRestUser": {},
"description": "<string>",
"enabled": true,
"expand": "<string>",
"favourite": true,
"id": 2154,
"link": {},
"parentKey": "<string>",
"parentLink": {},
"parentName": "<string>",
"planKey": "<string>",
"planName": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"restPlanKey": {},
"shortKey": "<string>",
"shortName": "<string>",
"stageName": "<string>",
"stages": {},
"type": "<string>",
"variableContext": {}
}
],
"size": 2154,
"startIndex": 2154
},
"project": {
"description": "<string>",
"entityType": "CHAIN",
"id": 2154,
"key": "<string>",
"labellings": [
{
"buildResultsSummary": {},
"creationDate": "<string>",
"id": 2154,
"label": {},
"lastModificationDate": "<string>",
"plan": {},
"root": {},
"userName": "<string>"
}
],
"markedForDeletion": true,
"name": "<string>",
"oid": {
"entityOid": 2154,
"entityType": "CHAIN",
"serverKey": 2154,
"value": 2154
},
"relatedLabellings": [
{
"buildResultsSummary": {},
"creationDate": "<string>",
"id": 2154,
"label": {},
"lastModificationDate": "<string>",
"plan": {},
"root": {},
"userName": "<string>"
}
],
"vcsBambooSpecsSource": {
"id": 2154,
"sourceLocation": "<string>",
"vcsLocationBambooSpecsState": {},
"yamlConfiguration": true
}
},
"uriInfo": {
"absolutePath": "<string>",
"absolutePathBuilder": {},
"baseUri": "<string>",
"baseUriBuilder": {},
"matchedResources": [
{}
],
"matchedURIs": [
"<string>"
],
"path": "<string>",
"pathParameters": {},
"pathSegments": [
{
"matrixParameters": {},
"path": "<string>"
}
],
"queryParameters": {},
"requestUri": "<string>",
"requestUriBuilder": {}
},
"user": {
"email": "<string>",
"enabled": true,
"fullName": "<string>",
"name": "<string>"
}
}Marks project for deletion. Project will be deleted by a batch job.
string
RequiredWhen project is successfully marked for deletion
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}'Retrieves paginated project repositories specified by the project key.
string
Requiredstring
integer
integer
when repositories were successfully retrieved
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/repositories' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"admin": true,
"icon": "<string>",
"id": 2154,
"location": "<string>",
"name": "<string>",
"type": "<string>",
"url": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Fetch list of repositories which granted to create plan in given project by Repository stored Bamboo Specs.
string
RequiredArray of repositories granted to create plan in given project by Repository stored Bamboo Specs
array<RestRepository>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/repository' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
[
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
]Grant permission to create/edit plan in given project by Bamboo Specs from given repository.
string
Requiredrepository id
integer
Added repository entity
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/repository' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"id": 2154
}'1
2
3
4
5
{
"id": 123,
"name": "linked repository 1",
"url": "http://localhost:8085/admin/configureLinkedRepositories.action?repositoryId=123"
}Search for linked repositories which can be granted to create plans by Repository stored Bamboo Specs in given project
string
Requiredstring
Page object with list of repositories.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/repository/search' \
--header 'Accept: application/json'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
{
"allElements": [
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
],
"maxResult": 2154,
"searchResults": [
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
],
"size": 2154,
"startIndex": 2154
}Remove approval to create plans in given project by given repository.
string
Requiredstring
RequiredSuccessfully removed link between project and repository.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/repository/{repositoryId}'Enables access (i.e. allowing usage) to all project's repositories by the Bamboo Specs code stored in this repository.
string
Requiredinteger
RequiredEnable request
boolean
Successfully enabled/disabled access of Bamboo Specs stored in the repository to all project's repositories
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/repository/{repositoryId}/enableAllRepositoriesAccess' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enable": true
}'Retrieves paginated shared credentials for the project specified by the project key.
string
Requiredstring
integer
integer
Project credentials
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/sharedCredentials' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0",
"results": [
{
"attributes": {},
"id": 2154,
"name": "myCredentials",
"projectKey": "<string>",
"self": "<string>"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Deletes shared project credentials specified by id.
string
Requiredstring
RequiredProject credentials removed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/sharedCredentials/{sharedCredentialId}'Export all of the plans for a project to Bamboo specs.
string
Requiredstring
string
representation of all project plans as Bamboo specs
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/specs' \
--header 'Accept: application/json'Create or update project variable.
string
RequiredProject variable
string
string
Updated variable
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/variable' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "my_variable",
"value": "variable value"
}'1
2
3
4
5
6
{
"key": "<string>",
"password": true,
"value": "<string>",
"variableType": "<string>"
}Retrieve the project variable by given name.
string
Requiredstring
RequiredA project variable with the given name
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/variable/{variableName}' \
--header 'Accept: application/json'1
2
3
4
{
"name": "my_variable",
"value": "variable value"
}Delete the project variable.
string
Requiredstring
RequiredProject variable successfully deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/variable/{variableName}'Retrieve the list of all variables for a project.
string
RequiredList of variables for the given project
array<RestVariable>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/variables' \
--header 'Accept: application/json'1
2
3
4
5
6
[
{
"name": "my_variable",
"value": "variable value"
}
]Provide list of build scheduled for execution and waiting in build queue.
integer
integer
List of queued builds waiting in the build queue
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/queue' \
--header 'Accept: application/json'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
{
"link": {
"href": "<string>",
"rel": "<string>"
},
"queuedBuilds": {
"allElements": [
{
"buildNumber": 2154,
"buildResultKey": "<string>",
"changes": {},
"changesets": [
{}
],
"expand": "<string>",
"link": {},
"planKey": "<string>",
"triggerReason": "<string>"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
}
}Provide list of deployment results scheduled for execution and waiting in queue.
string
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/queue/deployment' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"link": {
"href": "<string>",
"rel": "<string>"
},
"queuedDeployments": {
"allElements": [
{
"deploymentResultId": 2154
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
}
}Trigger deployment for deployment environment and version.
string
Requiredstring
Requiredstring
Trigger deployment for environment and version
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/queue/deployment?versionId={versionId}&environmentId={environmentId}' \
--header 'Accept: application/json'1
2
3
{
"deploymentResultId": 2154
}Remove deployment result from queue.
integer
RequiredSuccessfully removed deployment result from queue
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/queue/deployment/{deploymentResultId}'Fire build execution for specified plan.
Effectively, this method adds build to the build queue, so is not guarantied that build would be executed immediately.
Depending on currently executed builds and length of build queue, build may be executed when queue would be drained.
Additional variables could be passed to this method either as form encoded POST payload or query parameters. PLEASE note: Query parameters are more important - override those stored in form payload.
Variables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable.
When global or plan variables would be passed to this method, will override default values for variables.
string
Requiredstring
Requiredboolean
string
string
Information for queued build, including build number, changes and reason of build
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/queue/{projectKey}-{buildKey}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
{
"buildNumber": 2154,
"buildResultKey": "<string>",
"changes": {
"allElements": [
{
"author": "<string>",
"changeFiles": {},
"changesetId": "<string>",
"comment": "<string>",
"commitUrl": "<string>",
"date": "<string>",
"expand": "<string>",
"fullName": "<string>",
"userName": "<string>"
}
],
"change": [
{
"author": "<string>",
"changeFiles": {},
"changesetId": "<string>",
"comment": "<string>",
"commitUrl": "<string>",
"date": "<string>",
"expand": "<string>",
"fullName": "<string>",
"userName": "<string>"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"changesets": [
{
"buildTrigger": true,
"changesetId": "<string>",
"commits": [
{
"author": {},
"authorContext": {},
"changeSetId": "<string>",
"comment": "<string>",
"date": "<string>",
"files": [
{}
],
"foreignCommit": true,
"id": 2154
}
],
"id": 2154,
"position": 2154,
"repositoryData": {
"description": "<string>",
"entityType": "CHAIN",
"global": true,
"id": 2154,
"markedForDeletion": true,
"name": "<string>",
"oid": {},
"pluginKey": "<string>",
"projectId": 2154,
"version": 2154,
"xmlData": "<string>"
},
"resultsSummary": {
"active": true,
"artifactLinks": [
{}
],
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"failed": true,
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [],
"restartCount": 2154,
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"waiting": true
},
"skippedCommitsCount": 2154
}
],
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"planKey": "<string>",
"triggerReason": "<string>"
}Continue partially done build.
Effectively, this method adds build to the build queue, so is not guarantied that build would be executed immediately. Depending on currently executed builds and length of build queue, build may be executed when queue would be drained. Additional variables could be passed to this method only query parameters (variableName=variableValue). Variables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable. When global or plan variables would be passed to this method, will override values valid for previous build execution (override).
string
Requiredstring
Requiredinteger
Requiredboolean
string
Information for queued build, including build number, changes and reason of build
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/queue/{projectKey}-{buildKey}-{buildNumber}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
{
"buildNumber": 2154,
"buildResultKey": "<string>",
"changes": {
"allElements": [
{
"author": "<string>",
"changeFiles": {},
"changesetId": "<string>",
"comment": "<string>",
"commitUrl": "<string>",
"date": "<string>",
"expand": "<string>",
"fullName": "<string>",
"userName": "<string>"
}
],
"change": [
{
"author": "<string>",
"changeFiles": {},
"changesetId": "<string>",
"comment": "<string>",
"commitUrl": "<string>",
"date": "<string>",
"expand": "<string>",
"fullName": "<string>",
"userName": "<string>"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"changesets": [
{
"buildTrigger": true,
"changesetId": "<string>",
"commits": [
{
"author": {},
"authorContext": {},
"changeSetId": "<string>",
"comment": "<string>",
"date": "<string>",
"files": [
{}
],
"foreignCommit": true,
"id": 2154
}
],
"id": 2154,
"position": 2154,
"repositoryData": {
"description": "<string>",
"entityType": "CHAIN",
"global": true,
"id": 2154,
"markedForDeletion": true,
"name": "<string>",
"oid": {},
"pluginKey": "<string>",
"projectId": 2154,
"version": 2154,
"xmlData": "<string>"
},
"resultsSummary": {
"active": true,
"artifactLinks": [
{}
],
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"failed": true,
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [],
"restartCount": 2154,
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"waiting": true
},
"skippedCommitsCount": 2154
}
],
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"planKey": "<string>",
"triggerReason": "<string>"
}Stop build execution.
string
Requiredstring
Requiredinteger
RequiredOn success (success is also when build was already completed - so nothing to stop)
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/queue/{projectKey}-{buildKey}-{buildNumber}'Obtain a list of quick filters defined for this Bamboo instance.
boolean
List of quick filters. Each entity will contain only basic configuration, excluding e.g. quick filter's rules
array<RestQuickFilter>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/quickFilter' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
[
{
"hasRules": true,
"id": 2154,
"name": "Integration Tests",
"position": 2154
}
]Create a new quick filter with basic configuration, e.g. name or position on list. This method does not allow to configure quick filter's rules.
Quick filter
boolean
integer
string
integer
Returned when quick filter was created successfully. Response will contain Quick Filter definition with assigned id
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/quickFilter' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"hasRules": true,
"id": 2154,
"name": "Integration Tests",
"position": 2154
}'1
2
3
4
5
6
{
"hasRules": true,
"id": 2154,
"name": "Integration Tests",
"position": 2154
}Return active quick filters for currently logged in user.
This request has no parameters.
List of active quick filters for logged in user. Each entity will contain only basic configuration, excluding e.g. quick filter's rules
array<RestQuickFilter>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/quickFilter/active' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
[
{
"hasRules": true,
"id": 2154,
"name": "Integration Tests",
"position": 2154
}
]Deactivates all quick filter for currently logged in user.
This request has no parameters.
When all filters were successfully deactivated for current user
any
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/quickFilter/deactivate' \
--header 'Accept: application/json'Return visible quick filters for currently logged in user.
This request has no parameters.
List of visible quick filters for logged in user. Each entity will contain only basic configuration, excluding e.g. quick filter's rules
array<RestQuickFilter>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/quickFilter/visible' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
[
{
"hasRules": true,
"id": 2154,
"name": "Integration Tests",
"position": 2154
}
]Saves the list of visible quick filters for currently logged in user.
Quick filter ids
array<integer>
Returned without any content when the visible filters were successfully saved for current user
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/quickFilter/visible' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
2154
]'Get a single quick filter by id.
integer
RequiredSingle quick filter data. Will contain only basic configuration, excluding e.g. quick filter's rules
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/quickFilter/{id}' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"hasRules": true,
"id": 2154,
"name": "Integration Tests",
"position": 2154
}Update quick filter's basic configuration, e.g. name or position on list. This method does not allow to configure quick filter's rules.
integer
RequiredQuick filter
boolean
integer
string
integer
Returned when quick filter was updated successfully. Response will contain Quick Filter definition with data after update
1
2
3
4
5
6
7
8
9
10
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/quickFilter/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"hasRules": true,
"id": 2154,
"name": "Integration Tests",
"position": 2154
}'1
2
3
4
5
6
{
"hasRules": true,
"id": 2154,
"name": "Integration Tests",
"position": 2154
}Delete a quick filter.
integer
RequiredReturned when quick filter was deleted successfully
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/quickFilter/{id}'Activates a quick filter for currently logged in user.
integer
RequiredWhen filter with given id was successfully activated for current user
any
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/quickFilter/{id}/activate' \
--header 'Accept: application/json'Deactivates a quick filter for currently logged in user.
integer
RequiredWhen filter with given id was successfully deactivated for current user
any
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/quickFilter/{id}/deactivate' \
--header 'Accept: application/json'Performs a starts with search against projects, plans, plan branches, deployment projects
string
string
Search results
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/quicksearch' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
{
"json": {
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonArray": {
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonNull": {},
"asJsonObject": {},
"asJsonPrimitive": {},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true
},
"asJsonNull": {
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonArray": {},
"asJsonObject": {},
"asJsonPrimitive": {},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true
},
"asJsonObject": {
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonArray": {},
"asJsonNull": {},
"asJsonPrimitive": {},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true
},
"asJsonPrimitive": {
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonArray": {},
"asJsonNull": {},
"asJsonObject": {},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"boolean": true,
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true,
"number": true,
"string": true
},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true
},
"maxResult": 2154,
"searchResults": [
{
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonArray": {
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonNull": {},
"asJsonObject": {},
"asJsonPrimitive": {},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true
},
"asJsonNull": {
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonArray": {},
"asJsonObject": {},
"asJsonPrimitive": {},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true
},
"asJsonObject": {
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonArray": {},
"asJsonNull": {},
"asJsonPrimitive": {},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true
},
"asJsonPrimitive": {
"asBigDecimal": 2154,
"asBigInteger": 2154,
"asBoolean": true,
"asByte": "<string>",
"asCharacter": "<string>",
"asDouble": 2154,
"asFloat": 2154,
"asInt": 2154,
"asJsonArray": {},
"asJsonNull": {},
"asJsonObject": {},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"boolean": true,
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true,
"number": true,
"string": true
},
"asLong": 2154,
"asNumber": 2154,
"asShort": 2154,
"asString": "<string>",
"jsonArray": true,
"jsonNull": true,
"jsonObject": true,
"jsonPrimitive": true
}
],
"size": 2154,
"startIndex": 2154
}Kicks off a reindex. Requires system admin permissions to perform this reindex.
This request has no parameters.
Reindex is finished
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/reindex' \
--header 'Accept: application/json'1
2
3
4
{
"reindexInProgress": true,
"reindexPending": true
}Kicks off a reindex. Requires system admin permissions to perform this operation.
This request has no parameters.
Response that provides a redirect to the GET
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/reindex' \
--header 'Accept: application/json'1
2
3
4
{
"reindexInProgress": true,
"reindexPending": true
}Search for existing linked repositories by name.
string
The page object with repositories
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/repository' \
--header 'Accept: application/json'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
{
"allElements": [
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
],
"maxResult": 2154,
"searchResults": [
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
],
"size": 2154,
"startIndex": 2154
}Webhook resource for triggering Repository-stored Bamboo Specs. Either repository ID or name must be provided via query parameters to identify the linked repository in which Bamboo Specs are defined.
Ambiguous requests, which reference more than one repository via the query params, will result in one parameter taking precedence over the others. There's no guarantee which one.
This resource does not require authorisation. It will always return HTTP 204 response on every valid request, even if the targeted repository doesn't exist or does not contain Bamboo Specs.
string
integer
integer
string
On any valid request
1
2
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/repository/scan'Tests connection to a repository if the repository type supports connection testing. Request payload should contain repository configuration.
object
Successful call (without validation errors) will result in HTTP 200. The response will contain potential connection errors. If the connection to repository was successful, the error list will be empty
1
2
3
4
5
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/repository/testConnection' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'1
2
3
4
5
{
"connectionErrors": [
"<string>"
]
}Enables access (i.e. allowing modifications) for all Bamboo projects by the Bamboo Specs code stored in this repository. Changes in Bamboo Specs detected will trigger execution of Specs and thus an update of corresponding entities (such as build plans or deployments).
integer
RequiredEnable request
boolean
Successfully enabled/disabled access of Bamboo Specs stored in the repository to all projects
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/enableAllProjectsAccess' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enable": true
}'Enables access (i.e. allowing usage in plans or deployment projects) for all Bamboo linked repositories by the Bamboo Specs code stored in this repository.
integer
RequiredEnable request
boolean
Successfully enabled/disabled access of Bamboo Specs stored in the repository to all linked repositories
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/enableAllRepositoriesAccess' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enable": true
}'Enables or disables detection of Bamboo Specs stored in the repository. If enabled, code changes detected in Bamboo Specs in new commits will trigger execution of Bamboo Specs and thus an update of corresponding entities (such as build plans, deployments or permissions).
integer
RequiredEnable request
boolean
Successfully enabled/disabled detection of Bamboo Specs stored in the repository
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/enableCi' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enable": true
}'Enables build and deployment project creation by the Bamboo Specs code stored in this repository.
integer
RequiredEnable request
boolean
Successfully enabled/disabled ability of Bamboo Specs stored in the repository to create projects and deployment projects
any
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/enableProjectCreation' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enable": true
}'Search for divergent branches names (i.e. vcs branches that have RSS execution results).
integer
Requiredstring
The page object with branches
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/rssBranches' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"allElements": [
{
"name": "<string>"
}
],
"maxResult": 2154,
"searchResults": [
{
"name": "<string>"
}
],
"size": 2154,
"startIndex": 2154
}Fetch list of RSS repositories which can use given repository by RSS code.
integer
Requiredarray of repositories granted to use given repository by Repository stored Bamboo Specs.
array<RestRepository>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/rssrepository' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
[
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
]Grant repository with RSS code to use target repository in build plans and deployments. If permission is not granted RSS import will fail when code tries to use target repository.
integer
RequiredId container
integer
Repository which was granted permission to
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/rssrepository' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"id": 2154
}'1
2
3
4
5
{
"id": 123,
"name": "linked repository 1",
"url": "http://localhost:8085/admin/configureLinkedRepositories.action?repositoryId=123"
}Search for existing linked repositories which can be granted to use given repository by RSS.
integer
Requiredstring
Page container with linked repositories which are RSS compatible
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/rssrepository/search' \
--header 'Accept: application/json'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
{
"allElements": [
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
],
"maxResult": 2154,
"searchResults": [
{
"id": 2154,
"name": "<string>",
"projectKey": "<string>",
"projectName": "<string>",
"rssEnabled": true,
"url": "<string>"
}
],
"size": 2154,
"startIndex": 2154
}Resource providing status of RSS processing for a given repository and optional branch.
integer
Requiredinteger
string
The object representing RSS status
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/scan/status' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"inProgress": true,
"specsLogs": [
{
"branch": "<string>",
"id": 2154,
"logFilename": "<string>",
"logUrl": "<string>",
"revision": "<string>",
"specImportState": "SUCCESS",
"specsExecutionDate": "<string>",
"specsNotFound": true,
"vcsLocationId": 2154
}
]
}Resource for triggering Repository-stored Bamboo Specs in a 'forced' way. Successful requests to this resource will trigger Bamboo Specs execution even if standard processing would have been skipped (e.g. no new commits to process).
integer
Requiredstring
On a valid request, when Specs scanning has been successfully enqueued
1
2
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/scanNow'Search for usages of given repository.
integer
Requiredinteger
integer
Plans and environments which use this repository
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/repository/{repositoryId}/usage' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
{
"environments": [
{
"configurationState": "CREATED",
"deploymentProjectId": 2154,
"description": "<string>",
"id": 2154,
"key": {
"key": "<string>"
},
"name": "<string>",
"operations": {
"admin": true,
"allowedToCreateVersion": true,
"allowedToExecute": true,
"allowedToSetVersionStatus": true,
"canClone": true,
"canDelete": true,
"canEdit": true,
"canExecute": true,
"canView": true,
"canViewConfiguration": true,
"cantExecuteReason": "<string>"
},
"position": 2154,
"releaseApprovalPrerequisite": "NONE",
"suspended": true,
"taskDefinitions": [
{
"conditions": [
{}
],
"configuration": {},
"enabled": true,
"entityType": "CHAIN",
"finalising": true,
"id": 2154,
"oid": {},
"pluginKey": "<string>",
"rootDirectorySelector": {},
"userDescription": "<string>"
}
],
"triggerDefinitions": [
{
"configuration": {},
"enabled": true,
"id": 2154,
"name": "<string>",
"pluginKey": "<string>",
"triggerConditionsConfiguration": {},
"triggeringRepositories": [
2154
],
"userDescription": "<string>"
}
]
}
],
"inaccessibleEnvironmentsCount": 2154,
"inaccessiblePlansCount": 2154,
"plans": [
{
"buildKey": "<string>",
"buildName": "<string>",
"description": "<string>",
"id": 2154,
"masterId": 2154,
"name": "<string>",
"planKey": "<string>",
"planType": "<string>",
"project": {
"description": "<string>",
"key": "<string>",
"name": "<string>"
},
"suspendedFromBuilding": true
}
],
"totalEnvironments": 2154,
"totalPlans": 2154
}Revoke access of RSS code stored in repository defined by repositoryId from repository defined by targetRepositoryId. Use this method when need to prevent usage of target repository by RSS code stored in repository referenced by repositoryId.
integer
Requiredinteger
RequiredWhen successfully removed link between target repository and repository
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/repository/{targetRepositoryId}/rssrepository/{repositoryId}'Provide list of the latest build results for top level plans visible for users.
boolean
boolean
string
string
integer
integer
string
string
string
string
Latest build results for all plans
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result' \
--header 'Accept: application/json'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
{
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"results": {
"allElements": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"maxResult": 2154,
"results": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"size": 2154,
"startIndex": 2154
}
}Provide list of build results related to changeset id passed as parameter. List of results contains results from all plans related to this changeset.
string
RequiredBuild results for specified changeset
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/byChangeset/{csid}' \
--header 'Accept: application/json'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
{
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"results": {
"allElements": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"maxResult": 2154,
"results": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"size": 2154,
"startIndex": 2154
}
}Provide list of build results related to changeset id passed as parameter. List of results contains results from all plans which have repositories checked out with this changeset.
string
RequiredBuild results for specified changeset
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/byCheckoutChangeset/{csid}' \
--header 'Accept: application/json'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
{
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"results": {
"allElements": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"maxResult": 2154,
"results": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"size": 2154,
"startIndex": 2154
}
}Provide runtime information for currently executing build result. The key difference to other methods is that method is optimized to provide information available in memory only, so no database calls are made. The information provided is not as wide as for finished results, but the call is optimized for speed.
string
Requiredstring
Requiredstring
RequiredCurrently executing build status
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/status/{projectKey}-{buildKey}-{buildNumber}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"finished": true,
"planResultKey": "<string>",
"prettyQueuedTime": "<string>",
"progress": {
"averageBuildDuration": 2154,
"buildTime": 2154,
"expand": "<string>",
"percentageCompleted": 2154,
"percentageCompletedPretty": "<string>",
"prettyAverageBuildDuration": "<string>",
"prettyBuildTime": "<string>",
"prettyStartedTime": "<string>",
"prettyTimeRemaining": "<string>",
"prettyTimeRemainingLong": "<string>",
"startedTime": "<string>",
"startedTimeFormatted": "<string>",
"underAverageTime": true,
"valid": true
}
}Provide list of latest build results for top level plans for specified project. List of results is limited to plans visible for user.
string
Requiredboolean
boolean
string
string
integer
integer
string
string
string
string
Latest build results for plans for specified project
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}' \
--header 'Accept: application/json'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
{
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"results": {
"allElements": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"maxResult": 2154,
"results": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"size": 2154,
"startIndex": 2154
}
}Provide list of build results for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).
string
Requiredstring
Requiredboolean
boolean
string
string
integer
integer
string
string
string
string
Latest build results for specified plan. Results are ordered from latest or oldest
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}' \
--header 'Accept: application/json'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
{
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"results": {
"allElements": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"maxResult": 2154,
"results": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"size": 2154,
"startIndex": 2154
}
}Provide build result specified by projectKey-buildKey-buildNumber.
string
Requiredstring
Requiredstring
Requiredstring
string
Result of single build. Presented content contain information for finished build. If build is in progress, contains additional runtime information. Top level plan contains additionally progress information, job progress information, current log entries and hasExecutableAgent boolean flag.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}-{buildNumber}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
{
"artifacts": {
"allElements": [
{
"link": {},
"producerJobKey": {}
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {
"active": true,
"artifactLinks": [
{
"artifact": {},
"buildResultsSummary": {},
"id": 2154,
"label": "<string>",
"linkType": "<string>",
"producerJobResult": {},
"sharedArtifact": true,
"subscriptions": [
{}
]
}
],
"artifactLinksThatExist": [
{
"artifact": {},
"buildResultsSummary": {},
"id": 2154,
"label": "<string>",
"linkType": "<string>",
"producerJobResult": {},
"sharedArtifact": true,
"subscriptions": [
{}
]
}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildNumber": 2154,
"buildState": "Unknown",
"buildTime": "<string>",
"changesListSummary": "<string>",
"commits": [
{
"author": {},
"authorContext": {},
"changeSetId": "<string>",
"comment": "<string>",
"date": "<string>",
"files": [
{}
],
"foreignCommit": true,
"id": 2154,
"repositoryChangeset": {}
}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"failed": true,
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{
"id": 2154,
"issueKey": "<string>",
"issueType": "BUILD_RELATES",
"jiraIssueDetails": {},
"resultsSummary": {}
}
],
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {
"active": true,
"allJobs": [
{}
],
"allStages": [
{}
],
"averageBuildDuration": 2154,
"buildDefinition": {},
"buildKey": "<string>",
"buildLogger": {},
"buildName": "<string>",
"busy": true,
"creationDate": "<string>",
"currentStatus": "<string>",
"databaseId": 2154,
"description": "<string>",
"effectiveVariables": [
{}
],
"entityType": "CHAIN",
"executing": true,
"firstBuildNumber": 2154,
"id": 2154,
"jobCount": 2154,
"key": "<string>",
"labelNames": [
"<string>"
],
"lastBuildNumber": 2154,
"lastResultKey": {},
"markedForDeletion": true,
"masterId": 2154,
"masterIdIfExists": 2154,
"name": "<string>",
"notificationSet": {},
"oid": {},
"planKey": {},
"planRepositoryDefinitions": [
{}
],
"planType": "CHAIN",
"project": {},
"stages": [
{}
],
"suspended": true,
"suspendedFromBuilding": true,
"triggerDefinitions": [
{}
],
"type": "<string>",
"variables": [
{}
],
"vcsBambooSpecsSource": {},
"version": 2154
},
"immutablePlan": {
"active": true,
"averageBuildDuration": 2154,
"buildDefinition": {},
"buildKey": "<string>",
"buildLogger": {},
"buildName": "<string>",
"busy": true,
"currentStatus": "<string>",
"databaseId": 2154,
"description": "<string>",
"effectiveVariables": [
{}
],
"entityType": "CHAIN",
"executing": true,
"firstBuildNumber": 2154,
"id": 2154,
"key": "<string>",
"labelNames": [
"<string>"
],
"lastBuildNumber": 2154,
"markedForDeletion": true,
"masterId": 2154,
"masterIdIfExists": 2154,
"name": "<string>",
"oid": {},
"planKey": {},
"planType": "CHAIN",
"project": {},
"suspendedFromBuilding": true,
"type": "<string>",
"variables": [
{}
],
"version": 2154
},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{
"id": 2154,
"issueKey": "<string>",
"issueType": "BUILD_RELATES",
"jiraIssueDetails": {},
"resultsSummary": {}
}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{
"id": 2154,
"key": "<string>",
"resultSummary": {},
"value": "<string>",
"variableType": "GLOBAL"
}
],
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {
"active": true,
"averageBuildDuration": 2154,
"buildDefinition": {},
"buildKey": "<string>",
"buildLogger": {},
"buildName": "<string>",
"busy": true,
"currentStatus": "<string>",
"databaseId": 2154,
"description": "<string>",
"effectiveVariables": [
{}
],
"entityType": "CHAIN",
"executing": true,
"firstBuildNumber": 2154,
"id": 2154,
"key": "<string>",
"labelNames": [
"<string>"
],
"lastBuildNumber": 2154,
"markedForDeletion": true,
"masterId": 2154,
"masterIdIfExists": 2154,
"name": "<string>",
"oid": {},
"planKey": {},
"planType": "CHAIN",
"project": {},
"suspendedFromBuilding": true,
"type": "<string>",
"variables": [
{}
],
"version": 2154
},
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"planName": "<string>",
"planResultKey": {
"buildNumber": 2154,
"entityKey": {},
"key": "<string>",
"planKey": {},
"resultNumber": 2154,
"resultNumberLong": 2154
},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{
"id": 2154,
"issueKey": "<string>",
"issueType": "BUILD_RELATES",
"jiraIssueDetails": {},
"resultsSummary": {}
}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{
"buildTrigger": true,
"changesetId": "<string>",
"commits": [
{}
],
"id": 2154,
"position": 2154,
"repositoryData": {},
"resultsSummary": {},
"skippedCommitsCount": 2154
}
],
"restartCount": 2154,
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{
"artifactLink": {},
"consumerResultSummary": {},
"destinationDirectory": "<string>",
"id": 2154,
"name": "<string>"
}
],
"substitutedVariables": [
{
"id": 2154,
"key": "<string>",
"resultSummary": {},
"value": "<string>",
"variableType": "GLOBAL"
}
],
"successful": true,
"testResultsSummary": {
"existingFailedTestCount": 2154,
"failedTestCaseCount": 2154,
"fixedTestCaseCount": 2154,
"ignoredTestCaseCount": 2154,
"newFailedTestCaseCount": 2154,
"quarantinedTestCaseCount": 2154,
"skippedTestCaseCount": 2154,
"successfulTestCaseCount": 2154,
"testSummaryDescription": "<string>",
"totalTestCaseCount": 2154,
"totalTestDuration": 2154
},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {
"key": "<string>",
"name": "<string>",
"nameForSentence": "<string>"
},
"uniqueAuthors": [
{
"allTriggeredBuildResults": [
{}
],
"breakages": [
{}
],
"email": "<string>",
"failedBuilds": [
{}
],
"fixes": [
{}
],
"fullName": "<string>",
"linkedUserName": "<string>",
"name": "<string>",
"numberOfBreakages": 2154,
"numberOfFailedBuilds": 2154,
"numberOfFixes": 2154,
"numberOfSuccessfulBuilds": 2154,
"numberOfTriggeredBuilds": 2154,
"successfulBuilds": [
{}
],
"triggeredBuildResults": [
{}
]
}
],
"variableContextLogs": [
{
"id": 2154,
"key": "<string>",
"resultSummary": {},
"value": "<string>",
"variableType": "GLOBAL"
}
],
"waiting": true
},
"comments": {
"allElements": [
{
"content": "first successful build",
"id": 2154
}
],
"comment": [
{
"content": "first successful build",
"id": 2154
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"jiraIssues": {
"allElements": [
{
"url": {}
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"labels": {
"allElements": [
{
"name": "someLabel"
}
],
"label": [
{
"name": "someLabel"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"link": {
"href": "<string>",
"rel": "<string>"
},
"parentLink": {
"href": "<string>",
"rel": "<string>"
},
"planResultKey": {
"buildNumber": 2154,
"entityKey": {
"key": "<string>"
},
"key": "<string>",
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"resultNumber": 2154,
"resultNumberLong": 2154
},
"stageResult": {
"allJobsExist": true,
"allNotSuccessfulJobsExist": true,
"buildResults": [
{
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"chainResultsSummary": {},
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"extraBuildResultsData": {},
"failed": true,
"filteredTestResults": {},
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueDuration": 2154,
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"resultVariables": {},
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"vcsUpdateDuration": 2154,
"vcsUpdateTime": "<string>",
"waiting": true
}
],
"chainResult": {
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"changesListSummary": "<string>",
"commits": [
{}
],
"continuable": true,
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"failed": true,
"failedJobResults": [
{}
],
"finalized": true,
"finished": true,
"fixedInResult": 2154,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"mergeResult": {},
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"orderedJobResultSummaries": [
{}
],
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"restartable": true,
"shortReasonSummary": "<string>",
"specsResult": true,
"stageResults": [],
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"totalJobCount": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"waiting": true
},
"completed": true,
"description": "<string>",
"failed": true,
"failedBuildResults": [
{
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"chainResultsSummary": {},
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"extraBuildResultsData": {},
"failed": true,
"filteredTestResults": {},
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueDuration": 2154,
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"resultVariables": {},
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"vcsUpdateDuration": 2154,
"vcsUpdateTime": "<string>",
"waiting": true
}
],
"final": true,
"finished": true,
"id": 2154,
"lifeCycleState": "Pending",
"manual": true,
"manualVariables": [
{
"id": 2154,
"key": "<string>",
"value": "<string>",
"variableType": "GLOBAL"
}
],
"manualVariablesEncrypted": [
{
"id": 2154,
"key": "<string>",
"value": "<string>",
"variableType": "GLOBAL"
}
],
"name": "<string>",
"notBuilt": true,
"pending": true,
"processingDuration": 2154,
"restartable": true,
"runnable": true,
"sortedBuildResults": [
{
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"chainResultsSummary": {},
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"extraBuildResultsData": {},
"failed": true,
"filteredTestResults": {},
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueDuration": 2154,
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"resultVariables": {},
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"vcsUpdateDuration": 2154,
"vcsUpdateTime": "<string>",
"waiting": true
}
],
"state": "Unknown",
"successful": true,
"successfulBuildResults": [
{
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"chainResultsSummary": {},
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"extraBuildResultsData": {},
"failed": true,
"filteredTestResults": {},
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueDuration": 2154,
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"resultVariables": {},
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"vcsUpdateDuration": 2154,
"vcsUpdateTime": "<string>",
"waiting": true
}
]
},
"stages": {
"allElements": [
{
"results": {}
}
],
"maxResult": 2154,
"size": 2154,
"stages": [
{
"results": {}
}
],
"startIndex": 2154
},
"variables": {
"allElements": [
{
"name": "my_variable",
"value": "variable value"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
}
}Provide list of comments for build result specified by projectKey-buildKey-buildNumber.
string
Requiredstring
Requiredstring
RequiredList of comments for build result
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/comment' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"comments": {
"allElements": [
{
"content": "first successful build",
"id": 2154
}
],
"comment": [
{
"content": "first successful build",
"id": 2154
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"link": {
"href": "<string>",
"rel": "<string>"
}
}Adds new comment to build result.
string
Requiredstring
Requiredstring
RequiredBuild result comment
string
Comment added
1
2
3
4
5
6
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/comment' \
--header 'Content-Type: application/json' \
--data '{
"content": "first successful build"
}'Removes a comment from a build result.
string
Requiredstring
Requiredstring
Requiredstring
RequiredComment deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/comment/{commentId}'Provide list of labels for build result specified by projectKey-buildKey-buildNumber.
string
Requiredstring
Requiredstring
RequiredList of comments for build result
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/label' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"labels": {
"allElements": [
{
"name": "someLabel"
}
],
"label": [
{
"name": "someLabel"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"link": {
"href": "<string>",
"rel": "<string>"
}
}Adds new label to build result specified by projectKey-buildKey-buildNumber.
string
Requiredstring
Requiredstring
RequiredBuild result label
string
On success
1
2
3
4
5
6
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/label' \
--header 'Content-Type: application/json' \
--data '{
"name": "someLabel"
}'Removes label from build result specified by projectKey-buildKey-buildNumber.
string
Requiredstring
Requiredstring
Requiredstring
RequiredOn success
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/label/{labelName}'Provide list of build results for specified plan's branch. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).
string
Requiredstring
Requiredstring
Requiredboolean
boolean
string
integer
integer
string
string
string
string
string
Latest build results for specified plan. Results are ordered from latest or oldest
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}/branch/{branchName}' \
--header 'Accept: application/json'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
{
"expand": "<string>",
"link": {
"href": "<string>",
"rel": "<string>"
},
"results": {
"allElements": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"maxResult": 2154,
"results": [
{
"artifacts": {},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {},
"comments": {},
"jiraIssues": {},
"labels": {},
"link": {},
"parentLink": {},
"planResultKey": {},
"stageResult": {},
"stages": {},
"variables": {}
}
],
"size": 2154,
"startIndex": 2154
}
}Provide build result specified by projectKey-buildKey-buildNumber.
string
Requiredstring
Requiredstring
Requiredstring
Result of single build. Presented content contain information for finished build. If build is in progress, contains additional runtime information. Top level plan contains additionally progress information, job progress information, current log entries and hasExecutableAgent boolean flag.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/result/{projectKey}-{buildKey}/{buildNumber}' \
--header 'Accept: application/json'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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
{
"artifacts": {
"allElements": [
{
"link": {},
"producerJobKey": {}
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"buildNumber": 2154,
"buildState": "<string>",
"buildSummary": {
"active": true,
"artifactLinks": [
{
"artifact": {},
"buildResultsSummary": {},
"id": 2154,
"label": "<string>",
"linkType": "<string>",
"producerJobResult": {},
"sharedArtifact": true,
"subscriptions": [
{}
]
}
],
"artifactLinksThatExist": [
{
"artifact": {},
"buildResultsSummary": {},
"id": 2154,
"label": "<string>",
"linkType": "<string>",
"producerJobResult": {},
"sharedArtifact": true,
"subscriptions": [
{}
]
}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildNumber": 2154,
"buildState": "Unknown",
"buildTime": "<string>",
"changesListSummary": "<string>",
"commits": [
{
"author": {},
"authorContext": {},
"changeSetId": "<string>",
"comment": "<string>",
"date": "<string>",
"files": [
{}
],
"foreignCommit": true,
"id": 2154,
"repositoryChangeset": {}
}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"failed": true,
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{
"id": 2154,
"issueKey": "<string>",
"issueType": "BUILD_RELATES",
"jiraIssueDetails": {},
"resultsSummary": {}
}
],
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {
"active": true,
"allJobs": [
{}
],
"allStages": [
{}
],
"averageBuildDuration": 2154,
"buildDefinition": {},
"buildKey": "<string>",
"buildLogger": {},
"buildName": "<string>",
"busy": true,
"creationDate": "<string>",
"currentStatus": "<string>",
"databaseId": 2154,
"description": "<string>",
"effectiveVariables": [
{}
],
"entityType": "CHAIN",
"executing": true,
"firstBuildNumber": 2154,
"id": 2154,
"jobCount": 2154,
"key": "<string>",
"labelNames": [
"<string>"
],
"lastBuildNumber": 2154,
"lastResultKey": {},
"markedForDeletion": true,
"masterId": 2154,
"masterIdIfExists": 2154,
"name": "<string>",
"notificationSet": {},
"oid": {},
"planKey": {},
"planRepositoryDefinitions": [
{}
],
"planType": "CHAIN",
"project": {},
"stages": [
{}
],
"suspended": true,
"suspendedFromBuilding": true,
"triggerDefinitions": [
{}
],
"type": "<string>",
"variables": [
{}
],
"vcsBambooSpecsSource": {},
"version": 2154
},
"immutablePlan": {
"active": true,
"averageBuildDuration": 2154,
"buildDefinition": {},
"buildKey": "<string>",
"buildLogger": {},
"buildName": "<string>",
"busy": true,
"currentStatus": "<string>",
"databaseId": 2154,
"description": "<string>",
"effectiveVariables": [
{}
],
"entityType": "CHAIN",
"executing": true,
"firstBuildNumber": 2154,
"id": 2154,
"key": "<string>",
"labelNames": [
"<string>"
],
"lastBuildNumber": 2154,
"markedForDeletion": true,
"masterId": 2154,
"masterIdIfExists": 2154,
"name": "<string>",
"oid": {},
"planKey": {},
"planType": "CHAIN",
"project": {},
"suspendedFromBuilding": true,
"type": "<string>",
"variables": [
{}
],
"version": 2154
},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{
"id": 2154,
"issueKey": "<string>",
"issueType": "BUILD_RELATES",
"jiraIssueDetails": {},
"resultsSummary": {}
}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{
"id": 2154,
"key": "<string>",
"resultSummary": {},
"value": "<string>",
"variableType": "GLOBAL"
}
],
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {
"active": true,
"averageBuildDuration": 2154,
"buildDefinition": {},
"buildKey": "<string>",
"buildLogger": {},
"buildName": "<string>",
"busy": true,
"currentStatus": "<string>",
"databaseId": 2154,
"description": "<string>",
"effectiveVariables": [
{}
],
"entityType": "CHAIN",
"executing": true,
"firstBuildNumber": 2154,
"id": 2154,
"key": "<string>",
"labelNames": [
"<string>"
],
"lastBuildNumber": 2154,
"markedForDeletion": true,
"masterId": 2154,
"masterIdIfExists": 2154,
"name": "<string>",
"oid": {},
"planKey": {},
"planType": "CHAIN",
"project": {},
"suspendedFromBuilding": true,
"type": "<string>",
"variables": [
{}
],
"version": 2154
},
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"planName": "<string>",
"planResultKey": {
"buildNumber": 2154,
"entityKey": {},
"key": "<string>",
"planKey": {},
"resultNumber": 2154,
"resultNumberLong": 2154
},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{
"id": 2154,
"issueKey": "<string>",
"issueType": "BUILD_RELATES",
"jiraIssueDetails": {},
"resultsSummary": {}
}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{
"buildTrigger": true,
"changesetId": "<string>",
"commits": [
{}
],
"id": 2154,
"position": 2154,
"repositoryData": {},
"resultsSummary": {},
"skippedCommitsCount": 2154
}
],
"restartCount": 2154,
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{
"artifactLink": {},
"consumerResultSummary": {},
"destinationDirectory": "<string>",
"id": 2154,
"name": "<string>"
}
],
"substitutedVariables": [
{
"id": 2154,
"key": "<string>",
"resultSummary": {},
"value": "<string>",
"variableType": "GLOBAL"
}
],
"successful": true,
"testResultsSummary": {
"existingFailedTestCount": 2154,
"failedTestCaseCount": 2154,
"fixedTestCaseCount": 2154,
"ignoredTestCaseCount": 2154,
"newFailedTestCaseCount": 2154,
"quarantinedTestCaseCount": 2154,
"skippedTestCaseCount": 2154,
"successfulTestCaseCount": 2154,
"testSummaryDescription": "<string>",
"totalTestCaseCount": 2154,
"totalTestDuration": 2154
},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {
"key": "<string>",
"name": "<string>",
"nameForSentence": "<string>"
},
"uniqueAuthors": [
{
"allTriggeredBuildResults": [
{}
],
"breakages": [
{}
],
"email": "<string>",
"failedBuilds": [
{}
],
"fixes": [
{}
],
"fullName": "<string>",
"linkedUserName": "<string>",
"name": "<string>",
"numberOfBreakages": 2154,
"numberOfFailedBuilds": 2154,
"numberOfFixes": 2154,
"numberOfSuccessfulBuilds": 2154,
"numberOfTriggeredBuilds": 2154,
"successfulBuilds": [
{}
],
"triggeredBuildResults": [
{}
]
}
],
"variableContextLogs": [
{
"id": 2154,
"key": "<string>",
"resultSummary": {},
"value": "<string>",
"variableType": "GLOBAL"
}
],
"waiting": true
},
"comments": {
"allElements": [
{
"content": "first successful build",
"id": 2154
}
],
"comment": [
{
"content": "first successful build",
"id": 2154
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"jiraIssues": {
"allElements": [
{
"url": {}
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"labels": {
"allElements": [
{
"name": "someLabel"
}
],
"label": [
{
"name": "someLabel"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"link": {
"href": "<string>",
"rel": "<string>"
},
"parentLink": {
"href": "<string>",
"rel": "<string>"
},
"planResultKey": {
"buildNumber": 2154,
"entityKey": {
"key": "<string>"
},
"key": "<string>",
"planKey": {
"key": "<string>",
"partialKey": "<string>"
},
"resultNumber": 2154,
"resultNumberLong": 2154
},
"stageResult": {
"allJobsExist": true,
"allNotSuccessfulJobsExist": true,
"buildResults": [
{
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"chainResultsSummary": {},
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"extraBuildResultsData": {},
"failed": true,
"filteredTestResults": {},
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueDuration": 2154,
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"resultVariables": {},
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"vcsUpdateDuration": 2154,
"vcsUpdateTime": "<string>",
"waiting": true
}
],
"chainResult": {
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"changesListSummary": "<string>",
"commits": [
{}
],
"continuable": true,
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"failed": true,
"failedJobResults": [
{}
],
"finalized": true,
"finished": true,
"fixedInResult": 2154,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"mergeResult": {},
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"orderedJobResultSummaries": [
{}
],
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"restartable": true,
"shortReasonSummary": "<string>",
"specsResult": true,
"stageResults": [],
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"totalJobCount": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"waiting": true
},
"completed": true,
"description": "<string>",
"failed": true,
"failedBuildResults": [
{
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"chainResultsSummary": {},
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"extraBuildResultsData": {},
"failed": true,
"filteredTestResults": {},
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueDuration": 2154,
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"resultVariables": {},
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"vcsUpdateDuration": 2154,
"vcsUpdateTime": "<string>",
"waiting": true
}
],
"final": true,
"finished": true,
"id": 2154,
"lifeCycleState": "Pending",
"manual": true,
"manualVariables": [
{
"id": 2154,
"key": "<string>",
"value": "<string>",
"variableType": "GLOBAL"
}
],
"manualVariablesEncrypted": [
{
"id": 2154,
"key": "<string>",
"value": "<string>",
"variableType": "GLOBAL"
}
],
"name": "<string>",
"notBuilt": true,
"pending": true,
"processingDuration": 2154,
"restartable": true,
"runnable": true,
"sortedBuildResults": [
{
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"chainResultsSummary": {},
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"extraBuildResultsData": {},
"failed": true,
"filteredTestResults": {},
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueDuration": 2154,
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"resultVariables": {},
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"vcsUpdateDuration": 2154,
"vcsUpdateTime": "<string>",
"waiting": true
}
],
"state": "Unknown",
"successful": true,
"successfulBuildResults": [
{
"active": true,
"artifactLinksThatExist": [
{}
],
"buildAgentId": 2154,
"buildAgentType": "LOCAL",
"buildCancelledDate": "<string>",
"buildCompletedDate": "<string>",
"buildDate": "<string>",
"buildKey": "<string>",
"buildNumber": 2154,
"buildResultKey": "<string>",
"buildState": "Unknown",
"buildTime": "<string>",
"chainResultsSummary": {},
"changesListSummary": "<string>",
"commits": [
{}
],
"customBuild": true,
"customBuildData": {},
"deltaState": "NONE",
"duration": 2154,
"durationDescription": "<string>",
"extraBuildResultsData": {},
"failed": true,
"filteredTestResults": {},
"finalized": true,
"finished": true,
"fixingJiraIssues": [
{}
],
"formatVersion": 2154,
"fullPlanName": "<string>",
"id": 2154,
"immutableChain": {},
"immutablePlan": {},
"inProgress": true,
"jiraIssueKeys": [
"<string>"
],
"jiraIssues": [
{}
],
"labelNames": [
"<string>"
],
"lifeCycleState": "Pending",
"logSize": 2154,
"manuallyOverriddenVariables": [
{}
],
"markedForDeletion": true,
"notBuilt": true,
"notRunYet": true,
"onceOff": true,
"pending": true,
"planIfExists": {},
"planKey": {},
"planName": "<string>",
"planResultKey": {},
"processingDuration": 2154,
"processingDurationDescription": "<string>",
"queueDuration": 2154,
"queueTime": "<string>",
"queued": true,
"reasonSummary": "<string>",
"rebuild": true,
"relatedJiraIssues": [
{}
],
"relativeBuildDate": "<string>",
"relativeBuildStartedDate": "<string>",
"relativeQueueDate": "<string>",
"repositoryChangesets": [
{}
],
"restartCount": 2154,
"resultVariables": {},
"shortReasonSummary": "<string>",
"statDate": "<string>",
"subscriptions": [
{}
],
"substitutedVariables": [
{}
],
"substitutedVariablesEncrypted": [
{}
],
"successful": true,
"testResultsSummary": {},
"testSummary": "<string>",
"timeToFix": 2154,
"triggerReason": {},
"uniqueAuthors": [
{}
],
"variableContextBaselineId": 2154,
"variableContextLogs": [
{}
],
"variableContextLogsEncrypted": [
{}
],
"vcsUpdateDuration": 2154,
"vcsUpdateTime": "<string>",
"waiting": true
}
]
},
"stages": {
"allElements": [
{
"results": {}
}
],
"maxResult": 2154,
"size": 2154,
"stages": [
{
"results": {}
}
],
"startIndex": 2154
},
"variables": {
"allElements": [
{
"name": "my_variable",
"value": "variable value"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
}
}A starts-with search of authors based on their author name.
integer
boolean
string
Requiredinteger
Search results for authors matching the provided search term
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/search/authors?searchTerm={searchTerm}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}Performs a "starts with" search against full plan branch name and full plan branch key. Branches are restricted to "masterPlanKey" plan.
integer
string
boolean
integer
boolean
boolean
string
Requiredinteger
Search results for plans matching the provided search term
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/search/branches?masterPlanKey={masterPlanKey}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}Performs a contains search against deployment project name.
integer
string
integer
string
Search results for plans matching the provided search term
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/search/deployments' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}Performs a "starts with" search against full job name and full job key.
string
Requiredinteger
string
integer
Search results for plans matching the provided search term
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/search/jobs/{planKey}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}Performs a "starts with" search against full plan name and full plan key. Use "type" argument to filter by plan type by default will return TopLevelPlans
integer
string
integer
string
string
boolean
Search results for plans matching the provided search term
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/search/plans' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}Performs a contains search against project name.
integer
string
integer
string
Search results for plans matching the provided search term
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/search/projects' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}Performs a "starts with" search against full stage name.
string
Requiredinteger
string
integer
string
Search results for plans matching the provided search term
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/search/stages/{planKey}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}A starts-with search of users based on their username, full-name and if allowed email address.
integer
string
Requiredinteger
Search results for users matching the provided search term
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/search/users?searchTerm={searchTerm}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}Performs a contains search against a version name.
integer
string
string
integer
integer
Requiredboolean
Search results for plans matching the provided search term
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/search/versions?deploymentProjectId={deploymentProjectId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"maxResult": 2154,
"mayHaveMore": true,
"searchResults": [
{
"entity": {
"id": "<string>",
"type": "<string>"
},
"entityType": "<string>",
"id": "<string>"
}
],
"startIndex": 2154
}Get both the asked node and cluster states.
This request has no parameters.
Server status
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/server' \
--header 'Accept: application/json'1
2
3
4
5
{
"askedNodeState": "SETUP",
"clusterState": "STARTING",
"reindexInProgress": true
}Get both the asked node and cluster states together with all nodes' statuses.
This request has no parameters.
Nodes status
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/server/nodes' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"askedNodeState": "SETUP",
"clusterState": "STARTING",
"nodeStatuses": [
{
"alive": true,
"buildNumber": "<string>",
"hostname": "<string>",
"internalCommunicationPort": 2154,
"lastHeartbeat": "<string>",
"nodeId": "<string>",
"nodeName": "<string>",
"primary": true
}
],
"reindexInProgress": true
}Pauses the cluster.
This request has no parameters.
Both the asked node and cluster states
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/server/pause' \
--header 'Accept: application/json'1
2
3
4
5
{
"askedNodeState": "SETUP",
"clusterState": "STARTING",
"reindexInProgress": true
}Prepare the asked node for restarting: suspend change detection, stop indexing, stop ec2 instance ordering etc.
This request has no parameters.
Both the asked node and cluster states
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/server/prepareForRestart' \
--header 'Accept: application/json'1
2
3
4
5
{
"askedNodeState": "SETUP",
"clusterState": "STARTING",
"reindexInProgress": true
}Resumes the cluster.
This request has no parameters.
Both the asked node and cluster states
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/server/resume' \
--header 'Accept: application/json'1
2
3
4
5
{
"askedNodeState": "SETUP",
"clusterState": "STARTING",
"reindexInProgress": true
}Returns the current status of the Bamboo node. This endpoint enables a basic status check on the status of a Bamboo node.
The status endpoint will be responsive as long as the Bamboo REST plugin will be running. In other words, this endpoint does depend on the instance health and might not answer as a result of a failure or when Bamboo is still starting.
This request has no parameters.
Returns the current status of the server
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/status' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"status": {
"PAUSED": "SETUP",
"PAUSING": "SETUP",
"PREPARING_FOR_RESTART": "SETUP",
"READY_FOR_RESTART": "SETUP",
"RUNNING": "SETUP",
"RUNNING_AS_SECONDARY": "SETUP",
"SETUP": "SETUP",
"STARTING": "SETUP",
"correspondingClusterState": "STARTING"
}
}Get the web sudo expiry from session.
This request has no parameters.
The expiry time of the current web sudo session
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/websudo-session' \
--header 'Accept: application/json'Refresh the web sudo expiry for the current session.
This request has no parameters.
The new expiry time of the current web sudo session
any
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/websudo-session' \
--header 'Accept: application/json'Remove web sudo from session.
This request has no parameters.
Web sudo has been removed from the current session
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/websudo-session'Rate this page: