Action Types

Action Types

 

 

 

Check

sleep

Sleep a number of seconds. Defaults to 1 second. Use in ACLI scripts that may need to wait before proceeding to the next action. For instance, waiting for server to complete updating search indexes or polling type scenarios.

 

Create

addDownload

Add a download file to a repository.

addEnvironment

Add deployment environment to a repository. Type must be one of Test, Staging, or Production. Premium plan users can use '--options adminOnly' to restrict who can deploy to this environment. Use '--replace' to remove and replace an existing environment. Use '--continue' to ignore an already exist error.

addRunner

Add a pipeline runner to a workspace or repository. Exactly one platform label (linux, linux.shell, windows, macos) can be specified. Defaults to linux if none is provided. Also, self.hosted is added if not provided as required by Bitbucket.

addVariables

Add workspace, repository, or deployment environment variables. Use one or more field parameters where each field parameter is a key=value pair. Specify a secured variable by appending ':secured' like key=value:secured. To secure all variables added, use the secured parameter. Variables can also be added from a property file using the propertyFile parameter.

createBranch

Create repository branch. Use the from parameter to specify the source reference (commit, branch, or tag) that this branch will be created from. Use optional type parameter to specify branch types like Feature, Bugfix, Release etc. The final branch name will be combination of type and branch name with a slash. Use continue parameter to ignore when branch already exists.

createCommit

Create a repository commit for a single file add, change, or delete. The path parameter path specifies the path of the repository file to be added, changed, or deleted. Use the data or file parameter to provide new contents of the file otherwise the file will be deleted. Use the name parameter for the commit message. If name is not provided, a system generated name will be used.

createProject

Create a new project in a workspace. Use private (default) or public parameter to set the visibility of the project. Use continue parameter to ignore an error when the project already exists.

createPullRequest

Create a new pull request. Use parameter from to set the source branch. Use parameter to to set the target branch. The target branch will be defaulted to master branch if parameter to is not specified. Use parameter reviewers to provide comma separated list of reviewers for the pull request. Note the owner of the pull request cannot be in the reviewers list. Note if there is already an open pull request with provided source and target branch, that pull request will be updated.

createRepository

Create a new repository in a workspace. Use private (default) or public parameter to set the visibility of the project. Use continue parameter to ignore an error when the project already exists.

provideFeedback

Provide feedback, comments, and suggestions to ACLI developers based on your experience with the product. We appreciate all feedback in the spirit of continuous improvement in helping customers with their tasks. For specific product issues and immediate help, please submit a request to our support portal at https://apps.appf.re/acli-support.

 

Delete

deleteBranch

Delete repository branch.

deleteProject

Delete project.

 

deleteRepository

Delete repository.

removeDownload

Remove download from repository download area.

removeEnvironment

Remove deployment environment by name or UUID.

removePipelineCache

Remove a pipeline cache by name or UUID.

removeRunner

Remove pipeline runner from workspace or repository by name or UUID. If a name is not unique, the first runner found will be removed.

 

removeVariables

Remove workspace, repository, or deployment environment variables. Specify the variable names using the field parameters. Variables can also be removed by keys specified in a property file using the propertyFile parameter.

Export

exportData

Export data in a ACLI compatible script suitable for use with the run action. Supported export types are WORKSPACE and REPOSITORY. The most important data that is exported are variables and deployment environments. There are 2 ways to export variables. By default they are exported using 'addVariables' actions. If you want to export them into a property file instead, set the propertyFile parameter. Use '--options appendPropertyFile' to append to the property file instead of overwriting it. Secure variable values can be exported to the secure property file associated to the session if a secure property password is provided. In this case, the secure property file can be used to restore the variables faithfully using the 'addVariables' action. Use '--options includeReplace' to have generated actions include the '--replace' parameter where appropriate to force replace of existing variables or deployment environments. Otherwise, use '--options includeContinue' to have generated actions include the '--continue' parameter where appropriate to ignore already exists and similar errors.

 

Get

getAutomation

Get information for an automations specified by name or directory or both. An automation is a directory containing a 'automation.yaml' description and optional ACLI script files or related resources.

getAutomationList

Get a list of automations with regex filtering on name. An automation is a directory containing a 'automation.yaml' description and optional ACLI script files or related resources.

 

getBranch

Get repository branch information.

getBranchList

Get a list of branches with optional regex filtering on name. Date range filtering on last commit date is available using startDate and endDate parameters. 365 When no start date is specified, the default will be to limit the results to the last 365 days - - the default is equivalent to using '--startDate -365d'. Use '--startDate @all' to avoid the limit.

getBuildStatusList

Get a list of build status entries associated with a repository commit with regex filtering on build status name. The list includes entries from Bitbucket pipelines, Bamboo builds, and other CI servers like AWS and Azure that specifically support this Bitbucket feature. Use the commit parameter to specify the commit id or @last to get the last commit. If no commit is specified and the branch parameter is used, commit will be the last commit for the branch.

getClientInfo

Get information about this client.

 

getCommit

Get repository commit information by commit hash. Use @last to get the last (most recent) commit or combine with filtering similar to getCommitList to find the last commit that matches all the filter conditions.

getCommitList

Get list of commits with optional regex filtering on commit message and commit id. Date range filtering on commit date is available using startDate and endDate parameters. When no start date is specified, the default will be to limit the results to the last 30 days - the default is equivalent to using '--startDate -30d'. Use '--startDate @all' to avoid the limit. This is done to prevent inadvertently large queries. Additional, high performing filtering can be done using the branch and/or the path parameters. There is no default date limit for these filters. Branch can be a branch or tag name. Path can be a file path (not a directory) in the repository which will result in commits that modified that file.

getDeployment

Get repository deployment information by name or UUID. Use @last to get the last (most recent) deployment or combine with filtering similar to getDeploymentList to find the last deployment that matches all the filter conditions.

getDeploymentList

Get a list of repository deployments matching the selection criteria and optional regex filtering on name, key (slug), or UUID. List is sorted with more recently started first. Date range filtering on started date is available using startDate and endDate parameters. When no start date is specified, the default will be to limit the results to the last 30 days - - the default is equivalent to using '--startDate -30d'. Use '--startDate @all' to avoid the limit.

getDownload

Get repository download file by name.

getDownloadList

Get a list of downloads for a repository with regex filtering on download name. Filter by date using the startDate and endDate parameters with absolute dates or durations specified by a negative integer value with s (secs), m (mins), h (hours), or d (days). Examples are '--endDate -30d', '--endDate -7days', or '--endDate -1h'.

getEnvironment

Get deployment environment by name or UUID.

getEnvironmentList

Get a list of repository deployment environments matching the selection criteria and optional regex filtering on name or UUID.

getFile

Get source files or binary files from a repository identified by the file path. For binary files, the file parameter is required.

getFileList

Get file and directory list with regex filtering on path.

getPermissionList

Get a list of user and group permissions for a workspace, project, or repository.

getPipeline

Get pipeline by pipeline number or UUID. Use @last (most recent) to get the last pipeline or combine filtering similar to getPipelineList to find the last pipeline that matches the all the filter conditions. to find the last pipeline that matches all the filter conditions. Note that when the wait parameter is used, the state parameter will not be used for filtering, but is used as part of the wait condition handling. This action supports wait and related parameters similar to the startPipeline action. See the startPipeline action for more information.

getPipelineCache

Get pipeline cache archive by cache name or UUID.

getPipelineCacheList

Get list of pipeline caches for a repository with regex filtering on path.

getPipelineList

Get list of pipelines with regex filtering by selector. Additional filtering available with the branch, commit, selector, and state parameters. Date range filtering on pipeline start date is available using startDate and endDate parameters. When no start date is specified, the default will be to limit the results to the last 30 days - - the default is equivalent to using '--startDate -30d'. Use '--startDate @all' to avoid the limit. This protects against inadvertent use potentially taking many minutes if not longer on older sites. Recommend restricting the number of pipelines that need to be accessed by using the limit parameter or the startDate and endDate parameters to restrict the date range. Otherwise, it will be slow to retrieve large numbers of pipelines. Note that the commit parameter could reference a branch or tag. Normally ordered by descending pipeline id. Special case to just get a count of all pipelines across all repositories, use '--repository @all --limit 0'. This may take a long time if user is authorized to a large numbers of repositories.

getPipelineStep

Get pipeline step by name or UUID. This action supports wait and related parameters similar to the startPipelineStep action. See the startPipelineStep action for more information.

getPipelineStepList

Get list of pipeline steps with regex filtering on step name.

getProject

Get project information.

getProjectList

Get a list of projects which belongs to the given workspace.

 

getPullRequest

Get pull request information under a repository. Pull request can be identified by number. Name can also be used to identify the pull request, but this is done via name search determined lookup on a list of pull requests which uses a most recent filter based on started date and defaulting to the last 365 days equivalent to using '--startDate -365d'. Use '--startDate @all' to avoid the limit.

getPullRequestList

Get List of pull requests for a user with optional filtering on repository, state and optional regex filtering on name. Date range filtering on created date is available using startDate and endDate parameters. When no start date is specified, the default will be to limit the results to the last 365 days - - the default is equivalent to using '--startDate -365d'. Use '--startDate @all' to avoid the limit.

getReplacementVariableList

Get a list of replacement variable names and values with regex filtering on name. This action is only useful within a run script where replacement variables are remembered.

 

getRepository

Get repository information.

getRepositoryList

Get a list of repositories matching the filtering criteria including regex filtering on name or slug or UUID. Filter using user role or query parameters. Also, filter by using the project parameter or if you are using the query parameter then add 'project.key="..."' as part of the query parameter. By default, list is sorted by repository name. Alternatively, specify a valid sort parameter. See the Bitbucket documentation (https://developer.atlassian.com/cloud/bitbucket/rest/intro/#filtering) for valid query and sort parameter values. Note - if you are getting a list across multiple workspaces, only repositories within each workspace will be sorted based on the sort parameter. The final list is an amalgamation of all the sorted lists for each workspace.

 

Publish

publishSource

Publish source to Confluence. When the path represents a directory, all files included in the same file list filtering conditions as getFileList will be published to the page.

Run

Generating content properties report...

Start

Generating content properties report...

Stop

Generating content properties report...

Update

Generating content properties report...

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.