Connectors
Cloud Infrastructure & DevOps
Bitbucket
Git hosting: repositories, pull requests, pipelines, and commit events
Bitbucket API referenceAPI checked August 17, 2026
- Signs in with
- Username and password
- Runs on
- Cloud or On-Prem Worker
- Operations
- 331
- Ready-made triggers
- 0
Connect Bitbucket
- In Neblex open Connect › Connections and click New Connection.
- Search for Bitbucket and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| UsernameRequired | |
| App passwordRequiredSecret |
Use it in a flow
- Open a flow, open the node library and search for Bitbucket.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Bitbucket without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Bitbucket can send webhooks, a Webhook trigger receives them at its own URL.
Operations
331 operations in 23 groups. Each one is a step you can add to a flow.
Addon3
Delete an appdeleteaddon | DELETE | Deletes the application for the user. |
Get the client key of a Connect addongetaddon_addon_key_client_key | GET | Get the client key of the Connect addon associated with a Forge app install via forgeAppId linkage. |
Update an installed appputaddon | PUT | Updates the application installation for the user. |
Branch Restrictions5
Create a branch restriction rulepostrepositories_workspace_repo_slug_branch_restrictions | POST | Creates a new branch restriction rule for a repository. |
Delete a branch restriction ruledeleterepositories_workspace_repo_slug_branch_restrictions_id | DELETE | Deletes an existing branch restriction rule. |
Get a branch restriction rulegetrepositories_workspace_repo_slug_branch_restrictions_id | GET | Returns a specific branch restriction rule. |
List branch restrictionsgetrepositories_workspace_repo_slug_branch_restrictions | GET | Returns a paginated list of all branch restrictions on the repository. |
Update a branch restriction ruleputrepositories_workspace_repo_slug_branch_restrictions_id | PUT | Updates an existing branch restriction rule. |
Branching Model7
Get the branching model config for a projectgetworkspaces_workspace_projects_project_key_branching_model_settings | GET | Return the branching model configuration for a project. |
Get the branching model config for a repositorygetrepositories_workspace_repo_slug_branching_model_settings | GET | Return the branching model configuration for a repository. |
Get the branching model for a projectgetworkspaces_workspace_projects_project_key_branching_model | GET | Return the branching model set at the project level. |
Get the branching model for a repositorygetrepositories_workspace_repo_slug_branching_model | GET | Return the branching model as applied to the repository. |
Get the effective, or currently applied, branching model for a repositorygetrepositories_workspace_repo_slug_effective_branching_model | GET | Get the effective, or currently applied, branching model for a repository |
Update the branching model config for a projectputworkspaces_workspace_projects_project_key_branching_model_settings | PUT | Update the branching model configuration for a project. |
Update the branching model config for a repositoryputrepositories_workspace_repo_slug_branching_model_settings | PUT | Update the branching model configuration for a repository. |
Commit Statuses4
Create a build status for a commitpostrepositories_workspace_repo_slug_commit_commit_statuses_build | POST | Creates a new build status against the specified commit. |
Get a build status for a commitgetrepositories_workspace_repo_slug_commit_commit_statuses_build_key | GET | Returns the specified build status for a commit. |
List commit statuses for a commitgetrepositories_workspace_repo_slug_commit_commit_statuses | GET | Returns all statuses (e.g. build results) for a specific commit. |
Update a build status for a commitputrepositories_workspace_repo_slug_commit_commit_statuses_build_key | PUT | Used to update the current status of a build status object on the specific commit. |
Commits17
Approve a commitpostrepositories_workspace_repo_slug_commit_commit_approve | POST | Approve the specified commit as the authenticated user. |
Compare two commit diff statsgetrepositories_workspace_repo_slug_diffstat_spec | GET | Produces a response in JSON format with a record for every path modified, including information on the type of the change and the number of lines added and removed. |
Compare two commitsgetrepositories_workspace_repo_slug_diff_spec | GET | Produces a raw git-style diff. |
Create comment for a commitpostrepositories_workspace_repo_slug_commit_commit_comments | POST | Creates new comment on the specified commit. |
Delete a commit commentdeleterepositories_workspace_repo_slug_commit_commit_comments_comment_id | DELETE | Deletes the specified commit comment. |
Get a commitgetrepositories_workspace_repo_slug_commit_commit | GET | Returns the specified commit. |
Get a commit commentgetrepositories_workspace_repo_slug_commit_commit_comments_comment_id | GET | Returns the specified commit comment. |
Get a patch for two commitsgetrepositories_workspace_repo_slug_patch_spec | GET | Produces a raw patch for a single commit (diffed against its first parent), or a patch-series for a revspec of 2 commits (e.g. 3a8b42..9ff173 where the first commit represents the source... |
Get file conflicts for a commit specgetrepositories_workspace_repo_slug_file_conflicts_spec | GET | Get file conflicts for a commit spec |
Get the common ancestor between two commitsgetrepositories_workspace_repo_slug_merge_base_revspec | GET | Returns the best common ancestor between two commits, specified in a revspec of 2 commits (e.g. 3a8b42..9ff173). |
List a commit's commentsgetrepositories_workspace_repo_slug_commit_commit_comments | GET | Returns the commit's comments. |
List commitsgetrepositories_workspace_repo_slug_commits | GET | These are the repository's commits. |
List commits for revisiongetrepositories_workspace_repo_slug_commits_revision | GET | These are the repository's commits. |
List commits for revision using include/excludepostrepositories_workspace_repo_slug_commits_revision | POST | Identical to GET /repositories/{workspace}/{repo slug}/commits/{revision}, except that POST allows clients to place the include and exclude parameters in the request body to avoid URL... |
List commits with include/excludepostrepositories_workspace_repo_slug_commits | POST | Identical to GET /repositories/{workspace}/{repo slug}/commits, except that POST allows clients to place the include and exclude parameters in the request body to avoid URL length issues. |
Unapprove a commitdeleterepositories_workspace_repo_slug_commit_commit_approve | DELETE | Redact the authenticated user's approval of the specified commit. |
Update a commit commentputrepositories_workspace_repo_slug_commit_commit_comments_comment_id | PUT | Used to update the contents of a comment. |
Deployments16
Add a repository deploy keypostrepositories_workspace_repo_slug_deploy_keys | POST | Create a new deploy key in a repository. |
Create a project deploy keypostworkspaces_workspace_projects_project_key_deploy_keys | POST | Create a new deploy key in a project. |
Create an environmentcreateEnvironment | POST | Create an environment. |
Delete a deploy key from a projectdeleteworkspaces_workspace_projects_project_key_deploy_keys_key_id | DELETE | This deletes a deploy key from a project. |
Delete a repository deploy keydeleterepositories_workspace_repo_slug_deploy_keys_key_id | DELETE | This deletes a deploy key from a repository. |
Delete an environmentdeleteEnvironmentForRepository | DELETE | Delete an environment |
Get a deploymentgetDeploymentForRepository | GET | Retrieve a deployment |
Get a project deploy keygetworkspaces_workspace_projects_project_key_deploy_keys_key_id | GET | Returns the deploy key belonging to a specific key ID. |
Get a repository deploy keygetrepositories_workspace_repo_slug_deploy_keys_key_id | GET | Returns the deploy key belonging to a specific key. |
Get an environmentgetEnvironmentForRepository | GET | Retrieve an environment |
List deploymentsgetDeploymentsForRepository | GET | Find deployments |
List environmentsgetEnvironmentsForRepository | GET | Find environments |
List project deploy keysgetworkspaces_workspace_projects_project_key_deploy_keys | GET | Returns all deploy keys belonging to a project. |
List repository deploy keysgetrepositories_workspace_repo_slug_deploy_keys | GET | Returns all deploy-keys belonging to a repository. |
Update a repository deploy keyputrepositories_workspace_repo_slug_deploy_keys_key_id | PUT | Update an existing deploy key in a repository. |
Update an environmentupdateEnvironmentForRepository | POST | Update an environment |
Downloads4
Delete a download artifactdeleterepositories_workspace_repo_slug_downloads_filename | DELETE | Deletes the specified download artifact from the repository. |
Get a download artifact linkgetrepositories_workspace_repo_slug_downloads_filename | GET | Return a redirect to the contents of a download artifact. |
List download artifactsgetrepositories_workspace_repo_slug_downloads | GET | Returns a list of download links associated with the repository. |
Upload a download artifactpostrepositories_workspace_repo_slug_downloads | POST | Upload new download artifacts. |
GPG4
Add a new GPG keypostusers_selected_user_gpg_keys | POST | Adds a new GPG public key to the specified user account and returns the resulting key. |
Delete a GPG keydeleteusers_selected_user_gpg_keys_fingerprint | DELETE | Deletes a specific GPG public key from a user's account. |
Get a GPG keygetusers_selected_user_gpg_keys_fingerprint | GET | Returns a specific GPG public key belonging to a user. |
List GPG keysgetusers_selected_user_gpg_keys | GET | Returns a paginated list of the user's GPG public keys. |
Issue Tracker33
Check if current user is watching a issuegetrepositories_workspace_repo_slug_issues_issue_id_watch | GET | Indicated whether or not the authenticated user is watching this issue. |
Check if current user voted for an issuegetrepositories_workspace_repo_slug_issues_issue_id_vote | GET | Check whether the authenticated user has voted for this issue. |
Check issue export statusgetrepositories_workspace_repo_slug_issues_export_repo_name_issues_task_id_zip | GET | This endpoint is used to poll for the progress of an issue export job and return the zip file after the job is complete. |
Check issue import statusgetrepositories_workspace_repo_slug_issues_import | GET | When using GET, this endpoint reports the status of the current import task. |
Create a comment on an issuepostrepositories_workspace_repo_slug_issues_issue_id_comments | POST | Creates a new issue comment. |
Create an issuepostrepositories_workspace_repo_slug_issues | POST | Creates a new issue. |
Delete a comment on an issuedeleterepositories_workspace_repo_slug_issues_issue_id_comments_comment_id | DELETE | Deletes the specified comment. |
Delete an attachment for an issuedeleterepositories_workspace_repo_slug_issues_issue_id_attachments_path | DELETE | Deletes an attachment. |
Delete an issuedeleterepositories_workspace_repo_slug_issues_issue_id | DELETE | Deletes the specified issue. |
Export issuespostrepositories_workspace_repo_slug_issues_export | POST | A POST request to this endpoint initiates a new background celery task that archives the repo's issues. |
Get a comment on an issuegetrepositories_workspace_repo_slug_issues_issue_id_comments_comment_id | GET | Returns the specified issue comment object. |
Get a component for issuesgetrepositories_workspace_repo_slug_components_component_id | GET | Returns the specified issue tracker component object. |
Get a defined version for issuesgetrepositories_workspace_repo_slug_versions_version_id | GET | Returns the specified issue tracker version object. |
Get a milestonegetrepositories_workspace_repo_slug_milestones_milestone_id | GET | Returns the specified issue tracker milestone object. |
Get an issuegetrepositories_workspace_repo_slug_issues_issue_id | GET | Returns the specified issue. |
Get attachment for an issuegetrepositories_workspace_repo_slug_issues_issue_id_attachments_path | GET | Returns the contents of the specified file attachment. |
Get issue change objectgetrepositories_workspace_repo_slug_issues_issue_id_changes_change_id | GET | Returns the specified issue change object. |
Import issuespostrepositories_workspace_repo_slug_issues_import | POST | A POST request to this endpoint will import the zip file given by the archive parameter into the repository. |
List attachments for an issuegetrepositories_workspace_repo_slug_issues_issue_id_attachments | GET | Returns all attachments for this issue. |
List changes on an issuegetrepositories_workspace_repo_slug_issues_issue_id_changes | GET | Returns the list of all changes that have been made to the specified issue. |
List comments on an issuegetrepositories_workspace_repo_slug_issues_issue_id_comments | GET | Returns a paginated list of all comments that were made on the specified issue. |
List componentsgetrepositories_workspace_repo_slug_components | GET | Returns the components that have been defined in the issue tracker. |
List defined versions for issuesgetrepositories_workspace_repo_slug_versions | GET | Returns the versions that have been defined in the issue tracker. |
List issuesgetrepositories_workspace_repo_slug_issues | GET | Returns the issues in the issue tracker. |
List milestonesgetrepositories_workspace_repo_slug_milestones | GET | Returns the milestones that have been defined in the issue tracker. |
Modify the state of an issuepostrepositories_workspace_repo_slug_issues_issue_id_changes | POST | Makes a change to the specified issue. |
Remove vote for an issuedeleterepositories_workspace_repo_slug_issues_issue_id_vote | DELETE | Retract your vote. |
Stop watching an issuedeleterepositories_workspace_repo_slug_issues_issue_id_watch | DELETE | Stop watching this issue. |
Update a comment on an issueputrepositories_workspace_repo_slug_issues_issue_id_comments_comment_id | PUT | Updates the content of the specified issue comment. |
Update an issueputrepositories_workspace_repo_slug_issues_issue_id | PUT | Modifies the issue. |
Upload an attachment to an issuepostrepositories_workspace_repo_slug_issues_issue_id_attachments | POST | Upload new issue attachments. |
Vote for an issueputrepositories_workspace_repo_slug_issues_issue_id_vote | PUT | Vote for this issue. |
Watch an issueputrepositories_workspace_repo_slug_issues_issue_id_watch | PUT | Start watching this issue. |
Pipelines68
Create a known hostcreateRepositoryPipelineKnownHost | POST | Create a repository level known host. |
Create a schedulecreateRepositoryPipelineSchedule | POST | Create a schedule for the given repository. |
Create a variable for a repositorycreateRepositoryPipelineVariable | POST | Create a repository level variable. |
Create a variable for a usercreatePipelineVariableForTeam | POST | Create an account level variable. |
Create a variable for a usercreatePipelineVariableForUser | POST | Create a user level variable. |
Create a variable for a workspacecreatePipelineVariableForWorkspace | POST | Create a workspace level variable. |
Create a variable for an environmentcreateDeploymentVariable | POST | Create a deployment environment level variable. |
Create repository runnercreateRepositoryRunner | POST | Create repository runner. |
Create workspace runnercreateWorkspaceRunner | POST | Create workspace runner. |
Delete a cachedeleteRepositoryPipelineCache | DELETE | Delete a repository cache. |
Delete a known hostdeleteRepositoryPipelineKnownHost | DELETE | Delete a repository level known host. |
Delete a scheduledeleteRepositoryPipelineSchedule | DELETE | Delete a schedule. |
Delete a variable for a repositorydeleteRepositoryPipelineVariable | DELETE | Delete a repository level variable. |
Delete a variable for a teamdeletePipelineVariableForTeam | DELETE | Delete a team level variable. |
Delete a variable for a userdeletePipelineVariableForUser | DELETE | Delete an account level variable. |
Delete a variable for a workspacedeletePipelineVariableForWorkspace | DELETE | Delete a workspace level variable. |
Delete a variable for an environmentdeleteDeploymentVariable | DELETE | Delete a deployment environment level variable. |
Delete cachesdeleteRepositoryPipelineCaches | DELETE | Delete repository cache versions by name. |
Delete repository runnerdeleteRepositoryRunner | DELETE | Delete repository runner by uuid. |
Delete SSH key pairdeleteRepositoryPipelineKeyPair | DELETE | Delete the repository SSH key pair. |
Delete workspace runnerdeleteWorkspaceRunner | DELETE | Delete workspace runner by uuid. |
Get a known hostgetRepositoryPipelineKnownHost | GET | Retrieve a repository level known host. |
Get a pipelinegetPipelineForRepository | GET | Retrieve a specified pipeline |
Get a schedulegetRepositoryPipelineSchedule | GET | Retrieve a schedule by its UUID. |
Get a step of a pipelinegetPipelineStepForRepository | GET | Retrieve a given step of a pipeline. |
Get a summary of test reports for a given step of a pipeline.getPipelineTestReports | GET | Get a summary of test reports for a given step of a pipeline. |
Get a variable for a repositorygetRepositoryPipelineVariable | GET | Retrieve a repository level variable. |
Get a variable for a teamgetPipelineVariableForTeam | GET | Retrieve a team level variable. |
Get a variable for a usergetPipelineVariableForUser | GET | Retrieve a user level variable. |
Get cache content URIgetRepositoryPipelineCacheContentURI | GET | Retrieve the URI of the content of the specified cache. |
Get configurationgetRepositoryPipelineConfig | GET | Retrieve the repository pipelines configuration. |
Get keys for OIDC in PipelinesgetOIDCKeys | GET | This is part of OpenID Connect for Pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/ |
Get log file for a stepgetPipelineStepLogForRepository | GET | Retrieve the log file for a given step of a pipeline. |
Get OpenID configuration for OIDC in PipelinesgetOIDCConfiguration | GET | This is part of OpenID Connect for Pipelines, see https://support.atlassian.com/bitbucket-cloud/docs/integrate-pipelines-with-resource-servers-using-oidc/ |
Get repository runnergetRepositoryRunner | GET | Retrieve repository runner by uuid. |
Get repository runnersgetRepositoryRunners | GET | Retrieve repository runners. |
Get SSH key pairgetRepositoryPipelineSshKeyPair | GET | Retrieve the repository SSH key pair excluding the SSH private key. |
Get test case reasons (output) for a given test case in a step of a pipeline.getPipelineTestReportTestCaseReasons | GET | Get test case reasons (output) for a given test case in a step of a pipeline. |
Get test cases for a given step of a pipeline.getPipelineTestReportTestCases | GET | Get test cases for a given step of a pipeline. |
Get the logs for the build container or a service container for a given step of a pipeline.getPipelineContainerLog | GET | Retrieve the log file for a build container or service container. |
Get variable for a workspacegetPipelineVariableForWorkspace | GET | Retrieve a workspace level variable. |
Get workspace runnergetWorkspaceRunner | GET | Get workspace runner by uuid. |
Get workspace runnersgetWorkspaceRunners | GET | Retrieve workspace runners. |
List cachesgetRepositoryPipelineCaches | GET | Retrieve the repository pipelines caches. |
List executions of a schedulegetRepositoryPipelineScheduleExecutions | GET | Retrieve the executions of a given schedule. |
List known hostsgetRepositoryPipelineKnownHosts | GET | Find repository level known hosts. |
List pipelinesgetPipelinesForRepository | GET | Find pipelines in a repository. |
List schedulesgetRepositoryPipelineSchedules | GET | Retrieve the configured schedules for the given repository. |
List steps for a pipelinegetPipelineStepsForRepository | GET | Find steps for the given pipeline. |
List variables for a repositorygetRepositoryPipelineVariables | GET | Find repository level variables. |
List variables for a usergetPipelineVariablesForUser | GET | Find user level variables. |
List variables for a workspacegetPipelineVariablesForWorkspace | GET | Find workspace level variables. |
List variables for an accountgetPipelineVariablesForTeam | GET | Find account level variables. |
List variables for an environmentgetDeploymentVariables | GET | Find deployment environment level variables. |
Run a pipelinecreatePipelineForRepository | POST | Endpoint to create and initiate a pipeline. |
Stop a pipelinestopPipeline | POST | Signal the stop of a pipeline and all of its steps that not have completed yet. |
Update a known hostupdateRepositoryPipelineKnownHost | PUT | Update a repository level known host. |
Update a scheduleupdateRepositoryPipelineSchedule | PUT | Update a schedule. |
Update a variable for a repositoryupdateRepositoryPipelineVariable | PUT | Update a repository level variable. |
Update a variable for a teamupdatePipelineVariableForTeam | PUT | Update a team level variable. |
Update a variable for a userupdatePipelineVariableForUser | PUT | Update a user level variable. |
Update a variable for an environmentupdateDeploymentVariable | PUT | Update a deployment environment level variable. |
Update configurationupdateRepositoryPipelineConfig | PUT | Update the pipelines configuration for a repository. |
Update repository runnerupdateRepositoryRunner | PUT | Update repository runner. |
Update SSH key pairupdateRepositoryPipelineKeyPair | PUT | Create or update the repository SSH key pair. |
Update the next build numberupdateRepositoryBuildNumber | PUT | Update the next build number that should be assigned to a pipeline. |
Update variable for a workspaceupdatePipelineVariableForWorkspace | PUT | Update a workspace level variable. |
Update workspace runnerupdateWorkspaceRunner | PUT | Update workspace runner. |
Projects16
Add the specific user as a default reviewer for the projectputworkspaces_workspace_projects_project_key_default_reviewers_selected_user | PUT | Adds the specified user to the project's list of default reviewers. |
Create a project in a workspacepostworkspaces_workspace_projects | POST | Creates a new project. |
Delete a project for a workspacedeleteworkspaces_workspace_projects_project_key | DELETE | Deletes this project. |
Delete an explicit group permission for a projectdeleteworkspaces_workspace_projects_project_key_permissions_config_groups_group_slug | DELETE | Deletes the project group permission between the requested project and group, if one exists. |
Delete an explicit user permission for a projectdeleteworkspaces_workspace_projects_project_key_permissions_config_users_selected_user_id | DELETE | Deletes the project user permission between the requested project and user, if one exists. |
Get a default reviewergetworkspaces_workspace_projects_project_key_default_reviewers_selected_user | GET | Returns the specified default reviewer. |
Get a project for a workspacegetworkspaces_workspace_projects_project_key | GET | Returns the requested project. |
Get an explicit group permission for a projectgetworkspaces_workspace_projects_project_key_permissions_config_groups_group_slug | GET | Returns the group permission for a given group and project. |
Get an explicit user permission for a projectgetworkspaces_workspace_projects_project_key_permissions_config_users_selected_user_id | GET | Returns the explicit user permission for a given user and project. |
List explicit group permissions for a projectgetworkspaces_workspace_projects_project_key_permissions_config_groups | GET | Returns a paginated list of explicit group permissions for the given project. |
List explicit user permissions for a projectgetworkspaces_workspace_projects_project_key_permissions_config_users | GET | Returns a paginated list of explicit user permissions for the given project. |
List the default reviewers in a projectgetworkspaces_workspace_projects_project_key_default_reviewers | GET | Return a list of all default reviewers for a project. |
Remove the specific user from the project's default reviewersdeleteworkspaces_workspace_projects_project_key_default_reviewers_selected_user | DELETE | Removes a default reviewer from the project. |
Update a project for a workspaceputworkspaces_workspace_projects_project_key | PUT | Since this endpoint can be used to both update and to create a project, the request body depends on the intent. |
Update an explicit group permission for a projectputworkspaces_workspace_projects_project_key_permissions_config_groups_group_slug | PUT | Updates the group permission, or grants a new permission if one does not already exist. |
Update an explicit user permission for a projectputworkspaces_workspace_projects_project_key_permissions_config_users_selected_user_id | PUT | Updates the explicit user permission for a given user and project. |
Properties12
Delete a commit application propertydeleteCommitHostedPropertyValue | DELETE | Delete an application property value stored against a commit. |
Delete a pull request application propertydeletePullRequestHostedPropertyValue | DELETE | Delete an application property value stored against a pull request. |
Delete a repository application propertydeleteRepositoryHostedPropertyValue | DELETE | Delete an application property value stored against a repository. |
Delete a user application propertydeleteUserHostedPropertyValue | DELETE | Delete an application property value stored against a user. |
Get a commit application propertygetCommitHostedPropertyValue | GET | Retrieve an application property value stored against a commit. |
Get a pull request application propertygetPullRequestHostedPropertyValue | GET | Retrieve an application property value stored against a pull request. |
Get a repository application propertygetRepositoryHostedPropertyValue | GET | Retrieve an application property value stored against a repository. |
Get a user application propertyretrieveUserHostedPropertyValue | GET | Retrieve an application property value stored against a user. |
Update a commit application propertyupdateCommitHostedPropertyValue | PUT | Update an application property value stored against a commit. |
Update a pull request application propertyupdatePullRequestHostedPropertyValue | PUT | Update an application property value stored against a pull request. |
Update a repository application propertyupdateRepositoryHostedPropertyValue | PUT | Update an application property value stored against a repository. |
Update a user application propertyupdateUserHostedPropertyValue | PUT | Update an application property value stored against a user. |
Pullrequests37
Add a user to the default reviewersputrepositories_workspace_repo_slug_default_reviewers_target_username | PUT | Adds the specified user to the repository's list of default reviewers. |
Approve a pull requestpostrepositories_workspace_repo_slug_pullrequests_pull_request_id_approve | POST | Approve the specified pull request as the authenticated user. |
Create a comment on a pull requestpostrepositories_workspace_repo_slug_pullrequests_pull_request_id_comments | POST | Creates a new pull request comment. |
Create a pull requestpostrepositories_workspace_repo_slug_pullrequests | POST | Creates a new pull request where the destination repository is this repository and the author is the authenticated user. |
Create a task on a pull requestpostrepositories_workspace_repo_slug_pullrequests_pull_request_id_tasks | POST | Creates a new pull request task. |
Decline a pull requestpostrepositories_workspace_repo_slug_pullrequests_pull_request_id_decline | POST | Declines the pull request. |
Delete a comment on a pull requestdeleterepositories_workspace_repo_slug_pullrequests_pull_request_id_comments_comment_id | DELETE | Deletes a specific pull request comment. |
Delete a task on a pull requestdeleterepositories_workspace_repo_slug_pullrequests_pull_request_id_tasks_task_id | DELETE | Deletes a specific pull request task. |
Get a comment on a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_comments_comment_id | GET | Returns a specific pull request comment. |
Get a default reviewergetrepositories_workspace_repo_slug_default_reviewers_target_username | GET | Returns the specified reviewer. |
Get a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id | GET | Returns the specified pull request. |
Get a task on a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_tasks_task_id | GET | Returns a specific pull request task. |
Get file conflicts for a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_conflicts | GET | Redirects to the repository file conflicts with the revspec that corresponds to the pull request. |
Get the diff stat for a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_diffstat | GET | Redirects to the repository diffstat with the revspec that corresponds to the pull request. |
Get the merge task status for a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_merge_task_status_task_id | GET | When merging a pull request takes too long, the client receives a task ID along with a 202 status code. |
Get the patch for a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_patch | GET | Redirects to the repository patch with the revspec that corresponds to pull request. |
List a pull request activity loggetrepositories_workspace_repo_slug_pullrequests_activity | GET | Returns a paginated list of the pull request's activity log. |
List a pull request activity loggetrepositories_workspace_repo_slug_pullrequests_pull_request_id_activity | GET | Returns a paginated list of the pull request's activity log. |
List changes in a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_diff | GET | Redirects to the repository diff with the revspec that corresponds to the pull request. |
List comments on a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_comments | GET | Returns a paginated list of the pull request's comments. |
List commit statuses for a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_statuses | GET | Returns all statuses (e.g. build results) for the given pull request. |
List commits on a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_commits | GET | Returns a paginated list of the pull request's commits. |
List default reviewersgetrepositories_workspace_repo_slug_default_reviewers | GET | Returns the repository's default reviewers. |
List effective default reviewersgetrepositories_workspace_repo_slug_effective_default_reviewers | GET | Returns the repository's effective default reviewers. |
List pull requestsgetrepositories_workspace_repo_slug_pullrequests | GET | Returns all pull requests on the specified repository. |
List pull requests that contain a commitgetPullrequestsForCommit | GET | Returns a paginated list of all pull requests as part of which this commit was reviewed. |
List tasks on a pull requestgetrepositories_workspace_repo_slug_pullrequests_pull_request_id_tasks | GET | Returns a paginated list of the pull request's tasks. |
Merge a pull requestpostrepositories_workspace_repo_slug_pullrequests_pull_request_id_merge | POST | Merges the pull request. |
Remove a user from the default reviewersdeleterepositories_workspace_repo_slug_default_reviewers_target_username | DELETE | Removes a default reviewer from the repository. |
Remove change request for a pull requestdeleterepositories_workspace_repo_slug_pullrequests_pull_request_id_request_changes | DELETE | Remove change request for a pull request |
Reopen a comment threaddeleterepositories_workspace_repo_slug_pullrequests_pull_request_id_comments_comment_id_resolve | DELETE | Reopen a comment thread |
Request changes for a pull requestpostrepositories_workspace_repo_slug_pullrequests_pull_request_id_request_changes | POST | Request changes for a pull request |
Resolve a comment threadpostrepositories_workspace_repo_slug_pullrequests_pull_request_id_comments_comment_id_resolve | POST | Resolve a comment thread |
Unapprove a pull requestdeleterepositories_workspace_repo_slug_pullrequests_pull_request_id_approve | DELETE | Redact the authenticated user's approval of the specified pull request. |
Update a comment on a pull requestputrepositories_workspace_repo_slug_pullrequests_pull_request_id_comments_comment_id | PUT | Updates a specific pull request comment. |
Update a pull requestputrepositories_workspace_repo_slug_pullrequests_pull_request_id | PUT | Mutates the specified pull request. |
Update a task on a pull requestputrepositories_workspace_repo_slug_pullrequests_pull_request_id_tasks_task_id | PUT | Updates a specific pull request task. |
Refs9
Create a branchpostrepositories_workspace_repo_slug_refs_branches | POST | Creates a new branch in the specified repository. |
Create a tagpostrepositories_workspace_repo_slug_refs_tags | POST | Creates a new annotated tag in the specified repository. |
Delete a branchdeleterepositories_workspace_repo_slug_refs_branches_name | DELETE | Delete a branch in the specified repository. |
Delete a tagdeleterepositories_workspace_repo_slug_refs_tags_name | DELETE | Delete a tag in the specified repository. |
Get a branchgetrepositories_workspace_repo_slug_refs_branches_name | GET | Returns a branch object within the specified repository. |
Get a taggetrepositories_workspace_repo_slug_refs_tags_name | GET | Returns the specified tag. |
List branches and tagsgetrepositories_workspace_repo_slug_refs | GET | Returns the branches and tags in the repository. |
List open branchesgetrepositories_workspace_repo_slug_refs_branches | GET | Returns a list of all open branches within the specified repository. |
List tagsgetrepositories_workspace_repo_slug_refs_tags | GET | Returns the tags in the repository. |
Reports9
Bulk create or update annotationsbulkCreateOrUpdateAnnotations | POST | Bulk upload of annotations. |
Create or update a reportcreateOrUpdateReport | PUT | Creates or updates a report for the specified commit. |
Create or update an annotationcreateOrUpdateAnnotation | PUT | Creates or updates an individual annotation for the specified report. |
Delete a reportdeleteReport | DELETE | Deletes a single Report matching the provided ID. |
Delete an annotationdeleteAnnotation | DELETE | Deletes a single Annotation matching the provided ID. |
Get a reportgetReport | GET | Returns a single Report matching the provided ID. |
Get an annotationgetAnnotation | GET | Returns a single Annotation matching the provided ID. |
List annotationsgetAnnotationsForReport | GET | Returns a paginated list of Annotations for a specified report. |
List reportsgetReportsForCommit | GET | Returns a paginated list of Reports linked to this commit. |
Repositories26
Create a repositorypostrepositories_workspace_repo_slug | POST | Creates a new repository. |
Create a webhook for a repositorypostrepositories_workspace_repo_slug_hooks | POST | Creates a new webhook on the specified repository. |
Delete a repositorydeleterepositories_workspace_repo_slug | DELETE | Deletes the repository. |
Delete a webhook for a repositorydeleterepositories_workspace_repo_slug_hooks_uid | DELETE | Deletes the specified webhook subscription from the given repository. |
Delete an explicit group permission for a repositorydeleterepositories_workspace_repo_slug_permissions_config_groups_group_slug | DELETE | Deletes the repository group permission between the requested repository and group, if one exists. |
Delete an explicit user permission for a repositorydeleterepositories_workspace_repo_slug_permissions_config_users_selected_user_id | DELETE | Deletes the repository user permission between the requested repository and user, if one exists. |
Fork a repositorypostrepositories_workspace_repo_slug_forks | POST | Creates a new fork of the specified repository. |
Get a repositorygetrepositories_workspace_repo_slug | GET | Returns the object describing this repository. |
Get a webhook for a repositorygetrepositories_workspace_repo_slug_hooks_uid | GET | Returns the webhook with the specified id installed on the specified repository. |
Get an explicit group permission for a repositorygetrepositories_workspace_repo_slug_permissions_config_groups_group_slug | GET | Returns the group permission for a given group slug and repository Only users with admin permission for the repository may access this resource. |
Get an explicit user permission for a repositorygetrepositories_workspace_repo_slug_permissions_config_users_selected_user_id | GET | Returns the explicit user permission for a given user and repository. |
List explicit group permissions for a repositorygetrepositories_workspace_repo_slug_permissions_config_groups | GET | Returns a paginated list of explicit group permissions for the given repository. |
List explicit user permissions for a repositorygetrepositories_workspace_repo_slug_permissions_config_users | GET | Returns a paginated list of explicit user permissions for the given repository. |
List public repositoriesgetrepositories | GET | This endpoint is deprecated. |
List repositories in a workspacegetrepositories_workspace | GET | Returns a paginated list of all repositories owned by the specified workspace. |
List repositories watchersgetrepositories_workspace_repo_slug_watchers | GET | Returns a paginated list of all the watchers on the specified repository. |
List repository forksgetrepositories_workspace_repo_slug_forks | GET | Returns a paginated list of all the forks of the specified repository. |
List repository permissions for a usergetuser_permissions_repositories | GET | This endpoint is deprecated. |
List repository permissions in a workspace for a usergetuser_workspaces_workspace_permissions_repositories | GET | Returns an object for each repository the caller has explicit access to in the specified workspace and their effective permission - the highest level of permission the caller has. |
List webhooks for a repositorygetrepositories_workspace_repo_slug_hooks | GET | Returns a paginated list of webhooks installed on this repository. |
Retrieve the inheritance state for repository settingsgetrepositories_workspace_repo_slug_override_settings | GET | Retrieve the inheritance state for repository settings |
Set the inheritance state for repository settings
putrepositories_workspace_repo_slug_override_settings | PUT | Set the inheritance state for repository settings |
Update a repositoryputrepositories_workspace_repo_slug | PUT | Since this endpoint can be used to both update and to create a repository, the request body depends on the intent. |
Update a webhook for a repositoryputrepositories_workspace_repo_slug_hooks_uid | PUT | Updates the specified webhook subscription. |
Update an explicit group permission for a repositoryputrepositories_workspace_repo_slug_permissions_config_groups_group_slug | PUT | Updates the group permission, or grants a new permission if one does not already exist. |
Update an explicit user permission for a repositoryputrepositories_workspace_repo_slug_permissions_config_users_selected_user_id | PUT | Updates the explicit user permission for a given user and repository. |
Search3
Search for code in a team's repositoriessearchTeam | GET | This API will be deprecated on November 1, 2026. |
Search for code in a user's repositoriessearchAccount | GET | This API will be deprecated on November 1, 2026. |
Search for code in a workspacesearchWorkspace | GET | This API will be deprecated on November 1, 2026. |
Snippets25
Check if the current user is watching a snippetgetsnippets_workspace_encoded_id_watch | GET | Used to check if the current user is watching a specific snippet. |
Create a comment on a snippetpostsnippets_workspace_encoded_id_comments | POST | Creates a new comment. |
Create a snippetpostsnippets | POST | Creates a new snippet under the authenticated user's account. |
Create a snippet for a workspacepostsnippets_workspace | POST | Identical to /snippets, except that the new snippet will be created under the workspace specified in the path parameter {workspace}. |
Delete a comment on a snippetdeletesnippets_workspace_encoded_id_comments_comment_id | DELETE | Deletes a snippet comment. |
Delete a previous revision of a snippetdeletesnippets_workspace_encoded_id_node_id | DELETE | Deletes the snippet. |
Delete a snippetdeletesnippets_workspace_encoded_id | DELETE | Deletes a snippet and returns an empty response. |
Get a comment on a snippetgetsnippets_workspace_encoded_id_comments_comment_id | GET | Returns the specific snippet comment. |
Get a previous revision of a snippetgetsnippets_workspace_encoded_id_node_id | GET | Identical to GET /snippets/encoded id, except that this endpoint can be used to retrieve the contents of the snippet as it was at an older revision, while /snippets/encoded id always... |
Get a previous snippet changegetsnippets_workspace_encoded_id_commits_revision | GET | Returns the changes made on this snippet in this commit. |
Get a snippetgetsnippets_workspace_encoded_id | GET | Retrieves a single snippet. |
Get a snippet's raw filegetsnippets_workspace_encoded_id_node_id_files_path | GET | Retrieves the raw contents of a specific file in the snippet. |
Get a snippet's raw file at HEADgetsnippets_workspace_encoded_id_files_path | GET | 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. |
Get snippet changes between versionsgetsnippets_workspace_encoded_id_revision_diff | GET | Returns the diff of the specified commit against its first parent. |
Get snippet patch between versionsgetsnippets_workspace_encoded_id_revision_patch | GET | Returns the patch of the specified commit against its first parent. |
List comments on a snippetgetsnippets_workspace_encoded_id_comments | GET | Used to retrieve a paginated list of all comments for a specific snippet. |
List snippet changesgetsnippets_workspace_encoded_id_commits | GET | Returns the changes (commits) made on this snippet. |
List snippetsgetsnippets | GET | This endpoint is deprecated. |
List snippets in a workspacegetsnippets_workspace | GET | Identical to /snippets, except that the result is further filtered by the snippet owner and only those that are owned by {workspace} are returned. |
List users watching a snippetgetsnippets_workspace_encoded_id_watchers | GET | Returns a paginated list of all users watching a specific snippet. |
Stop watching a snippetdeletesnippets_workspace_encoded_id_watch | DELETE | Used to stop watching a specific snippet. |
Update a comment on a snippetputsnippets_workspace_encoded_id_comments_comment_id | PUT | Updates a comment. |
Update a previous revision of a snippetputsnippets_workspace_encoded_id_node_id | PUT | Identical to UPDATE /snippets/encoded id, except that this endpoint takes an explicit commit revision. |
Update a snippetputsnippets_workspace_encoded_id | PUT | Used to update a snippet. |
Watch a snippetputsnippets_workspace_encoded_id_watch | PUT | Used to start watching a specific snippet. |
Source4
Create a commit by uploading a filepostrepositories_workspace_repo_slug_src | POST | This endpoint is used to create new commits in the repository by uploading files. |
Get file or directory contentsgetrepositories_workspace_repo_slug_src_commit_path | GET | This endpoints is used to retrieve the contents of a single file, or the contents of a directory at a specified revision. |
Get the root directory of the main branchgetrepositories_workspace_repo_slug_src | GET | This endpoint redirects the client to the directory listing of the root directory on the main branch. |
List commits that modified a filegetrepositories_workspace_repo_slug_filehistory_commit_path | GET | Returns a paginated list of commits that modified the specified file. |
SSH5
Add a new SSH keypostusers_selected_user_ssh_keys | POST | Adds a new SSH public key to the specified user account and returns the resulting key. |
Delete a SSH keydeleteusers_selected_user_ssh_keys_key_id | DELETE | Deletes a specific SSH public key from a user's account. |
Get a SSH keygetusers_selected_user_ssh_keys_key_id | GET | Returns a specific SSH public key belonging to a user. |
List SSH keysgetusers_selected_user_ssh_keys | GET | Returns a paginated list of the user's SSH public keys. |
Update a SSH keyputusers_selected_user_ssh_keys_key_id | PUT | Updates a specific SSH public key on a user's account Note: Only the 'comment' field can be updated using this API. |
Users4
Get a usergetusers_selected_user | GET | Gets the public information associated with a user account. |
Get an email address for current usergetuser_emails_email | GET | Returns details about a specific one of the authenticated user's email addresses. |
Get current usergetuser | GET | Returns the currently logged in user. |
List email addresses for current usergetuser_emails | GET | Returns all the authenticated user's email addresses. |
Webhooks2
Get a webhook resourcegethook_events | GET | Returns the webhook resource or subject types on which webhooks can be registered. |
List subscribable webhook typesgethook_events_subject_type | GET | Returns a paginated list of all valid webhook events for the specified entity. |
Workspaces18
Create a webhook for a workspacepostworkspaces_workspace_hooks | POST | Creates a new webhook on the specified workspace. |
Delete a webhook for a workspacedeleteworkspaces_workspace_hooks_uid | DELETE | Deletes the specified webhook subscription from the given workspace. |
Get a webhook for a workspacegetworkspaces_workspace_hooks_uid | GET | Returns the webhook with the specified id installed on the given workspace. |
Get a workspacegetworkspaces_workspace | GET | Returns the requested workspace. |
Get the workspace system GPG public key(s)getworkspaces_workspace_settings_gpg_public_key | GET | Returns the system public GPG key(s). |
Get user membership for a workspacegetworkspaces_workspace_members_member | GET | Returns the workspace membership, which includes a User object for the member and a Workspace object for the requested workspace. |
Get user permission on a workspacegetuser_workspaces_workspace_permission | GET | Returns the caller's effective role; as in, the highest level of privilege the caller has for the workspace. |
List a repository permissions for a workspacegetworkspaces_workspace_permissions_repositories_repo_slug | GET | Returns an object for the repository permission of each user in the requested repository. |
List all repository permissions for a workspacegetworkspaces_workspace_permissions_repositories | GET | Returns an object for each repository permission for all of a workspace's repositories. |
List projects in a workspacegetworkspaces_workspace_projects | GET | Returns the list of projects in this workspace. |
List user permissions in a workspacegetworkspaces_workspace_permissions | GET | Returns the list of members in a workspace and their permission levels. |
List users in a workspacegetworkspaces_workspace_members | GET | Returns all members of the requested workspace. |
List webhooks for a workspacegetworkspaces_workspace_hooks | GET | Returns a paginated list of webhooks installed on this workspace. |
List workspace pull requests for a usergetworkspaces_workspace_pullrequests_selected_user | GET | Returns all workspace pull requests authored by the specified user. |
List workspaces for the current usergetuser_permissions_workspaces | GET | This endpoint is deprecated. |
List workspaces for the current usergetuser_workspaces | GET | Returns an object for each workspace accessible to the caller. |
List workspaces for usergetworkspaces | GET | This endpoint is deprecated. |
Update a webhook for a workspaceputworkspaces_workspace_hooks_uid | PUT | Updates the specified webhook subscription. |