Actions - 6.7.0

 

Action

Description

Required Parameters

Optional Parameters

Output Formats

1

addAgent

Add a local agent.

agent

description

 

2

addAgentAssignment

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.

agent, assignment

continue

 

3

addArtifact

Add an artifact definition to a job.

plan, job, artifact, copyPattern

location, shared

 

4

addArtifactDependency

Add an artifact dependency to a job. Artifact must be a shared artifact from another job.

plan, job, artifact, location

 

 

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

 

6

addComment

Add a comment to a build.

build, comment

number, findReplace, findReplaceRegex, file, encoding

 

7

addEnvironment

Experimental. Add an environment to deployment project.

deploymentProject, name

description

 

8

addEnvironmentTask

Experimental. Add a task to a deployment environment.

deploymentProject, environment, taskKey

description, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

9

addEnvironmentTrigger

Experimental. Add a trigger to a deployment project. Pre-defined types are: scheduled, afterSuccessfulStage. One or more repositories can be specified for pre-defined type triggers based on repositories. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters.

deploymentProject, name, type

repository, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

10

addJob

Add a job to a stage.

plan, stage, job

name, description, disable

 

11

addLabels

Add a comma separated list of labels to a build.

build, labels

number

 

12

addNotification

Add a plan notification. There are 2 parts to a notification - an event that triggers the notification and a recipient type that determines the notification protocol. There are built-in notifications and others provided by add-ons. A recipient type may have additional parameters. Generally, these can be specified by the field and values parameters. In some cases, pre-defined parameters are available.

plan, event, recipientType

recipient, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

13

addRepository

Add a global or plan repository. For a plan repository, you can reference a linked (global) repository. Otherwise a valid repository key or alias is required. Valid aliases are: BITBUCKET, BITBUCKET_CLOUD, BITBUCKET_SERVER, STASH, BCVS, GIT, GITHUB, MERCURIAL, PERFORCE, SUBVERSION

repository or name

plan, repositoryKey, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

14

addRequirement

Add requirement to a plan job.

plan, job, requirement

type, value

 

15

addStage

Add a stage to a plan.

plan, stage

description, manual

 

16

addTask

Add a task to a plan job. A valid task key or alias is required. Valid aliases are: ANT, ARTIFACT_DOWNLOAD, CHECKOUT, CLI_BAMBOO, CLI_BITBUCKET, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_HIPCHAT, CLI_JIRA, CLI_SERVICE_DESK, CLI_UPM, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACE

plan, job, taskKey

disable, final, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

17

addTrigger

Add a trigger to a plan. Pre-defined types are: polling, remote, scheduled. One or more repositories can be specified for pre-defined type triggers based on repositories. Polling triggers default to all plan repositories or use repository @all. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters. Use of the name parameter is deprecated - description should be used instead.

plan, type

description, repository, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

18

addVariables

Add global or plan variables. Defaults to global variables unless a plan is specified. Use the field parameters for the variable name and the corresponding value parameters for the variable values,

 

plan, replace fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

19

clonePlan

Clone a plan.

plan, toPlan, name

description, projectName, disable

 

20

cloneProject

Clone each plan in a project to another project. If toProject is not provided, the plans will be cloned to the same project. If the toProject does not exist, it will be created with name provided by projectName.

project, toProject, projectName, disable

 

 

21

createDeploymentProject

Experimental. Create a deployment project for a plan.

plan, name

description, branch

 

22

createOrUpdatePlan

Same as createPlan when plan does not exist. However, it will update an existing plan's name and description.

plan

name, projectName, description, disable

 

23

createPlan

Create a new plan. Provide a 2-part plan key where the first part is the project key. If the project key does not exist, it will be created with the provided project name. Use continue to ignore the request if the plan already exists.

plan

name, projectName, description, disable, continue

 

24

deleteDeploymentProject

Experimental. Delete a deployment project by name or id.

deploymentProject

continue

 

25

deletePlan

Delete a plan.

plan

 

 

26

deleteProject

Delete project and all project plans.

project

file

 

27

deployEnvironment

Experimental. Deploy environment. To promote (re-deploy) an existing version, use --replace.

deploymentProject, environment, version

build, number, replace

 

28

disableAgent

Disable an agent.

agent

 

 

29

disableJob

Disable a job from running.

plan, job

 

 

30

disablePlan

Disable a plan from running.

plan

 

 

31

disableProject

Disable all project plans.

project

 

 

32

enableAgent

Enable an agent.

agent

 

 

33

enableJob

Enable a job to run.

plan, job

 

 

34

enablePlan

Enable a plan to run.

plan

 

 

35

enableProject

Enable all project plans.

project

 

 

36

exportPlan

Experimental. Export a plan to source that can be used for plan creation. Valid export types are CLI, JAVA (Bamboo 6.0 and higher).

plan

type, file, encoding, dateFormat

 

37

getAgentList

Get a list of agents based on regex filtering of agent names.

 

regex, file, append, encoding, columns

1 - basic, 2 - detail

38

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

39

getArtifactDefinitionList

Get a list of artifact definitions for a plan with regex filtering on artifact name.

plan

limit, regex, columns, file, append, encoding

 

40

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

 

41

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

 

42

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

 

43

getBuild

Get build result.

build

number, expand, file, encoding

 

44

getBuildList

Get a list of build reults. Build results can be filtered by using fields and values. Supported fields are state, notState, and started. For example, include only successful results by using: --field1 state --value SUCCESSFUL, or include only builds started after a specific date use: --field2 started --value2 2016-04-30 --dateFormat yyyy-MM-dd. Default limit is 25.

plan

limit, favorite, labels, issues, columns, file, append, encoding, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

1 - basic, 2 - test information

45

getBuildQueueList

Get a list of builds waiting in the build queue. Subset by project or build.

 

project, build, file, append, encoding, columns

 

46

getClientInfo

Get information about this client tool.

 

outputFormat, file, append, encoding

1 - basic, 2 - JVM, 11 - action list, 12 - parameter list

47

getCommentList

Get a list of comments for a build.

build

number, file, append, encoding, columns

 

48

getDeploymentProject

Experimental. Get information for a deployment project by name or id.

deploymentProject

 

 

49

getDeploymentProjectList

Experimental. Get a list of deployment projects based on regex filtering of project names.

 

regex, file, append, encoding, columns

 

50

getEnvironment

Experimental. Get information for an environment from a deployment project by name or id.

deploymentProject, environment

file, encoding

 

51

getEnvironmentList

Experimental. Get a list of environments for a deployment project based on regex filtering of environment names.

deploymentProject

regex, file, append, encoding, columns

 

52

getJobList

Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired.

plan

stage, regex, file, attribute, columns

 

53

getLabelList

Get a list of labels for a build.

build

number, file, append, encoding, columns

 

54

getLatestBuildNumber

Get the number of the last completed build for this plan.

plan

 

 

55

getNotificationList

Get a list of plan notifications.

 

plan, file, append, encoding

 

56

getPlan

Get plan information.

plan

 

 

57

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.

project

favorite, excludeDisabled, excludeEnabled, limit, regex, outputFormat, dateFormat, columns, file, append, encoding

1 - plan, 999 - last build results

58

getProjectList

Get a list of projects. Projects are selected based on regex filtering on project key or name.

 

regex, file, append, encoding, columns

 

59

getRepository

Get details of a global or plan repository. Sets the repository and repositoryId replacement variables.

repository

plan

 

60

getRepositoryList

Get a list of global or plan repositories with regex filtering on repository name.

 

plan, regex, file, append, encoding

 

61

getServerInfo

Get information about the Bamboo server.

 

outputFormat, dateFormat, file, append, encoding

1 - basic, 2 - detail, 3 - state

62

getStage

Get plan stage information.

plan, stage

 

 

63

getStageList

Get a list of stages for a plan with regex filtering on stage name.

plan

regex, file, attribute, columns

 

64

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

 

 

65

getTaskList

Get a list of tasks for a job with regex filtering on task name.

plan, job

limit, regex, file, columns

 

66

getTaskTypeList

Get a list of task types available with regex filtering on type name and description.

plan, job

limit, regex, file, columns

 

67

getVariableList

Get a list of global or plan variables based on regex filtering of variable names.

 

plan, regex, file, append, encoding

 

68

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. Before the move takes place, the server state will be checked and paused if necessary and, if paused, resumed after the end of the operation.

project or plan, toProject

toPlan, name, excludeEnabled, excludeDisabled, limit, regex

 

69

moveStage

Change the position of a stage in a plan.

plan, stage

 

 

70

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

 

71

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

 

72

pauseServer

Pause the server to prevent builds from starting.

 

 

 

73

queueBuild

Queue a build to run. If wait is specified, the action will not complete until the queued build completes or the timeout period elapses. The action will fail if the build fails unless continue parameter is used to ignore a failed result. A specific revision can be built if the revision parameter is specified. Plan variables can be set using the field and value parameters. Conditional queueing is supported - see the documentation for details.

plan

branch, revision, wait, continue, timeout, dateFormat, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

74

queueBuildFromList

Queue multiple builds to run and wait for results. The action will not complete until all queued builds complete or times out. If continue is specified, builds will continue to be queued even after an attempt to queue a build fails. The action will fail if any build fails or times out. Conditional queueing is supported - see the documentation for details.

project or list

regex, limit, continue, timeout, dateFormat, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

75

removeAgent

Remove an agent.

agent

 

 

76

removeAgentAssignment

Remove an assignment from a specific agent. Use continue to ignore not found error.

agent, assignment

continue

 

77

removeArtifact

Remove an artifact definition from a job.

plan, job, artifact

 

 

78

removeBranch

Removes a branch from a plan. Use --branch @all to remove all branches from a plan.

plan, branch

 

 

79

removeEnvironment

Experimental. Remove an environment from a deployment project by name or id.

deploymentProject, environment

continue

 

80

removeLabels

Remove labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided

labels

build, number, searchLabels, issues, favorite

 

81

removeNotification

Remove a plan notification. Use id of -1 to remove all notifications for a plan.

plan, id

 

 

82

removeRepository

Remove global or plan repository. Use @all to remove all repositories.

repository or id

plan, continue

 

83

removeRequirement

Remove a plan requirement.

plan, job, id

 

 

84

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

 

85

removeTask

Remove a task from a plan job. Use --task @all to remove all tasks.

plan, job, task or id

 

 

86

removeTrigger

Remove a trigger from a plan. Use id = -1 to remove all triggers.

plan, id

 

 

87

removeVariables

Remove global or plan variables. Specify the variable names using the field parameters.

 

plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

88

renderRequest

Render url based request. The response data modified by findReplace processing is returned.

request

requestParameters, requestType, type, acceptType, build, file, encoding, findReplace, findReplaceRegex

 

89

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

 

90

resumeServer

Resume server to allow builds to be started.

 

 

 

91

run

Run actions from a file or standard input.

file or standard input

common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

92

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

 

93

runFromCsv

Run actions generated from a CSV file.

file

common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

94

runFromDeploymentProjectList

Experimental. Run actions for each deployment project with regex filtering on deployment project name. Available replacement variables are deploymentProject and deploymentProjectId.

 

regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex

 

95

runFromEnvironmentList

Experimental. Run actions for each environment defined for a deployment project with regex filtering on environment name. Available replacement variables are environment and environmentId.

 

regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex

 

96

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

 

97

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

 

98

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. Available replacement variables are project, projectName, plan, and planName.

project

favorite, excludeDisabled, excludeEnabled, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex

 

99

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

 

100

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

 

101

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

 

102

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

 

103

setDependencyOptions

Set child dependencies and other related options.

plan

children, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

104

setFavoritePlan

Set the plan as a favorite.

plan

 

 

105

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

 

106

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

 

107

unsetFavoritePlan

Remove the plan from the favorite list.

plan

 

 

108

updatePlan

Update a plans name or description. Provide a 2-part plan key where the first part is the project key.

plan

name, description

 

109

updateRepository

Update a global or plan repository.

repository or id

plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

110

updateRequirement

Update a plan requirement.

plan, job, id

type, value

 

111

updateStage

Update stage details.

plan, stage

name, description, manual, automatic

 

112

updateTask

Update a task in a plan job. You must provide the same parameters as if you were creating the task.

plan, job, task or id

enable, disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

113

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,

 

plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

114

validateLicense

Validates the CLI Connector is enabled and licensed on the server.

 

 

 

115

verifyBuild

Verify build was successful.

build

number

 

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.