Rate this page:
GET /rest/api/latest/status
Returns the current status of the server. This endpoint enables a basic status check on the status of a Bamboo instance.
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.
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/status' \
--header 'Accept: application/json'
Returns the current status of the server
Content type | Value |
---|---|
application/json |
GET /rest/api/latest/permissions/plan/{key}/available-users
Returns list of users which weren't granted explicitly any plan permissions. Resource is paged, returns single page of resources.
string
Plan entity key
integer
Page request size
25
, Format: int32
integer
Page request start index
int32
string
User filter, filter is case insensitive matches: username, user's full name, user's email
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/available-users' \
--header 'Accept: application/json'
Return single page of users which don't have any explicit permissions granted
Content type | Value |
---|---|
application/json |
GET /rest/api/latest/permissions/plan/{key}/groups
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
Plan entity key
integer
Page request size
25
, Format: int32
integer
Page request start index
int32
string
Group name filter, filter is case insensitive matches group name
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/groups' \
--header 'Accept: application/json'
Return single page of groups with their permissions
Content type | Value |
---|---|
application/json |
PUT /rest/api/latest/permissions/plan/{key}/groups/{name}
Grants plan permissions to a given group.
string
Affected group
string
Plan entity key
Content type | Value |
---|---|
application/json | Array<string> |
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>"
]'
If permissions were granted
Content type | Value |
---|---|
application/json | anything |
DELETE /rest/api/latest/permissions/plan/{key}/groups/{name}
Revokes plan permissions from a given group.
string
Affected group
string
Plan entity key
Content type | Value |
---|---|
application/json | Array<string> |
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>"
]'
If permissions were revoked
GET /rest/api/latest/permissions/plan/{key}/available-groups
Returns list of groups which weren't granted explicitly any plan permissions. Resource is paged, returns single page of resources.
string
Plan entity key
integer
Page request size
25
, Format: int32
integer
Page request start index
int32
string
Group name filter, filter is case insensitive matches group name
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/available-groups' \
--header 'Accept: application/json'
Return single page of groups which don't have any explicit permissions granted
Content type | Value |
---|---|
application/json |
GET /rest/api/latest/permissions/plan/{key}/roles
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
Plan entity key
integer
Page request size
25
, Format: int32
integer
Page request start index
int32
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/roles' \
--header 'Accept: application/json'
Return single page of roles with their permissions
Content type | Value |
---|---|
application/json |
PUT /rest/api/latest/permissions/plan/{key}/roles/{name}
Grants plan permissions to a given role.
string
Affected role
string
Plan entity key
Content type | Value |
---|---|
application/json | Array<string> |
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>"
]'
If permissions were granted
Content type | Value |
---|---|
application/json | anything |
DELETE /rest/api/latest/permissions/plan/{key}/roles/{name}
Revokes plan permissions from a given role.
string
Affected role
string
Plan entity key
Content type | Value |
---|---|
application/json | Array<string> |
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>"
]'
If permissions were revoked
GET /rest/api/latest/permissions/plan/{key}/users
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
Plan entity key
integer
Page request size
25
, Format: int32
integer
Page request start index
int32
string
User filter, filter is case insensitive matches: username, user's full name, user's email
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/permissions/plan/{key}/users' \
--header 'Accept: application/json'
Return single page of users with their permissions
Content type | Value |
---|---|
application/json |
PUT /rest/api/latest/permissions/plan/{key}/users/{name}
Grants plan permissions to a given user.
string
Username of the affected user
string
Plan entity key
Content type | Value |
---|---|
application/json | Array<string> |
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>"
]'
If permissions were granted
Content type | Value |
---|---|
application/json | anything |
DELETE /rest/api/latest/permissions/plan/{key}/users/{name}
Revokes plan permissions from a given user.
string
Username of the affected user
string
Plan entity key
Content type | Value |
---|---|
application/json | Array<string> |
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>"
]'
If permissions were revoked
GET /rest/api/latest/project/{projectKey}
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
project key
string
Possible expand parameters: plans, plans.plan, plans.plan.actions
boolean
flag to return project without plans, true by default
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}' \
--header 'Accept: application/json'
Project details
Content type | Value |
---|---|
application/json |
DELETE /rest/api/latest/project/{projectKey}
Marks project for deletion. Project will be deleted by a batch job.
string
project key
1 2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}'
When project is successfully marked for deletion
GET /rest/api/latest/project
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
Possible expand parameters: projects, projects.project.plans, projects.project.plans.plan
boolean
flag to display projects without plans
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project' \
--header 'Accept: application/json'
List of Bamboo projects
Content type | Value |
---|---|
application/json |
POST /rest/api/latest/project
Create project.
Content type | Value |
---|---|
application/xml | |
application/json |
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 '{
"name": "My first project",
"key": "PROJ",
"description": "<string>",
"publicAccess": true
}'
Created project
Content type | Value |
---|---|
application/json |
GET /rest/api/latest/project/{projectKey}/repositories
Retrieves paginated project repositories specified by the project key.
string
project key
string
filter to retrieve matching results
integer
Page request size
25
, Maximum: 500
, Format: int32
integer
Page request start index
int32
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/repositories' \
--header 'Accept: application/json'
when repositories were successfully retrieved
Content type | Value |
---|---|
application/json |
GET /rest/api/latest/project/{projectKey}/repository
Fetch list of repositories which granted to create plan in given project by Repository stored Bamboo Specs.
string
project key
1 2 3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/project/{projectKey}/repository' \
--header 'Accept: application/json'
Array of repositories granted to create plan in given project by Repository stored Bamboo Specs
Content type | Value |
---|---|
application/json | Array<RestRepository> |
POST /rest/api/latest/project/{projectKey}/repository
Grant permission to create/edit plan in given project by Bamboo Specs from given repository.
string
project key
Content type | Value |
---|---|
application/xml | |
application/json |
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
}'
Added repository entity
Content type | Value |
---|---|
application/json |
GET /rest/api/latest/project/{projectKey}/repository/search
Search for linked repositories which can be granted to create plans by Repository stored Bamboo Specs in given project
string
project key
string
part of repository name. Used to filter output.