Actions - 7.0.0

	Action	Description	Required Parameters	Optional Parameters	Output Formats	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.	agent, assignment	type, continue		Agent Assignments	Create
3	addArtifact	Add an artifact definition to a job.	plan, job, artifact, copyPattern	location, shared		Artifacts	Create
4	addArtifactDependency	Add an artifact dependency to a job. Artifact must be a shared artifact from another job.	plan, job, artifact, location			Artifacts	Create
5	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		Branches	Create
6	addComment	Add a comment to a build.	build, comment	number, findReplace, findReplaceRegex, file, encoding		Comments	Create
7	addEnvironment	Add an environment to deployment project.	deploymentProject, name	description		Deployment	Create
8	addEnvironmentTask	Add a task to a deployment environment.	deploymentProject, environment, taskKey	description, field, fields, field1-8, value1-8		Deployment	Create
9	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, field, fields, field1-8, value1-8		Deployment	Create
10	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-8, value1-8		Deployment	Create
11	addJob	Add a job to a stage.	plan, stage, job	name, description, disable		Jobs	Create
12	addLabels	Add a comma separated list of labels to a build.	build, labels	number		Labels	Create
13	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-8, value1-8		Notifications	Create
14	addRepository	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, field, fields, field1-8, value1-8		Repositories	Create
15	addRequirement	Add requirement to a plan job.	plan, job, requirement	type, value		Requirements	Create
16	addStage	Add a stage to a plan.	plan, stage	description, manual		Stages	Create
17	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, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACE	plan, job, taskKey	disable, final, field, fields, field1-8, value1-8		Tasks	Create
18	addTrigger	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. 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.	plan, type	description, repository, schedule, passingPlans, ipRestriction, field, fields, field1-8, value1-8		Triggers	Create
19	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, field, fields, field1-8, value1-8		Variables	Create
20	clonePlan	Clone a plan.	plan, toPlan, name	description, projectName, disable		Plans	Create
21	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
22	createDeploymentProject	Create a deployment project for a plan.	plan, name	description, branch		Deployment	Create
23	createOrUpdatePlan	Same as createPlan when plan does not exist. However, it will update an existing plan's name and description.	plan	name, projectName, description, disable		Plans	Create
24	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.	plan	name, projectName, description, disable, replace, continue		Plans	Create
25	deleteDeploymentProject	Delete a deployment project by name or id.	deploymentProject	continue		Deployment	Delete
26	deletePlan	Delete a plan.	plan			Plans	Delete
27	deleteProject	Delete project and all project plans.	project	file		Projects	Delete
28	deployEnvironment	Deploy environment. To promote (re-deploy) an existing version, use --replace.	deploymentProject, environment, version	build, number, replace, wait, timeout		Deployment
29	disableAgent	Disable an agent.	agent			Agents	Update
30	disableJob	Disable a job from running.	plan, job			Jobs	Update
31	disablePlan	Disable a plan from running.	plan			Plans	Update
32	disableProject	Disable all project plans.	project			Projects	Update
33	enableAgent	Enable an agent.	agent			Agents	Update
34	enableJob	Enable a job to run.	plan, job			Jobs	Update
35	enablePlan	Enable a plan to run.	plan			Plans	Update
36	enableProject	Enable all project plans.	project			Projects	Update
37	exportPlan	Export a plan to source that can be used for plan creation. Valid export types are CLI, JAVA (Bamboo 6.0 and higher).	deploymentProject, environment	type, file, encoding, dateFormat		Plans	Export
38	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
39	getAgentList	Get a list of agents based on regex filtering of agent names.		regex, file, append, encoding, columns	1 - basic, 2 - detail	Agents	Get
40	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
41	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
42	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
43	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
44	getBranchList	Get a list of branches for a plan with regex filtering on branch name or short name.	plan	limit, regex, columns, file, append, encoding		Branches	Get
45	getBuild	Get build result.	build	number, expand, file, encoding		Builds	Get
46	getBuildList	Get a list of build results. 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	labels, issues, limit, columns, file, append, encoding, field, fields, field1-8, value1-8	1 - basic, 999 - test information and other details	Builds	Get
47	getBuildQueueList	Get a list of builds waiting in the build queue. Subset by project or build.		project, build, file, append, encoding, columns		Builds	Get
48	getClientInfo	Get information about this client tool.		outputFormat, file, append, encoding	1 - basic, 2 - JVM, 11 - action list, 12 - parameter list	Info	Get
49	getCommentList	Get a list of comments for a build.	build	number, file, append, encoding, columns		Comments	Get
50	getDeploymentProject	Get information for a deployment project by name or id.	deploymentProject			Deployment	Get
51	getDeploymentProjectList	Get a list of deployment projects based on regex filtering of project names.		regex, file, append, encoding, columns		Deployment	Get
52	getEnvironment	Get information for an environment from a deployment project by name or id.	deploymentProject, environment	file, encoding		Deployment	Get
53	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
54	getEnvironmentTrigger	Get information for a deployment environment trigger.	deploymentProject, environment, id or name	file, encoding		Deployment	Get
55	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
56	getEnvironmentVariableList	Get a list of deployment environment variables based on regex filtering of variable names.		plan, regex, file, append, encoding		Deployment	Get
57	getJob	Get job information.	plan, job			Jobs	Get
58	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
59	getLabelList	Get a list of labels for a build.	build	number, file, append, encoding, columns		Labels	Get
60	getLatestBuildNumber	Get the number of the last completed build for this plan.	plan			Builds	Get
61	getNotificationList	Get a list of plan notifications.		plan, file, append, encoding		Notifications	Get
62	getPlan	Get plan information.	plan			Plans	Get
63	getPlanList	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. Advanced filtering based on state and date of the latest build for the plan is also available. See getBuildList for more information.	project	favorite, excludeDisabled, excludeEnabled, limit, regex, outputFormat, dateFormat, columns, file, append, encoding, field, fields, field1-8, value1-8	1 - plan, 999 - last build results	Plans	Get
64	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
65	getRepository	Get details of a global or plan repository. Sets the repository and repositoryId replacement variables.	repository	plan		Repositories	Get
66	getRepositoryList	Get a list of global or plan repositories with regex filtering on repository name.		plan, regex, file, append, encoding		Repositories	Get
67	getServerInfo	Get information about the Bamboo server.		outputFormat, dateFormat, file, append, encoding	1 - basic, 2 - detail, 3 - state	Info	Get
68	getStage	Get plan stage information.	plan, stage			Stages	Get
69	getStageList	Get a list of stages for a plan with regex filtering on stage name.	plan	regex, file, columns		Stages	Get
70	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
71	getTaskList	Get a list of tasks for a job with regex filtering on task name.	plan, job	limit, regex, file, columns		Tasks	Get
72	getTaskTypeList	Get a list of task types available with regex filtering on type name and description.	plan, job	limit, regex, file, columns		Tasks	Get
73	getTrigger	Get information for a plan trigger.	plan, id or name	file, encoding		Triggers	Get
74	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
75	getVariableList	Get a list of global or plan variables based on regex filtering of variable names.		plan, regex, file, append, encoding		Variables	Get
76	movePlans	Move one or more plans from one project to another project (existing or new). 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, limit, regex		Plans
77	moveStage	Change the position of a stage in a plan.	plan, stage			Stages
78	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 or before, final		Tasks
79	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
80	pauseServer	Pause the server to prevent builds from starting.				Server	Stop
81	queueBuild	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	branch, revision, wait, continue, timeout, dateFormat, field, fields, field1-8, value1-8		Builds
82	queueBuildFromList	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, field, fields, field1-8, value1-8		Builds
83	removeAgent	Remove an agent.	agent	continue		Agents	Delete
84	removeAgentAssignment	Remove an assignment from a specific agent. Use continue to ignore not found error.	agent, assignment	type, continue		Agent Assignments	Delete
85	removeArtifact	Remove an artifact definition from a job.	plan, job, artifact			Artifacts	Delete
86	removeBranch	Removes a branch from a plan. Use --branch @all to remove all branches from a plan.	plan, branch			Branches	Delete
87	removeEnvironment	Remove an environment from a deployment project by name or id.	deploymentProject, environment	continue		Deployment	Delete
88	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
89	removeEnvironmentVariables	Remove deployment environment variables. Specify the variable names using the field parameters.	deploymentProject, environment	field, fields, field1-8, value1-8		Deployment	Delete
90	removeJob	Remove a job from a plan.	plan, job	continue		Jobs	Delete
91	removeLabels	Remove labels from a build. Labels can be a comma separated list or regex.	build, labels	number, continue		Labels	Delete
92	removeNotification	Remove a plan notification. Use id of -1 to remove all notifications for a plan.	plan, id			Notifications	Delete
93	removeRepository	Remove global or plan repository. Use @all to remove all repositories.	repository or id	plan, continue		Repositories	Delete
94	removeRequirement	Remove a plan requirement.	plan, job, id			Requirements	Delete
95	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
96	removeTask	Remove a task from a plan job. Use --task @all to remove all tasks.	plan, job, task or id			Tasks	Delete
97	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
98	removeVariables	Remove global or plan variables. Specify the variable names using the field parameters.		plan, field, fields, field1-8, value1-8		Variables	Delete
99	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
100	restartBuild	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		Builds
101	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
102	resumeServer	Resume server to allow builds to be started.				Server	Start
103	run	Run actions from a file or standard input.	file or standard input	common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex		Run	Run
104	runFromAgentAssignmentList	Run actions for each agent assignment with filtering like getAgentAssignment. Available replacement variables are agent, agentId, assignment, assignmentId, and assignmentKey.		agent, type, limit, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex		Agent Assignments	Run
105	runFromAgentList	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		Agents	Run
106	runFromBuildList	Run actions for each build with filtering like getBuildList. Available replacement variables are build.	plan	labels, issues, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex		Builds	Run
107	runFromCsv	Run actions generated from a CSV file.	file	common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex		CSV	Run
108	runFromDeploymentProjectList	Run actions for each deployment project with regex filtering on deployment project name. Available replacement variables are deploymentProject and deploymentProjectId.		regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex		Deployment	Run
109	runFromEnvironmentList	Run actions for each environment defined for a deployment project with regex filtering on environment name. Available replacement variables are environment and environmentId.	plan	regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex		Deployment	Run
110	runFromEnvironmentTriggerList	Run actions for each environment trigger defined for a deployment environment with regex filtering on trigger name or description. Available replacement variables are triggerId.	deploymentProject, environment	regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex		Deployment	Run
111	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 are project, projectName, plan, planName, stageId, stageName, job, and jobName.	plan	stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex		Jobs	Run
112	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 are entry, entry2.	list	list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex		Run	Run
113	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 are project, projectName, plan, and planName.	project	favorite, excludeDisabled, excludeEnabled, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex		Plans	Run
114	runFromProjectList	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		Projects	Run
115	runFromRepositoryList	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		Repositories	Run
116	runFromSql	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		SQL	Run
117	runFromStageList	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		Stages	Run
118	runFromTriggerList	Run actions for each plan trigger with regex filtering on trigger name or description. Available replacement variables are triggerId.	plan	regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex		Triggers	Run
119	setDependencyOptions	Set child dependencies and other related options.	plan	children, field, fields, field1-8, value1-8		Options	Update
120	setFavoritePlan	Set the plan as a favorite.	plan			Plans	Update
121	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
122	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
123	unsetFavoritePlan	Remove the plan from the favorite list.	plan			Plans
124	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-8, value1-8		Deployment	Update
125	updatePlan	Update a plans name or description. Provide a 2-part plan key where the first part is the project key.	plan	name, description		Plans	Update
126	updateRepository	Update a global or plan repository.	repository or id	plan, field, fields, field1-8, value1-8		Repositories	Update
127	updateRequirement	Update a plan requirement.	plan, job, id	type, value		Requirements	Update
128	updateStage	Update stage details.	plan, stage	name, description, manual, automatic		Stages	Update
129	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, field, fields, field1-8, value1-8		Tasks	Update
130	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, field, fields, field1-8, value1-8		Variables	Update
131	validateLicense	Validates the CLI Connector is enabled and licensed on the server.				Misc	Check
132	verifyBuild	Verify build was successful. Throws exception if not successful.	build	number		Builds