Actions - 6.9.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	Experimental. Add an environment to deployment project.	deploymentProject, name	description		Deployment	Create
8	addEnvironmentTask	Experimental. Add a task to a deployment environment.	deploymentProject, environment, taskKey	description, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Deployment	Create
9	addEnvironmentTrigger	Experimental. Add a trigger to a deployment project. Pre-defined types are: scheduled, afterSuccessfulStage. 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, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Deployment	Create
10	addJob	Add a job to a stage.	plan, stage, job	name, description, disable		Jobs	Create
11	addLabels	Add a comma separated list of labels to a build.	build, labels	number		Labels	Create
12	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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Notifications	Create
13	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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Repositories	Create
14	addRequirement	Add requirement to a plan job.	plan, job, requirement	type, value		Requirements	Create
15	addStage	Add a stage to a plan.	plan, stage	description, manual		Stages	Create
16	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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Tasks	Create
17	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, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Triggers	Create
18	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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Variables	Create
19	clonePlan	Clone a plan.	plan, toPlan, name	description, projectName, disable		Plans	Create
20	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
21	createDeploymentProject	Experimental. Create a deployment project for a plan.	plan, name	description, branch		Deployment	Create
22	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
23	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
24	deleteDeploymentProject	Experimental. Delete a deployment project by name or id.	deploymentProject	continue		Deployment	Delete
25	deletePlan	Delete a plan.	plan			Plans	Delete
26	deleteProject	Delete project and all project plans.	project	file		Projects	Delete
27	deployEnvironment	Experimental. Deploy environment. To promote (re-deploy) an existing version, use --replace.	deploymentProject, environment, version	build, number, replace, wait, timeout		Deployment
28	disableAgent	Disable an agent.	agent			Agents	Update
29	disableJob	Disable a job from running.	plan, job			Jobs	Update
30	disablePlan	Disable a plan from running.	plan			Plans	Update
31	disableProject	Disable all project plans.	project			Projects	Update
32	enableAgent	Enable an agent.	agent			Agents	Update
33	enableJob	Enable a job to run.	plan, job			Jobs	Update
34	enablePlan	Enable a plan to run.	plan			Plans	Update
35	enableProject	Enable all project plans.	project			Projects	Update
36	exportPlan	Experimental. Export a plan to source that can be used for plan creation. Valid export types are CLI, JAVA (Bamboo 6.0 and higher).	plan	type, file, encoding, dateFormat		Plans	Export
37	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
38	getAgentList	Get a list of agents based on regex filtering of agent names.		regex, file, append, encoding, columns	1 - basic, 2 - detail	Agents	Get
39	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
40	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
41	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
42	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
43	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
44	getBuild	Get build result.	build	number, expand, file, encoding		Builds	Get
45	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	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	Builds	Get
46	getBuildQueueList	Get a list of builds waiting in the build queue. Subset by project or build.		project, build, file, append, encoding, columns		Builds	Get
47	getClientInfo	Get information about this client tool.		outputFormat, file, append, encoding	1 - basic, 2 - JVM, 11 - action list, 12 - parameter list	Info	Get
48	getCommentList	Get a list of comments for a build.	build	number, file, append, encoding, columns		Comments	Get
49	getDeploymentProject	Experimental. Get information for a deployment project by name or id.	deploymentProject			Deployment	Get
50	getDeploymentProjectList	Experimental. Get a list of deployment projects based on regex filtering of project names.		regex, file, append, encoding, columns		Deployment	Get
51	getEnvironment	Experimental. Get information for an environment from a deployment project by name or id.	deploymentProject, environment	file, encoding		Deployment	Get
52	getEnvironmentList	Experimental. Get a list of environments for a deployment project based on regex filtering of environment names.	deploymentProject	regex, file, append, encoding, columns		Deployment	Get
53	getJob	Get job information.	plan, job			Jobs	Get
54	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, attribute, columns		Jobs	Get
55	getLabelList	Get a list of labels for a build.	build	number, file, append, encoding, columns		Labels	Get
56	getLatestBuildNumber	Get the number of the last completed build for this plan.	plan			Builds	Get
57	getNotificationList	Get a list of plan notifications.		plan, file, append, encoding		Notifications	Get
58	getPlan	Get plan information.	plan			Plans	Get
59	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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8	1 - plan, 999 - last build results	Plans	Get
60	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
61	getRepository	Get details of a global or plan repository. Sets the repository and repositoryId replacement variables.	repository	plan		Repositories	Get
62	getRepositoryList	Get a list of global or plan repositories with regex filtering on repository name.		plan, regex, file, append, encoding		Repositories	Get
63	getServerInfo	Get information about the Bamboo server.		outputFormat, dateFormat, file, append, encoding	1 - basic, 2 - detail, 3 - state	Info	Get
64	getStage	Get plan stage information.	plan, stage			Stages	Get
65	getStageList	Get a list of stages for a plan with regex filtering on stage name.	plan	regex, file, attribute, columns		Stages	Get
66	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
67	getTaskList	Get a list of tasks for a job with regex filtering on task name.	plan, job	limit, regex, file, columns		Tasks	Get
68	getTaskTypeList	Get a list of task types available with regex filtering on type name and description.	plan, job	limit, regex, file, columns		Tasks	Get
69	getVariableList	Get a list of global or plan variables based on regex filtering of variable names.		plan, regex, file, append, encoding		Variables	Get
70	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
71	moveStage	Change the position of a stage in a plan.	plan, stage			Stages
72	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
73	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
74	pauseServer	Pause the server to prevent builds from starting.				Server	Stop
75	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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Builds
76	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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Builds
77	removeAgent	Remove an agent.	agent	continue		Agents	Delete
78	removeAgentAssignment	Remove an assignment from a specific agent. Use continue to ignore not found error.	agent, assignment	type, continue		Agent Assignments	Delete
79	removeArtifact	Remove an artifact definition from a job.	plan, job, artifact			Artifacts	Delete
80	removeBranch	Removes a branch from a plan. Use --branch @all to remove all branches from a plan.	plan, branch			Branches	Delete
81	removeEnvironment	Experimental. Remove an environment from a deployment project by name or id.	deploymentProject, environment	continue		Deployment	Delete
82	removeJob	Remove a job from a plan.	plan, job	continue		Jobs	Delete
83	removeLabels	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		Labels	Delete
84	removeNotification	Remove a plan notification. Use id of -1 to remove all notifications for a plan.	plan, id			Notifications	Delete
85	removeRepository	Remove global or plan repository. Use @all to remove all repositories.	repository or id	plan, continue		Repositories	Delete
86	removeRequirement	Remove a plan requirement.	plan, job, id			Requirements	Delete
87	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
88	removeTask	Remove a task from a plan job. Use --task @all to remove all tasks.	plan, job, task or id			Tasks	Delete
89	removeTrigger	Remove a trigger from a plan. Use id = -1 to remove all triggers.	plan, id			Triggers	Delete
90	removeVariables	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		Variables	Delete
91	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
92	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
93	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
94	resumeServer	Resume server to allow builds to be started.				Server	Start
95	run	Run actions from a file or standard input.	file or standard input	common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex		Run	Run
96	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
97	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
98	runFromCsv	Run actions generated from a CSV file.	file	common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex		CSV	Run
99	runFromDeploymentProjectList	Experimental. 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
100	runFromEnvironmentList	Experimental. Run actions for each environment defined for a deployment project with regex filtering on environment name. Available replacement variables are environment and environmentId.		regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex		Deployment	Run
101	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
102	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
103	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
104	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
105	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
106	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
107	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
108	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		Options	Update
109	setFavoritePlan	Set the plan as a favorite.	plan			Plans	Update
110	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
111	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
112	unsetFavoritePlan	Remove the plan from the favorite list.	plan			Plans
113	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
114	updateRepository	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		Repositories	Update
115	updateRequirement	Update a plan requirement.	plan, job, id	type, value		Requirements	Update
116	updateStage	Update stage details.	plan, stage	name, description, manual, automatic		Stages	Update
117	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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Tasks	Update
118	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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8		Variables	Update
119	validateLicense	Validates the CLI Connector is enabled and licensed on the server.				Misc	Check
120	verifyBuild	Verify build was successful.	build	number		Builds