Bitbucket
Learn how to use Bitbucket with Composio
Overview
Enum
BITBUCKET
Description
Bitbucket is a Git-based code hosting and collaboration platform supporting private and public repositories, enabling teams to manage and review code through pull requests and integrations
Authentication Details
OAUTH2
Actions
BITBUCKET_DELETE_A_WEBHOOK_FOR_A_REPOSITORY
Deletes the specified webhook subscription from the given repository.
Action Parameters
Action Response
BITBUCKET_LIST_A_PULL_REQUEST_ACTIVITY_LOG
The handler provides a paginated pull request activity log, offering comments, updates, and approvals via v20, and adds tasks and attachments for internal use. comments on code are marked ‘inline’.
Action Parameters
Action Response
BITBUCKET_LIST_COMMITS_FOR_REVISION_USING_INCLUDE_EXCLUDE
The post method for get /repositories/
{workspace}/
{repo_slug}/commits/
{revision}“ lets clients use the request body for include and exclude parameters, avoiding url length problems. it doesn’t support creating new commits.
Action Parameters
Action Response
BITBUCKET_GET_A_COMMIT_APPLICATION_PROPERTY
Retrieve an application property value stored against a commit.
Action Parameters
Action Response
BITBUCKET_CREATE_A_BRANCH_RESTRICTION_RULE
Introduces branch restriction rules for actions like push
and delete
with matching via glob
patterns or the branching model. specific users/groups for restrictions, with each unique blend allowed but overlapping may cause unpredictable behavior.
Action Parameters
Action Response
BITBUCKET_GET_A_PULL_REQUEST
Returns the specified pull request.
Action Parameters
Action Response
BITBUCKET_DELETE_A_COMMENT_ON_A_SNIPPET
Deletes a snippet comment. comments can only be removed by the comment author, snippet creator, or workspace admin.
Action Parameters
Action Response
BITBUCKET_APPROVE_A_COMMIT
The operation allows the authenticated user to approve a commit, but only if they have explicit repository access. public access does not grant approval capabilities.
Action Parameters
Action Response
BITBUCKET_CREATE_OR_UPDATE_A_REPORT
This text describes how to create or update a bitbucket commit report using a unique id to prevent collisions. it outlines using a curl command to upload reports with data fields like security and failed, and discusses formatting for display.
Action Parameters
Action Response
BITBUCKET_GET_SSH_KEY_PAIR
Retrieve the repository ssh key pair excluding the ssh private key. the private key is a write only field and will never be exposed in the logs or the rest api.
Action Parameters
Action Response
BITBUCKET_LIST_EXECUTIONS_OF_A_SCHEDULE
Retrieve the executions of a given schedule.
Action Parameters
Action Response
BITBUCKET_CREATE_A_COMMENT_ON_A_PULL_REQUEST
Creates a new pull request comment. returns the newly created pull request comment.
Action Parameters
Action Response
BITBUCKET_UPLOAD_AN_ATTACHMENT_TO_AN_ISSUE
Upload new issue attachments. to upload files, perform a multipart/form-data
post containing one or more file fields. when a file is uploaded with the same name as an existing attachment, then the existing file will be replaced.
Action Parameters
Action Response
BITBUCKET_LIST_DOWNLOAD_ARTIFACTS
Returns a list of download links associated with the repository.
Action Parameters
Action Response
BITBUCKET_LIST_BRANCHES_AND_TAGS
The text explains a function for listing version control system branches and tags, akin to “git show-ref”, but faces sorting issues, where ‘branch10’ precedes ‘branch2’. using “?sort=name” in bitbucket offers a more natural sort order.
Action Parameters
Action Response
BITBUCKET_CREATE_AN_ENVIRONMENT
Create an environment.
Action Parameters
Action Response
BITBUCKET_GET_A_COMMIT
Returns the specified commit.
Action Parameters
Action Response
BITBUCKET_GET_A_MILESTONE
Returns the specified issue tracker milestone object.
Action Parameters
Action Response
BITBUCKET_LIST_SNIPPETS_IN_A_WORKSPACE
Identical to /snippets
, except that the result is further filtered by the snippet owner and only those that are owned by {workspace}
are returned.
Action Parameters
Action Response
BITBUCKET_GET_A_SUMMARY_OF_TEST_REPORTS_FOR_A_GIVEN_STEP_OF_A_PIPELINE
Obtain a summary of test reports for a specific step in a pipeline by providing workspace id or uuid, repository slug, pipeline uuid, and step uuid. supports oauth2, basic auth, and api key methods.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_COMMENT_ON_AN_ISSUE
This technique updates a bitbucket issue comment by modifying its content.raw
field using a put request.
Action Parameters
Action Response
BITBUCKET_GET_THE_BRANCHING_MODEL_FOR_A_PROJECT
The text describes a read-only project-level branching model, changeable via an api. it includes a guaranteed ‘development’ property, an optional ‘production’ property, and an array of enabled ‘branch types’.
Action Parameters
Action Response
BITBUCKET_LIST_SSH_KEYS
Returns a paginated list of the user’s ssh public keys.
Action Parameters
Action Response
BITBUCKET_LIST_PULL_REQUESTS
The endpoint fetches repository pull requests, mainly open ones, but can filter by state (allowing multiples) and supports sorting and filtering. for details, see bitbucket’s documentation on filtering and sorting.
Action Parameters
Action Response
BITBUCKET_GET_A_SSH_KEY
Returns a specific ssh public key belonging to a user.
Action Parameters
Action Response
BITBUCKET_GET_A_SNIPPET_S_RAW_FILE_AT_HEAD
Convenience resource for getting to a snippet’s raw files without the need for first having to retrieve the snippet itself and having to pull out the versioned file links.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_SSH_KEY
Updates the comment of an ssh public key on a user’s bitbucket account. key or comment changes require deletion and re-adding of the key. example provided for updating via api.
Action Parameters
Action Response
BITBUCKET_FORK_A_REPOSITORY
To fork a bitbucket repo, send a post request including workspace & new name. access as a contributor is needed. you can customize the fork’s properties except for scm
, parent
, and full name
.
Action Parameters
Action Response
BITBUCKET_REMOVE_THE_SPECIFIC_USER_FROM_THE_PROJECT_S_DEFAULT_REVIEWERS
Removes a default reviewer from the project. example: \$ curl https://api.bitbucket.org/2.0/.../default-reviewers/\%7bf0e0e8e9-66c1-4b85-a784-44a9eb9ef1a6\%7d http/1.1 204
Action Parameters
Action Response
BITBUCKET_GET_SNIPPET_CHANGES_BETWEEN_VERSIONS
Diffs display changes between a commit and its parent with filters and merge views, similar to pull requests, whereas patches detail commits but handle merges differently. diff encoding is impacted by git limitations.
Action Parameters
Action Response
BITBUCKET_GET_THE_ROOT_DIRECTORY_OF_THE_MAIN_BRANCH
This endpoint allows clients to be redirected to a root directory listing on the main branch of a repository, equivalent to accessing a specific path without needing the main branch’s name or sha1. new commits can be created by posting to a provided url.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_REPOSITORY_DEPLOY_KEY
To add a new deploy key to a repository on bitbucket, use a put request with curl, including the authorization header, content type, repository url, and data with the new label and unchanged key.
Action Parameters
Action Response
BITBUCKET_CHECK_ISSUE_EXPORT_STATUS
This endpoint checks the progress of an issue export job, returning a 202 response (with current status) while running, and a 200 response indicating ‘success’ or ‘failure’ upon completion.
Action Parameters
Action Response
BITBUCKET_ADD_THE_SPECIFIC_USER_AS_A_DEFAULT_REVIEWER_FOR_THE_PROJECT
Adds the specified user to the project’s list of default reviewers. the method is idempotent. accepts an optional body containing the uuid
of the user to be added.
Action Parameters
Action Response
BITBUCKET_GET_REASONS_FOR_TEST_CASE_IN_PIPELINE_STEP
Get reasons (output) for a specific test case in a pipeline step, requiring workspace id, repo slug, pipeline, step, and test case uuids. supports oauth2, basic auth, and api key.
Action Parameters
Action Response
BITBUCKET_GET_THE_DIFF_STAT_FOR_A_PULL_REQUEST
Redirects to the repository diffstat with the revspec that corresponds to the pull request.
Action Parameters
Action Response
BITBUCKET_LIST_CHANGES_IN_A_PULL_REQUEST
Redirects to the repository diff with the revspec that corresponds to the pull request.
Action Parameters
Action Response
BITBUCKET_GET_THE_BRANCHING_MODEL_FOR_A_REPOSITORY
The repository’s branching model is readonly; it shows development and optionally production branches and enabled branch types. changes can be made via the settings api.
Action Parameters
Action Response
BITBUCKET_STOP_A_PIPELINE
Signal the stop of a pipeline and all of its steps that not have completed yet.
Action Parameters
Action Response
BITBUCKET_LIST_TASKS_ON_A_PULL_REQUEST
Returns a paginated list of the pull request’s tasks. this endpoint supports filtering and sorting of the results by the ‘task’ field. see filtering and sorting for more details.
Action Parameters
Action Response
BITBUCKET_LIST_A_REPOSITORY_PERMISSIONS_FOR_A_WORKSPACE
Returns an object listing each user’s highest permission level in a repository, accessible only by users with admin rights. permissions include admin, write, read, and results can be filtered or sorted by user or permission.
Action Parameters
Action Response
BITBUCKET_CREATE_A_BRANCH
To create a new branch in a bitbucket repository, send a post request with json containing the branch’s name and the commit’s hash. authentication is required, and using a full commit hash is recommended to avoid errors.
Action Parameters
Action Response
BITBUCKET_LIST_REPOSITORY_FORKS
Returns a paginated list of all the forks of the specified repository.
Action Parameters
Action Response
BITBUCKET_LIST_SNIPPETS
The text describes filtering user-accessible content like pull requests using ?role=
parameter by ownership/collaboration across workspaces, including accessing public/private snippets, outputting a paginated json list.
Action Parameters
Action Response
BITBUCKET_REMOVE_VOTE_FOR_AN_ISSUE
Retract your vote.
Action Parameters
Action Response
BITBUCKET_DELETE_A_BRANCH
Delete a branch in the specified repository. the main branch is not allowed to be deleted and will return a 400 response. the branch name should not include any prefixes (e.g. refs/heads).
Action Parameters
Action Response
BITBUCKET_LIST_REPOSITORIES_IN_A_WORKSPACE
This api endpoint returns a paginated list of repositories owned by a specified workspace, filterable by the authenticated user’s role (e.g., contributor) to display repositories they have write access to. it also offers filtering and sorting options.
Action Parameters
Action Response
BITBUCKET_GET_A_DEFAULT_REVIEWER_FOR_WORKSPACE
Returns the specified default reviewer.
Action Parameters
Action Response
BITBUCKET_DELETE_ALL_LINKER_VALUES
Delete all linker values for the specified linker of the authenticated application.
Action Parameters
Action Response
BITBUCKET_CREATE_A_VARIABLE_FOR_A_USER
Create a user level variable. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_LIST_SCHEDULES
Retrieve the configured schedules for the given repository.
Action Parameters
Action Response
BITBUCKET_LIST_REPOSITORY_DEPLOY_KEYS
Returns all deploy-keys belonging to a repository.
Action Parameters
Action Response
BITBUCKET_UPDATE_AN_EXPLICIT_GROUP_PERMISSION_FOR_A_REPOSITORY
Updates or grants new group permissions for repository access. access limited to users with admin permissions, authenticated via app passwords. permissions include admin, write, and read.
Action Parameters
Action Response
BITBUCKET_ADD_A_USER_TO_THE_DEFAULT_REVIEWERS
Adds the specified user to the repository’s list of default reviewers. this method is idempotent. adding a user a second time has no effect.
Action Parameters
Action Response
BITBUCKET_UPDATE_AN_EXPLICIT_USER_PERMISSION_FOR_A_PROJECT
Updates user permissions within a project, ensuring the user is a workspace member but not the owner. only project admins can update permissions, excluding jwt and oauth authentication. permissions include admin, create-repo, write, and read.
Action Parameters
Action Response
BITBUCKET_GET_A_TAG
The tag 3.8 in sean farley’s bitbucket hg repository includes links to commits, its details, and tagger info (matt mackall). the tag was added for changeset f85de28 on 2016-05-01, with related links and author details provided.
Action Parameters
Action Response
BITBUCKET_CREATE_A_TAG
The text explains how to create a new tag in a bitbucket repository using a post request with json data that includes the tag name and target commit hash. it notes using a full hash is preferred to avoid errors.
Action Parameters
Action Response
BITBUCKET_DELETE_AN_ENVIRONMENT
Delete an environment
Action Parameters
Action Response
BITBUCKET_CREATE_A_REPOSITORY
To make a new bitbucket repository, add the project key/uuid in the request. without it, the repo goes to the oldest workspace project. replace teamsinspace
and hablanding
in the curl examples provided.
Action Parameters
Action Response
BITBUCKET_REMOVE_A_USER_FROM_THE_DEFAULT_REVIEWERS
Removes a default reviewer from the repository.
Action Parameters
Action Response
BITBUCKET_GET_A_REPOSITORY_DEPLOY_KEY
Returns the deploy key belonging to a specific key.
Action Parameters
Action Response
BITBUCKET_REQUEST_CHANGES_FOR_A_PULL_REQUEST
This endpoint allows for pull request changes in a specific repository, supporting oauth2, basic auth, and api keys. it returns a participant object for successful requests or errors for issues like invalid authentication or non-existent/merged prs.
Action Parameters
Action Response
BITBUCKET_DELETE_A_WEBHOOK_FOR_A_WORKSPACE
Deletes the specified webhook subscription from the given workspace.
Action Parameters
Action Response
BITBUCKET_GET_A_PROJECT_FOR_A_WORKSPACE
Returns the requested project.
Action Parameters
Action Response
BITBUCKET_GET_A_VARIABLE_FOR_A_USER
Retrieve a user level variable. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_REOPEN_A_COMMENT_THREAD
Authenticated users can reopen resolved top-level comments in a pull request by deleteing to a specific url. success returns 204, access issues or reopening non-top-level comments return 403, and invalid comments return 404.
Action Parameters
Action Response
BITBUCKET_CREATE_A_WEBHOOK_FOR_A_WORKSPACE
Creates a new webhook for all repos in a bitbucket workspace, triggering on specified events. requires webhook
, repository
, and issue
scopes. only workspace owners can install it. the secret key for hmac validation is optional.
Action Parameters
Action Response
BITBUCKET_GET_THE_PATCH_FOR_A_PULL_REQUEST
Redirects to the repository patch with the revspec that corresponds to pull request.
Action Parameters
Action Response
BITBUCKET_LIST_USERS_IN_A_WORKSPACE
Returns all members of the requested workspace.
Action Parameters
Action Response
BITBUCKET_DELETE_A_PULL_REQUEST_APPLICATION_PROPERTY
Delete an application property value stored against a pull request.
Action Parameters
Action Response
BITBUCKET_LIST_TAGS
By default, tags in a repository are listed in lexical order, leading to unintuitive sorting (e.g., “v9” after “v11”). applying the ?sort= query parameter enables natural, numerical sorting.
Action Parameters
Action Response
BITBUCKET_LIST_PROJECT_DEPLOY_KEYS
Returns all deploy keys belonging to a project.
Action Parameters
Action Response
BITBUCKET_CREATE_OR_UPDATE_AN_ANNOTATION
This text guides on creating/updating annotations for reports, indicating vulnerabilities in code. annotations, which can detail files/lines, are optional with a maximum of 1000 per report and need a unique id for management.
Action Parameters
Action Response
BITBUCKET_GET_A_PIPELINE
Retrieve a specified pipeline
Action Parameters
Action Response
BITBUCKET_GET_A_SNIPPET
The text discusses retrieving snippets in different formats: application/json (default, contains file links, requires n+1 requests for n files), multipart/related (single response with all files), and multipart/form-data (simpler, omits nested elements).
Action Parameters
Action Response
BITBUCKET_LIST_EXPLICIT_USER_PERMISSIONS_FOR_A_REPOSITORY
Returns a paginated list of explicit user permissions for the given repository. this endpoint does not support bbql features.
Action Parameters
Action Response
BITBUCKET_LIST_BRANCH_RESTRICTIONS
Returns a paginated list of all branch restrictions on the repository.
Action Parameters
Action Response
BITBUCKET_LIST_ALL_REPOSITORY_PERMISSIONS_FOR_A_WORKSPACE
The text outlines a system for managing repository permissions in a workspace, exclusive to admin users, and includes admin, write, and read permissions with sorting/filtering options by repository, user, or permission.
Action Parameters
Action Response
BITBUCKET_GET_TEST_CASES_FOR_A_GIVEN_STEP_OF_A_PIPELINE
Fetch test case details for a specific pipeline step in a repository, requiring workspace, repo slug, pipeline, and step uuids. supports oauth2, basic auth, and api key. responses include test cases or error details.
Action Parameters
Action Response
BITBUCKET_DELETE_A_LINKER_VALUE
Delete a single linker value of the authenticated application.
Action Parameters
Action Response
BITBUCKET_LIST_VARIABLES_FOR_A_REPOSITORY
Find repository level variables.
Action Parameters
Action Response
BITBUCKET_GET_A_LINKER_VALUE
Get a single linker value of the authenticated application.
Action Parameters
Action Response
BITBUCKET_CREATE_A_VARIABLE_FOR_A_REPOSITORY
Create a repository level variable.
Action Parameters
Action Response
BITBUCKET_DELETE_A_COMMENT_ON_A_PULL_REQUEST
Deletes a specific pull request comment.
Action Parameters
Action Response
BITBUCKET_UPDATE_VARIABLE_FOR_A_WORKSPACE
Update a workspace level variable.
Action Parameters
Action Response
BITBUCKET_GET_A_REPORT
Returns a single report matching the provided id.
Action Parameters
Action Response
BITBUCKET_SEARCH_FOR_CODE_IN_A_WORKSPACE
Search for code in a workspace by matching content or path using ui syntax. specify repositories with search query
and request additional info with fields
. example queries provided.
Action Parameters
Action Response
BITBUCKET_COMPARE_TWO_COMMIT_DIFF_STATS
The api tracks changes in paths for each commit, detailing modifications and line edits. it supports comparing a single commit or two, influenced by the ‘topic’ query parameter.
Action Parameters
Action Response
BITBUCKET_GET_AN_ANNOTATION
Returns a single annotation matching the provided id.
Action Parameters
Action Response
BITBUCKET_GET_A_PULL_REQUEST_APPLICATION_PROPERTY
Retrieve an application property value stored against a pull request.
Action Parameters
Action Response
BITBUCKET_LIST_EXPLICIT_GROUP_PERMISSIONS_FOR_A_REPOSITORY
Returns a paginated list of explicit group permissions for the given repository. this endpoint does not support bbql features.
Action Parameters
Action Response
BITBUCKET_LIST_WORKSPACES_FOR_USER
Authenticated users can access workspaces list, filter/sort by workspace/permission with queries (slug
, is private
) and sort
. important: collaborator
role removed from bitbucket api. more on deprecation at atlassian’s site.
Action Parameters
Action Response
BITBUCKET_DELETE_AN_EXPLICIT_GROUP_PERMISSION_FOR_A_PROJECT
Deletes the project group permission between the requested project and group, if one exists. only users with admin permission for the project may access this resource.
Action Parameters
Action Response
BITBUCKET_DELETE_A_REPORT
Deletes a single report matching the provided id.
Action Parameters
Action Response
BITBUCKET_DELETE_AN_EXPLICIT_USER_PERMISSION_FOR_A_REPOSITORY
Deletes the repository user permission between the requested repository and user, if one exists. only users with admin permission for the repository may access this resource. the only authentication method for this endpoint is via app passwords.
Action Parameters
Action Response
BITBUCKET_STOP_WATCHING_A_SNIPPET
Used to stop watching a specific snippet. returns 204 (no content) to indicate success.
Action Parameters
Action Response
BITBUCKET_GET_CURRENT_BRANCHING_MODEL
This endpoint gets the branching model for a repository, detailing branch types and dev/production specifics. it supports oauth2, basic, and api key authentication, with a json response of branch settings and metadata.
Action Parameters
Action Response
BITBUCKET_RETRIEVE_BUILD_OR_SERVICE_LOGS_FOR_STEP
Retrieve the log file for a build container or service container. this endpoint supports (and encourages!) the use of http range requests to deal with potentially very large log files.
Action Parameters
Action Response
BITBUCKET_APPROVE_A_PULL_REQUEST
Approve the specified pull request as the authenticated user.
Action Parameters
Action Response
BITBUCKET_GET_AN_EXPLICIT_USER_PERMISSION_FOR_A_PROJECT
Returns the explicit user permission for a given user and project. only users with admin permission for the project may access this resource. permissions can be: * admin
* create-repo
* write
* read
* none
Action Parameters
Action Response
BITBUCKET_GET_A_LINKER_FOR_AN_APP
Gets a linker specified by linker key
for the authenticated application.
Action Parameters
Action Response
BITBUCKET_LIST_ENVIRONMENTS
Find environments
Action Parameters
Action Response
BITBUCKET_LIST_COMMIT_STATUSES_FOR_A_PULL_REQUEST
Returns all statuses (e.g. build results) for the given pull request.
Action Parameters
Action Response
BITBUCKET_LIST_OPEN_BRANCHES
Summarize bitbucket branches: lists open branches in a repository, supports filtering and sorting (e.g., by name with “stab”). uses default lexical order or ?q= for natural sorting via api.
Action Parameters
Action Response
BITBUCKET_VOTE_FOR_AN_ISSUE
Vote for this issue. to cast your vote, do an empty put. the 204 status code indicates that the operation was successful.
Action Parameters
Action Response
BITBUCKET_WATCH_AN_ISSUE
Start watching this issue. to start watching this issue, do an empty put. the 204 status code indicates that the operation was successful.
Action Parameters
Action Response
BITBUCKET_DELETE_AN_ISSUE
Deletes the specified issue. this requires write access to the repository.
Action Parameters
Action Response
BITBUCKET_GET_THE_MERGE_TASK_STATUS_FOR_A_PULL_REQUEST
After a slow pull request merge, a task id and 202 status are given for status checks via api. responses include pending, success, or error states, with relevant links and details.
Action Parameters
Action Response
BITBUCKET_GET_THE_COMMON_ANCESTOR_BETWEEN_TWO_COMMITS
Returns the best common ancestor between two commits, specified in a revspec of 2 commits (e.g. 3a8b42..9ff173). if more than one best common ancestor exists, only one will be returned. it is unspecified which will be returned.
Action Parameters
Action Response
BITBUCKET_DELETE_CACHES
Delete repository cache versions by name.
Action Parameters
Action Response
BITBUCKET_DELETE_A_CACHE
Delete a repository cache.
Action Parameters
Action Response
BITBUCKET_LIST_KNOWN_HOSTS
Find repository level known hosts.
Action Parameters
Action Response
BITBUCKET_LIST_COMPONENTS
Returns the components that have been defined in the issue tracker. this resource is only available on repositories that have the issue tracker enabled.
Action Parameters
Action Response
BITBUCKET_LIST_WEBHOOKS_FOR_A_REPOSITORY
Returns a paginated list of webhooks installed on this repository.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_VARIABLE_FOR_A_USER
Update a user level variable. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_GET_ISSUE_CHANGE_OBJECT
Returns the specified issue change object. this resource is only available on repositories that have the issue tracker enabled.
Action Parameters
Action Response
BITBUCKET_SEARCH_FOR_CODE_IN_A_TEAM_S_REPOSITORIES
Search code in team repositories by matching text, path, or both. use ui syntax for queries, adjustable with search query
for specifics and fields
for additional details.
Action Parameters
Action Response
BITBUCKET_CHECK_ISSUE_IMPORT_STATUS
This endpoint tracks the status of import tasks: initially a 202 accepted
, then a 202 started
with progress, and finally a 200 indicating success
or failure
.
Action Parameters
Action Response
BITBUCKET_UPLOAD_A_DOWNLOAD_ARTIFACT
Upload files to bitbucket by performing a multipart/form-data
post with files
fields. use curl with authentication. uploading a file with an existing name replaces it.
Action Parameters
Action Response
BITBUCKET_CREATE_A_TASK_ON_A_PULL_REQUEST
The text describes functionality for creating a new pull request task in bitbucket which can be linked to a specific comment by its id, causing the task to appear under the comment in the pull request view.
Action Parameters
Action Response
BITBUCKET_LIST_COMMITS_ON_A_PULL_REQUEST
Returns a paginated list of the pull request’s commits. these are the commits that are being merged into the destination branch when the pull requests gets accepted.
Action Parameters
Action Response
BITBUCKET_DELETE_A_COMMENT_ON_AN_ISSUE
Deletes the specified comment.
Action Parameters
Action Response
BITBUCKET_DELETE_AN_APP
This endpoint allows bitbucket connect apps to delete an app installation using jwt authentication, not needed for apps updated via the bitbucket marketplace ui.
Action Parameters
Action Response
BITBUCKET_GET_A_PREVIOUS_REVISION_OF_A_SNIPPET
This endpoint fetches an older revision of a snippet’s contents, unlike /snippets/encoded id
, which returns the current version. only the file contents are versioned, not the meta data. otherwise, both endpoints work the same.
Action Parameters
Action Response
BITBUCKET_GET_A_DEFAULT_REVIEWER_FOR_REPOSITORY
Returns the specified reviewer. this can be used to test whether a user is among the repository’s default reviewers list. a 404 indicates that that specified user is not a default reviewer.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_COMMIT_COMMENT
This command updates a comment’s content in a bitbucket repository using curl with a put request, modifying the comment to “one more actually thing!” with json data.
Action Parameters
Action Response
BITBUCKET_GET_A_BRANCH
This call retrieves a branch object from a repository, needing authentication and proper authorization for private repositories. it functions without prefixes like “refs/heads” for the branch name in git.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_PULL_REQUEST
Mutates the specified pull request. this can be used to change the pull request’s branches or description. only open pull requests can be mutated.
Action Parameters
Action Response
BITBUCKET_DELETE_A_REPOSITORY_DEPLOY_KEY
This deletes a deploy key from a repository.
Action Parameters
Action Response
BITBUCKET_CREATE_A_COMMENT_ON_A_SNIPPET
Creates a new comment. the only required field in the body is content.raw
. to create a threaded reply to an existing comment, include parent.id
.
Action Parameters
Action Response
BITBUCKET_LIST_PULL_REQUESTS_FOR_A_USER
Returns pull requests by a specific user, defaulting to open ones. use the state
parameter to filter by state and supports sorting and filtering. see documentation for more on filtering/sorting.
Action Parameters
Action Response
BITBUCKET_CREATE_AN_ISSUE
This function allows creating a new issue, requiring user authentication. it works for private repositories/issues if the user has the necessary permissions. the authenticated user becomes the issue’s reporter.
Action Parameters
Action Response
BITBUCKET_ADD_A_REPOSITORY_DEPLOY_KEY
Create a new deploy key for a repository. changing the oauth consumer that authenticates the deploy key will invalidate it. example provided for deploying a key via curl command.
Action Parameters
Action Response
BITBUCKET_DELETE_A_COMMIT_COMMENT
Deleting a commit comment marks it as ‘deleted’ and blanks out the content without removing it from the comment tree or endpoints, maintaining the integrity of comment threads.
Action Parameters
Action Response
BITBUCKET_GET_A_COMMENT_ON_AN_ISSUE
Returns the specified issue comment object.
Action Parameters
Action Response
BITBUCKET_CREATE_A_PROJECT_DEPLOY_KEY
Add a new deploy key to a bitbucket project via a curl post request, including authorization and the key details in the json payload.
Action Parameters
Action Response
BITBUCKET_RETRIEVE_THE_INHERITANCE_STATE_FOR_REPOSITORY_SETTINGS
The get /repositories/
{workspace}/
{repo_slug}/override-settings
endpoint fetches a repo’s setting inheritance status, needing repository:admin
permission. it returns the settings state or 404 if the repo is missing.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_USER_APPLICATION_PROPERTY
Update an application property value stored against a user.
Action Parameters
Action Response
BITBUCKET_DELETE_AN_ATTACHMENT_FOR_AN_ISSUE
Deletes an attachment.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_WEBHOOK_FOR_A_REPOSITORY
The text outlines how to update a webhook subscription, including changes to its description, url, secret, and event subscriptions. secrets can be updated or removed by setting a new value or null
.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_REPOSITORY_APPLICATION_PROPERTY
Update an application property value stored against a repository.
Action Parameters
Action Response
BITBUCKET_CREATE_COMMENT_FOR_A_COMMIT
This text explains how to create a new comment on a specific commit in bitbucket or reply to an existing comment by including the parent.id
field, using a curl
command example.
Action Parameters
Action Response
BITBUCKET_GET_AN_EXPLICIT_USER_PERMISSION_FOR_A_REPOSITORY
Returns the explicit user permission for a given user and repository. only users with admin permission for the repository may access this resource. permissions can be: * admin
* write
* read
* none
Action Parameters
Action Response
BITBUCKET_DECLINE_A_PULL_REQUEST
Declines the pull request.
Action Parameters
Action Response
BITBUCKET_LIST_EFFECTIVE_DEFAULT_REVIEWERS
The text discusses the repository’s default reviewers, including those set at the repository level and inherited from the project, who are automatically added as reviewers on all new pull requests.
Action Parameters
Action Response
BITBUCKET_WATCH_A_SNIPPET
Used to start watching a specific snippet. returns 204 (no content).
Action Parameters
Action Response
BITBUCKET_LIST_PUBLIC_REPOSITORIES
Returns a paginated list of all public repositories. this endpoint also supports filtering and sorting of the results. see filtering and sorting for more details.
Action Parameters
Action Response
BITBUCKET_GET_A_SNIPPET_S_RAW_FILE
The text outlines a secure method to retrieve raw file data using the “content-disposition: attachment” header, while the “content-type” header specifies the file’s mime type based on its name, excluding text file character encoding.
Action Parameters
Action Response
BITBUCKET_CREATE_A_SNIPPET
This text guides on creating snippets in bitbucket, accommodating text and binary files. snippets are made via multipart/form-data
or multipart/related
for advanced settings, with visibility set by the is private
flag.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_BRANCH_RESTRICTION_RULE
Updates an existing branch restriction rule. fields not present in the request body are ignored. see post
for details.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_PREVIOUS_REVISION_OF_A_SNIPPET
This endpoint updates the newest snippet version, rejects older ones with a 405 error, and operates as a “compare and swap” (cas) mechanism to prevent concurrent edits, mirroring the unrestricted update feature.
Action Parameters
Action Response
BITBUCKET_DELETE_A_TAG
Delete a tag in the specified repository. the tag name should not include any prefixes (e.g. refs/tags).
Action Parameters
Action Response
BITBUCKET_UPDATE_A_COMMENT_ON_A_PULL_REQUEST
Updates a specific pull request comment.
Action Parameters
Action Response
BITBUCKET_GET_THE_BRANCHING_MODEL_CONFIG_FOR_A_REPOSITORY
The configuration for a repository’s branching model includes a development
property, a production
property (which can be disabled), and all branch types under branch types
. for current branches, see the active model api.
Action Parameters
Action Response
BITBUCKET_LIST_LINKER_VALUES_FOR_A_LINKER
The document explains how authenticated applications can retrieve a list of linker values, which allow modifications to a base regular expression using a match group (?k)
. these values must match the pattern ([w-]+)
.
Action Parameters
Action Response
BITBUCKET_CREATE_A_COMMIT_BY_UPLOADING_A_FILE
This bitbucket api endpoint enables commits to be created by altering files within a repository, supporting operations like symlinks or executables creation but not subrepos/submodules.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_SCHEDULE
Update a schedule.
Action Parameters
Action Response
BITBUCKET_DELETE_A_PREVIOUS_REVISION_OF_A_SNIPPET
To remove a snippet, use delete /snippets/
{encoded_id}“. this works for any version of the snippet. using a versioned url for the latest commit is fine, but older commits yield a 405 error.
Action Parameters
Action Response
BITBUCKET_LIST_CACHES
Retrieve the repository pipelines caches.
Action Parameters
Action Response
BITBUCKET_GET_LOG_FILE_FOR_A_STEP
Retrieve the log file for a given step of a pipeline. this endpoint supports (and encourages!) the use of http range requests to deal with potentially very large log files.
Action Parameters
Action Response
BITBUCKET_DELETE_A_SNIPPET
Deletes a snippet and returns an empty response.
Action Parameters
Action Response
BITBUCKET_LIST_COMMIT_STATUSES_FOR_A_COMMIT
Returns all statuses (e.g. build results) for a specific commit.
Action Parameters
Action Response
BITBUCKET_GET_A_USER_APPLICATION_PROPERTY
Retrieve an application property value stored against a user.
Action Parameters
Action Response
BITBUCKET_LIST_LINKERS_FOR_AN_APP
Gets a list of all linkers for the authenticated application.
Action Parameters
Action Response
BITBUCKET_LIST_COMMITS
This api endpoint offers paginated, reverse chronological commit logs of a repo, similar to git log --all
, but with filter options for including/excluding branches or paths, affecting file/directory changes. supports get
and post
for large queries.
Action Parameters
Action Response
BITBUCKET_CHECK_IF_CURRENT_USER_VOTED_FOR_AN_ISSUE
Check whether the authenticated user has voted for this issue. a 204 status code indicates that the user has voted, while a 404 implies they haven’t.
Action Parameters
Action Response
BITBUCKET_LIST_CHANGES_ON_AN_ISSUE
Provides a chronological list of unchangeable historical changes for issue /issues/123/changes
, including comments, with filtering/sorting options. updating due to privacy concerns; only for repositories that enable issue tracking.
Action Parameters
Action Response
BITBUCKET_GET_A_COMMIT_COMMENT
Returns the specified commit comment.
Action Parameters
Action Response
BITBUCKET_UPDATE_SSH_KEY_PAIR
Create or update the repository ssh key pair. the private key will be set as a default ssh identity in your build container.
Action Parameters
Action Response
BITBUCKET_DELETE_AN_ANNOTATION
Deletes a single annotation matching the provided id.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_PROJECT_FOR_A_WORKSPACE
This endpoint can create or update projects, with requests varying by intent. for creation, exclude ‘key’ but include ‘name’; for updates, ‘key’ is optional unless changing it, affecting the project’s location.
Action Parameters
Action Response
BITBUCKET_DELETE_AN_EXPLICIT_USER_PERMISSION_FOR_A_PROJECT
Deletes project user permission if it exists, only accessible by project admins. jwt and oauth authentication are unsupported to prevent integrations from altering permissions due to security concerns.
Action Parameters
Action Response
BITBUCKET_CREATE_A_WEBHOOK_FOR_A_REPOSITORY
Creates a new bitbucket webhook for a repo with json data via curl, requiring a set secret for hmac signature, and proper scopes (webhook
, repository
, issue
). url must be accessible, not internal.
Action Parameters
Action Response
BITBUCKET_LIST_PIPELINES
Find pipelines
Action Parameters
Action Response
BITBUCKET_LIST_ATTACHMENTS_FOR_AN_ISSUE
Returns all attachments for this issue. this returns the files’ meta data. this does not return the files’ actual contents. the files are always ordered by their upload date.
Action Parameters
Action Response
BITBUCKET_GET_A_KNOWN_HOST
Retrieve a repository level known host.
Action Parameters
Action Response
BITBUCKET_LIST_REPOSITORY_PERMISSIONS_FOR_A_USER
The api details user-specific access to repositories, showing the top permission level and excludes public repos without explicit permissions. it also offers filtering and sorting by repository or permission.
Action Parameters
Action Response
BITBUCKET_GET_A_COMPONENT_FOR_ISSUES
Returns the specified issue tracker component object.
Action Parameters
Action Response
BITBUCKET_LIST_ISSUES
Returns the issues in the issue tracker.
Action Parameters
Action Response
BITBUCKET_REMOVE_CHANGE_REQUEST_FOR_A_PULL_REQUEST
This endpoint enables logged-in users to cancel a change request on a pull request, supporting oauth2, basic auth, and api keys. possible responses: 204 (success), 400 (failure if merged), 401 (unauthenticated), and 404 (not found).
Action Parameters
Action Response
BITBUCKET_DELETE_A_DOWNLOAD_ARTIFACT
Deletes the specified download artifact from the repository.
Action Parameters
Action Response
BITBUCKET_LIST_COMMITS_WITH_INCLUDE_EXCLUDE
The post method for /repositories/
{workspace}/
{repo_slug}/commits
allows including or excluding parameters in the request body, preventing url length problems, unlike the get method. it doesn’t support creating new commits.
Action Parameters
Action Response
BITBUCKET_CREATE_A_PROJECT_IN_A_WORKSPACE
Guide to create a new project with an avatar as data-url or external image link. example includes project details like name, key, description, avatar link, and privacy status, using curl to post data to bitbucket api.
Action Parameters
Action Response
BITBUCKET_LIST_PROJECTS_IN_A_WORKSPACE
Returns the list of projects in this workspace.
Action Parameters
Action Response
BITBUCKET_CREATE_A_LINKER_VALUE
The text describes how to create a linker value for an authenticated application, allowing modifications to its regular expression. it specifies using a bitbucket-specific match group (?k)
translated to ([w-]+)
for values to match.
Action Parameters
Action Response
BITBUCKET_LIST_SUBSCRIBABLE_WEBHOOK_TYPES
Provides a paginated list of all valid webhook events for a specified entity. team and user webhooks are deprecated in favor of workspace. no scopes or authentication needed. see atlassian’s announcement for more details.
Action Parameters
Action Response
BITBUCKET_ADD_A_NEW_SSH_KEY
Guide on adding an ssh public key to a user account on bitbucket, including a curl post request example with the key and user details.
Action Parameters
Action Response
BITBUCKET_DELETE_A_USER_APPLICATION_PROPERTY
Delete an application property value stored against a user.
Action Parameters
Action Response
BITBUCKET_LIST_USERS_WATCHING_A_SNIPPET
Returns a paginated list of all users watching a specific snippet.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_COMMENT_ON_A_SNIPPET
Updates a comment. the only required field in the body is content.raw
. comments can only be updated by their author.
Action Parameters
Action Response
BITBUCKET_LIST_DEFAULT_REVIEWERS
To find a repository’s default reviewers for new pull requests, use the effective-default-reviewers endpoint to see both repository and project level defaults.
Action Parameters
Action Response
BITBUCKET_DELETE_A_PROJECT_FOR_A_WORKSPACE
Deleting a project is irreversible and requires deleting or transferring any contained repositories first. use the provided curl command for deletion.
Action Parameters
Action Response
BITBUCKET_COMPARE_TWO_COMMITS
This api produces git-style diffs, comparing a single commit to its parent or creating 2-way/simple diffs between two commits. it omits commit headers and can filter diffs by file path, outputting results in plain text.
Action Parameters
Action Response
BITBUCKET_LIST_COMMITS_FOR_REVISION
Repository commits appear in reverse order like git log
, can be sorted using filters, and searched by ref, tags, or specific paths. results are paginated and might exclude irrelevant parent commits.
Action Parameters
Action Response
BITBUCKET_GET_A_VARIABLE_FOR_A_TEAM
Retrieve a team level variable. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_DELETE_A_REPOSITORY_APPLICATION_PROPERTY
Delete an application property value stored against a repository.
Action Parameters
Action Response
BITBUCKET_DELETE_A_TASK_ON_A_PULL_REQUEST
Deletes a specific pull request task.
Action Parameters
Action Response
BITBUCKET_GET_A_WEBHOOK_FOR_A_REPOSITORY
Returns the webhook with the specified id installed on the specified repository.
Action Parameters
Action Response
BITBUCKET_EXPORT_ISSUES
A post request to this endpoint starts a celery task to archive repo issues. on acceptance, a 202 response and a unique url for the zip file retrieval are provided in the ‘location’ header.
Action Parameters
Action Response
BITBUCKET_LIST_A_PULL_REQUEST_ACTIVITY_LOG_BY_REQUEST_ID
The handler provides a paginated activity log for pull requests, detailing comments, updates, approvals, and changes for both v20 and internal endpoints—with the latter also including tasks and attachments. comments feature an ‘inline’ property.
Action Parameters
Action Response
BITBUCKET_DELETE_A_VARIABLE_FOR_A_WORKSPACE
Delete a workspace level variable.
Action Parameters
Action Response
BITBUCKET_GET_A_DEFINED_VERSION_FOR_ISSUES
Returns the specified issue tracker version object.
Action Parameters
Action Response
BITBUCKET_GET_A_WEBHOOK_FOR_A_WORKSPACE
Returns the webhook with the specified id installed on the given workspace.
Action Parameters
Action Response
BITBUCKET_CHECK_IF_THE_CURRENT_USER_IS_WATCHING_A_SNIPPET
Used to check if the current user is watching a specific snippet. returns 204 (no content) if the user is watching the snippet and 404 if not. hitting this endpoint anonymously always returns a 404.
Action Parameters
Action Response
BITBUCKET_GET_A_BUILD_STATUS_FOR_A_COMMIT
Returns the specified build status for a commit.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_COMMIT_APPLICATION_PROPERTY
Update an application property value stored against a commit.
Action Parameters
Action Response
BITBUCKET_MERGE_A_PULL_REQUEST
Merges the pull request.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_WEBHOOK_FOR_A_WORKSPACE
Updates webhook subscription by allowing changes to its description, url, secret, active status, and events. the secret, if set, is used for the hmac hex digest in the x-hub-signature
header. secret can be updated or removed.
Action Parameters
Action Response
BITBUCKET_DELETE_A_BRANCH_RESTRICTION_RULE
Deletes an existing branch restriction rule.
Action Parameters
Action Response
BITBUCKET_GET_AN_EMAIL_ADDRESS_FOR_CURRENT_USER
Returns details about a specific one of the authenticated user’s email addresses. details describe whether the address has been confirmed by the user and whether it is the user’s primary address or not.
Action Parameters
Action Response
BITBUCKET_LIST_EXPLICIT_USER_PERMISSIONS_FOR_A_PROJECT
Returns a paginated list of explicit user permissions for the given project. this endpoint does not support bbql features.
Action Parameters
Action Response
BITBUCKET_DELETE_A_VARIABLE_FOR_A_USER
Delete an account level variable. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_RESOLVE_A_COMMENT_THREAD
This endpoint, supporting post and various authentication methods, resolves pull request comment threads, returning json data on success. failures could stem from unauthorized access or problems with the comments themselves.
Action Parameters
Action Response
BITBUCKET_LIST_THE_DEFAULT_REVIEWERS_IN_A_PROJECT
Return a list of all default reviewers for a project. this is a list of users that will be added as default reviewers to pull requests for any repository within the project.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_KNOWN_HOST
Update a repository level known host.
Action Parameters
Action Response
BITBUCKET_GET_AN_EXPLICIT_GROUP_PERMISSION_FOR_A_PROJECT
Returns the group permission for a given group and project. only users with admin permission for the project may access this resource. permissions can be: * admin
* create-repo
* write
* read
* none
Action Parameters
Action Response
BITBUCKET_GET_A_TASK_ON_A_PULL_REQUEST
Returns a specific pull request task.
Action Parameters
Action Response
BITBUCKET_LIST_VARIABLES_FOR_A_WORKSPACE
Find workspace level variables.
Action Parameters
Action Response
BITBUCKET_DELETE_A_SSH_KEY
Deletes a specific ssh public key from a user’s account.
Action Parameters
Action Response
BITBUCKET_LIST_SNIPPET_CHANGES
Returns the changes (commits) made on this snippet.
Action Parameters
Action Response
BITBUCKET_LIST_VARIABLES_FOR_AN_ENVIRONMENT
Find deployment environment level variables.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_PULL_REQUEST_APPLICATION_PROPERTY
Update an application property value stored against a pull request.
Action Parameters
Action Response
BITBUCKET_DELETE_AN_EXPLICIT_GROUP_PERMISSION_FOR_A_REPOSITORY
Deletes the repository group permission between the requested repository and group, if one exists. only users with admin permission for the repository may access this resource.
Action Parameters
Action Response
BITBUCKET_UPDATE_THE_BRANCHING_MODEL_CONFIG_FOR_A_REPOSITORY
The branching model allows for setting development
and production
branches, updates properties, and prevents invalid states with unique prefixes. changes stop project inheritance, with a fix expected by 1 august 2022.
Action Parameters
Action Response
BITBUCKET_CREATE_A_VARIABLE_FOR_A_WORKSPACE
Create a workspace level variable.
Action Parameters
Action Response
BITBUCKET_DELETE_A_REPOSITORY
Deletes the repository. this is an irreversible operation. this does not affect its forks.
Action Parameters
Action Response
BITBUCKET_GET_A_DEPLOYMENT
Retrieve a deployment
Action Parameters
Action Response
BITBUCKET_LIST_EMAIL_ADDRESSES_FOR_CURRENT_USER
Returns all the authenticated user’s email addresses. both confirmed and unconfirmed.
Action Parameters
Action Response
BITBUCKET_CREATE_A_KNOWN_HOST
Create a repository level known host.
Action Parameters
Action Response
BITBUCKET_GET_A_VARIABLE_FOR_A_REPOSITORY
Retrieve a repository level variable.
Action Parameters
Action Response
BITBUCKET_GET_A_STEP_OF_A_PIPELINE
Retrieve a given step of a pipeline.
Action Parameters
Action Response
BITBUCKET_GET_A_PATCH_FOR_TWO_COMMITS
Generates a raw patch for a single commit or a series for a 2-commit range, differing from diffs by including commit headers, not supporting path
queries, and returning in the original encoding as text/plain
.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_BUILD_STATUS_FOR_A_COMMIT
Used to update the current status of a build status object on the specific commit. this operation can also be used to change other properties of the build status: * state
* name
* description
* url
* refname
the key
cannot be changed.
Action Parameters
Action Response
BITBUCKET_GET_CURRENT_USER
Returns the currently logged in user.
Action Parameters
Action Response
BITBUCKET_GET_AN_EXPLICIT_GROUP_PERMISSION_FOR_A_REPOSITORY
Returns the group permission for a given group slug and repository only users with admin permission for the repository may access this resource. permissions can be: * admin
* write
* read
* none
Action Parameters
Action Response
BITBUCKET_LIST_COMMITS_THAT_MODIFIED_A_FILE
Bitbucket’s api returns a paginated, reverse chronological list of commits modifying a specified file, tracking renames by default. commits can be filtered/sorted, with an example showing how to retrieve commits before a specific date for a file.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_VARIABLE_FOR_A_TEAM
Update a team level variable. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_REPOSITORY
This endpoint is for creating or updating a repository. updating the name changes its url, which may cause conflicts. successful updates include the new url in the response’s location
header.
Action Parameters
Action Response
BITBUCKET_GET_THE_BRANCHING_MODEL_CONFIG_FOR_A_PROJECT
The summary describes a project’s raw branching model configuration, including development
and production
branches (the latter can be disabled), and branch types
. for current branches, see the active model api.
Action Parameters
Action Response
BITBUCKET_LIST_REPORTS
Returns a paginated list of reports linked to this commit.
Action Parameters
Action Response
BITBUCKET_GET_A_BRANCH_RESTRICTION_RULE
Returns a specific branch restriction rule.
Action Parameters
Action Response
BITBUCKET_CREATE_A_PULL_REQUEST
To create a pull request in bitbucket, title
and source
branch are mandatory. by default, it targets the main branch unless a destination
is specified. you may add reviewers
and optional fields like description
and close source branch
.
Action Parameters
Action Response
BITBUCKET_DELETE_A_SCHEDULE
Delete a schedule.
Action Parameters
Action Response
BITBUCKET_UPDATE_THE_NEXT_BUILD_NUMBER
Update the next build number that should be assigned to a pipeline. the next build number that will be configured has to be strictly higher than the current latest build number for this repository.
Action Parameters
Action Response
BITBUCKET_LIST_ANNOTATIONS
Returns a paginated list of annotations for a specified report.
Action Parameters
Action Response
BITBUCKET_GET_A_REPOSITORY
Returns the object describing this repository.
Action Parameters
Action Response
BITBUCKET_GET_AN_ISSUE
Returns the specified issue.
Action Parameters
Action Response
BITBUCKET_GET_A_SCHEDULE
Retrieve a schedule by its uuid.
Action Parameters
Action Response
BITBUCKET_LIST_WORKSPACES_FOR_THE_CURRENT_USER
Summary: users get a summary of their top role in each workspace, with roles being owner
, collaborator
(phasing out), or member
. bitbucket cloud updates affect workspace membership
fields, allowing sorting/filtering by workspace or permission.
Action Parameters
Action Response
BITBUCKET_GET_A_REPOSITORY_APPLICATION_PROPERTY
Retrieve an application property value stored against a repository.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_TASK_ON_A_PULL_REQUEST
Updates a specific pull request task.
Action Parameters
Action Response
BITBUCKET_UPDATE_THE_BRANCHING_MODEL_CONFIG_FOR_A_PROJECT
The project adopts a branching model with development
and production
branches, enabling production
toggling and selective property updates. updates require valid branch types
prefixes and existing branches.
Action Parameters
Action Response
BITBUCKET_DELETE_A_VARIABLE_FOR_AN_ENVIRONMENT
Delete a deployment environment level variable.
Action Parameters
Action Response
BITBUCKET_IMPORT_ISSUES
Post request to import issues from a zip file into a bitbucket repository, deleting existing issues. requires “archive” field in multipart/form-data. use curl with the specified format.
Action Parameters
Action Response
BITBUCKET_DELETE_A_KNOWN_HOST
Delete a repository level known host.
Action Parameters
Action Response
BITBUCKET_GET_A_USER
The text details an api’s ability to fetch public user account info, highlighting limitations on private profiles due to privacy changes, with a reference to an announcement for more.
Action Parameters
Action Response
BITBUCKET_CREATE_A_COMMENT_ON_AN_ISSUE
Creates a new issue comment. \$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/ -x post -u evzijst -h 'content-type: application/json' -d '{"content": `{`raw`: `lorem_ipsum.`}`}'
Action Parameters
Action Response
BITBUCKET_CHECK_IF_CURRENT_USER_IS_WATCHING_A_ISSUE
Indicated whether or not the authenticated user is watching this issue.
Action Parameters
Action Response
BITBUCKET_GET_AN_ENVIRONMENT
Retrieve an environment
Action Parameters
Action Response
BITBUCKET_UPDATE_A_SNIPPET
To update a snippet, use put for a full snapshot or changes, omitting values deletes properties. file renaming requires deletion and re-addition. it supports json and multipart content types for editing metadata, file contents, or both.
Action Parameters
Action Response
BITBUCKET_DELETE_A_DEPLOY_KEY_FROM_A_PROJECT
This deletes a deploy key from a project.
Action Parameters
Action Response
BITBUCKET_LIST_USER_PERMISSIONS_IN_A_WORKSPACE
The text discusses how to get workspace members and their permissions in bitbucket cloud, highlights the removal of the collaborator
role and some workspace membership
fields post-migration, and details permission level filtering options.
Action Parameters
Action Response
BITBUCKET_LIST_MILESTONES
Returns the milestones that have been defined in the issue tracker. this resource is only available on repositories that have the issue tracker enabled.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_VARIABLE_FOR_A_REPOSITORY
Update a repository level variable.
Action Parameters
Action Response
BITBUCKET_GET_A_WEBHOOK_RESOURCE
Describes how to access webhook resource/subject types and their events via a public endpoint. each type has an events
link providing a paginated list of its specific events. no authentication needed.
Action Parameters
Action Response
BITBUCKET_LIST_VARIABLES_FOR_AN_ACCOUNT
Find account level variables. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_LIST_COMMENTS_ON_AN_ISSUE
This endpoint lists comments on a specific issue, paginated and sorted from oldest to newest by default. it supports overriding sorting and filtering. for more, see filtering and sorting details.
Action Parameters
Action Response
BITBUCKET_MODIFY_THE_STATE_OF_AN_ISSUE
To update an issue’s state and assignee in bitbucket, send a post request with change details and an optional comment. authentication is necessary, especially for private items.
Action Parameters
Action Response
BITBUCKET_GET_ATTACHMENT_FOR_AN_ISSUE
This endpoint redirects to a file’s contents, returning a non-json response with a one-time, short-lived token in the url, which should not be saved or shared.
Action Parameters
Action Response
BITBUCKET_DELETE_A_VARIABLE_FOR_A_REPOSITORY
Delete a repository level variable.
Action Parameters
Action Response
BITBUCKET_LIST_STEPS_FOR_A_PIPELINE
Find steps for the given pipeline.
Action Parameters
Action Response
BITBUCKET_CREATE_A_VARIABLE_FOR_A_USER_IN_TEAM
Create an account level variable. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_UPDATE_AN_INSTALLED_APP
This endpoint updates bitbucket connect app installations with jwt authentication, permitting descriptor updates but not url changes unless marketplace registration is updated. it doesn’t apply to “develop apps” section apps.
Action Parameters
Action Response
BITBUCKET_GET_OPEN_ID_CONFIGURATION_FOR_OIDC_IN_PIPELINES
This is part of openid connect for pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/
Action Parameters
Action Response
BITBUCKET_UNAPPROVE_A_PULL_REQUEST
Redact the authenticated user’s approval of the specified pull request.
Action Parameters
Action Response
BITBUCKET_DELETE_A_COMMIT_APPLICATION_PROPERTY
Delete an application property value stored against a commit.
Action Parameters
Action Response
BITBUCKET_CREATE_A_SNIPPET_FOR_A_WORKSPACE
Identical to /snippets
, except that the new snippet will be created under the workspace specified in the path parameter {workspace}
.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_LINKER_VALUE
Bulk update allows authenticated applications to modify linker values, which adjust its regex. the base regex must include a bitbucket-specific match group (?k)
that translates to ([w-]+)
.
Action Parameters
Action Response
BITBUCKET_GET_CONFIGURATION
Retrieve the repository pipelines configuration.
Action Parameters
Action Response
BITBUCKET_LIST_PULL_REQUESTS_THAT_CONTAIN_A_COMMIT
This api returns a paginated list of pull requests that reviewed the commit. the pull request commit links app, which auto-installs upon using ‘go to pull request’ in the commit’s web details, is required.
Action Parameters
Action Response
BITBUCKET_LIST_A_COMMIT_S_COMMENTS
Returns the commit’s comments. this includes both global and inline comments. the default sorting is oldest to newest and can be overridden with the sort
query parameter.
Action Parameters
Action Response
BITBUCKET_CREATE_A_VARIABLE_FOR_AN_ENVIRONMENT
Create a deployment environment level variable.
Action Parameters
Action Response
BITBUCKET_UPDATE_AN_ENVIRONMENT
Update an environment
Action Parameters
Action Response
BITBUCKET_LIST_VARIABLES_FOR_A_USER
Find user level variables. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_UNAPPROVE_A_COMMIT
The operation to redact a user’s commit approval is reserved for users with explicit access to the repository, highlighting that public access does not grant this capability.
Action Parameters
Action Response
BITBUCKET_GET_A_DOWNLOAD_ARTIFACT_LINK
Return a redirect to the contents of a download artifact. this endpoint returns the actual file contents and not the artifact’s metadata. $ curl -s -l https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt hello world
Action Parameters
Action Response
BITBUCKET_GET_A_PREVIOUS_SNIPPET_CHANGE
Returns the changes made on this snippet in this commit.
Action Parameters
Action Response
BITBUCKET_GET_SNIPPET_PATCH_BETWEEN_VERSIONS
The resource returns a commit’s patch, differing from the diff
resource by including commit headers and lacking path
query filtering. patches detail each commit’s changes for merges unlike diffs. character encoding for patches is unspecified.
Action Parameters
Action Response
BITBUCKET_GET_FILE_OR_DIRECTORY_CONTENTS
This bitbucket endpoint fetches contents of files or directories at a certain revision, returning raw data or metadata, and listing directory contents non-recursively with an optional depth. it includes file details and commit information.
Action Parameters
Action Response
BITBUCKET_SEARCH_FOR_CODE_IN_A_USER_S_REPOSITORIES
Search for code in a user’s repositories, matching content or path. use ui syntax for queries, e.g., search query=foo+repo:demo
. add fields with fields
parameter for extra details.
Action Parameters
Action Response
BITBUCKET_CREATE_A_BUILD_STATUS_FOR_A_COMMIT
Creates or overwrites a build status for a commit on bitbucket using a post request. you can include dynamic urls with uri templates using context variables like repository
and commit
.
Action Parameters
Action Response
BITBUCKET_DELETE_A_VARIABLE_FOR_A_TEAM
Delete a team level variable. this endpoint has been deprecated, and you should use the new workspaces endpoint. for more information, see the announcement.
Action Parameters
Action Response
BITBUCKET_GET_CACHE_CONTENT_URI
Retrieve the uri of the content of the specified cache.
Action Parameters
Action Response
BITBUCKET_GET_A_WORKSPACE
Returns the requested workspace.
Action Parameters
Action Response
BITBUCKET_LIST_DEPLOYMENTS
Find deployments
Action Parameters
Action Response
BITBUCKET_GET_VARIABLE_FOR_A_WORKSPACE
Retrieve a workspace level variable.
Action Parameters
Action Response
BITBUCKET_LIST_EXPLICIT_GROUP_PERMISSIONS_FOR_A_PROJECT
Returns a paginated list of explicit group permissions for the given project. this endpoint does not support bbql features.
Action Parameters
Action Response
BITBUCKET_UPDATE_AN_ISSUE
The provided curl command updates a bitbucket issue’s title, assignee, priority, and version, and clears its component by setting it to null. editing creates an immutable record and comment at /issues/123/changes
.
Action Parameters
Action Response
BITBUCKET_GET_A_PROJECT_DEPLOY_KEY
Returns the deploy key belonging to a specific key id.
Action Parameters
Action Response
BITBUCKET_UPDATE_A_VARIABLE_FOR_AN_ENVIRONMENT
Update a deployment environment level variable.
Action Parameters
Action Response
BITBUCKET_GET_USER_MEMBERSHIP_FOR_A_WORKSPACE
Returns the workspace membership, which includes a user
object for the member and a workspace
object for the requested workspace.
Action Parameters
Action Response
BITBUCKET_UPDATE_AN_EXPLICIT_USER_PERMISSION_FOR_A_REPOSITORY
Updates user permissions for a repository within a workspace. only accessible to users with admin rights and requires an app password for authentication. the user can be assigned admin
, write
, or read
permissions but can’t be the workspace owner.
Action Parameters
Action Response
BITBUCKET_UPDATE_AN_EXPLICIT_GROUP_PERMISSION_FOR_A_PROJECT
Admins can update or grant project permissions. unsupported jwt and oauth prevent add-on changes. permissions include admin, create-repo, write, and read.
Action Parameters
Action Response
BITBUCKET_LIST_COMMENTS_ON_A_SNIPPET
Used to retrieve a paginated list of all comments for a specific snippet. this resource works identical to commit and pull request comments. the default sorting is oldest to newest and can be overridden with the sort
query parameter.
Action Parameters
Action Response
BITBUCKET_LIST_COMMENTS_ON_A_PULL_REQUEST
The endpoint provides a paginated list of a pull request’s comments, including global, inline, and replies, sorted from oldest to newest by default but adjustable via the sort
query parameter. it supports filtering and sorting.
Action Parameters
Action Response
BITBUCKET_GET_A_COMMENT_ON_A_SNIPPET
Returns the specific snippet comment.
Action Parameters
Action Response
BITBUCKET_LIST_WEBHOOKS_FOR_A_WORKSPACE
Returns a paginated list of webhooks installed on this workspace.
Action Parameters
Action Response
BITBUCKET_GET_A_COMMENT_ON_A_PULL_REQUEST
Returns a specific pull request comment.
Action Parameters
Action Response
BITBUCKET_CREATE_A_SCHEDULE
Create a schedule for the given repository.
Action Parameters
Action Response
BITBUCKET_STOP_WATCHING_AN_ISSUE
Stop watching this issue.
Action Parameters
Action Response
BITBUCKET_LIST_REPOSITORIES_WATCHERS
Returns a paginated list of all the watchers on the specified repository.
Action Parameters
Action Response
BITBUCKET_LIST_DEFINED_VERSIONS_FOR_ISSUES
Returns the versions that have been defined in the issue tracker. this resource is only available on repositories that have the issue tracker enabled.
Action Parameters
Action Response
BITBUCKET_DELETE_SSH_KEY_PAIR
Delete the repository ssh key pair.
Action Parameters
Action Response
BITBUCKET_GET_KEYS_FOR_OIDC_IN_PIPELINES
This is part of openid connect for pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/
Action Parameters
Action Response
BITBUCKET_UPDATE_CONFIGURATION
Update the pipelines configuration for a repository.
Action Parameters
Action Response
BITBUCKET_RUN_A_PIPELINE
The document outlines methods for initiating bitbucket pipelines via api, covering triggering by branch, commit, tag, specifying custom pipelines with variables, and for pull requests, with curl command examples for execution.
Action Parameters
Action Response