Actions - 7.1.0
|
Action |
Description |
Required Parameters |
Optional Parameters |
Output Formats |
Category |
Type |
---|---|---|---|---|---|---|---|
1 |
Add a local agent. |
|
Agents |
Create |
|||
2 |
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 Assignments |
Create |
|||
3 |
Add an artifact definition to a job. |
|
Artifacts |
Create |
|||
4 |
Add an artifact dependency to a job. Artifact must be a shared artifact from another job. |
|
|
Artifacts |
Create |
||
5 |
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. |
|
Branches |
Create |
|||
6 |
Add a comment to a build. |
|
Comments |
Create |
|||
7 |
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. |
userId or file or accessKeyId |
|
|
Create |
||
8 |
Add an environment to deployment project. |
|
Deployment |
Create |
|||
9 |
Add a task to a deployment environment. |
description, field, fields, field1-8, value1-8 |
|
Deployment |
Create |
||
10 |
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. |
repository, branch, schedule, ipRestriction, triggeringEnvironment, field, fields, field1-8, value1-8 |
|
Deployment |
Create |
||
11 |
Add deployment environment variables. Use the field parameters for the variable name and the corresponding value parameters for the variable values. |
|
Deployment |
Create |
|||
12 |
Add a job to a stage. |
|
Jobs |
Create |
|||
13 |
Add a comma separated list of labels to a build. |
|
Labels |
Create |
|||
14 |
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. |
|
Notifications |
Create |
|||
15 |
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, replace, field, fields, field1-8, value1-8 |
|
Repositories |
Create |
|
16 |
Add requirement to a plan job. |
|
Requirements |
Create |
|||
17 |
Add a stage to a plan. |
|
Stages |
Create |
|||
18 |
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 |
|
Tasks |
Create |
|||
19 |
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. |
description, repository, schedule, passingPlans, ipRestriction, field, fields, field1-8, value1-8 |
|
Triggers |
Create |
||
20 |
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. |
|
|
Variables |
Create |
||
21 |
Clone a plan. |
|
Plans |
Create |
|||
22 |
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. |
|
|
Projects |
Create |
||
23 |
Create a deployment project for a plan. |
|
Deployment |
Create |
|||
24 |
Same as createPlan when plan does not exist. However, it will update an existing plan's name and description. |
|
Plans |
Create |
|||
25 |
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. |
|
Plans |
Create |
|||
26 |
Bamboo 6.2 and higher. Create a new project. |
|
Projects |
Create |
|||
27 |
Delete a deployment project by name or id. |
|
Deployment |
Delete |
|||
28 |
Delete a plan. |
|
|
Plans |
Delete |
||
29 |
Delete project and all project plans. |
|
Projects |
Delete |
|||
30 |
Deploy environment. To promote (re-deploy) an existing version, use --replace. |
|
Deployment |
|
|||
31 |
Disable an agent. |
|
|
Agents |
Update |
||
32 |
Disable a job from running. |
|
|
Jobs |
Update |
||
33 |
Disable a plan from running. |
|
|
Plans |
Update |
||
34 |
Disable all project plans. |
|
|
Projects |
Update |
||
35 |
Enable an agent. |
|
|
Agents |
Update |
||
36 |
Enable a job to run. |
|
|
Jobs |
Update |
||
37 |
Enable a plan to run. |
|
|
Plans |
Update |
||
38 |
Enable all project plans. |
|
|
Projects |
Update |
||
39 |
Export a job to CLI source. |
|
Jobs |
Export |
|||
40 |
Export a plan to source that can be used for plan creation. Valid export types are CLI, JAVA (Bamboo 6.0 and higher). |
|
Plans |
Export |
|||
41 |
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 Assignments |
Get |
||
42 |
Get a list of agents based on regex filtering of agent names. |
|
1 - basic, 2 - detail |
Agents |
Get |
||
43 |
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. |
job, number, replace, encoding |
Artifacts |
Get |
||
44 |
Get a list of artifact definitions for a plan with regex filtering on artifact name. |
|
Artifacts |
Get |
|||
45 |
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. |
|
Artifacts |
Get |
|||
46 |
Get information for a branch to a plan. Branch can be either the short or long name of the branch. |
|
Branches |
Get |
|||
47 |
Get a list of branches for a plan with regex filtering on branch name or short name. |
|
Branches |
Get |
|||
48 |
Get build result. |
|
Builds |
Get |
|||
49 |
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. |
labels, issues, limit, columns, file, append, encoding, field, fields, field1-8, value1-8 |
1 - basic, 999 - test information and other details |
Builds |
Get |
||
50 |
Get a list of builds waiting in the build queue. Subset by project or build. |
|
|
Builds |
Get |
||
51 |
Get information about this client tool. |
|
1 - basic, 2 - JVM, 11 - action list, 12 - parameter list |
Info |
Get |
||
52 |
Get a list of comments for a build. |
|
Comments |
Get |
|||
53 |
Get a list of credentials based on regex filtering of credentials name. |
|
|
Lists |
Get |
||
54 |
Get information for a deployment project by name or id. |
|
|
Deployment |
Get |
||
55 |
Get a list of deployment projects based on regex filtering of project names. |
|
|
Deployment |
Get |
||
56 |
Get information for an environment from a deployment project by name or id. |
|
Deployment |
Get |
|||
57 |
Get a list of environments for a deployment project based on regex filtering of environment names. |
|
Deployment |
Get |
|||
58 |
Get information for a deployment environment trigger. |
|
Deployment |
Get |
|||
59 |
Get a list of environment triggers for a deployment environment based on regex filtering of trigger names or descriptions. |
|
Deployment |
Get |
|||
60 |
Get a list of deployment environment variables based on regex filtering of variable names. |
|
|
Deployment |
Get |
||
61 |
Get job information. |
|
|
Jobs |
Get |
||
62 |
Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired. |
|
Jobs |
Get |
|||
63 |
Get a list of labels for a build. |
|
Labels |
Get |
|||
64 |
Get the number of the last completed build for this plan. |
|
|
Builds |
Get |
||
65 |
Get a list of plan notifications. |
|
|
Notifications |
Get |
||
66 |
Get plan information. |
|
|
Plans |
Get |
||
67 |
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. |
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 |
||
68 |
Get a list of projects. Projects are selected based on regex filtering on project key or name. |
|
|
Projects |
Get |
||
69 |
Get details of a global or plan repository. Sets the repository and repositoryId replacement variables. |
1 - basic, 999 - all |
Repositories |
Get |
|||
70 |
Get a list of global or plan repositories with regex filtering on repository name. |
|
|
Repositories |
Get |
||
71 |
Get information about the Bamboo server. |
|
1 - basic, 2 - detail, 3 - state |
Info |
Get |
||
72 |
Get plan stage information. |
|
|
Stages |
Get |
||
73 |
Get a list of stages for a plan with regex filtering on stage name. |
|
Stages |
Get |
|||
74 |
Get detail information on a task from a plan job. Use --task @all to give detail information on all tasks for a job. |
|
|
Tasks |
Get |
||
75 |
Get a list of tasks for a job with regex filtering on task name. |
|
Tasks |
Get |
|||
76 |
Get a list of task types available with regex filtering on type name and description. |
|
Tasks |
Get |
|||
77 |
Get information for a plan trigger. |
|
Triggers |
Get |
|||
78 |
Get a list of triggers for a job based on regex filtering of trigger names or descriptions. |
|
Triggers |
Get |
|||
79 |
Get a list of global or plan variables based on regex filtering of variable names. |
|
|
Variables |
Get |
||
80 |
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. |
|
Plans |
|
|||
81 |
Change the position of a stage in a plan. |
|
|
Stages |
|
||
82 |
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. |
|
Tasks |
|
|||
83 |
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. |
|
Repositories |
|
|||
84 |
Pause the server to prevent builds from starting. |
|
|
|
Server |
Stop |
|
85 |
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. |
branch, revision, wait, continue, timeout, dateFormat, field, fields, field1-8, value1-8 |
|
Builds |
|
||
86 |
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. |
regex, limit, continue, timeout, dateFormat, field, fields, field1-8, value1-8 |
|
Builds |
|
||
87 |
Remove an agent. |
|
Agents |
Delete |
|||
88 |
Remove an assignment from a specific agent. Use continue to ignore not found error. |
|
Agent Assignments |
Delete |
|||
89 |
Remove an artifact definition from a job. |
|
|
Artifacts |
Delete |
||
90 |
Removes a branch from a plan. Use --branch @all to remove all branches from a plan. |
|
|
Branches |
Delete |
||
91 |
Remove credentials by name or id. |
|
|
Delete |
|||
92 |
Remove an environment from a deployment project by name or id. |
|
Deployment |
Delete |
|||
93 |
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. |
|
Deployment |
Delete |
|||
94 |
Remove deployment environment variables. Specify the variable names using the field parameters. |
|
Deployment |
Delete |
|||
95 |
Remove a job from a plan. |
|
Jobs |
Delete |
|||
96 |
Remove labels from a build. Labels can be a comma separated list or regex. |
|
Labels |
Delete |
|||
97 |
Remove a plan notification. Use id of -1 to remove all notifications for a plan. |
|
|
Notifications |
Delete |
||
98 |
Remove global or plan repository. Use @all to remove all repositories. |
repository or id |
|
Repositories |
Delete |
||
99 |
Remove a plan requirement. |
|
|
Requirements |
Delete |
||
100 |
Remove a stage from a plan. Use --stage @all to remove all stages. Use continue to ignore not found errors. |
|
Stages |
Delete |
|||
101 |
Remove a task from a plan job. Use --task @all to remove all tasks. |
|
|
Tasks |
Delete |
||
102 |
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. |
|
Triggers |
Delete |
|||
103 |
Remove global or plan variables. Specify the variable names using the field parameters. |
|
|
Variables |
Delete |
||
104 |
Render url based request. The response data modified by findReplace processing is returned. |
requestParameters, requestType, type, acceptType, build, file, encoding, findReplace, findReplaceRegex |
|
Render |
Get |
||
105 |
Restart a build that failed or was stopped. Use continue to ignore errors finding a build to restart or failed results. |
|
Builds |
|
|||
106 |
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. |
|
|
Agent Assignments |
Import |
||
107 |
Resume server to allow builds to be started. |
|
|
|
Server |
Start |
|
108 |
Run actions from a file or standard input. |
common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
|
Run |
Run |
||
109 |
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 |
|
110 |
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 |
|
111 |
Run actions for each build with filtering like getBuildList. Available replacement variables are build. |
labels, issues, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Builds |
Run |
||
112 |
Run actions generated from a CSV file. |
common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
|
CSV |
Run |
||
113 |
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 |
|
114 |
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 |
||
115 |
Run actions for each environment trigger defined for a deployment environment with regex filtering on trigger name or description. Available replacement variables are triggerId. |
regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Deployment |
Run |
||
116 |
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 |
|
Jobs |
Run |
||
117 |
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. |
list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
|
Run |
Run |
||
118 |
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. |
favorite, excludeDisabled, excludeEnabled, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Plans |
Run |
||
119 |
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 |
|
120 |
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 |
|
121 |
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 |
|
SQL |
Run |
||
122 |
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 |
|
Stages |
Run |
||
123 |
Run actions for each plan trigger with regex filtering on trigger name or description. Available replacement variables are triggerId. |
regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Triggers |
Run |
||
124 |
Set child dependencies and other related options. |
|
Options |
Update |
|||
125 |
Set the plan as a favorite. |
|
|
Plans |
Update |
||
126 |
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. |
|
Jobs |
Update |
|||
127 |
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. |
|
Builds |
|
|||
128 |
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. |
|
Repositories |
|
|||
129 |
Remove the plan from the favorite list. |
|
|
Plans |
|
||
130 |
Update existing credentials. Credentials can be renamed by providing a name. |
name, userId, file, accessKeyId, userPassword, sshParaphrase, accessKey |
|
|
Update |
||
131 |
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. |
|
Deployment |
Update |
|||
132 |
Update a plans name or description. Provide a 2-part plan key where the first part is the project key. |
|
Plans |
Update |
|||
133 |
Update a global or plan repository.If the credentials parameter is provided the appropriate fields will be added automatically for GIT, Mercurial, and Bitbucket Cloud repositories. |
repository or id |
|
Repositories |
Update |
||
134 |
Update a plan requirement. |
|
Requirements |
Update |
|||
135 |
Update stage details. |
|
Stages |
Update |
|||
136 |
Update a task in a plan job. You must provide the same parameters as if you were creating the task. |
|
Tasks |
Update |
|||
137 |
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. |
|
|
Variables |
Update |
||
138 |
Validates the CLI Connector is enabled and licensed on the server. |
|
|
|
Misc |
Check |
|
139 |
Verify build was successful. Throws exception if not successful. |
|
Builds |
|
Log a request with our support team.
Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.