Actions - 7.7.0

 

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

addApplicationLink

Add an application link to another application. By default, both incoming and outgoing links are enabled and configured without impersonation (users are not shared). Use the options parameter to customize the behavior. Use '--options impersonate' to enable shared users. Other examples are '--options disableIncoming' and '--options disableOutgoing'. If another link of the same type already exists as primary, use '--options primary' to force the new link to be primary instead.

url

name, options, continue

 

Links

Create

4

addArtifact

Add an artifact definition to a job.

plan, job, artifact, copyPattern

location, shared

 

Artifacts

Create

5

addArtifactDependency

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

plan, job, artifact, location

 

 

Artifacts

Create

6

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

7

addCapability

Add a shared or agent specific server capability.

type

agent, name, value, field, fields, field1, value1, field2, value2

 

 

Create

8

addComment

Add a comment to a build.

build, comment

number, findReplace, findReplaceRegex, input, file, encoding

 

Comments

Create

9

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.

credentials, userId or file or accessKeyId and accessKey

userPassword, sshParaphrase, accessKey, replace

 

 

Create

10

addEnvironment

Add an environment to deployment project.
Available replacement variables: environment, environmentId.

deploymentProject, name

description

 

Deployment

Create

11

addEnvironmentTask

Add a task to a deployment environment.

deploymentProject, environment, taskKey

description, field, fields, field1, value1, field2, value2

 

Deployment

Create

12

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, value1, field2, value2

 

Deployment

Create

13

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, value1, field2, value2

 

Deployment

Create

14

addGroup

Add a new group.

group

continue

 

Groups

Create

15

addJob

Add a job to a stage.
Available replacement variables: job, jobName.

plan, stage, job

name, description, disable

 

Jobs

Create

16

addLabels

Add a comma separated list of labels to a build or plan.

build or plan, labels

number

 

Labels

Create

17

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, value1, field2, value2

 

Notifications

Create

18

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, value1, field2, value2

 

Repositories

Create

19

addRequirement

Add requirement to a plan job.

plan, job, requirement

type, value

 

Requirements

Create

20

addStage

Add a stage to a plan.
Available replacement variables: stage.

plan, stage

description, manual

 

Stages

Create

21

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
Available replacement variables: taskId.

plan, job, taskKey

disable, final, field, fields, field1, value1, field2, value2

 

Tasks

Create

22

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.
Available replacement variables: triggerId.

plan, type

description, repository, schedule, passingPlans, ipRestriction, field, fields, field1, value1, field2, value2

 

Triggers

Create

23

addUser

Add a new user. User can be added to a group (or groups) using the group parameter.

userId, userEmail, group

userFullName, userPassword, continue

 

Users

Create

24

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, value1, field2, value2

 

Variables

Create

25

clonePlan

Clone a plan.
Available replacement variables: project,plan.

plan, toPlan, name

description, projectName, disable

 

Plans

Create

26

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

27

createDeploymentProject

Create a deployment project for a plan.
Available replacement variables: deploymentProject, deploymentProjectId.

plan, name

description, branch

 

Deployment

Create

28

createOrUpdatePlan

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

plan

name, projectName, description, disable

 

Plans

Create

29

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.
Available replacement variables: project, plan.

plan

name, projectName, description, disable, replace, continue

 

Plans

Create

30

createProject

Bamboo 6.2 and higher. Create a new project.

project

name, description

 

Projects

Create

31

deleteDeploymentProject

Delete a deployment project by name or id.

deploymentProject

continue

 

Deployment

Delete

32

deletePlan

Delete a plan.

plan

 

 

Plans

Delete

33

deleteProject

Delete project and all project plans.

project

file

 

Projects

Delete

34

deployEnvironment

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

deploymentProject, environment, version

build, number, replace, wait, timeout

 

Deployment

 

35

disableAgent

Disable an agent.

agent

 

 

Agents

Update

36

disableJob

Disable a job from running. Use @all for job to enable all jobs in a stage.

plan, job

stage

 

Jobs

Update

37

disablePlan

Disable a plan from running.

plan

 

 

Plans

Update

38

disableProject

Disable all project plans.

project

 

 

Projects

Update

39

enableAgent

Enable an agent.

agent

 

 

Agents

Update

40

enableJob

Enable a job to run. Use @all for job to enable all jobs in a stage.

plan, job

stage

 

Jobs

Update

41

enablePlan

Enable a plan to run.

plan

 

 

Plans

Update

42

enableProject

Enable all project plans.

project

 

 

Projects

Update

43

exportJob

Export a job to CLI source.

plan, job

file, encoding, dateFormat

 

Jobs

Export

44

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

45

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

46

getAgentList

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

 

regex, file, append, encoding, columns

1 - basic, 2 - detail, 999 - all

Agents

Get

47

getApplicationLink

Get information for an application link identified by name or url.
Available replacement variables: applicationLinkId.

name or url

 

 

Links

Get

48

getApplicationLinkList

Get list of a application links with optional filtering on application type and regex filtering on the name or url. Use '--options excludeSystemLinks' to exclude system defined links. Example types: jira, confluence.

 

type, limit, regex, outputFormat, file, append, columns, encoding

1 - basic, 2 - status, 999 - all

Links

Get

49

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

50

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

51

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

52

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

53

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

54

getBuild

Get build result.

build

number, file, encoding

 

Builds

Get

55

getBuildList

Get a list of build results. Build results can be filtered by using fields and values. Supported fields are state, notState, started, endedBefore. 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, value1, field2, value2

1 - basic, 999 - test information and other details

Builds

Get

56

getBuildQueueList

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

 

project, build, file, append, encoding, columns

 

Builds

Get

57

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

58

getClientInfo

Get information about this client tool.

 

outputFormat, file, append, encoding

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

Info

Get

59

getCommentList

Get a list of comments for a build.

build

number, file, append, encoding, columns

 

Comments

Get

60

getCredentialsList

Get a list of credentials based on regex filtering of credentials name.

 

regex, limit, file, append, encoding

 

Lists

Get

61

getDeploymentProject

Get information for a deployment project by name or id.

deploymentProject

 

 

Deployment

Get

62

getDeploymentProjectList

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

 

regex, file, append, encoding, columns

 

Deployment

Get

63

getEnvironment

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

deploymentProject, environment

file, encoding

 

Deployment

Get

64

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

65

getEnvironmentTaskList

Get a list of tasks for a deployment environments with regex filtering of task name or description.

deploymentProject, environment

regex, file, append, encoding, columns

 

Deployment

Get

66

getEnvironmentTrigger

Get information for a deployment environment trigger.

deploymentProject, environment, id or name

file, encoding

 

Deployment

Get

67

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

68

getEnvironmentVariableList

Get a list of deployment environment variables based on regex filtering of variable names.

 

plan, regex, limit, file, append, encoding

 

Deployment

Get

69

getJob

Get job information.

plan, job

 

 

Jobs

Get

70

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

71

getLabelList

Get a list of labels for a build or plan.

build or plan

number, file, append, encoding, columns

 

Labels

Get

72

getLatestBuildNumber

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

plan

 

 

Builds

Get

73

getNotificationList

Get a list of plan notifications.

 

plan, file, append, encoding

 

Notifications

Get

74

getPlan

Get plan information.

plan

 

 

Plans

Get

75

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, value1, field2, value2

1 - plan, 999 - last build results

Plans

Get

76

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

77

getRepository

Get details of a global or plan repository.
Available replacement variables: repository, repositoryId.

repository

plan

1 - basic, 999 - all

Repositories

Get

78

getRepositoryList

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

 

plan, regex, file, append, encoding

 

Repositories

Get

79

getServerInfo

Get information about the Bamboo server.

 

outputFormat, dateFormat, file, append, encoding

1 - basic, 2 - detail, 3 - state, 999 - all

Info

Get

80

getStage

Get plan stage information.

plan, stage

 

 

Stages

Get

81

getStageList

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

plan

regex, file, columns

 

Stages

Get

82

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

83

getTaskList

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

plan, job

limit, regex, file, columns

 

Tasks

Get

84

getTaskTypeList

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

plan, job

limit, regex, file, columns

 

Tasks

Get

85

getTrigger

Get information for a plan trigger.

plan, id or name

file, encoding

 

Triggers

Get

86

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

87

getUserList

Get list of a users with regex filtering on the userId or name.

 

limit, regex, file, append, columns, encoding

 

Users

Get

88

getVariableList

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

 

plan, regex, file, append, encoding

 

Variables

Get

89

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

 

90

moveStage

Change the position of a stage in a plan to be after another stage or, by default, to the top.

plan, stage

after

 

Stages

 

91

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

 

92

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

 

93

pauseServer

Pause the server to prevent builds from starting.

 

 

 

Server

Stop

94

queueBuild

Queue a build to run. If a build number is provided (number parameter or 3 part build key), an existing failed or incomplete build can be restarted. 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 or build

branch, revision, number, wait, continue, timeout, dateFormat, field, fields, field1, value1, field2, value2

 

Builds

 

95

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, value1, field2, value2

 

Builds

 

96

removeAgent

Remove an agent.

agent

continue

 

Agents

Delete

97

removeAgentAssignment

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

agent, assignment

type, continue

 

Agent Assignments

Delete

98

removeApplicationLink

Remove an application link identified by name or url.

name or url

continue

 

Links

Delete

99

removeArtifact

Remove an artifact definition from a job.

plan, job, artifact

 

 

Artifacts

Delete

100

removeBranch

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

plan, branch

 

 

Branches

Delete

101

removeBuildHistory

Remove history for specific build.

build

number, continue

 

Builds

Delete

102

removeCapability

Remove a shared or agent specific server capability identified by key (label) or unique name.

capability

agent

 

 

Delete

103

removeCredentials

Remove credentials by name or id.

credentials

continue

 

 

Delete

104

removeEnvironment

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

deploymentProject, environment

continue

 

Deployment

Delete

105

removeEnvironmentTask

Remove a task from a deployment environment.

deploymentProject, environment, task or id

 

 

Deployment

Delete

106

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

107

removeEnvironmentVariables

Remove deployment environment variables. Specify the variable names using the field parameters.

deploymentProject, environment

field, fields, field1, value1, field2, value2

 

Deployment

Delete

108

removeGroup

Remove a group.

group

continue

 

Groups

Delete

109

removeJob

Remove a job from a plan.

plan, job

continue

 

Jobs

Delete

110

removeLabels

Remove labels from a build or plan. Labels can be a comma separated list or regex.

build or plan, labels

number, continue

 

Labels

Delete

111

removeNotification

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

plan, id

 

 

Notifications

Delete

112

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

113

removeRequirement

Remove a plan requirement.

plan, job, id

 

 

Requirements

Delete

114

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

115

removeTask

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

plan, job, task or id

 

 

Tasks

Delete

116

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

117

removeUser

Remove a user.

userId

continue

 

Users

Delete

118

removeVariables

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

 

plan, field, fields, field1, value1, field2, value2

 

Variables

Delete

119

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

120

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

 

121

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

122

resumeServer

Resume server to allow builds to be started.

 

 

 

Server

Start

123

run

Run actions from a file or standard input.

file or input or standard input

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

 

Run

Run

124

runFromAgentAssignmentList

Run actions for each agent assignment with filtering like getAgentAssignment.
Available replacement variables: agent, agentId, assignment, assignmentId, assignmentKey.

 

agent, type, limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

 

Agent Assignments

Run

125

runFromAgentList

Run actions for each agent with regex filtering on agent name.
Available replacement variables: agent, agentId.

 

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

 

Agents

Run

126

runFromBuildList

Run actions for each build with filtering like getBuildList.
Available replacement variables: build.

plan

labels, issues, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex

 

Builds

Run

127

runFromCsv

Run actions generated from a CSV file.

file

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

 

CSV

Run

128

runFromDeploymentProjectList

Run actions for each deployment project with regex filtering on deployment project name.
Available replacement variables: deploymentProject, deploymentProjectId.

 

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

 

Deployment

Run

129

runFromEnvironmentList

Run actions for each environment defined for a deployment project with regex filtering on environment name.
Available replacement variables: environment, environmentId.

plan

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

 

Deployment

Run

130

runFromEnvironmentTriggerList

Run actions for each environment trigger defined for a deployment environment with regex filtering on trigger name or description.
Available replacement variables: triggerId.

deploymentProject, environment

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

 

Deployment

Run

131

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: project, projectName, plan, planName, stageId, stageName, job, jobName.

plan

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

 

Jobs

Run

132

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: entry, entry2.

list

list2, input, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

Run

Run

133

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: project, projectName, plan, planName.

project

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

 

Plans

Run

134

runFromProjectList

Run actions for each project with regex filtering on project key or name.
Available replacement variables: project, projectName.

 

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

 

Projects

Run

135

runFromRepositoryList

Run actions for each repository with regex filtering on repository name.
Available replacement variables: repository, repositoryId.

 

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

 

Repositories

Run

136

runFromSql

Run actions generated by SQL provided by the sql parameter, a file, or standard input

sql or file

common, driver, database, host, port, url, dbUser, dbPassword, input, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

SQL

Run

137

runFromStageList

Run actions for each stage with regex filtering on stage name.
Available replacement variables: project, projectName, plan, planName, stageId, stageName.

plan

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

 

Stages

Run

138

runFromTaskList

Run actions for each task in a job with regex filtering like getTaskList.
Available replacement variables: plan, job, taskId.

plan, job

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

 

Tasks

Run

139

runFromTriggerList

Run actions for each plan trigger with regex filtering on trigger name or description.
Available replacement variables: triggerId.

plan

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

 

Triggers

Run

140

runFromUserList

Run actions for each user with regex filtering the same as getUserList.
Available replacement variables: userId.

 

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

 

Users

Run

141

runIf

Run actions only if a regex based condition is met. Other parameters and behavior is the same as the run action. By default the regex is used as a find operation in the value. Options parameter can be set to one or more of the following to modify the default behavior: literal - to treat the regex string as a literal string, exact - to require an exact match of the value, negative - to reverse the condition so a match means do NOT run action.

regex, file or input or standard input

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

 

Run

Run

142

setDependencyOptions

Set child dependencies and other related options.

plan

children, field, fields, field1, value1, field2, value2

 

Options

Update

143

setFavoritePlan

Set the plan as a favorite.

plan

 

 

Plans

Update

144

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

145

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

 

146

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

 

147

unsetFavoritePlan

Remove the plan from the favorite list.

plan

 

 

Plans

 

148

updateCapability

Update a capabilities value.

capability

agent, value

 

 

Update

149

updateCredentials

Update existing credentials. Credentials can be renamed by providing a name.

credentials

name, userId, file, input, accessKeyId, userPassword, sshParaphrase, accessKey

 

 

Update

150

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, value1, field2, value2

 

Deployment

Update

151

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

152

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, value1, field2, value2

 

Repositories

Update

153

updateRequirement

Update a plan requirement.

plan, job, id

type, value

 

Requirements

Update

154

updateStage

Update stage details.

plan, stage

name, description, manual, automatic

 

Stages

Update

155

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, value1, field2, value2

 

Tasks

Update

156

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, value1, field2, value2

 

Variables

Update

157

validateLicense

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

 

 

 

Misc

Check

158

verifyBuild

Verify build was successful. Throws exception if not successful.

build

number

 

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.