...
Actions
P | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
csv
| ||||||||||||
|
Category | Description | Required parameters | Optional parameters | Output formats | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
1 |
| Agent Assignments | Assign a project, plan, or job to a specific agent. This makes the agent is dedicated to only perform builds for all assignments. Use continue to ignore already exists error. |
| ||||||||
2 |
| Agents | Add a local agent. |
| ||||||||
3 |
| Artifacts | Add an artifact dependency a job. Artifact must be a shared artifact from another job. |
|
| |||||||
4 |
| Artifacts | Add an artifact definition to a job. Server instances only. |
| ||||||||
5 |
| Comments | Add a comment to a build. |
| ||||||||
6 |
| Jobs | Add a job to a stage. |
| ||||||||
7 |
| Labels | Add a comma separated list of labels to a build. |
| ||||||||
8 |
| Repositories | Add a global or plan repository. For a plan repository, you can reference a linked (global) repository. Otherwise a valid repository key or alias is required. Valid aliases are: BITBUCKET, CVS, GIT, GITHUB, MERCURIAL, PERFORCE, STASH, SUBVERSION | repository or name | plan, repositoryKey, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6 |
| ||||||
9 |
| Requirements | Add requirement to a plan job. |
| ||||||||
10 |
| Stages | Add a stage to a plan. |
| ||||||||
11 |
| Tasks | Add a task to a plan job. A valid task key or alias is required. Valid aliases are: ANT, CHECKOUT, CLI_BAMBOO, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_HIPCHAT, CLI_JIRA, CLI_STASH, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCRIPT | disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6 |
| |||||||
12 |
| Triggers | Add a trigger to a plan. Valid types are: polling, remote, scheduled. One or more repositories can be specified for triggers based on repositories. See the schedule parameter for accepted values. Server instances only. |
| ||||||||
13 |
| Variables | Add global or plan variables. |
| plan, replace fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6 |
| ||||||
14 |
| Plans | Clone a plan. |
| ||||||||
15 |
| Projects | Clone each plan in a project to another project. If toProject is not provided, the plans will be cloned to the same project. If the toProject does not exist, it will be created with name provided by projectName. |
|
| |||||||
16 |
| Plans | Create a new plan. Provide a 2-part plan key where the first part is the project key. If the project key does not exist, it will be created with the provided project name. Server instances only. |
| ||||||||
17 |
| Plans | Delete a plan. |
|
| |||||||
18 |
| Projects | Delete project and all project plans. |
| ||||||||
19 |
| Agents | Disable an agent. |
|
| |||||||
20 |
| Jobs | Disable a job from running. |
|
| |||||||
21 |
| Plans | Disable a plan from running. |
|
| |||||||
22 |
| Projects | Disable all project plans. |
|
| |||||||
23 |
| Agents | Enable an agent. |
|
| |||||||
24 |
| Jobs | Enable a job to run. |
|
| |||||||
25 |
| Plans | Enable a plan to run. |
|
| |||||||
26 |
| Projects | Enable all project plans. |
|
| |||||||
27 |
| Lists | Get a list of agents based on regex filtering of agent names.. |
| 1 - basic | |||||||
28 |
| Artifacts | Download a copy of a build artifact into a file. |
| ||||||||
29 |
| Lists | Get a list of builds. Default limit is 25. | limit, favorite, labels, issues, columns, file, append, encoding | 1 - basic | |||||||
30 |
| Lists | Get a list of builds waiting in the build queue. Subset by project or build. |
|
| |||||||
31 |
| Builds | Get build result. |
| ||||||||
32 |
| Info | Get information about the this client tool. |
| 1 - basic | |||||||
33 |
| Lists | Get a list of comments for a build. |
| ||||||||
34 |
| Lists | Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired. |
| ||||||||
35 |
| Lists | Get a list of labels for a build. |
| ||||||||
36 |
| Builds | Get the number of the last completed build for this plan. |
|
| |||||||
37 |
| Lists | Get a list of plans for a project with regex filtering on plan key or name. Use @all for project to get a list of plans across all projects. |
| ||||||||
38 |
| Plans | Get plan information. |
|
| |||||||
39 |
| Lists | Get a list of projects. Projects are selected based on regex filtering on project key or name. Legacy list support is deprecated and will be removed in the near future. |
|
| |||||||
40 |
| Lists | Get a list of global or plan repositories with regex filtering on repository name. |
|
| |||||||
41 |
| Repositories | Get details of a global or plan repository. Sets the repository and repositoryId replacement variables. |
| ||||||||
42 |
| Info | Get information about the Bamboo server. |
| 1 - basic | |||||||
43 |
| Lists | Get a list of stages for a plan with regex filtering on stage name. |
| ||||||||
44 |
| Lists | Get a list of global or plan variables based on regex filtering of variable names. |
|
| |||||||
45 |
| Builds | Queue a build to run. If wait is specified, the action will not complete until the queued build completes or the timeout period elapses. The action will fail if the build fails unless continue parameter is used to ignore a failed result. A specific revision can be built if the revision parameter is specified. Plan variables can be set using the field and value parameters. | revision, wait, continue, timeout, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6 |
| |||||||
46 |
| Agent Assignments | Remove an assignment from a specific agent. Use continue to ignore not found error. |
| ||||||||
47 |
| Agents | Remove an agent. |
|
| |||||||
48 |
| Artifacts | Remove an artifact definition from a job. Server instances only. |
|
| |||||||
49 |
| Labels | Remove labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided |
| ||||||||
50 |
| Repositories | Remove global or plan repository. Use @all to remove all repositories. | repository or id |
| |||||||
51 |
| Requirements | Remove a plan requirement. |
|
| |||||||
52 |
| Stages | Remove a stage from a plan. Use id = -1 to remove all stages. Use continue to ignore not found errors. |
| ||||||||
53 |
| Tasks | Remove a task from a plan job. Use id = -1 to remove all tasks. |
|
| |||||||
54 |
| Triggers | Remove a trigger from a plan. Use id = -1 to remove all triggers. Server instances only. |
|
| |||||||
55 |
| Variables | Remove global or plan variables |
| plan, fields, field1, field2, field3, field4, field5, field6 |
| ||||||
56 |
| Render | Render url based request. The response data modified by findReplace processing is returned. | requestParameters, requestType, type, acceptType, build, file, encoding, findReplace, findReplaceRegex |
| |||||||
57 |
| Run | Run actions for each agent with regex filtering on agent name. Available replacement variables are agent and agentId. |
| regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
| ||||||
58 |
| Run | Run actions generated from a CSV file. | common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
| |||||||
59 |
| Run | Run actions for each job with regex filtering on job key or name. Restrict to a specific stage or leave stage blank to get jobs across all stages. Available replacement variables are project, projectName, plan, planName, stageId, stageName, job, and jobName. | stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
| |||||||
60 |
| Run | Run actions for each entry in a list. When file is provided, each action in the file augmented by the common parameter will be run for each entry. Otherwise, just the action specified by the common parameter will be run. Available replacement variable is entry. | file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
| |||||||
61 |
| Run | Run actions for each plan with regex filtering on plan key or name. Use @all for project to get a list of plans across all projects. Available replacement variables are project, projectName, plan, and planName. | favorite, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
| |||||||
62 |
| Run | Run actions for each project with regex filtering on project key or name. Available replacement variables are project and projectName. |
| regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
| ||||||
63 |
| Run | Run actions for each repository with regex filtering on repository name. Available replacement variables are repository and repositoryId. |
| plan, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
| ||||||
64 |
| Run | Run actions generated by SQL provided by the sql parameter, a file, or standard input | common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
| |||||||
65 |
| Run | Run actions for each stage with regex filtering on stage name. Available replacement variables are project, projectName, plan, planName, stageId, and stageName. | stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
| |||||||
66 |
| Run | Run actions from a file or standard input. | file or standard input | common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
| ||||||
67 |
| Repositories | Update a global or plan repository. | repository or id | plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6 |
| ||||||
68 |
| Requirements | Update a plan requirement. |
| ||||||||
69 |
| Tasks | Update a task in a plan job. You must provide the same parameters as if you were creating the task. | enable, disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6 |
| |||||||
70 |
| Variables | Update existing global or plan variables |
| plan fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6 |
| ||||||
71 |
|
| Validates the CLI Connector is enabled and licensed on the server. |
|
|
| ||||||
72 |
| Builds | Verify build was successful. |
|
Parameter Tips
Include Page | ||||
---|---|---|---|---|
|
Parameters
output | wiki |
---|---|
sortColumn | 1 |
columnTypes | S,S,E,S |
autoNumber | true |
sortIcon | false |
|
Parameters
Parameter | Short | Value | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
1 | acceptType
|
|
| Content type to accept for renderRequest if different than type. | ||||||
2 | action
| a |
|
| ||||||
3 | agent
|
|
| Agent name. | ||||||
4 | api
|
|
| API version. Some requests produce different results based on the api version used. (default: latest) | ||||||
5 | append
|
|
| For some actions using the file parameter, append will append output to the existing file. | ||||||
6 | artifact
|
|
| Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory. | ||||||
7 | assignment
|
|
| Key used to identify a project, plan, or job to be assigned to a specific agent. This makes the agent dedicated to only perform builds for all assignments. Example: XXX, XXX-DEF, XXX-DEF-JOB1 | ||||||
8 | attribute
|
|
| Attribute to list. | ||||||
9 | build
|
|
| Build key. Normally used to refer to a specific build (3 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 | ||||||
10 | clearFileBeforeAppend
|
|
| For run actions, this option will automatically clear an existing file on the first append requested. | ||||||
11 | 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. | ||||||
12 | comment
|
|
| Comment for an build. | ||||||
13 | common
|
|
| Common parameter string added to all run actions. | ||||||
14 | connectionTimeout
|
|
| Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite. | ||||||
15 | 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. | ||||||
16 | 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. | ||||||
17 | copyPattern
|
|
| Copy pattern for an artifact definition. | ||||||
18 | database
|
|
| Database name is required for SQL actions. | ||||||
19 | dateFormat
|
|
| Format string for date in Java SimpleDateFormat, default is client date format. | ||||||
20 | dbPassword
|
|
| Database user password. Defaults to password. | ||||||
21 | dbUser
|
|
| Database user name. Defaults to user. | ||||||
22 | debug
|
|
| Requests detail debug output. Optional for all actions. | ||||||
23 | description
|
|
| Description for entity. | ||||||
24 | disable
|
|
| Disable an entity for those entities like plans, stages, jobs, and tasks. | ||||||
25 | driver
|
|
| JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions. | ||||||
26 | enable
|
|
| Enable an entity when updating. | ||||||
27 | encoding
|
|
| Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform. | ||||||
28 | expand
|
|
| Expanded request information to obtain more detailed data on request. | ||||||
29 | favorite
|
|
| Subset to favorites. Same as favourite. | ||||||
30 | favourite
|
|
| Subset to favourites. Same as favorite. | ||||||
31 | field1
|
|
| Task or repository specific field or variable name. Value is specified by the value1 parameter. | ||||||
32 | field2
|
|
| Task or repository specific field or variable name. Value is specified by the value2 parameter. | ||||||
33 | field3
|
|
| Task or repository specific field or variable name. Value is specified by the value3 parameter. | ||||||
34 | field4
|
|
| Task or repository specific field or variable name. Value is specified by the value4 parameter. | ||||||
35 | field5
|
|
| Task or repository specific field or variable name. Value is specified by the value5 parameter. | ||||||
36 | field6
|
|
| Task or repository specific field or variable name. Value is specified by the value6 parameter. | ||||||
37 | 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. | ||||||
38 | file
| f |
| Path to file based content or result output. Use - for standard input. | ||||||
39 | findReplace
|
|
| Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled. | ||||||
40 | 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. | ||||||
41 | help
|
|
| Prints this help message. | ||||||
42 | host
|
|
| Database host server for SQL actions. Not used if url is provided. (default: localhost) | ||||||
43 | id
|
|
| Stage or task id. | ||||||
44 | ipRestriction
|
|
| Comma separated list of IP addresses to restrict ability to remotely trigger builds. | ||||||
45 | issues
|
|
| Comma separated list of JIRA issue keys. | ||||||
46 | job
|
|
| Job key. Example: JOB1 | ||||||
47 | labels
|
|
| Comma or blank separated list of labels. | ||||||
48 | limit
|
|
| Maximum number of entries to return. (default: 2147483647) | ||||||
49 | list
|
|
| Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled. | ||||||
50 | location
|
|
| Working directory relative path to a source location for an artifact definition or a destination location for an artifact dependency. | ||||||
51 | manual
|
|
| Indicate that a stage be run manually. | ||||||
52 | name
|
|
| Name of entity, like plan name. | ||||||
53 | number
|
|
| Build number. Defaults to latest. (default: 0) | ||||||
54 | outputFormat
|
|
| Specify output format for an action. (default: 1) | ||||||
55 | password
| p |
| User password for remote access. | ||||||
56 | plan
|
|
| Plan key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example: XXX-DEF | ||||||
57 | port
|
|
| Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided. | ||||||
58 | project
|
|
| Project key. Example: XXX | ||||||
59 | projectName
|
|
| Project name. | ||||||
60 | propertyFile
|
|
| Property file with mapping information. | ||||||
61 | quiet
|
|
| Limit some output messages. Optional for all actions. | ||||||
62 | regex
|
|
| Regular expression for including matching content. | ||||||
63 | replace
|
|
| Replace existing entity. | ||||||
64 | repository
|
|
| Name of a repository. In some cases, a comma separated list of repository names. | ||||||
65 | repositoryKey
|
|
| Repository key. Example: com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg |
...
66 | request
|
|
| URL fragment for a request. | ||||||
67 | requestParameters
|
|
| URL request parameters | ||||||
68 | requestType
|
|
| Type of a render request like GET or POST (default: GET) | ||||||
69 | requirement
|
|
| Plan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant. |
...
70 | revision
|
|
| Revision id or tag. | ||||||
71 | 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. | ||||||
72 | searchLabels
|
|
| Comma or blank separated list of labels used for search. | ||||||
73 | server
| s |
| Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser. | ||||||
74 | service
|
|
| Service address extension. (default: /rest/api) | ||||||
75 | shared
|
|
| For an artifact definition, makes the artifact available for other builds. | ||||||
76 | simulate
|
|
| Simulate running actions. Log the action that would be taken. | ||||||
77 | special
|
|
| Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters. | ||||||
78 | sql
|
|
| SQL select statement used to generate a run script. | ||||||
79 | stage
|
|
| Stage name. | ||||||
80 | taskKey
|
|
| Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script |
...
81 | timeout
|
|
| Wait timeout in seconds. Use -1 to wait forever. (default: -1) | ||||||
82 | toPlan
|
|
| Plan key to be created. Example: XXX-DEF | ||||||
83 | toProject
|
|
| Project key to clone to. | ||||||
84 | type
|
|
| Requirement match type. Values: exist, equal, match. Also, content type for renderRequest. (default: exist) | ||||||
85 | url
|
|
| Action specific setting. Example: Database access url for SQL actions. Optional when host is provided. | ||||||
86 | user
| u |
| User name for remote access. (default: automation) | ||||||
87 | value
|
|
| Requirement match value. | ||||||
88 | value1
|
|
| Value corresponding to the field1 parameter name. | ||||||
89 | value2
|
|
| Value corresponding to the field2 parameter name. | ||||||
90 | value3
|
|
| Value corresponding to the field3 parameter name. | ||||||
91 | value4
|
|
| Value corresponding to the field4 parameter name. | ||||||
92 | value5
|
|
| Value corresponding to the field5 parameter name. | ||||||
93 | value6
|
|
| Value corresponding to the field6 parameter name. | ||||||
94 | verbose
| v |
| Requests verbose output to help with problem determination. Optional for all actions. | ||||||
95 | wait
|
|
| Wait for action to complete. |
P |
---|