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

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, CVS, GIT, GITHUB, MERCURIAL, PERFORCE, STASH, SUBVERSION

repository or name

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

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

addTask

Tasks

Add a task to a plan job. A valid task key or alias is required. Valid aliases are: ANT, CHECKOUT, CLI_BAMBOO, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_HIPCHAT, CLI_JIRA, CLI_STASH, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCRIPT

plan, job, taskKey

disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6

addTrigger

Triggers

Add a trigger to a plan. Valid types are: polling, remote, scheduled. One or more repositories can be specified for triggers based on repositories. See the schedule parameter for accepted values. Server instances only.

plan, name, type

repository, schedule, ipRestriction

addVariables

Variables

Add global or plan variables.

plan, replace fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6

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

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.

plan

name, projectName, description, disable

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

Lists

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

regex, file, append, encoding, columns

1 - basic
2 - detail

getArtifact

Artifacts

Download a copy of a build artifact into a file.

build, artifact, file

number

getBuildList

Lists

Get a list of builds. Default limit is 25.

plan

limit, favorite, labels, issues, columns, file, append, encoding

1 - basic
2 - test information

getBuildQueueList

Lists

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

Lists

Get a list of comments for a build.

build

number, file, append, encoding, columns

getJobList

Lists

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

Lists

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

getPlanList

Lists

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, regex, columns, file, append, encoding

getPlan

Plans

Get plan information.

plan

getProjectList

Lists

Get a list of projects. Projects are selected based on regex filtering on project key or name. Legacy list support is deprecated and will be removed in the near future.

regex, file, append, encoding, columns

getRepositoryList

Lists

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

getStageList

Lists

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

plan

regex, file, attribute, columns

getVariableList

Lists

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

plan, regex, file, append, encoding

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.

plan

revision, wait, continue, timeout, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6

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

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

plan, fields, field1, field2, field3, field4, field5, field6

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

runFromAgentList

Run

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

Run

Run actions generated from a CSV file.

file

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

runFromJobList

Run

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 variable is entry.

list

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

runFromPlanList

Run

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, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex

runFromProjectList

Run

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

Run

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

Run

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

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

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

updateVariables

Variables

Update existing global or plan variables

plan fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6

validateLicense

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

verifyBuild

Builds

Verify build was successful.

build

number