Retrieve configuration of Agent-Local Artifact Handler.
This request has no parameters.
Configuration of Agent-Local Artifact Handler
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/artifactHandlers/agentLocal' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"attributes": {},
"nonsharedArtifactsEnabled": true,
"self": "<string>",
"sharedArtifactsEnabled": true
}Update Agent-Local Artifact Handler configuration.
New configuration of the artifact handler. If a configuration attribute is not present in the request, the previously stored value is used
object
boolean
boolean
Configuration of updated Agent Local Artifact handler
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/artifactHandlers/agentLocal' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"attributes": {},
"nonsharedArtifactsEnabled": true,
"sharedArtifactsEnabled": true
}'1
2
3
4
5
6
{
"attributes": {},
"nonsharedArtifactsEnabled": true,
"self": "<string>",
"sharedArtifactsEnabled": true
}Retrieve configuration of Bamboo Server Artifact Handler.
This request has no parameters.
Configuration of Bamboo Server Artifact Handler
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/artifactHandlers/bambooRemote' \
--header 'Accept: application/json'1
2
3
4
5
{
"nonsharedArtifactsEnabled": true,
"self": "<string>",
"sharedArtifactsEnabled": true
}Update Bamboo Server Artifact Handler configuration.
New configuration of the artifact handler. If a configuration attribute is not present in the request, the previously stored value is used
boolean
boolean
Configuration of updated Bamboo Server artifact handler
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/artifactHandlers/bambooRemote' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"nonsharedArtifactsEnabled": true,
"sharedArtifactsEnabled": true
}'1
2
3
4
5
6
{
"attributes": {},
"nonsharedArtifactsEnabled": true,
"self": "<string>",
"sharedArtifactsEnabled": true
}Retrieve configuration of S3 Artifact Handler.
This request has no parameters.
Configuration of S3 Artifact Handler
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/artifactHandlers/s3' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"attributes": {},
"nonsharedArtifactsEnabled": true,
"self": "<string>",
"sharedArtifactsEnabled": true
}Update S3 Artifact Handler configuration.
New configuration of the artifact handler. If a configuration attribute is not present in the request, the previously stored value is used
object
boolean
boolean
Configuration of updated S3 Artifact handler
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/artifactHandlers/s3' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"attributes": {},
"nonsharedArtifactsEnabled": true,
"sharedArtifactsEnabled": true
}'1
2
3
4
5
6
{
"attributes": {},
"nonsharedArtifactsEnabled": true,
"self": "<string>",
"sharedArtifactsEnabled": true
}Retrieve configuration of SFTP Artifact Handler.
This request has no parameters.
Configuration of SFTP Artifact Handler
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/artifactHandlers/sftp' \
--header 'Accept: application/json'1
2
3
4
5
{
"nonsharedArtifactsEnabled": true,
"self": "<string>",
"sharedArtifactsEnabled": true
}Update SFTP Artifact Handler configuration.
New configuration of the artifact handler. If a configuration attribute is not present in the request, the previously stored value is used
boolean
boolean
Configuration of updated SFTP artifact handler
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/artifactHandlers/sftp' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"nonsharedArtifactsEnabled": true,
"sharedArtifactsEnabled": true
}'1
2
3
4
5
6
{
"attributes": {},
"nonsharedArtifactsEnabled": true,
"self": "<string>",
"sharedArtifactsEnabled": true
}Return collection of all agents of all types.
This request has no parameters.
All agents of all types and links to each
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/agents' \
--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": [
{
"description": "This is a description",
"enabled": true,
"id": 131073,
"link": "https://bamboo/rest/admin/latest/agent/131073",
"name": "Default Agent",
"type": "local"
}
],
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"start": 25
}Retrieve a build agent definition by id.
string
RequiredAgent definition of agent with the id
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/agents/{agentId}' \
--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"
}Update agent details
string
RequiredRestAgent that contains the update values
string
boolean
integer
string
string
string
Updated agent successfully
1
2
3
4
5
6
7
8
9
10
11
12
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/config/agents/{agentId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"description": "This is a description",
"enabled": true,
"id": 131073,
"link": "https://bamboo/rest/admin/latest/agent/131073",
"name": "Default Agent",
"type": "local"
}'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"
}Retrieve audit log settings.
This request has no parameters.
Audit log settings
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/auditLog' \
--header 'Accept: application/json'1
2
3
4
{
"auditLoggingEnabled": false,
"self": "<string>"
}Enable/disable audit log.
Audit log settings
boolean
Enable/disable audit log successfully
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/config/auditLog' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"auditLoggingEnabled": false
}'1
2
3
4
{
"auditLoggingEnabled": false,
"self": "<string>"
}Retrieve build concurrency settings.
This request has no parameters.
Bamboo build concurrency settings
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/build/concurrency' \
--header 'Accept: application/json'1
2
3
4
5
{
"buildConcurrencyEnabled": true,
"defaultConcurrentBuildsNumber": 10,
"self": "<string>"
}Update build concurrency settings. Partially update supported.
boolean
integer
Status of the update operation
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/config/build/concurrency' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"buildConcurrencyEnabled": true,
"defaultConcurrentBuildsNumber": 10
}'1
2
3
4
5
{
"buildConcurrencyEnabled": true,
"defaultConcurrentBuildsNumber": 10,
"self": "<string>"
}Retrieve build monitoring settings
This request has no parameters.
Bamboo build monitoring settings
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/build/monitoring' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"buildMonitoringEnabled": true,
"buildQueueMinutesTimeoutDefault": 30,
"buildTimeMultiplierDefault": 2.5,
"enableLogLineCountLimit": true,
"enableLogLineLengthLimit": true,
"enableLogSizeLimit": true,
"forceStopHangingBuilds": true,
"liveLogsAreActive": true,
"logQuietMinutesTimeDefault": 10,
"maxLogLineCount": 2154,
"maxLogLineLength": 2154,
"maxLogSizeKilobytes": 2154
}Update build monitoring settings. Partially update supported.
boolean
integer
number
boolean
boolean
boolean
boolean
boolean
integer
integer
Status of the update operation and a link to the REST endpoint
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/config/build/monitoring' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"buildMonitoringEnabled": true,
"buildQueueMinutesTimeoutDefault": 30,
"buildTimeMultiplierDefault": 2.5,
"enableLogLineCountLimit": true,
"enableLogLineLengthLimit": true,
"enableLogSizeLimit": true,
"forceStopHangingBuilds": true,
"liveLogsAreActive": true,
"logQuietMinutesTimeDefault": 10,
"maxLogLineCount": 2154,
"maxLogLineLength": 2154,
"maxLogSizeKilobytes": 2154
}'1
2
3
{
"link": "http://{baseurl}/rest/admin/latest/config/build/monitoring"
}Retrieve Bamboo server general configurations.
This request has no parameters.
Bamboo general configuration
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/general' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"baseUrl": "http://bamboo.local",
"branchDetectionIntervalSeconds": 100,
"brokerClientUrl": "tcp://bamboo.local:5555",
"brokerUrl": "nio://localhost:5555",
"dashboardDefaultPageSize": 50,
"enableGravatarSupport": true,
"enableGzipCompression": true,
"enableRssPolling": true,
"gravatarServerUrl": "<string>",
"instanceName": "CI instance",
"quietPeriodGloballyDisabled": true,
"rssPollingCronExpression": "0 7 * ? * *",
"self": "<string>"
}Update bamboo server general configurations. Partially update supported.
string
integer
string
string
integer
boolean
boolean
boolean
string
string
Update successfully
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/config/general' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"baseUrl": "http://bamboo.local",
"branchDetectionIntervalSeconds": 100,
"brokerClientUrl": "tcp://bamboo.local:5555",
"brokerUrl": "nio://localhost:5555",
"dashboardDefaultPageSize": 50,
"enableGravatarSupport": true,
"enableGzipCompression": true,
"enableRssPolling": true,
"gravatarServerUrl": "<string>",
"instanceName": "CI instance",
"quietPeriodGloballyDisabled": true,
"rssPollingCronExpression": "0 7 * ? * *"
}'1
2
3
4
5
{
"buildConcurrencyEnabled": true,
"defaultConcurrentBuildsNumber": 10,
"self": "<string>"
}Get instant message server configuration.
This request has no parameters.
Current IM server configuration
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/imServer' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
{
"host": "im.server.com",
"port": 8888,
"requireTLSSSLConnection": true,
"resource": "test",
"self": "<string>",
"username": "bamboo_user"
}Update or create existing IM server configuration in bamboo. If IM server is already configured in bamboo, update existing configuration. Otherwise, create IM server configuration.
string
string
integer
boolean
string
string
Updated IM server configuration
1
2
3
4
5
6
7
8
9
10
11
12
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/config/imServer' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"host": "im.server.com",
"password": "<string>",
"port": 8888,
"requireTLSSSLConnection": true,
"resource": "test",
"username": "bamboo_user"
}'1
2
3
4
5
6
7
8
{
"host": "im.server.com",
"port": 8888,
"requireTLSSSLConnection": true,
"resource": "test",
"self": "<string>",
"username": "bamboo_user"
}Delete current IM Server configuration.
This request has no parameters.
Current IM server configuration is deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/admin/latest/config/imServer'Retrieve the current mail server configuration.
This request has no parameters.
Mail Server configuration
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/mailServer' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"emailSetting": "SMTP",
"fromAddress": "mail@mailymail.com",
"jndiLocation": "<string>",
"name": "Amazing SMTP Server",
"precedenceBulkHeaderExcluded": true,
"self": "<string>",
"smtpPort": "25",
"smtpServer": "mail.thisisnotarealserver.com",
"smtpUsername": "user",
"subjectPrefix": "[READ THIS FROM BAMBOO]",
"tlsEnabled": true
}Update the mail server configuration.
string
string
string
string
boolean
string
string
string
string
string
Updated mail server configuration
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/config/mailServer' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"emailSetting": "SMTP",
"fromAddress": "mail@mailymail.com",
"jndiLocation": "<string>",
"name": "Amazing SMTP Server",
"precedenceBulkHeaderExcluded": true,
"smtpPassword": "pass",
"smtpPort": "25",
"smtpServer": "mail.thisisnotarealserver.com",
"smtpUsername": "user",
"subjectPrefix": "[READ THIS FROM BAMBOO]",
"tlsEnabled": true
}'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"emailSetting": "SMTP",
"fromAddress": "mail@mailymail.com",
"jndiLocation": "<string>",
"name": "Amazing SMTP Server",
"precedenceBulkHeaderExcluded": true,
"self": "<string>",
"smtpPort": "25",
"smtpServer": "mail.thisisnotarealserver.com",
"smtpUsername": "user",
"subjectPrefix": "[READ THIS FROM BAMBOO]",
"tlsEnabled": true
}Delete current mail configuration.
This request has no parameters.
Successfully deleted mail configuration
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/admin/latest/config/mailServer'Retrieve Bamboo quarantine settings.
This request has no parameters.
Current quarantine settings
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/quarantine' \
--header 'Accept: application/json'1
2
3
4
{
"quarantineTestsEnabled": true,
"self": "<string>"
}Update Bamboo quarantine settings.
boolean
Quarantine settings of Bamboo is updated successfully, return updated config
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/config/quarantine' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"quarantineTestsEnabled": true
}'1
2
3
4
{
"quarantineTestsEnabled": true,
"self": "<string>"
}Retrieve the remote agent configuration
This request has no parameters.
Remote agent support configuration
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/config/remoteAgentSupport' \
--header 'Accept: application/json'1
2
3
4
{
"remoteAgentsSupported": true,
"self": "<string>"
}Update the remote agent configuration
Remote agent configuration
boolean
The remote agent configuration after the update
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/config/remoteAgentSupport' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"remoteAgentsSupported": true
}'1
2
3
4
{
"remoteAgentsSupported": true,
"self": "<string>"
}Retrieves a list of dark features that are enabled for all users.
This request has no parameters.
A list of dark features that are enabled for all users
array<RestDarkFeature>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/darkFeatures' \
--header 'Accept: application/json'1
2
3
4
5
6
[
{
"enabled": true,
"key": "my.bamboo.feature.key"
}
]Retrieves whether a given dark feature key is enabled for this instance.
string
RequiredStatus of the dark feature for this instance
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/darkFeatures/{key}' \
--header 'Accept: application/json'1
2
3
4
{
"enabled": true,
"key": "my.bamboo.feature.key"
}Enable or disable a dark feature for all users of this instance.
string
Requiredboolean
string
The updated dark feature
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/darkFeatures/{key}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"key": "my.bamboo.feature.key"
}'1
2
3
4
{
"enabled": true,
"key": "my.bamboo.feature.key"
}Retrieves whether a given dark feature key is enabled for a given user. A dark feature is enabled for a user if its either enabled for this instance or for the specific user.
string
Requiredstring
RequiredStatus of the dark feature for the given user
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/darkFeatures/{key}/user/{userName}' \
--header 'Accept: application/json'1
2
3
4
5
{
"enabled": true,
"key": "my.bamboo.feature.key",
"userName": "admin"
}Enable or disable a dark feature for a given user.
string
Requiredstring
Requiredboolean
string
The updated dark feature
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/darkFeatures/{key}/user/{userName}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"key": "my.bamboo.feature.key"
}'1
2
3
4
5
{
"enabled": true,
"key": "my.bamboo.feature.key",
"userName": "admin"
}Retrieves the current elastic configuration.
This request has no parameters.
Current elastic configuration of bamboo server
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/elastic/config' \
--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
{
"accessKeyId": "TEST-ACCESS-KEY-ID",
"allocatePublicIpToVpcInstances": true,
"awsCredentialsType": "ACCESS_KEY",
"certificateFile": "/path/to/certificate",
"elasticInstanceManagement": {
"allowedNonBambooInstances": 3,
"avgQueueTimeMinutes": 10,
"idleAgentShutdownDelayMinutes": 5,
"maxNumOfInstancesStart": 7,
"numOfBuildsInQueue": 5,
"numOfElasticBuildsInQueue": 1,
"type": "Custom"
},
"elasticTerminationConfiguration": {
"enabled": true,
"shutdownDelay": 300
},
"enabled": true,
"maxNumOfElasticInstances": 15,
"privateKeyFile": "/path/to/privateKey",
"region": "US_EAST_1",
"self": "<string>",
"uploadAwsIdentifier": true
}Update elastic configuration.
string
boolean
string
string
RestElasticInstanceManagement
RestElasticTerminationConfiguration
boolean
integer
string
string
Updated elastic configuration
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
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/elastic/config' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"accessKeyId": "TEST-ACCESS-KEY-ID",
"allocatePublicIpToVpcInstances": true,
"awsCredentialsType": "ACCESS_KEY",
"certificateFile": "/path/to/certificate",
"elasticInstanceManagement": {
"allowedNonBambooInstances": 3,
"avgQueueTimeMinutes": 10,
"idleAgentShutdownDelayMinutes": 5,
"maxNumOfInstancesStart": 7,
"numOfBuildsInQueue": 5,
"numOfElasticBuildsInQueue": 1,
"type": "Custom"
},
"elasticTerminationConfiguration": {
"enabled": true,
"shutdownDelay": 300
},
"enabled": true,
"maxNumOfElasticInstances": 15,
"privateKeyFile": "/path/to/privateKey",
"region": "US_EAST_1",
"secretAccessKey": "<string>",
"uploadAwsIdentifier": 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
{
"accessKeyId": "TEST-ACCESS-KEY-ID",
"allocatePublicIpToVpcInstances": true,
"awsCredentialsType": "ACCESS_KEY",
"certificateFile": "/path/to/certificate",
"elasticInstanceManagement": {
"allowedNonBambooInstances": 3,
"avgQueueTimeMinutes": 10,
"idleAgentShutdownDelayMinutes": 5,
"maxNumOfInstancesStart": 7,
"numOfBuildsInQueue": 5,
"numOfElasticBuildsInQueue": 1,
"type": "Custom"
},
"elasticTerminationConfiguration": {
"enabled": true,
"shutdownDelay": 300
},
"enabled": true,
"maxNumOfElasticInstances": 15,
"privateKeyFile": "/path/to/privateKey",
"region": "US_EAST_1",
"self": "<string>",
"uploadAwsIdentifier": true
}Retrieves ephemeral agents configuration.
This request has no parameters.
Ephemeral agents configuration
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/ephemeral/config' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"enabled": true,
"label": "<string>",
"pathToConfig": "<string>",
"podsCleanup": {
"delay": 2154,
"enabled": true
},
"waitForEphemeralAgentDuration": 2154
}Modify ephemeral agents configuration.
boolean
string
string
PodsCleanup
integer
Ephemeral agents configuration
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/ephemeral/config' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"label": "<string>",
"pathToConfig": "<string>",
"podsCleanup": {
"delay": 2154,
"enabled": true
},
"waitForEphemeralAgentDuration": 2154
}'1
2
3
4
5
6
7
8
9
10
{
"enabled": true,
"label": "<string>",
"pathToConfig": "<string>",
"podsCleanup": {
"delay": 2154,
"enabled": true
},
"waitForEphemeralAgentDuration": 2154
}Test connection to ephemeral agents provider.
boolean
string
string
PodsCleanup
integer
Result of connection testing
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request POST \
--url 'http://{baseurl}/rest/admin/latest/ephemeral/config/test-connection' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"enabled": true,
"label": "<string>",
"pathToConfig": "<string>",
"podsCleanup": {
"delay": 2154,
"enabled": true
},
"waitForEphemeralAgentDuration": 2154
}'1
2
3
4
5
6
{
"clientVersion": "<string>",
"errorMessage": "<string>",
"serverVersion": "<string>",
"success": true
}Retrieves global build and deployment expiry configuration for this Bamboo instance.
This request has no parameters.
Current expiry configuration
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/expiry/configuration' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"buildsToKeep": 2154,
"cronExpression": "<string>",
"deploymentsToKeep": 2154,
"duration": 2154,
"expireArtifacts": true,
"expireLogs": true,
"expireResults": true,
"labelsToExclude": "<string>",
"maximumBuildsToKeep": 2154,
"maximumIgnoredLogSize": 2154,
"period": "<string>"
}Update global build and deployment expiry configuration for this Bamboo instance. Partial configuration is not allowed (it will fail validation).
integer
string
integer
integer
boolean
boolean
boolean
string
integer
integer
Newly saved expiry configuration
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/expiry/configuration' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"buildsToKeep": 2154,
"cronExpression": "<string>",
"deploymentsToKeep": 2154,
"duration": 2154,
"expireArtifacts": true,
"expireLogs": true,
"expireResults": true,
"labelsToExclude": "<string>",
"maximumBuildsToKeep": 2154,
"maximumIgnoredLogSize": 2154,
"period": "<string>"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"buildsToKeep": 2154,
"cronExpression": "<string>",
"deploymentsToKeep": 2154,
"duration": 2154,
"expireArtifacts": true,
"expireLogs": true,
"expireResults": true,
"labelsToExclude": "<string>",
"maximumBuildsToKeep": 2154,
"maximumIgnoredLogSize": 2154,
"period": "<string>"
}Executes build and deployment expiry process. Will only start each process if it's not currently running.
This request has no parameters.
Expiration process status
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/expiry/run' \
--header 'Accept: application/json'1
2
3
{
"statusUrl": "<string>"
}Retrieves build and deployment expiry status.
This request has no parameters.
Status of both build and deployment expiry, containing information whether expiry is currently running and the last expiry execution date
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/expiry/status' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"buildExpiryStatus": {
"lastFinished": 2154,
"lastFinishedDate": "<string>",
"lastRun": 2154,
"lastRunDate": "<string>",
"lastRunSuccessful": true,
"running": true
},
"deploymentExpiryStatus": {
"lastFinished": 2154,
"lastFinishedDate": "<string>",
"lastRun": 2154,
"lastRunDate": "<string>",
"lastRunSuccessful": true,
"running": true
}
}Return collection of all global variables. Value of variables that contain password in name will be encrypted with salted hash.
This request has no parameters.
Collection of all global variables
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/globalVariables' \
--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
{
"globalVariables": {
"allElements": [
{
"encrypted": true,
"id": 1000,
"link": "http://bamboo/rest/admin/latest/globalVariable/1000",
"name": "name",
"value": "value"
}
],
"globalVariables": [
{
"encrypted": true,
"id": 1000,
"link": "http://bamboo/rest/admin/latest/globalVariable/1000",
"name": "name",
"value": "value"
}
],
"maxResult": 2154,
"size": 2154,
"startIndex": 2154
},
"link": "<string>"
}Create a single global variable.
string
string
Global variable that is created
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/admin/latest/globalVariables' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "name",
"value": "value"
}'1
2
3
4
5
6
7
{
"encrypted": true,
"id": 1000,
"link": "http://bamboo/rest/admin/latest/globalVariable/1000",
"name": "name",
"value": "value"
}Server side verification that the encrypted value of a global variable has changed.
string
string
Variable value matches provided value
any
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/globalVariables/verify' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"rawValue": "<string>"
}'Retrieve a global variable definition. Value will be encrypted if variable name contains key word password.
string
RequiredVariable definition which contains name, value and link to the variable
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/globalVariables/{variableId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"encrypted": true,
"id": 1000,
"link": "http://bamboo/rest/admin/latest/globalVariable/1000",
"name": "name",
"value": "value"
}Update value of a global variable.
string
Requiredstring
string
Update variable successfully
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/globalVariables/{variableId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "name",
"value": "value"
}'1
2
3
4
5
6
7
{
"encrypted": true,
"id": 1000,
"link": "http://bamboo/rest/admin/latest/globalVariable/1000",
"name": "name",
"value": "value"
}Delete a global variable.
string
RequiredVariable deleted successfully
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/admin/latest/globalVariables/{variableId}'Gets the collection of jobs currently scheduled to run.
This request has no parameters.
Collection of jobs successfully retrieved
array<RestScheduledJob>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/scheduler/jobs' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
[
{
"groupName": "Plans",
"name": "Plan Cleanup",
"nextScheduledTime": "<string>",
"self": "<string>"
}
]Trigger background job execution.
string
string
Job is scheduled for execution
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/admin/latest/scheduler/jobs/trigger' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"groupName": "Plans",
"name": "Plan Cleanup"
}'1
2
3
4
{
"quarantineTestsEnabled": true,
"self": "<string>"
}Retrieve a list of groups in Bamboo. The list can be filtered by some attributes, e.g. name. Name is mandatory. Since name is unique, the result only contains 0 or 1 entry.
string
Requiredlist of groups
array<RestGroup>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/security/groups?name={name}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
[
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}
]Create a group.
string
Created group
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/admin/latest/security/groups' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "bamboo-admin"
}'1
2
3
4
5
{
"editable": false,
"name": "bamboo-admin",
"self": "<string>"
}Retrieve security settings.
This request has no parameters.
Bamboo security settings
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/security/settings' \
--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
{
"agentAssignmentModificationByUsersAllowed": true,
"bruteForceProtection": {
"enabled": true,
"loginAttempts": 2154
},
"displayContactDetailsEnabled": true,
"manageAcceptedSshHostKeys": true,
"manualEncryptionConfiguration": {
"enabled": true,
"limit": 2154,
"limitUnit": "NANOSECONDS"
},
"personalAccessTokensExpirationConfiguration": {
"expirationRequired": true,
"maxDaysUntilExpiry": 2154
},
"resolveArtifactsContentTypeByExtensionEnabled": true,
"restrictedAdministratorRoleEnabled": true,
"rssSecurityConfiguration": {
"dockerImage": "atlassian/bamboo-specs-runner:9.0.0",
"enabled": true,
"executeSpecsInDocker": true,
"localMavenDirectory": "<string>",
"mountLocalMavenDirectory": true
},
"showAuthorsDetailsToUsers": true,
"signUp": {
"enabled": true,
"enabledCaptcha": true
},
"soxComplianceModeEnabled": true,
"unauthenticatedRemoteTriggerAllowed": true,
"xsrfProtection": {
"disableForHTTPGET": true,
"enabled": true
}
}Update security settings. Partial update supported.
boolean
RestBruteForceProtection
boolean
boolean
RestManualEncryptionConfiguration
RestPersonalAccessTokensExpirationConfiguration
boolean
boolean
RestRssSecurityConfiguration
boolean
Link to the REST endpoint
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
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/security/settings' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"agentAssignmentModificationByUsersAllowed": true,
"bruteForceProtection": {
"enabled": true,
"loginAttempts": 2154
},
"displayContactDetailsEnabled": true,
"manageAcceptedSshHostKeys": true,
"manualEncryptionConfiguration": {
"enabled": true,
"limit": 2154,
"limitUnit": "NANOSECONDS"
},
"personalAccessTokensExpirationConfiguration": {
"expirationRequired": true,
"maxDaysUntilExpiry": 2154
},
"resolveArtifactsContentTypeByExtensionEnabled": true,
"restrictedAdministratorRoleEnabled": true,
"rssSecurityConfiguration": {
"dockerImage": "atlassian/bamboo-specs-runner:9.0.0",
"enabled": true,
"executeSpecsInDocker": true,
"localMavenDirectory": "<string>",
"mountLocalMavenDirectory": true
},
"showAuthorsDetailsToUsers": true,
"signUp": {
"enabled": true,
"enabledCaptcha": true
},
"soxComplianceModeEnabled": true,
"unauthenticatedRemoteTriggerAllowed": true,
"xsrfProtection": {
"disableForHTTPGET": true,
"enabled": true
}
}'1
2
3
{
"link": "http://{baseurl}/rest/admin/latest/security/settings"
}Get all trusted keys.
This request has no parameters.
A list of trusted keys.
array<RestTrustedKey>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/security/trustedKey' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
[
{
"host": "bitbucket.com",
"id": 2154,
"key": "trusted_key",
"self": "<string>"
}
]Create new trusted key.
Trusted key to add
string
string
Trusted key has been successfully added
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/admin/latest/security/trustedKey' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"host": "bitbucket.com",
"key": "trusted_key"
}'1
2
3
4
5
6
{
"host": "bitbucket.com",
"id": 2154,
"key": "trusted_key",
"self": "<string>"
}Delete trusted key.
string
RequiredTrusted key has been successfully deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/admin/latest/security/trustedKey/{id}'Invalidate active sessions of the given user
string
Requiredstring
RequiredRequested user sessions have been invalidated
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/admin/latest/session/{name}'Read storage configuration limits.
This request has no parameters.
The storage limits
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/admin/latest/storageSettings' \
--header 'Accept: application/json'1
2
3
4
{
"hardLimit": 25,
"softLimit": 20
}Set storage configuration limits.
New storage configuration limits
integer
integer
The storage limits
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/storageSettings' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"hardLimit": 25,
"softLimit": 20
}'1
2
3
4
{
"hardLimit": 25,
"softLimit": 20
}Renames specified user.
string
User rename request
string
string
User has been successfully renamed.
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/admin/latest/user' \
--header 'Content-Type: application/json' \
--data '{
"name": "newUsername",
"oldName": "oldUsername"
}'Renames specified user.
string
Requiredstring
User rename request
string
string
User has been successfully renamed.
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/admin/latest/user/{newUserName}' \
--header 'Content-Type: application/json' \
--data '{
"name": "newUsername",
"oldName": "oldUsername"
}'Rate this page: