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

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to webhook,pullrequest:write,project:admin,runner:write,project:write,snippet:write,team:write,pipeline:variable,repository:delete,repository:admin,account:write,wiki,issue:write
base_url
stringDefaults to https://api.bitbucket.org/2.0

Actions

Deletes the specified webhook subscription from the given repository.

Action Parameters

repo_slug
stringRequired
uid
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
revision
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve an application property value stored against a commit.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
app_key
stringRequired
property_name
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the specified pull request.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a snippet comment. comments can only be removed by the comment author, snippet creator, or workspace admin.

Action Parameters

comment_id
integerRequired
encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
reportId
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the executions of a given schedule.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
schedule_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Creates a new pull request comment. returns the newly created pull request comment.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a list of download links associated with the repository.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired
q
string
sort
string

Action Response

data
object
successful
boolean
error

Create an environment.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Returns the specified commit.

Action Parameters

commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the specified issue tracker milestone object.

Action Parameters

milestone_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
role
string

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired
pipeline_uuid
stringRequired
step_uuid
stringRequired

Action Response

data
object
successful
boolean
error

This technique updates a bitbucket issue comment by modifying its content.raw field using a put request.

Action Parameters

comment_id
integerRequired
issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of the user’s ssh public keys.

Action Parameters

selected_user
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired
state
string

Action Response

data
object
successful
boolean
error

Returns a specific ssh public key belonging to a user.

Action Parameters

key_id
stringRequired
selected_user
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
path
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

key_id
stringRequired
selected_user
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
selected_user
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
revision
stringRequired
workspace
stringRequired
path
string

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired
format
string

Action Response

data
object
successful
boolean
error

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

key_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_name
stringRequired
repo_slug
stringRequired
task_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
selected_user
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired
pipeline_uuid
stringRequired
step_uuid
stringRequired
test_case_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Redirects to the repository diffstat with the revspec that corresponds to the pull request.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Redirects to the repository diff with the revspec that corresponds to the pull request.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Signal the stop of a pipeline and all of its steps that not have completed yet.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
pipeline_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired
q
string
sort
string
pagelen
integer

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired
q
string
sort
string

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of all the forks of the specified repository.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired
role
string
q
string
sort
string

Action Response

data
object
successful
boolean
error

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

role
string

Action Response

data
object
successful
boolean
error

Retract your vote.

Action Parameters

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

name
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
role
string
q
string
sort
string

Action Response

data
object
successful
boolean
error

Returns the specified default reviewer.

Action Parameters

project_key
stringRequired
selected_user
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete all linker values for the specified linker of the authenticated application.

Action Parameters

linker_key
stringRequired

Action Response

data
object
successful
boolean
error

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

selected_user
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the configured schedules for the given repository.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Returns all deploy-keys belonging to a repository.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

group_slug
stringRequired
repo_slug
stringRequired
workspace
stringRequired
permission
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
target_username
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
selected_user_id
stringRequired
workspace
stringRequired
permission
stringRequired

Action Response

data
object
successful
boolean
error

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

name
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete an environment

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
environment_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Removes a default reviewer from the repository.

Action Parameters

repo_slug
stringRequired
target_username
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the deploy key belonging to a specific key.

Action Parameters

key_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deletes the specified webhook subscription from the given workspace.

Action Parameters

uid
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the requested project.

Action Parameters

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

selected_user
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

comment_id
integerRequired
pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired

Action Response

data
object
successful
boolean
error

Redirects to the repository patch with the revspec that corresponds to pull request.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns all members of the requested workspace.

Action Parameters

workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete an application property value stored against a pull request.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
pullrequest_id
stringRequired
app_key
stringRequired
property_name
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired
q
string
sort
string

Action Response

data
object
successful
boolean
error

Returns all deploy keys belonging to a project.

Action Parameters

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
reportId
stringRequired
annotationId
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a specified pipeline

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
pipeline_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of explicit user permissions for the given repository. this endpoint does not support bbql features.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of all branch restrictions on the repository.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired
kind
string
pattern
string

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
q
string
sort
string

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired
pipeline_uuid
stringRequired
step_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Delete a single linker value of the authenticated application.

Action Parameters

linker_key
stringRequired
value_id
integerRequired

Action Response

data
object
successful
boolean
error

Find repository level variables.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Get a single linker value of the authenticated application.

Action Parameters

linker_key
stringRequired
value_id
integerRequired

Action Response

data
object
successful
boolean
error

Create a repository level variable.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a specific pull request comment.

Action Parameters

comment_id
integerRequired
pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Update a workspace level variable.

Action Parameters

workspace
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Returns a single report matching the provided id.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
reportId
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
search_query
stringRequired
page
integerDefaults to 1
pagelen
integerDefaults to 10

Action Response

data
object
successful
boolean
error

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

ignore_whitespace
boolean
merge
boolean
path
string
renames
boolean
repo_slug
stringRequired
spec
stringRequired
topic
boolean
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a single annotation matching the provided id.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
reportId
stringRequired
annotationId
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve an application property value stored against a pull request.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
pullrequest_id
stringRequired
app_key
stringRequired
property_name
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of explicit group permissions for the given repository. this endpoint does not support bbql features.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

role
string
q
string
sort
string

Action Response

data
object
successful
boolean
error

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

group_slug
stringRequired
project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a single report matching the provided id.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
reportId
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
selected_user_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Used to stop watching a specific snippet. returns 204 (no content) to indicate success.

Action Parameters

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired
pipeline_uuid
stringRequired
step_uuid
stringRequired
log_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Approve the specified pull request as the authenticated user.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
selected_user_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Gets a linker specified by linker key for the authenticated application.

Action Parameters

linker_key
stringRequired

Action Response

data
object
successful
boolean
error

Find environments

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Returns all statuses (e.g. build results) for the given pull request.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired
q
string
sort
string

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired
q
string
sort
string

Action Response

data
object
successful
boolean
error

Vote for this issue. to cast your vote, do an empty put. the 204 status code indicates that the operation was successful.

Action Parameters

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deletes the specified issue. this requires write access to the repository.

Action Parameters

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

pull_request_id
integerRequired
repo_slug
stringRequired
task_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
revspec
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete repository cache versions by name.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
name
stringRequired

Action Response

data
object
successful
boolean
error

Delete a repository cache.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
cache_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Find repository level known hosts.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of webhooks installed on this repository.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

selected_user
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Returns the specified issue change object. this resource is only available on repositories that have the issue tracker enabled.

Action Parameters

change_id
stringRequired
issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

username
stringRequired
search_query
stringRequired
page
integerDefaults to 1
pagelen
integerDefaults to 10

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired
content__raw
string
pending
boolean

Action Response

data
object
successful
boolean
error

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

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deletes the specified comment.

Action Parameters

comment_id
integerRequired
issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

data
object
successful
boolean
error

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

encoded_id
stringRequired
node_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
target_username
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

comment_id
integerRequired
commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

name
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

This deletes a deploy key from a repository.

Action Parameters

key_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

selected_user
stringRequired
state
string

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

comment_id
integerRequired
commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the specified issue comment object.

Action Parameters

comment_id
integerRequired
issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Update an application property value stored against a user.

Action Parameters

selected_user
stringRequired
app_key
stringRequired
property_name
stringRequired
attributes
array

Action Response

data
object
successful
boolean
error

Deletes an attachment.

Action Parameters

issue_id
stringRequired
path
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
uid
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Update an application property value stored against a repository.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
app_key
stringRequired
property_name
stringRequired
attributes
array

Action Response

data
object
successful
boolean
error

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

commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
selected_user_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Declines the pull request.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Used to start watching a specific snippet. returns 204 (no content).

Action Parameters

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

after
string
role
string
q
string
sort
string

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
node_id
stringRequired
path
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

data
object
successful
boolean
error

Updates an existing branch restriction rule. fields not present in the request body are ignored. see post for details.

Action Parameters

id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
node_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete a tag in the specified repository. the tag name should not include any prefixes (e.g. refs/tags).

Action Parameters

name
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Updates a specific pull request comment.

Action Parameters

comment_id
integerRequired
pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

linker_key
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired
message
string
author
string
parents
string
files
string
branch
string

Action Response

data
object
successful
boolean
error

Update a schedule.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
schedule_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
node_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the repository pipelines caches.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired
pipeline_uuid
stringRequired
step_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a snippet and returns an empty response.

Action Parameters

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns all statuses (e.g. build results) for a specific commit.

Action Parameters

commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired
q
string
sort
string

Action Response

data
object
successful
boolean
error

Retrieve an application property value stored against a user.

Action Parameters

selected_user
stringRequired
app_key
stringRequired
property_name
stringRequired

Action Response

data
object
successful
boolean
error

Gets a list of all linkers for the authenticated application.

Action Parameters

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired
q
string
sort
string

Action Response

data
object
successful
boolean
error

Returns the specified commit comment.

Action Parameters

comment_id
integerRequired
commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a single annotation matching the provided id.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
reportId
stringRequired
annotationId
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
selected_user_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Find pipelines

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a repository level known host.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
known_host_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

q
string
sort
string

Action Response

data
object
successful
boolean
error

Returns the specified issue tracker component object.

Action Parameters

component_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the issues in the issue tracker.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deletes the specified download artifact from the repository.

Action Parameters

filename
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the list of projects in this workspace.

Action Parameters

workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

linker_key
stringRequired

Action Response

data
object
successful
boolean
error

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

subject_type
stringRequired

Action Response

data
object
successful
boolean
error

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

selected_user
stringRequired

Action Response

data
object
successful
boolean
error

Delete an application property value stored against a user.

Action Parameters

selected_user
stringRequired
app_key
stringRequired
property_name
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of all users watching a specific snippet.

Action Parameters

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Updates a comment. the only required field in the body is content.raw. comments can only be updated by their author.

Action Parameters

comment_id
integerRequired
encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deleting a project is irreversible and requires deleting or transferring any contained repositories first. use the provided curl command for deletion.

Action Parameters

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
spec
stringRequired
workspace
stringRequired
context
integer
path
string
ignore_whitespace
boolean
binary
boolean
renames
boolean
merge
boolean
topic
boolean

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
revision
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

username
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Delete an application property value stored against a repository.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
app_key
stringRequired
property_name
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a specific pull request task.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
task_id
integerRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the webhook with the specified id installed on the specified repository.

Action Parameters

repo_slug
stringRequired
uid
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired
type
stringRequired
project_key
string
project_name
string
send_email
boolean
include_attachments
boolean

Action Response

data
object
successful
boolean
error

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

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete a workspace level variable.

Action Parameters

workspace
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Returns the specified issue tracker version object.

Action Parameters

repo_slug
stringRequired
version_id
integerRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the webhook with the specified id installed on the given workspace.

Action Parameters

uid
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the specified build status for a commit.

Action Parameters

commit
stringRequired
key
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Update an application property value stored against a commit.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
app_key
stringRequired
property_name
stringRequired
attributes
array

Action Response

data
object
successful
boolean
error

Merges the pull request.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired
async
boolean
type
stringRequired
message
string
close_source_branch
boolean
merge_strategy
stringDefaults to merge_commit

Action Response

data
object
successful
boolean
error

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

uid
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deletes an existing branch restriction rule.

Action Parameters

id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

email
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of explicit user permissions for the given project. this endpoint does not support bbql features.

Action Parameters

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

selected_user
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

comment_id
integerRequired
pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Update a repository level known host.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
known_host_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

group_slug
stringRequired
project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a specific pull request task.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
task_id
integerRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Find workspace level variables.

Action Parameters

workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a specific ssh public key from a user’s account.

Action Parameters

key_id
stringRequired
selected_user
stringRequired

Action Response

data
object
successful
boolean
error

Returns the changes (commits) made on this snippet.

Action Parameters

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Find deployment environment level variables.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
environment_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Update an application property value stored against a pull request.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
pullrequest_id
stringRequired
app_key
stringRequired
property_name
stringRequired
attributes
array

Action Response

data
object
successful
boolean
error

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

group_slug
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Create a workspace level variable.

Action Parameters

workspace
stringRequired

Action Response

data
object
successful
boolean
error

Deletes the repository. this is an irreversible operation. this does not affect its forks.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired
redirect_to
string

Action Response

data
object
successful
boolean
error

Retrieve a deployment

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
deployment_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Returns all the authenticated user’s email addresses. both confirmed and unconfirmed.

Action Parameters

Action Response

data
object
successful
boolean
error

Create a repository level known host.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a repository level variable.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a given step of a pipeline.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
pipeline_uuid
stringRequired
step_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
spec
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

commit
stringRequired
key
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the currently logged in user.

Action Parameters

Action Response

data
object
successful
boolean
error

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

group_slug
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

commit
stringRequired
path
stringRequired
repo_slug
stringRequired
workspace
stringRequired
renames
string
q
string
sort
string

Action Response

data
object
successful
boolean
error

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

username
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of reports linked to this commit.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired

Action Response

data
object
successful
boolean
error

Returns a specific branch restriction rule.

Action Parameters

id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete a schedule.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
schedule_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of annotations for a specified report.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
reportId
stringRequired

Action Response

data
object
successful
boolean
error

Returns the object describing this repository.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the specified issue.

Action Parameters

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a schedule by its uuid.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
schedule_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

q
string
sort
string

Action Response

data
object
successful
boolean
error

Retrieve an application property value stored against a repository.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
app_key
stringRequired
property_name
stringRequired

Action Response

data
object
successful
boolean
error

Updates a specific pull request task.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
task_id
integerRequired
workspace
stringRequired
content__raw
string
state
string

Action Response

data
object
successful
boolean
error

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

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete a deployment environment level variable.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
environment_uuid
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete a repository level known host.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
known_host_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

selected_user
stringRequired

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Indicated whether or not the authenticated user is watching this issue.

Action Parameters

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve an environment

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
environment_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

This deletes a deploy key from a project.

Action Parameters

key_id
stringRequired
project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
q
string

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Update a repository level variable.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

data
object
successful
boolean
error

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

username
stringRequired

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired
q
string

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired
type
stringRequired
links__self__href
string
links__self__name
string
links__issue__href
string
links__issue__name
string
name
string
created_on
string
changes__title__old
string
changes__title__new
string
changes__version__old
string
changes__version__new
string
changes__assignee__old
string
changes__assignee__new
string
changes__state__old
string
changes__state__new
string
changes__kind__old
string
changes__kind__new
string
changes__milestone__old
string
changes__milestone__new
string
changes__component__old
string
changes__component__new
string
changes__priority__old
string
changes__priority__new
string
changes__content__old
string
changes__content__new
string
message__raw
string
message__markup
string
message__html
string

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
path
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete a repository level variable.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Find steps for the given pipeline.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
pipeline_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

username
stringRequired

Action Response

data
object
successful
boolean
error

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

data
object
successful
boolean
error

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

workspace
stringRequired

Action Response

data
object
successful
boolean
error

Redact the authenticated user’s approval of the specified pull request.

Action Parameters

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete an application property value stored against a commit.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
app_key
stringRequired
property_name
stringRequired

Action Response

data
object
successful
boolean
error

Identical to /snippets, except that the new snippet will be created under the workspace specified in the path parameter {workspace}.

Action Parameters

workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

linker_key
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the repository pipelines configuration.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired
commit
stringRequired
page
integerDefaults to 1
pagelen
integerDefaults to 30

Action Response

data
object
successful
boolean
error

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

commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired
q
string
sort
string

Action Response

data
object
successful
boolean
error

Create a deployment environment level variable.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
environment_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Update an environment

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
environment_uuid
stringRequired

Action Response

data
object
successful
boolean
error

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

selected_user
stringRequired

Action Response

data
object
successful
boolean
error

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

commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the changes made on this snippet in this commit.

Action Parameters

encoded_id
stringRequired
revision
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
revision
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

commit
stringRequired
path
stringRequired
repo_slug
stringRequired
workspace
stringRequired
format
string
q
string
sort
string
max_depth
integer

Action Response

data
object
successful
boolean
error

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

selected_user
stringRequired
search_query
stringRequired
page
integerDefaults to 1
pagelen
integerDefaults to 10

Action Response

data
object
successful
boolean
error

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

commit
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

username
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the uri of the content of the specified cache.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
cache_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Returns the requested workspace.

Action Parameters

workspace
stringRequired

Action Response

data
object
successful
boolean
error

Find deployments

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve a workspace level variable.

Action Parameters

workspace
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of explicit group permissions for the given project. this endpoint does not support bbql features.

Action Parameters

project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the deploy key belonging to a specific key id.

Action Parameters

key_id
stringRequired
project_key
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Update a deployment environment level variable.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired
environment_uuid
stringRequired
variable_uuid
stringRequired

Action Response

data
object
successful
boolean
error

Returns the workspace membership, which includes a user object for the member and a workspace object for the requested workspace.

Action Parameters

member
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
selected_user_id
stringRequired
workspace
stringRequired
permission
stringRequired

Action Response

data
object
successful
boolean
error

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

group_slug
stringRequired
project_key
stringRequired
workspace
stringRequired
permission
stringRequired

Action Response

data
object
successful
boolean
error

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

encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns the specific snippet comment.

Action Parameters

comment_id
integerRequired
encoded_id
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of webhooks installed on this workspace.

Action Parameters

workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a specific pull request comment.

Action Parameters

comment_id
integerRequired
pull_request_id
integerRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Create a schedule for the given repository.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

Stop watching this issue.

Action Parameters

issue_id
stringRequired
repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Returns a paginated list of all the watchers on the specified repository.

Action Parameters

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

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

repo_slug
stringRequired
workspace
stringRequired

Action Response

data
object
successful
boolean
error

Delete the repository ssh key pair.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired

Action Response

data
object
successful
boolean
error

Update the pipelines configuration for a repository.

Action Parameters

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error

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

workspace
stringRequired
repo_slug
stringRequired

Action Response

data
object
successful
boolean
error