Page Comparison

addAgent

Add a local agent.

agent

description, continue

Agents

Create

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

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

addArtifact

Add an artifact definition to a job.

plan, job, artifact, copyPattern

location, shared

Artifacts

Create

addArtifactDependency

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

plan, job, artifact, location

Artifacts

Create

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

addCapability

Add a shared or agent specific server capability.

type

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

Create

addComment

Add a comment to a build.

build, comment

number, findReplace, findReplaceRegex, input, file, encoding

Comments

Create

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

addEnvironment

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

deploymentProject, name

description

Deployment

Create

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

addEnvironmentRequirement

Add a requirement to a deployment environment.

deploymentProject, environment, requirement

type, value

Deployment

Create

addEnvironmentTask

Add a task to a deployment environment.

deploymentProject, environment, taskKey

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

Deployment

Create

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

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

addGroup

Add a new group.

group

continue

Groups

Create

addJob

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

plan, stage, job

name, description, disable

Jobs

Create

addLabels

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

build or plan, labels

number

Labels

Create

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

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

addRequirement

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

plan, job, requirement

type, value

Requirements

Create

addStage

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

plan, stage

description, manual

Stages

Create

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_HIPCHAT, CLI_JIRA, CLI_SERVICE_DESK, CLI_UPM, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, MAVEN_POM_EXTRACTOR, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACE
Available replacement variables: taskId.

plan, job, taskKey

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

Tasks

Create

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, passingPlans, ipRestriction, disable, field, fields, field1, value1, field2, value2

Triggers

Create

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

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

cloneEnvironment

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

deploymentProject, environment, name

description

Deployment

Create

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

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

createDeploymentProject

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

plan, name

description, branch

Deployment

Create

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

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.
Available replacement variables: project, plan.

plan

name, projectName, description, disable, replace, continue

Plans

Create

createProject

Bamboo 6.2 and higher. Create a new project.

project

name, description

Projects

Create

deleteDeploymentProject

Delete a deployment project by name or id.

deploymentProject

continue

Deployment

Delete

deletePlan

Delete a plan.

plan

Plans

Delete

deleteProject

Delete project and all project plans.

project

file

Projects

Delete

deployEnvironment

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

deploymentProject, environment, version

build, number, replace, wait, timeout

Deployment

disableAgent

Disable an agent.

agent

Agents

Update

disableJob

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

plan, job

stage

Jobs

Update

disablePlan

Disable a plan from running.

plan

Plans

Update

disableProject

Disable all project plans.

project

Projects

Update

enableAgent

Enable an agent.

agent

Agents

Update

enableJob

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

plan, job

stage

Jobs

Update

enablePlan

Enable a plan to run.

plan

Plans

Update

enableProject

Enable all project plans.

project

Projects

Update

exportDeploymentProject

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

deploymentProject

file, encoding, dateFormat

Deployment

Export

exportEnvironment

Export an environment for a deployment project to source.

deploymentProject, environment

file, encoding, dateFormat

Deployment

Export

exportJob

Export a job to CLI source.

plan, job

file, encoding, dateFormat

Jobs

Export

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

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

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

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

getApplicationLink

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

name or url

Links

Get

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

getArtifact

Download a copy of a build artifact into a file. Uses same parameters and logic as getArtifactList for identifying build result artifacts to search. For artifacts that represent a directory (not a file), use the artifact name plus the path to the file in the artifact.

plan or build, artifact, file

job, number, replace, encoding

Artifacts

Get

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

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

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

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

getBranchingOptions

Get branching options for a plan.

plan

file, encoding

Branches

Get

getBuild

Get build result.

build

number, file, encoding

Builds

Get

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

getBuildQueueList

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

project, build, file, append, encoding, columns

Builds

Get

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

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

getCommentList

Get a list of comments for a build.

build

number, file, append, encoding, columns

Comments

Get

getCredentialsList

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

regex, limit, file, append, encoding

Lists

Get

getDeploymentProject

Get information for a deployment project by name or id.

deploymentProject

Deployment

Get

getDeploymentProjectList

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

regex, file, append, encoding, columns

Deployment

Get

getEnvironment

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

deploymentProject, environment

file, encoding

Deployment

Get

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

getEnvironmentNotificationList

Get a list of environment notifications.

deploymentProject, environment

file, append, encoding

Deployment

Get

getEnvironmentRequirementList

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

deploymentProject, environment

regex, limit, file, append, encoding

Deployment

Get

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

getEnvironmentTrigger

Get information for a deployment environment trigger.

deploymentProject, environment, id or name

file, encoding

Deployment

Get

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

getEnvironmentVariableList

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

deploymentProject, environment

regex, limit, file, append, encoding

Deployment

Get

getJob

Get job information.

plan, job

Jobs

Get

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

getLabelList

Get a list of labels for a build or plan.

build or plan

number, file, append, encoding, columns

Labels

Get

getLatestBuildNumber

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

plan

Builds

Get

getNotificationList

Get a list of plan notifications.

plan

file, regex, append, encoding

Notifications

Get

getPlan

Get plan information.

plan

Plans

Get

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, file, append, encoding, field, fields, field1, value1, field2, value2

Plans

Get

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

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

getRepositoryList

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

plan, regex, file, append, encoding

Repositories

Get

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

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

getStage

Get plan stage information.

plan, stage

Stages

Get

getStageList

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

plan

regex, file, columns

Stages

Get

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

getTaskList

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

plan, job

limit, regex, file, columns

Tasks

Get

getTaskTypeList

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

plan, job

limit, regex, file, columns

Tasks

Get

getTrigger

Get information for a plan trigger.

plan, id or name

file, encoding

Triggers

Get

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

getUserList

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

limit, regex, file, append, columns, encoding

Users

Get

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

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

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

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

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

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

pauseServer

Pause the server to prevent builds from starting.

Server

Stop

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. Conditional queueing is supported - see the documentation for details.

plan or build

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

Builds

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

removeAgent

Remove an agent.

agent

continue

Agents

Delete

removeAgentAssignment

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

agent, assignment

type, continue

Agent Assignments

Delete

removeApplicationLink

Remove an application link identified by name or url.

name or url

continue

Links

Delete

removeArtifact

Remove an artifact definition from a job.

plan, job, artifact

Artifacts

Delete

removeBranch

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

plan, branch

Branches

Delete

removeBuildHistory

Remove history for specific build.

build

number, continue

Builds

Delete

removeCapability

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

capability

agent

Delete

removeCredentials

Remove credentials by name or id.

credentials

continue

Delete

removeEnvironment

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

deploymentProject, environment

continue

Deployment

Delete

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

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

removeEnvironmentTask

Remove a task from a deployment environment.

deploymentProject, environment, task or id

Deployment

Delete

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

removeEnvironmentVariables

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

deploymentProject, environment

field, fields, field1, value1, field2, value2

Deployment

Delete

removeGroup

Remove a group.

group

continue

Groups

Delete

removeJob

Remove a job from a plan.

plan, job

continue

Jobs

Delete

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

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

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

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

removeStage

Remove a stage from a plan. Use --stage @all to remove all stages. Use continue to ignore not found errors.

plan, stage or id

continue

Stages

Delete

removeTask