Action usage examples

Examples give users ideas on actual usage. We use automation to generate, test, and run these actions, so names and combinations may be odd or repetitive . In many cases, other actions or environmental setup is required for the action to run, so you will need to adjust the action parameters and setup appropriate for your environment.

Command line environments can be different, especially between Windows and non-Windows systems. Our Tips page talks about command line escaping differences and there are differences with respect to environment variable references ($ for non-Windows and %...% for Windows). These differences can impact examples, so recognize and adjust for your platform. In particular, all examples here are run with the standard bash shell on Linux.

addAccessToken

--action addAccessToken --name "ztokens" --permission "PROJECT_ADMIN, REPO_ADMIN"

--action addAccessToken  --userId "admin"  --name "ztokens"  --permission "PROJECT_READ, REPO_READ"  --user "admin"  --password "***"

addBranch

--action addBranch  --project "zcli"  --repository "zcli-repo"  --branch "add1"  --id "b145862f41c731c8683e1f691bfac80bacf1f1f9"  --message "addBranch action"

--action addBranch  --project "zcli"  --repository "zcli-repo"  --branch "forRemove"  --id "b145862f41c731c8683e1f691bfac80bacf1f1f9"

addBranchRestriction

--action addBranchRestriction  --project "zrestrictions"  --repository "zrestrictions-repo"  --branch "feature1"  --group "group1"

--action addBranchRestriction  --project "zrestrictions"  --repository "zrestrictions-repo"  --replace  --branch "feature1"  --group "group1,   group2"  --userId "user1,user3"

--action addBranchRestriction  --project "zrestrictions"  --repository "zrestrictions-repo"  --restriction "PULL-REQUEST-ONLY"  --branch "master*"  --matchingType "pattern"  --group "group1"

--action addBranchRestriction  --project "zrestrictions"  --repository "zrestrictions-repo"  --restriction "no-deletes"  --branch "HOTFIX"  --matchingType "MODEL"  --group "group1"

--action addBranchRestriction  --project "zrestrictions"  --repository "zrestrictions-repo"  --restriction "no-deletes"  --branch "feature1"  --group "group1"

addGroup

--action addGroup --group "testgroup1" --preserveCase

--action addGroup --group "testgroup2" --preserveCase

addSshKey

--action addSshKey --userId "testuser1" --file "./src/itest/bitbucket/resources/sshkey.rsa.pub"

--action addSshKey --userId "testuser2" --file "-"

addUser

--action addUser --userId "automation" --userEmail "testuser@x.com1"

--action addUser --userId "testuser1" --userFullName "Test User1" --userEmail "testuser@x.com1" --userPassword "***"

--action addUser --userId "testuser2" --userFullName "Test User2" --userEmail "testuser@x.com2" --userPassword "***"

--action addUser --userId "testuser3" --userFullName "Test User3" --userEmail "testuser@x.com3" --userPassword "***"

addUserToGroup

--action addUserToGroup --userId "testuser3" --group "testgroup2" --autoGroup

addWebhook

--action addWebhook  --project "ZCLI"  --repository "zcli-repo"  --name "zwebhooks1"  --url "https://examplegear.com/acli"  --events "repo:comment:added,repo:refs_changed"

--action addWebhook  --project "ZCLI"  --repository "zcli-repo"  --name "zwebhooks1"  --url "https://examplegear.com/acli"  --events "repo:comment:added,repo:refs_changed"  --options "secret=abcdefghi"

--action addWebhook  --project "ZCLI"  --repository "zcli-repo"  --name "zwebhooks2"  --events "repo:comment:added,repo:refs_changed"  --url "https://examplegear.com/acli"  --options "disable"  --options "secret=abcdefghi"

createProject

--action createProject --project "zcli" --name "zcli name" --description "zcli description"

--action createProject --project "zcli2" --public

createPullRequest

--action createPullRequest --project "zcli" --repository "zcli-repo" --name "pr1" --from "zfeature1" --to "master"

--action createPullRequest  --project "zcli"  --repository "zcli-repo"  --name "pr2"  --description "pr2 description"  --from "zfeature2"  --to "master"  --reviewers "user1,user2,user3"

createRepository

--action createRepository --project "zcli" --repository "zcli-repo" --name "zcli-repo"

--action createRepository --project "zcli" --repository "zcli2-repo" --public --forkable

declinePullRequest

--action declinePullRequest --project "zcli" --repository "zcli-repo" --pullRequest "pr1"

getAccessTokenList

--action getAccessTokenList

--action getAccessTokenList --regex "ztokens"

--action getAccessTokenList --userId "admin"

getApp

--action getApp --app "@default"

getApplicationLinkList

--action getApplicationLinkList

getBranch

--action getBranch --project "zcli" --repository "zcli-repo"

getBranchList

--action getBranchList --project "zcli" --repository "zcli-repo"

getBranchRestriction

--action getBranchRestriction --project "zrestrictions" --repository "zrestrictions-repo" --id "1235"

getBranchRestrictionList

--action getBranchRestrictionList --project "zrestrictions" --repository "zrestrictions-repo"

--action getBranchRestrictionList --project "zrestrictions" --repository "zrestrictions-repo" --matchingType "branch"

--action getBranchRestrictionList  --project "zrestrictions"  --repository "zrestrictions-repo"  --regex "(no-deletes)|(read-only)"

getBuildStatusList

--action getBuildStatusList --id "9a44c417d94441be306928e004d4b9d611544229" --dateFormat "yyyy-MM-dd HH:mm:ss"

getClientInfo

--action getClientInfo

getCommitList

--action getCommitList --project "ZCLI" --repository "zcli-repo" --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getCommitList  --project "ZCLI"  --repository "zcli-repo"  --from "9a44c417d94441be306928e004d4b9d611544229"  --to "689f9e50c0ea205d3b3b4e85b4982ed7fc4a1cb4"

--action getCommitList --project "ZCLI" --repository "zcli-repo" --from "master" --to "master"

--action getCommitList  --project "ZCLI"  --repository "zcli-repo"  --startDate "2021-03-30 14:03:43"  --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getCommitList  --project "ZCLI"  --repository "zcli-repo"  --startDate "2021-03-30 14:03:43"  --endDate "2021-03-30 14:03:43"  --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getCommitList  --project "ZCLI"  --repository "zcli-repo"  --userId "automation"  --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getCommitList --project "zcli" --repository "zcli-repo"

getGroupList

--action getGroupList

getHook

--action getHook --project "ZCLI" --repository "zcli-repo" --hook "Reject Force Push"

getHookList

--action getHookList --project "ZCLI" --repository "zcli-repo"

--action getHookList  --project "ZCLI"  --repository "zcli-repo"  --regex "com.atlassian.bitbucket.server.bitbucket-bundled-hooks:verify-committer-hook"  --outputFormat 2

getPermissionList

--action getPermissionList

--action getPermissionList --regex "testuser1"

getProject

--action getProject --project "1161"

--action getProject --project "zcli name"

--action getProject --project "zcli"

--action getProject --project "zcli2"

getProjectList

--action getProjectList

--action getProjectList --permission "PROJECT_ADMIN"

--action getProjectList --permission "PROJECT_VIEW"

--action getProjectList --regex "ZCLI"

--action getProjectList --token "***"

getProjectPermissionList

--action getProjectPermissionList --project "zcli"

--action getProjectPermissionList --project "zcli" --regex "user1"

getPullRequest

--action getPullRequest --project "zcli" --repository "zcli-repo" --pullRequest "2"

--action getPullRequest  --project "zcli"  --repository "zcli-repo"  --pullRequest "pr2"  --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getPullRequest  --project "zcli"  --repository "zcli-repo"  --pullRequest "pr2xxx"  --dateFormat "yyyy-MM-dd HH:mm:ss"

getPullRequestList

--action getPullRequestList --project "zcli" --repository "zcli-repo" --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getPullRequestList  --project "zcli"  --repository "zcli-repo"  --direction "INCOMING"  --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getPullRequestList  --project "zcli"  --repository "zcli-repo"  --direction "outgoing"  --dateFormat "yyyy-MM-dd HH:mm:ss"  --verbose

--action getPullRequestList  --project "zcli"  --repository "zcli-repo"  --regex "NOT_FOUND"  --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getPullRequestList  --project "zcli"  --repository "zcli-repo"  --regex "pr2"  --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getPullRequestList  --project "zcli"  --repository "zcli-repo"  --state "ALL"  --dateFormat "yyyy-MM-dd HH:mm:ss"

--action getPullRequestList  --project "zcli"  --repository "zcli-repo"  --state "MERGED"  --dateFormat "yyyy-MM-dd HH:mm:ss"

getRepository

--action getRepository --project "zcli" --repository "901"

--action getRepository --project "zcli" --repository "zcli-repo updated"

--action getRepository --project "zcli" --repository "zcli-repo"

--action getRepository --project "zcli" --repository "zcli2-repo"

getRepositoryList

--action getRepositoryList --project "zcli"

--action getRepositoryList --project "zcli" --regex "NOT_FOUND"

getRepositoryPermissionList

--action getRepositoryPermissionList --project "zcli" --repository "zcli-repo"

--action getRepositoryPermissionList --project "zcli" --repository "zcli-repo" --regex "user1"

getServerInfo

--action getServerInfo --outputFormat 2 --dateFormat "yyyy-MM-dd HH:mm"

--action getServerInfo --outputFormat 999

--action getServerInfo --user "anonymous"

getSshKeyList

--action getSshKeyList --userId "testuser1"

--action getSshKeyList --userId "testuser1" --regex "xxx"

getUser

--action getUser --dateFormat "yyyy-MM-dd"

--action getUser --userId "testuser1"

--action getUser --userId "testuser3"

getUserList

--action getUserList --dateFormat "yyyy-MM-dd"

--action getUserList --group "testgroup2"

--action getUserList --group "testgroup2" --regex "testuser3"

getWebhookList

--action getWebhookList --project "ZCLI" --repository "zcli-repo" --dateFormat "yyyy-mm-dd"

grantPermissions

--action grantPermissions --permission "ADMIN" --userId "testuser1"

--action grantPermissions --permission "PROJECT_CREATE" --group "testgroup1"

grantProjectPermissions

--action grantProjectPermissions --project "zcli" --permission "PROJECT_ADMIN" --userId "user1"

--action grantProjectPermissions --project "zcli" --permission "PROJECT_READ" --userId "user1,user2,user3"

--action grantProjectPermissions --project "zcli" --permission "PROJECT_WRITE" --group "group1"

--action grantProjectPermissions --project "zcli2" --permission "PROJECT_ADMIN" --userId "user2"

grantRepositoryPermissions

--action grantRepositoryPermissions  --project "zcli"  --repository "zcli-repo"  --permission "REPO_ADMIN"  --userId "user1"

--action grantRepositoryPermissions  --project "zcli"  --repository "zcli-repo"  --permission "REPO_READ"  --userId "user1,user2,user3"

--action grantRepositoryPermissions  --project "zcli"  --repository "zcli-repo"  --permission "REPO_WRITE"  --group "group1"

installApp

--action installApp --app "@default" --simulate

mergePullRequest

--action mergePullRequest --project "zcli" --repository "zcli-repo" --pullRequest "pr2"

removeAccessToken

--action removeAccessToken --userId "admin" --name "684551314733"

removeBranch

--action removeBranch --project "zcli" --repository "zcli-repo" --branch "forRemove"

removeBranchRestriction

--action removeBranchRestriction  --project "zrestrictions"  --repository "zrestrictions-repo"  --branch "master*"  --matchingType "PATTERN"  --continue

--action removeBranchRestriction  --project "zrestrictions"  --repository "zrestrictions-repo"  --branch "master*"  --matchingType "PATTERN"  --restriction "@all"  --continue

--action removeBranchRestriction  --project "zrestrictions"  --repository "zrestrictions-repo"  --id "123456789"  --continue

--action removeBranchRestriction --project "zrestrictions" --repository "zrestrictions-repo" --id "1235"

--action removeBranchRestriction  --project "zrestrictions"  --repository "zrestrictions-repo"  --restriction "pull-request-only"  --branch "master*"  --matchingType "PATTERN"

removeSshKey

--action removeSshKey --id "458"

removeSshKeys

--action removeSshKeys --userId "testuser1"

--action removeSshKeys --userId "testuser2"

removeUserFromGroup

--action removeUserFromGroup --userId "testuser3" --group "testgroup2"

removeWebhook

--action removeWebhook --project "ZCLI" --repository "zcli-repo" --name "zwebhooks1"

revokePermissions

--action revokePermissions --userId "testuser1"

revokeProjectPermissions

--action revokeProjectPermissions --project "zcli" --userId "user1"

revokeRepositoryPermissions

--action revokeRepositoryPermissions --project "zcli" --repository "zcli-repo" --userId "user1"

run

--action run -i "-a getApp --app @default"

--action run      -i "-a getServerInfo --outputFormat 2 --outputType text"  -i "-a getReplacementVariableList  --outputType text"

--action run  --common "--project ZCLI --repository zcli-repo"  --input "-a enableHook  --hook \"Verify Committer\""  --input "-a getHook  --hook \"Verify Committer\""  --input "-a disableHook --hook com.atlassian.bitbucket.server.bitbucket-bundled-hooks:verify-committer-hook"  --input "-a getHook  --hook \"Verify Committer\""

--action run  --common "--project zrestrictions --repository zrestrictions-repo --branch feature2"  --continue  --input "-a addBranchRestriction  --restriction fast-forward-only --group group1,group2 --userId user1,user2 --replace"  --input "-a getBranchRestriction  --id @restrictionId@"  --input "-a updateBranchRestriction --id @restrictionId@ --group group1 --options remove"  --input "-a getBranchRestriction  --id @restrictionId@"  --input "-a updateBranchRestriction --id @restrictionId@ --group group2 --userId user2 --options remove"  --input "-a getBranchRestriction  --id @restrictionId@"

--action run  --common "--project zrestrictions --repository zrestrictions-repo --branch feature2"  --continue  --input "-a addBranchRestriction  --restriction no-deletes --group group2 --userId user1,user2 --replace"  --input "-a getBranchRestriction  --id @restrictionId@"  --input "-a updateBranchRestriction --id @restrictionId@ --group group1 --replace"  --input "-a getBranchRestriction  --id @restrictionId@"  --input "-a updateBranchRestriction --id @restrictionId@ --group \"\" --userId \"\" --replace"  --input "-a getBranchRestriction  --id @restrictionId@"

--action run  --common "--project zrestrictions --repository zrestrictions-repo --branch feature2"  --continue  --input "-a addBranchRestriction  --restriction pull-request-only --replace"  --input "-a getBranchRestriction  --id @restrictionId@"  --input "-a updateBranchRestriction --id @restrictionId@ --group group1,group2"  --input "-a getBranchRestriction  --id @restrictionId@"  --input "-a updateBranchRestriction --id @restrictionId@ --userId user1,user2"  --input "-a getBranchRestriction  --id @restrictionId@"

--action run --file "./src/itest/bitbucket/resources/run.txt"

--action run --file "./src/itest/bitbucket/resources/runWithFindReplace.txt" --findReplace "##action##:getServerInfo"

--action run  --input "-a updateWebhook --project ZCLI --repository zcli-repo --name zwebhooks2 --options secret="  --input "-a getReplacementVariableList --outputType text"  --input "-a getWebhookList --project ZCLI --repository zcli-repo --regex zwebhooks2 --dateFormat yyyy-mm-dd"  --input "-a getWebhookList --project ZCLI --repository zcli-repo --dateFormat yyyy-mm-dd --outputType text --columns -5,6"

--action run --input "upm -a getAppList --token MDI5MzI0OTM4MjU3OkYZqASARHgMVrPrzjgjkL33xwFu"

--action run --token "***" --input "upm -a getAppList"

runFromBranchList

--action runFromBranchList  --project "zcli"  --repository "zcli-repo"  --common "-a getBranch --project zcli --repository zcli-repo --branch @branch@"

--action runFromBranchList  --project "zcli"  --repository "zcli-repo"  --order "Alphabetical"  --common "-a getBranch --project zcli --repository zcli-repo --branch @branch@"

runFromBranchRestrictionList

--action runFromBranchRestrictionList  --project "zrestrictions"  --repository "zrestrictions-repo"  --common "--action getBranchRestriction --project zrestrictions --repository zrestrictions-repo --id @restrictionId@"

runFromCommitList

--action runFromCommitList  --project "ZCLI"  --repository "zcli-repo"  --dateFormat "yyyy-MM-dd HH:mm:ss"  --common "--action getCommit --project @project@ --repository @repository@ --id @commitId@ --dateFormat \"yyyy-MM-dd HH:mm:ss\" "

runFromGroupList

--action runFromGroupList --limit 1 --common "-a getUserList --group @group@" --regex "testgroup2"

runFromList

--action runFromList --list "Client, Server" --common "-a get@entry@Info"

--action runFromList --list "org.*,com.*" --regex "@entry@" --common "-a getAppList --regex \"@entry@\""

runFromProjectList

--action runFromProjectList --common "-a getProject --project \"@project@\"" --regex "EXPERIMENT" --continue

--action runFromProjectList --common "-a getProject --project \"@projectId@\"" --continue --regex "EXPERIMENT"

--action runFromProjectList --permission "PROJECT_ADMIN" --common "--action getProject --project @project@"

runFromRepositoryList

--action runFromRepositoryList  --project "@all"  --common "-a getRepository --project @projectId@ --repository @repositoryId@"

--action runFromRepositoryList  --project "@all"  --common "-a getRepository --project @projectId@ --repository @repositoryId@"  --limit 1

--action runFromRepositoryList  --project "EXPERIMENT"  --common "-a getRepository --project @project@ --repository \"@repository@\""  --continue

--action runFromRepositoryList  --project "EXPERIMENT"  --common "-a getRepository --project @projectId@ --repository \"@repositoryId@\""  --continue  --regex "ex1"

runFromUserList

--action runFromUserList  --group "testgroup2"  --input "-a getUser --userId \"@userId@\""  --input "-a getUser --userId @userKey@"  --input "-a getUser --userId \"@userDisplayName@\""

--action runFromUserList  --input "-a getUser --userId \"@userId@\""  --input "-a getUser --userId @userKey@"  --input "-a getUser --userId \"@userDisplayName@\""

runFromWebhookList

--action runFromWebhookList  --project "ZCLI"  --repository "zcli-repo"  --regex "zwebhooks1.*"  --common "-a removeWebhook --project ZCLI --repository zcli-repo --id @webhookId@"

setBuildStatus

--action setBuildStatus  --id "9a44c417d94441be306928e004d4b9d611544229"  --state "INPROGRESS"  --key "myKey"  --url "http://xxx"

--action setBuildStatus  --id "9a44c417d94441be306928e004d4b9d611544229"  --state "successful"  --key "myKey"  --url "http://xxx"

updateProject

--action updateProject --project "zcli" --name "zcli name updated"

--action updateProject --project "zcli2" --private

updatePullRequest

--action updatePullRequest --project "zcli" --repository "zcli-repo" --pullRequest "pr2" --name "pr2xxx"

--action updatePullRequest --project "zcli" --repository "zcli-repo" --pullRequest "pr2xxx" --name "pr2"

updateRepository

--action updateRepository --project "zcli" --repository "zcli-repo updated" --name "zcli-repo"

--action updateRepository --project "zcli" --repository "zcli-repo" --name "zcli-repo updated"

--action updateRepository --project "zcli" --repository "zcli2-repo" --private --notForkable

updateUser

--action updateUser --userId "testuser1" --userEmail "former.employee.testuser@x.com1"

--action updateUser --userId "testuser1" --userFullName "Test User1" --userEmail "testuser@x.com1"

updateWebhook

--action updateWebhook  --project "ZCLI"  --repository "zcli-repo"  --id "269"  --url "https://examplegear.com/acli2"  --name "zwebhooks1updated"  --events "repo:comment:added,repo:refs_changed"  --options "disable"

--action updateWebhook  --project "ZCLI"  --repository "zcli-repo"  --name "zwebhooks2"  --events "repo:refs_changed"  --options "enable"

validateLicense

--action validateLicense