...
Actions
| P | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
csv
| wiki | |||||||||||
| sortColumn | 1 | |||||||||||
| autoNumber | true | |||||||||||
| sortIcon | false |
Description | Required parameters | Optional parameters | Output formats | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 |
| Comments | Add a comment to a build. |
| ||||||||
| 2 |
| Labels | Add a comma separated list of labels to a build. |
| ||||||||
| 3 |
| Repositories | Add a source repository to a build plan. | fields, field1, value1, field2, value2, field3, value3, field4, value4 |
| |||||||
| 4 |
|
| Beta. Add requirement to a plan job. |
| ||||||||
| 5 |
| Tasks | Add a task to a build plan job. | fields, field1, value1, field2, value2, field3, value3, field4, value4 |
| |||||||
| 6 |
| Plans | Clone a build plan. |
| ||||||||
| 7 |
| Projects | Clone each build plan in a project to another project. |
|
| |||||||
| 8 |
| Plans | Delete a build plan. |
|
| |||||||
| 9 |
| Projects | Delete project and all project plans. |
| ||||||||
| 10 |
| Plans | Disable a build plan from running. |
|
| |||||||
| 11 |
| Projects | Disable all project plans. |
|
| |||||||
| 12 |
| Plans | Enable a build plan to run. |
|
| |||||||
| 13 |
| Projects | Enable all project plans. |
|
| |||||||
| 14 |
| Artifacts | Download a copy of a build artifact into a file. |
| ||||||||
| 15 |
| Lists | Get a list of builds. |
|
| |||||||
| 16 |
| Lists | Get a list of builds waiting in the build queue. Subset by project or build. |
|
| |||||||
| 17 |
| Builds | Get build result. |
| ||||||||
| 18 |
| Info | Get information about the this client tool. |
|
|
| ||||||
| 19 |
| Lists | Get a list of comments for a build. |
| ||||||||
| 20 |
| Lists | Get a list of labels for a build. |
| ||||||||
| 21 |
| Builds | Get the number of the last completed build. |
|
| |||||||
| 22 |
| Lists | Get a list of build plans. |
|
| |||||||
| 23 |
| Plans | Get build plan information. |
|
| |||||||
| 24 |
| Lists | Get a list of projects in csv format. Projects are select based on regex filtering on project key or name. Legacy list support is deprecated and will be removed. |
|
| |||||||
| 25 |
| Info | Get information about the Bamboo server. |
| 1 - basic | |||||||
| 26 |
| 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. | revision, wait, continue, timeout, fields, field1, value1, field2, value2, field3, value3, field4, value4 |
| |||||||
| 27 |
| Labels | Delete labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided |
| ||||||||
| 28 |
| Repositories | Remove a source repository from a build plan. |
|
| |||||||
| 29 |
|
| Beta. Remove a plan requirement. |
|
| |||||||
| 30 |
| Tasks | Remove a task from a build plan job. |
|
| |||||||
| 31 |
| Render | Render url based request. The response data modified by findReplace processing is returned. | requestParameters, requestType, type, acceptType, build, file, encoding, findReplace, findReplaceRegex |
| |||||||
| 32 |
| Run | Run actions generated from a CSV file. | common, propertyFile, continue, quiet, simulate, encoding, findReplace, findReplaceRegex |
| |||||||
| 33 |
| 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, encoding, findReplace, findReplaceRegex |
| |||||||
| 34 |
| 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, file, encoding, findReplace, findReplaceRegex |
| ||||||
| 35 |
| 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, encoding, findReplace, findReplaceRegex |
| |||||||
| 36 |
| Run | Run actions from a file or standard input. | file or standard input | common, continue, simulate, encoding, findReplace, findReplaceRegex |
| ||||||
| 37 |
| Repositories | Update a source repository for a build plan. | fields, field1, value1, field2, value2, field3, value3, field4, value4 |
| |||||||
| 38 |
|
| Beta. Update a plan requirement. |
| ||||||||
| 39 |
| Tasks | Update a task in a build plan job. | fields, field1, value1, field2, value2, field3, value3, field4, value4 |
| |||||||
| 40 |
|
| Validates the CLI Connector is enabled and licensed on the server. |
|
|
| ||||||
| 41 |
| Builds | Verify build was successful. |
|
Parameter Tips
| Include Page | ||||
|---|---|---|---|---|
|
Parameters
csvParameter |
|---|
...
Short |
|---|
...
Value |
|---|
...
Description |
|---|
| 1 |
...
acceptType
|
| | Content type to accept for renderRequest if different than type. | |||||||
| 2 | action
| a | |
| ||||||
| 3 | api
|
| | API version. Some requests produce different results based on the api version used. (default: latest) | ||||||
| 4 | artifact
|
| | Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory. | ||||||
| 5 | attribute
|
| | Attribute to list. | ||||||
| 6 | build
|
| | Build key. Optionally, for some actions, may contain build number. Example: XXX-DEF or XXX-DEF-1 | ||||||
| 7 | 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. | ||||||
| 8 | comment
|
| | Comment for an build. | ||||||
| 9 | common
|
| | Common parameter string added to all run actions. | ||||||
| 10 | connectionTimeout
|
| | Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite. | ||||||
| 11 | continue
|
| | Continue processing even after errors are encountered. | ||||||
| 12 | 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. | ||||||
| 13 | database
|
| | Database name is required for SQL actions. | ||||||
| 14 | dateFormat
|
| | Format string for date in Java SimpleDateFormat, default is client date format. | ||||||
| 15 | dbPassword
|
| | Database user password. Defaults to password. | ||||||
| 16 | dbUser
|
| | Database user name. Defaults to user. | ||||||
| 17 | debug
|
| | Requests detail debug output. Optional for all actions. | ||||||
| 18 | description
|
| | Build plan description. | ||||||
| 19 | disable
|
| | Disable plan after it is created. | ||||||
| 20 | driver
|
| | JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions. | ||||||
| 21 | encoding
|
| | Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform. | ||||||
| 22 | expand
|
| | Expanded request information to obtain more detailed data on request. | ||||||
| 23 | favourite
|
| | Subset to favourites. | ||||||
| 24 | field1
|
| | Task specific field or build variable name. Complements the fields parameter. Value is specified by the value1 parameter. | ||||||
| 25 | field2
|
| | Task specific field or build variable name. Complements the fields parameter. Value is specified by the value2 parameter. | ||||||
| 26 | field3
|
| | Task specific field or build variable name. Complements the fields parameter. Value is specified by the value3 parameter. | ||||||
| 27 | field4
|
| | Task specific field or build variable name. Complements the fields parameter. Value is specified by the value4 parameter. | ||||||
| 28 | fields
|
| | Use to specify task specific fields or build 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. | ||||||
| 29 | file
| f | | Path to file based content or result output. Use - for standard input. | ||||||
| 30 | findReplace
|
| | Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled. | ||||||
| 31 | 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. | ||||||
| 32 | help
|
| | Prints this help message. | ||||||
| 33 | host
|
| | Database host server for SQL actions. Not used if url is provided. (default: localhost) | ||||||
| 34 | id
|
| | Task id. | ||||||
| 35 | issues
|
| | Comma separated list of JIRA issue keys. | ||||||
| 36 | job
|
| | Job key. Example: JOB1 | ||||||
| 37 | labels
|
| | Comma or blank separated list of labels. | ||||||
| 38 | limit
|
| | Maximum number of entries to return. (default: 2147483647) | ||||||
| 39 | list
|
| | Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled. | ||||||
| 40 | name
|
| | Build plan name. | ||||||
| 41 | number
|
| | Build number. Defaults to latest. (default: 0) | ||||||
| 42 | outputFormat
|
| | Specify output format for an action. (default: 1) | ||||||
| 43 | password
| p | | User password for remote access. | ||||||
| 44 | plan
|
| | Build plan key containing the project key. Example: XXX-DEF | ||||||
| 45 | port
|
| | Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided. | ||||||
| 46 | project
|
| | Project key. Example: XXX | ||||||
| 47 | projectName
|
| | Project name. | ||||||
| 48 | propertyFile
|
| | Property file with mapping information. | ||||||
| 49 | quiet
|
| | Limit some output messages. Optional for all actions. | ||||||
| 50 | regex
|
| | Regular expression for including matching content. | ||||||
| 51 | repositoryKey
|
| | Repository key. Example: com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg |
...
| 52 | request
|
| | URL fragment for a request. | ||||||
| 53 | requestParameters
|
| | URL request parameters | ||||||
| 54 | requestType
|
| | Type of a render request like GET or POST (default: GET) | ||||||
| 55 | requirement
|
| | Plan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant. |
...
| 56 | revision
|
| | Revision id or tag. | ||||||
| 57 | searchLabels
|
| | Comma or blank separated list of labels used for search. | ||||||
| 58 | server
| s | | Server URL. | ||||||
| 59 | service
|
| | Service address extension. (default: /rest/api) | ||||||
| 60 | simulate
|
| | Simulate running actions. Log the action that would be taken. | ||||||
| 61 | special
|
| | Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters. | ||||||
| 62 | sql
|
| | SQL select statement used to generate a run script. | ||||||
| 63 | stage
|
| | Stage name. | ||||||
| 64 | taskKey
|
| | Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script |
...
| 65 | timeout
|
| | Wait timeout in seconds. Use -1 to wait forever. (default: -1) | ||||||
| 66 | toPlan
|
| | Build plan key to be created. Example: XXX-DEF | ||||||
| 67 | toProject
|
| | Project key to clone to. | ||||||
| 68 | type
|
| | Requirement match type. Values: exist, equal, match. Also, content type for renderRequest. (default: exist) | ||||||
| 69 | url
|
| | Action specific setting. Example: Database access url for SQL actions. Optional when host is provided. | ||||||
| 70 | user
| u | | User name for remote access. (default: automation) | ||||||
| 71 | value
|
| | Requirement match value. | ||||||
| 72 | value1
|
| | Value corresponding to the field1 parameter name. | ||||||
| 73 | value2
|
| | Value corresponding to the field2 parameter name. | ||||||
| 74 | value3
|
| | Value corresponding to the field3 parameter name. | ||||||
| 75 | value4
|
| | Value corresponding to the field4 parameter name. | ||||||
| 76 | verbose
| v | | Requests verbose output to help with problem determination. Optional for all actions. | ||||||
| 77 | wait
|
| | Wait for action to complete. |
| P |
|---|