Actions - 8.3.0

 

Action

Description

Required Parameters

Optional Parameters

Category

Type

1

addAgent

Add a local agent.

agent

description, continue

Agents

Create

2

addAgentAssignment

Assign a project, plan, job, deployment project, or environment to a specific agent. This makes the agent dedicated to only perform builds for all assignments. If deployment or environment names are used instead of keys, type must be provided to indicate assignment represents a DEPLOYMENT_PROJECT or ENVIRONMENT. Use continue to ignore already exists error. Use --options autoAgent to automatically create a local agent if it does not already exist.

agent, assignment

type, options, continue

Agent Assignments

Create

3

addApplicationLink

Add an application link to another application. By default, both incoming and outgoing links are enabled and configured without impersonation (users are not shared). Use the options parameter to customize the behavior. Use '--options impersonate' to enable shared users. Other examples are '--options disableIncoming' and '--options disableOutgoing'. If another link of the same type already exists as primary, use '--options primary' to force the new link to be primary instead.

url

name, options, continue

Links

Create

4

addArtifact

Add an artifact definition to a job.

plan, job, artifact, copyPattern

location, shared

Artifacts

Create

5

addArtifactDependency

Add an artifact dependency to a job. Artifact must be a shared artifact from another job.

plan, job, artifact, location

 

Artifacts

Create

6

addBranch

Add a branch to a plan. The plan branch will be disabled by default. For add, the branch parameter refers to the repository branch. An optional name for the plan branch can be specified, otherwise the repository branch name will be used.

plan, branch

name, description, enable, continue

Branches

Create

7

addCapability

Add a shared or agent specific server capability.

type

agent, name, value, field, fields, field1, value1, field2, value2

 

Create

8

addComment

Add a comment to a build.

build, comment

number, findReplace, findReplaceRegex, input, file, encoding

Comments

Create

9

addCredentials

Add SSH, AWS, or user based credentials. For SSH, provide a file with the SSH private key. For AWS, provide an access key and secret.

credentials, userId or file or accessKeyId and accessKey

userPassword, sshParaphrase, accessKey, replace

 

Create

10

addEnvironment

Add an environment to deployment project.
Available replacement variables: environment, environmentId.

deploymentProject, name

description

Deployment

Create

11

addEnvironmentNotification

Add a notification to a deployment environment. There are 2 parts to a notification - an event that triggers the notification and a recipient type that determines the notification protocol. There are built-in notifications and others provided by add-ons. A recipient type may have additional parameters. Generally, these can be specified by the field and values parameters. In some cases, pre-defined parameters are available.

deploymentProject, environment, event, recipientType

recipient, field, fields, field1, value1, field2, value2

Deployment

Create

12

addEnvironmentRequirement

Add a requirement to a deployment environment.

deploymentProject, environment, requirement

type, value

Deployment

Create

13

addEnvironmentTask

Add a task to a deployment environment.

deploymentProject, environment, taskKey

description, field, fields, field1, value1, field2, value2

Deployment

Create

14

addEnvironmentTrigger

Add a trigger to a deployment project. Pre-defined types are: scheduled, afterSuccessfulStage, afterSuccessfulPlan, afterSuccessfulDeployment. One or more repositories can be specified for pre-defined type triggers based on repositories. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters.

deploymentProject, name, type

repository, branch, schedule, ipRestriction, triggeringEnvironment, disable, field, fields, field1, value1, field2, value2

Deployment

Create

15

addEnvironmentVariables

Add deployment environment variables. Use the field parameters for the variable name and the corresponding value parameters for the variable values.

deploymentProject, environment

replace, field, fields, field1, value1, field2, value2

Deployment

Create

16

addGroup

Add a new group.

group

continue

Groups

Create

17

addJob

Add a job to a stage.
Available replacement variables: job, jobName.

plan, stage, job

name, description, disable

Jobs

Create

18

addLabels

Add a comma separated list of labels to a build or plan.

build or plan

labels, number

Labels

Create

19

addNotification

Add a plan notification. There are 2 parts to a notification - an event that triggers the notification and a recipient type that determines the notification protocol. There are built-in notifications and others provided by add-ons. A recipient type may have additional parameters. Generally, these can be specified by the field and values parameters. In some cases, pre-defined parameters are available.

plan, event, recipientType

recipient, field, fields, field1, value1, field2, value2

Notifications

Create

20

addRepository

Add a global or plan repository. If both a name and repository are provided, the name will be used for the Bamboo name and repository will be used for the Bitbucket reposiotry. For a plan repository, you can reference a linked (global) repository. Otherwise a valid repository key or alias is required. Valid aliases are: BITBUCKET, BITBUCKET_CLOUD, BITBUCKET_SERVER, STASH, BCVS, GIT, GITHUB, MERCURIAL, PERFORCE, SUBVERSION. If the credentials parameter is provided the appropriate fields will be added automatically for GIT, Mercurial, and Bitbucket Cloud repositories.

repository or name

plan, repositoryKey, credentials, type, branch, continue, replace, field, fields, field1, value1, field2, value2

Repositories

Create

21

addRequirement

Add requirement to a plan job. Type defaults to EXISTS.

plan, job, requirement

type, value

Requirements

Create

22

addStage

Add a stage to a plan.
Available replacement variables: stage.

plan, stage

description, manual, final, continue

Stages

Create

23

addTask

Add a task to a plan job. A valid task key or alias is required. Valid aliases are: ANT, ARTIFACT_DOWNLOAD, CHECKOUT, CLI_BAMBOO, CLI_BITBUCKET, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_JIRA, CLI_SERVICE_DESK, CLI_SLACK, CLI_UPM, GANT, GINT, GINT3, GRADLE, GRADLEW, GROOVY, INJECT_VARIABLES, JUNIT_PARSER, MAVEN2, MAVEN3, MAVEN_POM_EXTRACTOR, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACE
Available replacement variables: taskId.

plan, job, taskKey

description, disable, final, field, fields, field1, value1, field2, value2

Tasks

Create

24

addTrigger

Add a trigger to a plan. Pre-defined types are: polling, remote, remoteBitbucketServer, scheduled. One or more repositories can be specified for pre-defined type triggers based on repositories or custom types. Polling triggers default to all plan repositories or use repository @all. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters. Use of the name parameter is deprecated - description should be used instead.
Available replacement variables: triggerId.

plan, type

description, repository, schedule, successfulPlans, ipRestriction, disable, field, fields, field1, value1, field2, value2

Triggers

Create

25

addUser

Add a new user. User can be added to a group (or groups) using the group parameter.

userId, userEmail, group

userFullName, userPassword, continue

Users

Create

26

addVariables

Add global or plan variables. Defaults to global variables unless a plan is specified. Use the field parameters for the variable name and the corresponding value parameters for the variable values.

 

plan, replace, findReplace, findReplaceRegex, field, fields, field1, value1, field2, value2

Variables

Create

27

cloneEnvironment

Clone an environment within a deployment project.
Available replacement variables: environment, environmentId.

deploymentProject, environment, name

description

Deployment

Create

28

clonePlan

Clone a plan. The disable parameter is deprecated and no longer works on Bamboo 6.4 or higher.
Available replacement variables: project,plan.

plan, toPlan, name

description, projectName

Plans

Create

29

cloneProject

Clone each plan in a project to another project. If toProject is not provided, the plans will be cloned to the same project. If the toProject does not exist, it will be created with name provided by projectName.

project, toProject, projectName, disable

 

Projects

Create

30

createDeploymentProject

Create a deployment project for a plan.
Available replacement variables: deploymentProject, deploymentProjectId.

plan, name

description, branch

Deployment

Create

31

createOrUpdatePlan

Same as createPlan when plan does not exist. However, it will update an existing plan's name and description.
Available replacement variables: project, plan.

plan

name, projectName, description, disable

Plans

Create

32

createPlan

Create a new plan. Provide a 2-part plan key where the first part is the project key. If the project key does not exist, it will be created with the provided project name. Use continue to ignore the request if the plan already exists. Use replace to replace an existing plan, which, by default, follows a move, delete, create scenario. Use '--options clear' to modify the replace scenario to only clearing most plan constructs so they can be reconstructed later. See the documentation on Plan Creation Scripting for more details.
Available replacement variables: project, plan.

plan

name, projectName, description, disable, replace, continue, options

Plans

Create

33

createProject

Bamboo 6.2 and higher. Create a new project.

project

name, description

Projects

Create

34

deleteDeploymentProject

Delete a deployment project by name or id.

deploymentProject

continue

Deployment

Delete

35

deletePlan

Delete a plan.

plan

 

Plans

Delete

36

deleteProject

Delete project and all project plans.

project

file

Projects

Delete

37

deployEnvironment

Deploy environment. To promote (re-deploy) an existing version, use --replace.

deploymentProject, environment, version

build, number, replace, wait, timeout

Deployment

 

38

disableAgent

Disable an agent.

agent

 

Agents

Update

39

disableJob

Disable a job from running. Use @all for job to disable all jobs in a stage.

plan, job

stage

Jobs

Update

40

disablePlan

Disable a plan from running.

plan

 

Plans

Update

41

disableProject

Disable all project plans.

project

 

Projects

Update

42

enableAgent

Enable an agent.

agent

 

Agents

Update

43

enableJob

Enable a job to run. Use @all for job to enable all jobs in a stage.

plan, job

stage

Jobs

Update

44

enablePlan

Enable a plan to run.

plan

 

Plans

Update

45

enableProject

Enable all project plans.

project

 

Projects

Update

46

exportDeploymentProject

Export a deployment project to source that can be used for deployment project creation.

deploymentProject

file, encoding, dateFormat

Deployment

Export

47

exportEnvironment

Export an environment for a deployment project to source.

deploymentProject, environment

file, encoding, dateFormat

Deployment

Export

48

exportJob

Export a job to CLI source.

plan, job

file, encoding, dateFormat

Jobs

Export

49

exportPlan

Export a plan to source that can be used for plan creation. Valid export types are CLI, JAVA.

plan

type, file, encoding, dateFormat

Plans

Export

50

exportSite

Export site to the exports directory in the home directory. By default, only the configuration is exported. Set appropriate options parameters to export additional data: exportResults, exportArtifacts, exportBuildLogs. Use the name parameter to set the file name, otherwise it will be automatically generated based on the date of the export using the date format requested.

 

name, options

 

Export

51

getAgentAssignmentList

Get a list of assignments for agents with regex filtering on entity key or name. Specify an agent to filter by agent. Specify an assignment type to filter on type. Valid types are PROJECT, PLAN, JOB, DEPLOYMENT_PROJECT, ENVIRONMENT.

 

agent, type, limit, regex, file, append, encoding, columns

Agent Assignments

Get

52

getAgentList

Get a list of agents based on regex filtering of agent names.
Available output formats: 1 - basic, 999 - all.

 

excludeEnabled, excludeDisabled, limit, regex, file, append, encoding, columns

Agents

Get

53

getApp

Get app information if installed. Use '--app @default' for the CLI app.
Available replacement variables: app, appName, appVersion.

app

 

App

Get

54

getApplicationLink

Get information for an application link identified by name or url.
Available replacement variables: applicationLinkId.

name or url

 

Links

Get

55

getApplicationLinkList

Get list of a application links with optional filtering on application type and regex filtering on the name or url. Use '--options excludeSystemLinks' to exclude system defined links. Example types: jira, confluence.
Available output formats: 1 - basic, 2 - status, 999 - all.

 

type, options, limit, regex, outputFormat, file, append, columns, encoding

Links

Get

56

getArtifact

Download a copy of a build artifact into a file or directory. Uses same parameters and logic as getArtifactList for identifying build result artifacts to search. For artifacts that represent a directory, specify an existing directory or use '--options mkdir' to create the directory path to download all files for the artifact. Otherwise, the html for the artifact will be downloaded to the file. Alternatively, use the artifact name plus the path to the file in the artifact to get a single artifact file.

plan or build, artifact, file

job, number, replace, options, encoding

Artifacts

Get

57

getArtifactDefinitionList

Get a list of artifact definitions for a plan with regex filtering on artifact name.

plan

limit, regex, columns, file, append, encoding

Artifacts

Get

58

getArtifactList

Get a list of build result artifacts. When the build does not include a job portion, only shared artifacts are provided. Use @all for the job parameter to get both sharted and non-shared artifacts for all plan jobs.

plan or build

job, number, limit, regex, file, append, encoding

Artifacts

Get

59

getBranch

Get information for a branch to a plan. Branch can be either the short or long name of the branch.

plan, branch

file, encoding

Branches

Get

60

getBranchList

Get a list of branches for a plan with regex filtering on branch name, short name, or full key.

plan

limit, regex, columns, file, append, encoding

Branches

Get

61

getBranchingOptions

Get branching options for a plan.

plan

file, encoding

Branches

Get

62

getBuild

Get build result.

build

number, file, encoding

Builds

Get

63

getBuildList

Get a list of build results. Build results can be filtered by using fields and values. Supported fields are state, notState, started, endedBefore. For example, include only successful results by using: --field1 state --value SUCCESSFUL, or include only builds started after a specific date use: --field2 started --value2 2016-04-30 --dateFormat yyyy-MM-dd. Default limit is 25.
Available output formats: 1 - basic, 999 - test information and other details.

plan

labels, issues, limit, columns, file, append, encoding, field, fields, field1, value1, field2, value2

Builds

Get

64

getBuildQueueList

Get a list of builds waiting in the build queue. Subset by project or build.

 

project, build, file, append, encoding, columns

Builds

Get

65

getCapabilityList

Get a list of shared or agent specific capabilities with regex filtering on capability key or name (label). Use @all for agent to get shared and agent specific capabilities. Specify --options includeUnreferenced to include unreferenced server capabilities keys known to the system.

 

agent, options, regex, options, limit, file, append, encoding

Lists

Get

66

getClientInfo

Get information about this client tool.
Available output formats: 1 - basic, 2 - JVM, 11 - action list, 12 - parameter list.

 

outputFormat, outputType, file, append, encoding

Info

Get

67

getCommentList

Get a list of comments for a build.

build

number, file, append, encoding, columns

Comments

Get

68

getCredentialsList

Get a list of credentials based on regex filtering of credentials name.

 

regex, limit, file, append, encoding

Lists

Get

69

getDeploymentProject

Get information for a deployment project by name or id.

deploymentProject

 

Deployment

Get

70

getDeploymentProjectList

Get a list of deployment projects based on regex filtering of project names.

 

regex, file, append, encoding, columns

Deployment

Get

71

getEnvironment

Get information for an environment from a deployment project by name or id.

deploymentProject, environment

file, encoding

Deployment

Get

72

getEnvironmentList

Get a list of environments for a deployment project based on regex filtering of environment names.

deploymentProject

regex, file, append, encoding, columns

Deployment

Get

73

getEnvironmentNotificationList

Get a list of environment notifications.

deploymentProject, environment

file, append, encoding

Deployment

Get

74

getEnvironmentRequirementList

Get a list of deployment environment requirements based on regex filtering of requirement names.

deploymentProject, environment

regex, limit, file, append, encoding

Deployment

Get

75

getEnvironmentTaskList

Get a list of tasks for a deployment environments with regex filtering of task name or description.

deploymentProject, environment

regex, file, append, encoding, columns

Deployment

Get

76

getEnvironmentTrigger

Get information for a deployment environment trigger.

deploymentProject, environment, id or name

file, encoding

Deployment

Get

77

getEnvironmentTriggerList

Get a list of environment triggers for a deployment environment based on regex filtering of trigger names or descriptions.

deploymentProject, environment

regex, file, append, encoding, columns

Deployment

Get

78

getEnvironmentVariableList

Get a list of deployment environment variables based on regex filtering of variable names.

deploymentProject, environment

regex, limit, file, append, encoding

Deployment

Get

79

getJob

Get job information.

plan, job

 

Jobs

Get

80

getJobList

Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired.

plan

stage, limit, regex, file, columns

Jobs

Get

81

getLabelList

Get a list of labels for a build or plan.

build or plan

number, file, append, encoding, columns

Labels

Get

82

getLatestBuildNumber

Get the number of the last completed build for this plan.

plan

 

Builds

Get

83

getNotificationList

Get a list of plan notifications.

plan

file, regex, append, encoding

Notifications

Get

84

getPlan

Get plan information.

plan

 

Plans

Get

85

getPlanList

Get a list of plans for a project with regex filtering on plan key or name. Additionally, use labels parameter to filter by labels. Use @all for project to get a list of plans across all projects. To also include branch plans in the list, use --options "includeBranchPlans". Advanced filtering based on state and date of the latest build for the plan is also available. See getBuildList for more information. Advanced filtering based on using a repository is also possible using --options "usingRepository=xxx".
Available output formats: 1 - plan, 999 - last build results.

project

favorite, excludeDisabled, excludeEnabled, labels, options, limit, regex, outputFormat, dateFormat, columns, options, file, append, encoding, field, fields, field1, value1, field2, value2

Plans

Get

86

getProjectList

Get a list of projects. Projects are selected based on regex filtering on project key or name.

 

regex, file, append, encoding, columns

Projects

Get

87

getRepository

Get details of a global or plan repository.
Available replacement variables: repository, repositoryId.
Available output formats: 1 - basic, 999 - all.

repository

plan

Repositories

Get

88

getRepositoryList

Get a list of global or plan repositories with regex filtering on repository name.

 

plan, regex, file, append, encoding

Repositories

Get

89

getRequirementList

Get a list of requirements for a job with regex filtering on requirement name.

plan, job, id

limit, regex, file, append, encoding, columns

Requirements

Get

90

getServerInfo

Get information about the Bamboo server.
Available output formats: 1 - basic, 2 - detail, 3 - state, 999 - all.

 

outputFormat, dateFormat, file, append, encoding

Info

Get

91

getStage

Get plan stage information.

plan, stage

 

Stages

Get

92

getStageList

Get a list of stages for a plan with regex filtering on stage name.

plan

regex, file, columns

Stages

Get

93

getTask

Get detail information on a task from a plan job. Use --task @all to give detail information on all tasks for a job.

plan, job, task or id

 

Tasks

Get

94

getTaskList

Get a list of tasks for a job with regex filtering on task name.

plan, job

limit, regex, file, columns

Tasks

Get

95

getTaskTypeList

Get a list of task types available with regex filtering on type name and description.

plan, job

limit, regex, file, columns

Tasks

Get

96

getTrigger

Get information for a plan trigger.

plan, id or name

file, encoding

Triggers

Get

97

getTriggerList

Get a list of triggers for a job based on regex filtering of trigger names or descriptions.

plan, job

regex, file, append, encoding, columns

Triggers

Get

98

getUserList

Get list of a users with regex filtering on the userId or name.

 

limit, regex, file, append, columns, encoding

Users

Get

99

getVariableList

Get a list of global or plan variables based on regex filtering of variable names. The optional reference parameter can be used to set a CLI replacement variable for each variable with name prefixed by the reference parameter. Use 'bamboo.' to make references look similar to how bamboo variables are used.

 

plan, regex, reference, file, append, encoding

Variables

Get

100

installApp

Install app via UPM. Use '--app @default' for the CLI app. See UPM CLI documentation for installApp for more details.
Available replacement variables: app, appName, appVersion.

url or file or app

version

App

Install

101

moveEnvironment

Move an environment after or before another environment identified by name or id. If neither before or after are specified, the environment will be moved to the top. Use --after @last to move environment to the last position. After parameter takes precedence.

deploymentProject, environment

after, before

Deployment

 

102

movePlans

Move one or more plans from one project to another project (existing or new) with filtering similar to getPlanList. Specifying a plan will move that plan. If plan is not specified, plans from the source project, with filtering like for getPlanList, will be moved. Plan key and name can be changed on the move by specifying toPlan and name respectively. When toPlan or name are provided for multiple plan moves, they must contain @plan@ or @planName@ replacement variables. Consider pausing the server to prevent activity during a move using the pauseServer action or specifying --options pause to have the action automatically pause the server and resume after the end of the operation.

project or plan, toProject

toPlan, name, excludeEnabled, excludeDisabled, labels, options, limit, regex

Plans

 

103

moveStage

Change the position of a stage in a plan to be after another stage or, by default, to the top.

plan, stage

after

Stages

 

104

moveTask

Move a task to before or after another task. Use final to make a task final. Final tasks must follow all non final tasks. If neither before or after are specified, the task will be moved to the last position respecting the final parameter.

plan, job, task or id

after, before, final

Tasks

 

105

orderRepository

Order repository in the list of repositories for a plan. Defaults to move the repository to the top to make it the default repository. Otherwise specify the after respository name.

plan, repository

after

Repositories

 

106

pauseServer

Pause the server to prevent builds from starting.

 

 

Server

Stop

107

queueBuild

Queue a build to run. If a build number is provided (number parameter or 3 part build key), an existing failed or incomplete build can be restarted. If wait is specified, the action will not complete until the queued build completes or the timeout period elapses. The action will fail if the build fails unless continue parameter is used to ignore a failed result. A specific revision can be built if the revision parameter is specified. Plan variables can be set using the field and value parameters. Plans with manual stages can be automatically continued to a specific stage or @ALL using the stage parameter provided wait is also used. Conditional queueing is supported - see the documentation for details.

plan or build

branch, revision, number, wait, stage, continue, timeout, dateFormat, field, fields, field1, value1, field2, value2

Builds

 

108

queueBuildFromList

Queue multiple builds to run and wait for results. Plans can be filtered by using the labels parameter. Project can be @all. The action will not complete until all queued builds complete or times out. If continue is specified, builds will continue to be queued even after an attempt to queue a build fails. The action will fail if any build fails or times out. Conditional queueing is supported - see the documentation for details.

project or list

labels, regex, limit, continue, simulate, timeout, dateFormat, field, fields, field1, value1, field2, value2

Builds

 

109

removeAgent

Remove an agent.

agent

continue

Agents

Delete

110

removeAgentAssignment

Remove an assignment from a specific agent. Use continue to ignore not found error.

agent, assignment

type, continue

Agent Assignments

Delete

111

removeApplicationLink

Remove an application link identified by name or url.

name or url

continue

Links

Delete

112

removeArtifact

Remove an artifact definition from a job.

plan, job, artifact

 

Artifacts

Delete

113

removeBranch

Removes a branch from a plan. Use --branch @all to remove all branches from a plan.

plan, branch

 

Branches

Delete

114

removeBuildHistory

Remove history for specific build.

build

number, continue

Builds

Delete

115

removeCapability

Remove a shared or agent specific server capability identified by key (label) or unique name.

capability

agent

 

Delete

116

removeCredentials

Remove credentials by name or id.

credentials

continue

 

Delete

117

removeEnvironment

Remove an environment from a deployment project by name or id.

deploymentProject, environment

continue

Deployment

Delete

118

removeEnvironmentNotification

Remove deployment environment notification. Use id of -1 to remove all notifications for an environment. If an id is not provided, all notifications found matching the event and recipientType will be removed.

deploymentProject, environment, id or event and recipientType

continue

Deployment

Delete

119

removeEnvironmentRequirement

Remove a deployment environment requirement. Specify -1 for id to remove all requirements from a plan that are eligible to be removed.

deploymentProject, environment, id

 

Deployment

Delete

120

removeEnvironmentTask

Remove a task from a deployment environment.

deploymentProject, environment, task or id

 

Deployment

Delete

121

removeEnvironmentTrigger

Remove a trigger from a deployment environment. Use --id -1 or --name @all to remove all triggers. Administrator permission required to use a name and only the first trigger with the given name will be removed.

deploymentProject, environment, id or name

continue

Deployment

Delete

122

removeEnvironmentVariables

Remove deployment environment variables. Specify the variable names using the field parameters.

deploymentProject, environment

field, fields, field1, value1, field2, value2

Deployment

Delete

123

removeGroup

Remove a group.

group

continue

Groups

Delete

124

removeJob

Remove a job from a plan.

plan, job

continue

Jobs

Delete

125

removeLabels

Remove labels from a build or plan. Labels can be a comma separated list or regex.

build or plan, labels

number, continue

Labels

Delete

126

removeNotification

Remove a plan notification. Use id of -1 to remove all notifications for a plan. If an id is not provided, all notifications found matching the event and recipientType will be removed.

plan, id or event and recipientType

continue

Notifications

Delete

127

removeRepository

Remove global or plan repository. Use @all to remove all repositories. When removing a single plan repository, you can replace references with another repository defined for the plan by using --options "replaceRepository=XXX".

repository or id

plan, options, continue

Repositories

Delete

128

removeRequirement

Remove a plan requirement. Specify -1 for id to remove all requirements from a plan that are eligible to be removed.

plan, job, id

 

Requirements

Delete

129

removeStage

Remove a stage from a plan. Use --stage @all to remove all stages. Use continue to ignore not found errors. On Bamboo 6.8 and higher, stages are removed in the background. Use wait to wait for the background removal to occur before completing the action.

plan, stage or id

wait, timeout, continue

Stages

Delete

130

removeTask

Remove a task from a plan job. Use --task @all to remove all tasks.

plan, job, task or id

 

Tasks

Delete

131

removeTrigger

Remove a trigger from a plan. Use --id -1 or --name @all to remove all triggers. Administrator permission required to use a name and only the first trigger with the given name will be removed.

plan, id or name

continue

Triggers

Delete

132

removeUser

Remove a user.

userId

continue

Users

Delete

133

removeVariables

Remove global or plan variables. Specify the variable names using the field parameters.

 

plan, field, fields, field1, value1, field2, value2

Variables

Delete

134

renderRequest

Render url based request. The response data modified by findReplace processing is returned.

request

requestParameters, requestType, type, acceptType, build, file, encoding, findReplace, findReplaceRegex

Render

Get

135

restartBuild

Restart a build that failed or was stopped or continue a build with unfinished manual stages. To build up to a specific manual stage, use wait and the stage parameter. Use *ALL for stage to run all stages. Use continue to ignore errors finding a build to restart or failed results.

plan

wait, stage, timeout, continue

Builds

 

136

restoreAgentAssignments

Only useful in the context of a run script replacing an existing plan with createPlan. This will attempt to add agent assignments saved during createPlan and that are still valid.

plan

 

Agent Assignments

Import

137

resumeServer

Resume server to allow builds to be started.

 

 

Server

Start

138

run

Run actions from a file, list of input parameters, or standard input.

file or input or standard input

common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

Run

Run

139

runFromAgentAssignmentList

Run actions for each agent assignment with filtering like getAgentAssignment.
Available replacement variables: agent, agentId, assignment, assignmentId, assignmentKey.

 

agent, type, limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Agent Assignments

Run

140

runFromAgentList

Run actions for each agent with regex filtering on agent name.
Available replacement variables: agent, agentId.

 

excludeEnabled, excludeDisabled, limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Agents

Run

141

runFromBuildList

Run actions for each build with filtering like getBuildList.
Available replacement variables: build.

plan

labels, issues, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Builds

Run

142

runFromCapabilityList

Run actions for each capability with regex filtering like getCapabilityList.
Available replacement variables: capability, capabilityKey, capabilityGroup.

 

agent, limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Run

Run

143

runFromCsv

Run actions generated from a CSV file.

file

common, input, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

CSV

Run

144

runFromDeploymentProjectList

Run actions for each deployment project with regex filtering on deployment project name.
Available replacement variables: deploymentProject, deploymentProjectId.

 

regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Deployment

Run

145

runFromEnvironmentList

Run actions for each environment defined for a deployment project with regex filtering on environment name.
Available replacement variables: environment, environmentId.

plan

regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Deployment

Run

146

runFromEnvironmentRequirementList

Run actions for each environment requirement defined for a deployment environment with regex filtering on requirement name.
Available replacement variables: requirement, requirementId.

deploymentProject, environment

regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Deployment

Run

147

runFromEnvironmentTriggerList

Run actions for each environment trigger defined for a deployment environment with regex filtering on trigger name or description.
Available replacement variables: triggerId.

deploymentProject, environment

regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Deployment

Run

148

runFromJobList

Run actions for each job with regex filtering on job key or name. Restrict to a specific stage or leave stage blank to get jobs across all stages.
Available replacement variables: project, projectName, plan, planName, stageId, stageName, job, jobName.

plan

stage, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Jobs

Run

149

runFromList

Run actions for each entry in a list. When file is provided, each action in the file augmented by the common parameter will be run for each entry. Otherwise, just the action specified by the common parameter will be run.
Available replacement variables: entry, entry2.

list

list2, input, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

Run

Run

150

runFromPlanList

Run actions for each plan with regex filtering on plan key or name. Use @all for project to get a list of plans across all projects. See getPlanList for all filtering capabilities.
Available replacement variables: project, projectName, plan, planName.

project

favorite, excludeDisabled, excludeEnabled, labels, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Plans

Run

151

runFromProjectList

Run actions for each project with regex filtering on project key or name.
Available replacement variables: project, projectName.

 

regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Projects

Run

152

runFromRepositoryList

Run actions for each repository with regex filtering on repository name.
Available replacement variables: repository, repositoryId.

 

plan, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Repositories

Run

153

runFromRequirementList

Run actions for each requirement defined for a job with regex filtering on requirement name.
Available replacement variables: requirement, requirementId.

plan, job

limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Requirements

Run

154

runFromSql

Run actions generated by SQL provided by the sql parameter, a file, or standard input

sql or file

common, driver, database, host, port, url, dbUser, dbPassword, input, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

SQL

Run

155

runFromStageList

Run actions for each stage with regex filtering on stage name.
Available replacement variables: project, projectName, plan, planName, stageId, stageName.

plan

stage, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Stages

Run

156

runFromTaskList

Run actions for each task in a job with regex filtering like getTaskList.
Available replacement variables: plan, job, taskId.

plan, job

limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Tasks

Run

157

runFromTriggerList

Run actions for each plan trigger with regex filtering on trigger name or description.
Available replacement variables: triggerId.

plan

regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Triggers

Run

158

runFromUserList

Run actions for each user with regex filtering the same as getUserList.
Available replacement variables: userId.

 

regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

Users

Run

159

runIf

Run actions only if a regex based condition is met. Other parameters and behavior are the same as the run action. By default the regex is used as a find operation in the value. Options parameter can be set to one or more of the following to modify the default behavior: literal - to treat the regex string as a literal string, exact - to require an exact match of the value, negative - to reverse the condition so a match means do NOT run action.

value, regex, file or input or standard input

common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

Run

Run

160

setDependencyOptions

Set child dependencies and other related options.

plan

childPlans, field, fields, field1, value1, field2, value2

Options

Update

161

setFavoritePlan

Set the plan as a favorite.

plan

 

Plans

Update

162

setJobOptions

Set miscellaneous option for a job. The following options are specifically supported: clean working directory after job completes (cleanAfter switch) and pattern matching labeling (regex and labels parameters). Use the field and value parameters for additional settings with values determined from the screen. Some previous settings may be lost if not specifically requested.

plan, job

cleanAfter, regex, labels

Jobs

Update

163

stopBuild

Request to stop a queued or running build. Use continue to ignore errors finding a build to stop or failed results. The wait parameter will cause processing to wait for completion or timeout before returning.

plan

wait, timeout, continue

Builds

 

164

testRepository

Experimental. Test a global or plan repository configuration to see if a successful connection can be made. Bamboo 5.15 or higher for Bitbucket, GIT, and Mercurial repositories using shared credentials only.

repository

plan

Repositories

 

165

unsetFavoritePlan

Remove the plan from the favorite list.

plan

 

Plans

 

166

updateBranchingOptions

Update branching options for a plan. Use the field or other field setting parameters to set options. Use getBranchingOptions to view the available fields that can be set.

plan

field, fields, field1, value1, field2, value2, file, encoding

Branches

Update

167

updateCapability

Update a capabilities value.

capability

agent, value

 

Update

168

updateCredentials

Update existing credentials. Credentials can be renamed by providing a name.

credentials

name, userId, file, input, accessKeyId, userPassword, sshParaphrase, accessKey

 

Update

169

updateEnvironmentRequirement

Update a deployment environment requirement.

deploymentProject, environment, id

type, value

Deployment

Update

170

updateEnvironmentTask

Update a task for a deployment environment.

deploymentProject, environment, task or id

description, taskKey, field, fields, field1, value1, field2, value2

Deployment

Update

171

updateEnvironmentVariables

Update existing deployment environment variables. Use the field parameters for the variable name and the corresponding value parameters for the variable values. Use append to add text to an existing variable.

deploymentProject, environment

append, field, fields, field1, value1, field2, value2

Deployment

Update

172

updatePlan

Update a plan's name or description. Provide a 2-part plan key where the first part is the project key. Variable @planName@ can be used in the name or description parameter to substitution the current plan name.

plan

name, description

Plans

Update

173

updateRepository

Update a global or plan repository. Be careful to provide all the parameters needed for the repository definition just like on addRepository. If the credentials parameter is provided the appropriate fields will be added automatically for GIT, Mercurial, and Bitbucket Cloud repositories.

repository or id

plan, name, credentials, field, fields, field1, value1, field2, value2

Repositories

Update

174

updateRequirement

Update a plan requirement.

plan, job, id

type, value

Requirements

Update

175

updateStage

Update stage details.

plan, stage

name, description, manual, final, automatic

Stages

Update

176

updateTask

Update a task in a plan job. You must provide the same parameters as if you were creating the task.

plan, job, task or id

enable, disable, taskKey, field, fields, field1, value1, field2, value2

Tasks

Update

177

updateVariables

Update existing global or plan variables. Defaults to global variables unless a plan is specified. Use the field parameters for the variable name and the corresponding value parameters for the variable values. Use append to add text to an existing variable.

 

plan, append, findReplace, findReplaceRegex, field, fields, field1, value1, field2, value2

Variables

Update

178

validateLicense

Validates the CLI Connector is enabled and licensed on the server.

 

 

Misc

Check

179

verifyBuild

Verify build was successful. Throws exception if not successful. If only a plan key is specified, it defaults to latest build. Use wait to loop waiting for the build to complete.

build

number, wait, timeout

Builds

 

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.