addAgentAssignment

Agent Assignments

Assign a project, plan, or job to a specific agent. This makes the agent is dedicated to only perform builds for all assignments. Use continue to ignore already exists error.

agent, assignment

continue

addAgent

Agents

Add a local agent.

agent

description

addArtifactDependency

Artifacts

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

plan, job, artifact, location

addArtifact

Artifacts

Add an artifact definition to a job. Server instances only.

plan, job, artifact, copyPattern

location, shared

addComment

Comments

Add a comment to a build.

build, comment

number, findReplace, findReplaceRegex, file, encoding

addJob

Jobs

Add a job to a stage.

plan, stage, job

name, description, disable

addLabels

Labels

Add a comma separated list of labels to a build.

build, labels

number

addNotification

Notifications

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

fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

addRepository

Repositories

Add a global or plan repository. 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

repository or name

plan, repositoryKey, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

addRequirement

Requirements

Add requirement to a plan job.

plan, job, requirement

type, value

addStage

Stages

Add a stage to a plan.

plan, stage

description, manual

addTask

Tasks

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, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACE

plan, job, taskKey

disable, final, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

addTrigger

Triggers

Add a trigger to a plan. Pre-defined types are: polling, remote, scheduled. 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. Alias types are: stashTrigger.

plan, name, type

repository, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

addVariables

Variables

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 fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

clonePlan

Plans

Clone a plan.

plan, toPlan, name

description, projectName, disable

cloneProject

Projects

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

createOrUpdatePlan

Plans

Same as createPlan when plan does not exist. However, it will update an existing plan's name and description. Server instances only.

plan

name, projectName, description, disable

createPlan

Plans

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. Server instances only. Use continue to ignore the request if the plan already exists.

plan

name, projectName, description, disable, continue

deletePlan

Plans

Delete a plan.

plan

deleteProject

Projects

Delete project and all project plans.

project

file

disableAgent

Agents

Disable an agent.

agent

disableJob

Jobs

Disable a job from running.

plan, job

disablePlan

Plans

Disable a plan from running.

plan

disableProject

Projects

Disable all project plans.

project

enableAgent

Agents

Enable an agent.

agent

enableJob

Jobs

Enable a job to run.

plan, job

enablePlan

Plans

Enable a plan to run.

plan

enableProject

Projects

Enable all project plans.

project

getAgentList

Agents

Get a list of agents based on regex filtering of agent names..

regex, file, append, encoding, columns

1 - basic
2 - detail

getArtifactDefinitionList

Artifacts

Experimental - only those available to be artifact dependencies in the last job! Get a list of shared artifact definitions for a plan with regex filtering on artifact name.

plan

limit, regex, columns, file, append, encoding

getArtifactList

Artifacts

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

getArtifact

Artifacts

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

getBuildList

Builds

Get a list of build reults. Build results can be filtered by using fields and values. Supported fields are state, notState, and started. 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.

plan

limit, favorite, labels, issues, columns, file, append, encoding, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

1 - basic
2 - test information

getBuildQueueList

Builds

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

project, build, file, append, encoding, columns

getBuild

Builds

Get build result.

build

number, expand, file

getClientInfo

Info

Get information about the this client tool.

outputFormat, file, append, encoding

1 - basic
2 - JVM

getCommentList

Comments

Get a list of comments for a build.

build

number, file, append, encoding, columns

getJobList

Jobs

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

plan

stage, regex, file, attribute, columns

getLabelList

Labels

Get a list of labels for a build.

build

number, file, append, encoding, columns

getLatestBuildNumber

Builds

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

plan

getNotificationList

Notifications

EAP (subject to change). Get a list of plan notifications.

plan, file, append, encoding

getPlanList

Plans

Get a list of plans for a project with regex filtering on plan key or name. Use @all for project to get a list of plans across all projects.

project

favorite, excludeDisabled, excludeEnabled, limit, regex, outputFormat, dateFormat, columns, file, append, encoding

1 - plan
999 - last build results

getPlan

Plans

Get plan information.

plan

getProjectList

Projects

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

regex, file, append, encoding, columns

getRepositoryList

Repositories

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

plan, regex, file, append, encoding

getRepository

Repositories

Get details of a global or plan repository. Sets the repository and repositoryId replacement variables.

repository

plan

getServerInfo

Info

Get information about the Bamboo server.

outputFormat, dateFormat, file, append, encoding

1 - basic
2 - detail
3 - state

getStageList

Stages

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

plan

regex, file, attribute, columns

getTaskList

Tasks

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

plan, job

limit, regex, file, columns

getVariableList

Variables

Get a list of global or plan variables based on regex filtering of variable names.

plan, regex, file, append, encoding

moveTask

Tasks

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, id

after or before, final

orderRepository

Repositories

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

queueBuildFromList

Builds

Queue multiple builds to run and wait for results. 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

regex, limit, continue, timeout, dateFormat, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

queueBuild

Builds

Queue a build to run. 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

revision, wait, continue, timeout, dateFormat, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

removeAgentAssignment

Agent Assignments

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

agent, assignment

continue

removeAgent

Agents

Remove an agent.

agent

removeArtifact

Artifacts

Remove an artifact definition from a job. Server instances only.

plan, job, artifact

removeLabels

Labels

Remove labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided

labels

build, number, searchLabels, issues, favorite

removeNotification

Notifications

Remove a plan notification. Use id of -1 to remove all notifications for a plan.

plan, id

removeRepository

Repositories

Remove global or plan repository. Use @all to remove all repositories.

repository or id

plan, continue

removeRequirement

Requirements

Remove a plan requirement.

plan, job, id

removeStage

Stages

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

plan, stage or id

continue

removeTask

Tasks

Remove a task from a plan job. Use id = -1 to remove all tasks.

plan, job, id

removeTrigger

Triggers

Remove a trigger from a plan. Use id = -1 to remove all triggers. Server instances only.

plan, id

removeVariables

Variables

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

plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

renderRequest

Render

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

request

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

restartBuild

Builds

Restart a build that failed or was stopped. Use continue to ignore errors finding a build to restart or failed results.

plan

wait, timeout, continue

runFromAgentList

Agents

Run actions for each agent with regex filtering on agent name. Available replacement variables are agent and agentId.

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

runFromCsv

CSV

Run actions generated from a CSV file.

file

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

runFromJobList

Jobs

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 are project, projectName, plan, planName, stageId, stageName, job, and jobName.

plan

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

runFromList

Run

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 are entry, entry2.

list

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

runFromPlanList

Plans

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. Available replacement variables are project, projectName, plan, and planName.

project

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

runFromProjectList

Projects

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

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

runFromRepositoryList

Repositories

Run actions for each repository with regex filtering on repository name. Available replacement variables are repository and repositoryId.

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

runFromSql

Run

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

sql or file or standard input

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

runFromStageList

Stages

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

plan

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

run

Run

Run actions from a file or standard input.

file or standard input

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

setDependencyOptions

Set child dependencies and other related options.

plan

children, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

setFavoritePlan

Plans

Set the plan as a favorite.

plan

setJobOptions

Jobs

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

stopBuild

Builds

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

unsetFavoritePlan

Plans

Remove the plan from the favorite list.

plan

updatePlan

Plans

Update a plans name or description. Provide a 2-part plan key where the first part is the project key.

plan

name, description

updateRepository

Repositories

Update a global or plan repository.

repository or id

plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

updateRequirement

Requirements

Update a plan requirement.

plan, job, id

type, value

updateTask

Tasks

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

plan, job, id

enable, disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

updateVariables

Variables

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,

plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

validateLicense

Misc

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

verifyBuild

Builds

Verify build was successful.

build

number