Related information for 7.3.0

Quick Tips

To get all help from a command line use: --help
To get help for any action, add --help to the action
- Example: --action getClientInfo --help
More tips

Actions

	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. Use --options autoAgent to automatically create a local agent if it does not already exist.	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	addCapability	Add a shared or agent specific server capability.	type	agent, name, value, field, fields, field1-8, value1-8			Create
7	addComment	Add a comment to a build.	build, comment	number, findReplace, findReplaceRegex, file, encoding		Comments	Create
8	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.	name and userId, file, or accessKeyId	userPassword, sshParaphrase, accessKey, replace			Create
9	addEnvironment	Add an environment to deployment project.	deploymentProject, name	description		Deployment	Create
10	addEnvironmentTask	Add a task to a deployment environment.	deploymentProject, environment, taskKey	description, field, fields, field1-8, value1-8		Deployment	Create
11	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
12	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
13	addJob	Add a job to a stage.	plan, stage, job	name, description, disable		Jobs	Create
14	addLabels	Add a comma separated list of labels to a build.	build, labels	number		Labels	Create
15	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
16	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. 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-8, value1-8		Repositories	Create
17	addRequirement	Add requirement to a plan job.	plan, job, requirement	type, value		Requirements	Create
18	addStage	Add a stage to a plan.	plan, stage	description, manual		Stages	Create
19	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	plan, job, taskKey	disable, final, field, fields, field1-8, value1-8		Tasks	Create
20	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.	plan, type	description, repository, schedule, passingPlans, ipRestriction, field, fields, field1-8, value1-8		Triggers	Create
21	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
22	clonePlan	Clone a plan.	plan, toPlan, name	description, projectName, disable		Plans	Create
23	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
24	createDeploymentProject	Create a deployment project for a plan.	plan, name	description, branch		Deployment	Create
25	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
26	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
27	createProject	Bamboo 6.2 and higher. Create a new project.	project	name, description		Projects	Create
28	deleteDeploymentProject	Delete a deployment project by name or id.	deploymentProject	continue		Deployment	Delete
29	deletePlan	Delete a plan.	plan			Plans	Delete
30	deleteProject	Delete project and all project plans.	project	file		Projects	Delete
31	deployEnvironment	Deploy environment. To promote (re-deploy) an existing version, use --replace.	deploymentProject, environment, version	build, number, replace, wait, timeout		Deployment
32	disableAgent	Disable an agent.	agent			Agents	Update
33	disableJob	Disable a job from running.	plan, job			Jobs	Update
34	disablePlan	Disable a plan from running.	plan			Plans	Update
35	disableProject	Disable all project plans.	project			Projects	Update
36	enableAgent	Enable an agent.	agent			Agents	Update
37	enableJob	Enable a job to run.	plan, job			Jobs	Update
38	enablePlan	Enable a plan to run.	plan			Plans	Update
39	enableProject	Enable all project plans.	project			Projects	Update
40	exportJob	Export a job to CLI source.	plan, job	file, encoding, dateFormat		Jobs	Export
41	exportPlan	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
42	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
43	getAgentList	Get a list of agents based on regex filtering of agent names.		regex, file, append, encoding, columns	1 - basic, 2 - detail	Agents	Get
44	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
45	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
46	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
47	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
48	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
49	getBuild	Get build result.	build	number, expand, file, encoding		Builds	Get
50	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
51	getBuildQueueList	Get a list of builds waiting in the build queue. Subset by project or build.		project, build, file, append, encoding, columns		Builds	Get
52	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, limit, file, append, encoding		Lists	Get
53	getClientInfo	Get information about this client tool.		outputFormat, file, append, encoding	1 - basic, 2 - JVM, 11 - action list, 12 - parameter list	Info	Get
54	getCommentList	Get a list of comments for a build.	build	number, file, append, encoding, columns		Comments	Get
55	getCredentialsList	Get a list of credentials based on regex filtering of credentials name.		regex, limit, file, append, encoding		Lists	Get
56	getDeploymentProject	Get information for a deployment project by name or id.	deploymentProject			Deployment	Get
57	getDeploymentProjectList	Get a list of deployment projects based on regex filtering of project names.		regex, file, append, encoding, columns		Deployment	Get
58	getEnvironment	Get information for an environment from a deployment project by name or id.	deploymentProject, environment	file, encoding		Deployment	Get
59	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
60	getEnvironmentTrigger	Get information for a deployment environment trigger.	deploymentProject, environment, id or name	file, encoding		Deployment	Get
61	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
62	getEnvironmentVariableList	Get a list of deployment environment variables based on regex filtering of variable names.		plan, regex, limit, file, append, encoding		Deployment	Get
63	getJob	Get job information.	plan, job			Jobs	Get
64	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
65	getLabelList	Get a list of labels for a build.	build	number, file, append, encoding, columns		Labels	Get
66	getLatestBuildNumber	Get the number of the last completed build for this plan.	plan			Builds	Get
67	getNotificationList	Get a list of plan notifications.		plan, file, append, encoding		Notifications	Get
68	getPlan	Get plan information.	plan			Plans	Get
69	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. Advanced filtering based on using a repository is also possible using --options "usingRepository=xxx".	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
70	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
71	getRepository	Get details of a global or plan repository. Sets the repository and repositoryId replacement variables.	repository	plan	1 - basic, 999 - all	Repositories	Get
72	getRepositoryList	Get a list of global or plan repositories with regex filtering on repository name.		plan, regex, file, append, encoding		Repositories	Get
73	getServerInfo	Get information about the Bamboo server.		outputFormat, dateFormat, file, append, encoding	1 - basic, 2 - detail, 3 - state	Info	Get
74	getStage	Get plan stage information.	plan, stage			Stages	Get
75	getStageList	Get a list of stages for a plan with regex filtering on stage name.	plan	regex, file, columns		Stages	Get
76	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
77	getTaskList	Get a list of tasks for a job with regex filtering on task name.	plan, job	limit, regex, file, columns		Tasks	Get
78	getTaskTypeList	Get a list of task types available with regex filtering on type name and description.	plan, job	limit, regex, file, columns		Tasks	Get
79	getTrigger	Get information for a plan trigger.	plan, id or name	file, encoding		Triggers	Get
80	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
81	getVariableList	Get a list of global or plan variables based on regex filtering of variable names.		plan, regex, file, append, encoding		Variables	Get
82	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
83	moveStage	Change the position of a stage in a plan.	plan, stage			Stages
84	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
85	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
86	pauseServer	Pause the server to prevent builds from starting.				Server	Stop
87	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
88	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
89	removeAgent	Remove an agent.	agent	continue		Agents	Delete
90	removeAgentAssignment	Remove an assignment from a specific agent. Use continue to ignore not found error.	agent, assignment	type, continue		Agent Assignments	Delete
91	removeArtifact	Remove an artifact definition from a job.	plan, job, artifact			Artifacts	Delete
92	removeBranch	Removes a branch from a plan. Use --branch @all to remove all branches from a plan.	plan, branch			Branches	Delete
93	removeCapability	Remove a shared or agent specific server capability identified by key (label) or unique name.	capability	agent			Delete
94	removeCredentials	Remove credentials by name or id.	credentials	continue			Delete
95	removeEnvironment	Remove an environment from a deployment project by name or id.	deploymentProject, environment	continue		Deployment	Delete
96	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
97	removeEnvironmentVariables	Remove deployment environment variables. Specify the variable names using the field parameters.	deploymentProject, environment	field, fields, field1-8, value1-8		Deployment	Delete
98	removeJob	Remove a job from a plan.	plan, job	continue		Jobs	Delete
99	removeLabels	Remove labels from a build. Labels can be a comma separated list or regex.	build, labels	number, continue		Labels	Delete
100	removeNotification	Remove a plan notification. Use id of -1 to remove all notifications for a plan.	plan, id			Notifications	Delete
101	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, continue		Repositories	Delete
102	removeRequirement	Remove a plan requirement.	plan, job, id			Requirements	Delete
103	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
104	removeTask	Remove a task from a plan job. Use --task @all to remove all tasks.	plan, job, task or id			Tasks	Delete
105	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
106	removeVariables	Remove global or plan variables. Specify the variable names using the field parameters.		plan, field, fields, field1-8, value1-8		Variables	Delete
107	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
108	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
109	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
110	resumeServer	Resume server to allow builds to be started.				Server	Start
111	run	Run actions from a file or standard input.	file or standard input	common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex		Run	Run
112	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
113	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
114	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
115	runFromCsv	Run actions generated from a CSV file.	file	common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex		CSV	Run
116	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
117	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
118	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
119	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
120	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
121	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
122	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
123	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
124	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
125	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
126	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
127	setDependencyOptions	Set child dependencies and other related options.	plan	children, field, fields, field1-8, value1-8		Options	Update
128	setFavoritePlan	Set the plan as a favorite.	plan			Plans	Update
129	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
130	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
131	testRepository	Experimental. Test a global or plan repository configuration to see if a successful connection can be made. Bamboo 5.15 or higher for Bitbucket, GIT, and Mercurial repositories using shared credentials only.	repository	plan		Repositories
132	unsetFavoritePlan	Remove the plan from the favorite list.	plan			Plans
133	updateCredentials	Update existing credentials. Credentials can be renamed by providing a name.	credentials	name, userId, file, accessKeyId, userPassword, sshParaphrase, accessKey			Update
134	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
135	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
136	updateRepository	Update a global or plan repository. Be careful to provide all the parameters needed for the repository definition just like on addRepository. If the credentials parameter is provided the appropriate fields will be added automatically for GIT, Mercurial, and Bitbucket Cloud repositories.	repository or id	plan, name, credentials, field, fields, field1-8, value1-8		Repositories	Update
137	updateRequirement	Update a plan requirement.	plan, job, id	type, value		Requirements	Update
138	updateStage	Update stage details.	plan, stage	name, description, manual, automatic		Stages	Update
139	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
140	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
141	validateLicense	Validates the CLI Connector is enabled and licensed on the server.				Misc	Check
142	verifyBuild	Verify build was successful. Throws exception if not successful.	build	number		Builds

Parameters

	Parameter	Short	Description
1	acceptType		Content type to accept for renderRequest if different than type.
2	accessKey		Secret access key for AWS credentials.
3	accessKeyId		Access key id for AWS credentials.
4	action	a	Requested operation to perform. Valid actions are listed at the end.
5	after		Used in orderRepository to name the repository after which the repository will be positioned. Similarly for moveTask where it represent the name or id of the task. Similarly for moveStage where it represent the name of the stage.
6	afterSql		SQL to run after a successful action. Limited to specific actions at this time.
7	agent		Agent name.
8	append		Append to existing varaibles on updateVariables. For some actions using the file parameter, append will append output to the existing file.
9	artifact		Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory.
10	assignment		Key used to identify a project, plan, job, deployment proejct, or environment to be assigned to a specific agent. This makes the agent dedicated to only perform builds for all assignments. Examples: XXX, XXX-DEF, XXX-DEF-JOB1, Deployment for XXX-DEF, Deployment for XXX-DEF:QA, 77857004-77955436
11	automatic		Indicate that a stage be run automatically.
12	before		Before task name or id.
13	branch		Plan branch name normally. In the context of a repository it can reference a repository branch.
14	build		Build key. Normally used to refer to a specific build (3 or 4 part name). However, it was also an older terminology for a plan and some action continue to accept the older terminology. Example: XXX-DEF or XXX-DEF-1
15	capability		Capability name (label) or key.
16	childPlans		Comma separated list of plan keys that represent child plan dependencies.
17	cleanAfter		Clean working directory after each job completes. Use on setJobOptions.
18	clearFileBeforeAppend		For run actions, this option will automatically clear an existing file on the first append requested.
19	columns		Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns will be ignored.
20	comment		Comment text.
21	common		Common parameter string added to all run actions.
22	connectionTimeout		Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.
23	continue		Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors like not found errors on remove actions.
24	cookies		Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session affinity for actions using REST APIs.
25	copyPattern		Copy pattern for an artifact definition.
26	credentials		Credentials name or id.
27	database		Database name is required for SQL actions.
28	dateFormat		Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is lenient starting with client date format and then some other standard formats based on JSON date format.
29	dateFormat2		Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd.
30	dbCreateTable		Database table needs to be created before adding rows.
31	dbJar		By default, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url reference for the database driver jar. Example /jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar
32	dbPassword		Database user password. Defaults to password.
33	dbTable		Database table name when creating or updating a database from list output.
34	dbTableKeys		Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table.
35	dbUser		Database user name. Defaults to user.
36	debug		Requests detail debug output. Optional for all actions.
37	deploymentProject		Deployment project name or id.
38	description		Description for entity.
39	disable		Disable an entity for those entities like plans, stages, jobs, and tasks.
40	driver		JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.
41	enable		Enable an entity when updating.
42	encoding		Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.
43	environment		Deployment environment name or id.
44	event		Event alias or key. Add-ons provide events identified by key. Example key: com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains
45	excludeDisabled		Filter out entries that are disabled.
46	excludeEnabled		Filter out entries that are enabled.
47	expand		Expanded request information to obtain more detailed data on request.
48	favorite		Subset to favorites. Same as favourite.
49	favourite		Subset to favourites. Same as favorite.
50	field		Use to set construct specific fields or variables using field=value syntax. The first equal sign (=) delineates the field name from it's value. Multiple field parameters can be provided. This provides a more convenient and expandable way to set fields as an alternative to the fields and numbered field parameters. Values are trimmed unless single quoted and single quoted strings will have single quotes removed.
51	field1		Construct specific field or variable name. Value is specified by the value1 parameter.
52	field2		Construct specific field or variable name. Value is specified by the value2 parameter.
53	field3		Construct specific field or variable name. Value is specified by the value3 parameter.
54	field4		Construct specific field or variable name. Value is specified by the value4 parameter.
55	field5		Construct specific field or variable name. Value is specified by the value5 parameter.
56	field6		Construct specific field or variable name. Value is specified by the value6 parameter.
57	field7		Construct specific field or variable name. Value is specified by the value7 parameter.
58	field8		Construct specific field or variable name. Value is specified by the value8 parameter.
59	fields		Use to specify task or repository specific fields or variables and their values. A comma separated list of key:value pairs. Single quote the key:value pair if it contains a comma (,) or line breaks.
60	file	f	Path to file based content or result output. Use - for standard input.
61	final		Make a final task.
62	findReplace		Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped.
63	findReplaceRegex		Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled.
64	help		Prints this help message.
65	host		Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.
66	id		Stage or task id.
67	ipRestriction		Comma separated list of IP addresses to restrict ability to remotely trigger builds.
68	issues		Comma separated list of JIRA issue keys.
69	job		Job key. Example: JOB1
70	labels		Comma or blank separated list of labels.
71	limit		Maximum number of entries to return.
72	list		Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.
73	list2		Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.
74	location		Working directory relative path to a source location for an artifact definition or a destination location for an artifact dependency.
75	manual		Indicate that a stage be run manually.
76	name		Name of entity, like plan name.
77	number		Build number. Defaults to latest.
78	options		Comma separated list of support, experimental, or other client or action specific options.
79	outputFormat		Specify output format for an action.
80	password	p	User password for remote access. This is a required parameter for most actions.
81	plan		Plan key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example: XXX-DEF
82	port		Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.
83	project		Project key. Example: XXX
84	projectName		Project name.
85	propertyFile		Property file with database parameters, field mappings, or client specific information.
86	quiet		Limit some output messages. Optional for all actions.
87	recipient		Recipient value for add notifications. Many recipient types need a primary recipient value. This parameter can be used instead of setting a recipient type specific field and value.
88	recipientType		Recipient type alias or key. Add-ons provide recipient types identified by key. Example key: com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchat
89	reference		Reference to a replacement key value used to remember an action specific value like issue key or similar so it can be referenced later.Each action that allows this parameter will specify what value is being set for the reference replacement key.
90	regex		Regular expression for list filtering and similar. Also for pattern match labelling.
91	replace		Replace existing entity on add, create, or similar actions.
92	repository		Name of a repository. In some cases, a comma separated list of repository names.
93	repositoryKey		Repository key that uniquely identifies the repository type. Example: com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg
94	request		URL fragment for a request.
95	requestParameters		URL request parameters or post data.
96	requestType		Type of a render request like GET or POST
97	requirement		Plan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant.
98	revision		Revision id or tag.
99	schedule		Cron, daily time, or periodic schedule. A cron schedule must be valid cron expresssions and defaults to 0 0 0 ? * *. A daily time is a 24 hour format (HH:mm) value. A periodic schedule is a numeric value in seconds and defaults to 180.
100	server	s	Server URL. Normally the same URL used when using a browser to access the server. This is a required parameter for most actions.
101	shared		For an artifact definition, makes the artifact available for other builds.
102	simulate		Simulate running actions. Log the action that would be taken.
103	special		Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters.
104	sql		SQL select statement used to generate a run script.
105	sshParaphrase		Paraphrase for SSH credentials.
106	stage		Stage name.
107	successfulPlans		Comma separated list of keys that represent plans that must be successful before a build is triggered.
108	task		Task id, name, or description. Task ids are unique, but names and descriptions are not. Name and description lookup is done by finding the first match in the ordered task list.
109	taskKey		Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script.An alias can also be used to make it easier and less error prone. See addTask for the list.
110	timeout		Wait timeout in seconds. Use -1 to wait forever.
111	toPlan		Plan key to be created. Example: XXX-DEF
112	toProject		Project key to clone to.
113	triggeringEnvironment		Deployment environment name or id.
114	type		Capability type like Executable, Custom, or JDK.Also requirement match type with values: exist (default), equal, match. Also, content type for renderRequest and trigger type for addTrigger.
115	url		Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.
116	user	u	User name for remote access.
117	userId		User id for user credentials.
118	userPassword		User password for user credentials.
119	value		Capability value or path. Also, requirement match value.
120	value1		Value corresponding to the field1 parameter name.
121	value2		Value corresponding to the field2 parameter name.
122	value3		Value corresponding to the field3 parameter name.
123	value4		Value corresponding to the field4 parameter name.
124	value5		Value corresponding to the field5 parameter name.
125	value6		Value corresponding to the field6 parameter name.
126	value7		Value corresponding to the field7 parameter name.
127	value8		Value corresponding to the field8 parameter name.
128	verbose		Requests verbose output to help with problem determination. Optional for all actions.
129	version		Version name for deployment.
130	wait		Wait for action to complete.

Parameter Tips

Common parameters

A few common parameters are available that are not specifically listed as optional parameters for each action: help, verbose, debug, quiet, special, dateFormat, dateFormat2, and outputType. Similarly for database related parameters that are optional for all get list actions: url, dbUser, dbPassword, database, driver, dbJar, host, port, dbCreateTable, dbTable, dbTableKeys, afterSql, and propertyFile.

Tips

To get help for a specific action, type the action followed by --help - example: --action getProjectList --help
Use double dash for multi-letter parameters - example: --help
Use single dash for single letter parameters indicated in the Short column in parameter help - example: -v
When parameters are specified, most need a value as indicated by a check in the Value column in parameter help - example: --action addPage
Some parameters are flags (boolean) and must not be followed by a value - example: --verbose
Parameter names are case sensitive, but, action values are not - example: --userid is invalid but --action addpage is equivalent to --action addPage
- An incorrect case parameter will result in an unknown parameter error and show action help with correctly cased parameter (9.8 or higher)
Some parameters become required once a specific action is chosen. This is indicated in the action help text as required.
Some parameters have both short (one letter) and long (more than one letter) parameter names - example: -a or --action are the same and cannot both be specified
Some parameters have default values, if so, they are indicated in the help text
Values that contain blanks or some special characters (platform specific) must be enclosed by double quotes - example: --title "this is my title"
Quoting rules in commands can vary by terminal environment:
- Windows command terminals or run action scripts for all platforms: embedded double quotes within a double quoted string must be escaped by doubling the double quote - example: –common "-a addComment --comment ""This is an example of a double quoted string inside a double quote"" "
- Linux and Mac/OSX command terminals require standard Linux style escaping: embedded double quotes within a double quoted string can be escaped with a \ - example: –common " -a addComment --comment \"This is an example of a double quoted string inside a double quote\" "
- Run CLI Actions usage: embedded double quotes within a double quoted string can be escaped by doubling the double quote (first example above)
- A single quote sometimes can used in place of a double quotes on some command terminal environments - example: –common '-a addComment --comment "This is an example of a double quoted string inside a double quote" '
Some parameters allow entry of a comma separated list of values, values containing a comma must be enclosed in single quotes - example: --custom "'first:a,b,c', second:x". Embedded single quotes within a quoted string must be doubled
Some text fields support the automatic conversion of " \n " (blanks are significant) to be replaced with a new line character - example: --description "A multi-line text field: \n # line 1 \n # line 2"

Special parameter

Some special characters are difficult to deal with or make action text very complicated. This is because they have special meaning in either the OS command terminal handling, the tool's command line parsing, or the tool's use of separators (like comma or colon separated lists). As a convenience to avoid some of these nasty situations, a special parameter was implemented to allow alternate characters to be used instead of (or in addition to) the problematic characters within parameter values. The choice of what special characters to use depends on the content so that you do not have conflicts with intended content. The special parameter works by the user providing a order specific alternate character. The alternative character is replaced with the real character after all other parsing occurs. It is implemented for many action parameters that are problematic in this area. Not all situations are covered, but, that will improve as other use cases are identified.

Position	Character	Character name	Suggested alternate	Usage
1	,	comma		Some parameters use comma separated lists.
2	:	colon	#	Some parameters use colon separated values.
3	@	at sign		Replacement variables syntax: @...@.
4	'	single quote		Used in separated lists to cover cases where content contains separator.
5	"	double quote	~	Parameters containing blanks.
6	^	caret		Substitution double quote indicator: ^^...^^. See ACLI-673 for details.

A blank in any position is ignored (no alternate provided).

Example: –special " #  ~" provides alternates for colon and double quote.

         --common "--findReplace ~something to find containing a : (colon)#replacement~"

Character Set

User and password values should be in the ISO-8859-1 character set. Also avoid characters that require escaping on your OS command terminal. Non standard characters will result in an authorization error similar to: User is not authorized to perform the request.

Bamboo Command Line Interface (CLI)

Reference - 7.3.0

On this page

Related information for 7.3.0

Quick Tips

Actions

Parameters

Parameter Tips