Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.bitbucket.org/2.0
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.
| method | path | what the vendor says it does |
|---|---|---|
PUT | /addon | Update an installed app Updates the application installation for the user. This endpoint is intended to be us |
DELETE | /addon | Delete an app Deletes the application for the user. This endpoint is intended to be used by Bitbucket Connect |
GET | /addon/linkers | List linkers for an app Gets a list of all [linkers](/cloud/bitbucket/modules/linker/) for the authenticated a |
GET | /addon/linkers/{linker_key} | Get a linker for an app Gets a [linker](/cloud/bitbucket/modules/linker/) specified by `linker_key` for the au |
GET | /addon/linkers/{linker_key}/values | List linker values for a linker Gets a list of all [linker](/cloud/bitbucket/modules/linker/) values for the s |
POST | /addon/linkers/{linker_key}/values | Create a linker value Creates a [linker](/cloud/bitbucket/modules/linker/) value for the specified linker of a |
PUT | /addon/linkers/{linker_key}/values | Update a linker value Bulk update [linker](/cloud/bitbucket/modules/linker/) values for the specified linker o |
DELETE | /addon/linkers/{linker_key}/values | Delete all linker values Delete all [linker](/cloud/bitbucket/modules/linker/) values for the specified linker |
GET | /addon/linkers/{linker_key}/values/{value_id} | Get a linker value Get a single [linker](/cloud/bitbucket/modules/linker/) value of the authenticated applicat |
DELETE | /addon/linkers/{linker_key}/values/{value_id} | Delete a linker value Delete a single [linker](/cloud/bitbucket/modules/linker/) value of the authenticated ap |
GET | /hook_events | Get a webhook resource Returns the webhook resource or subject types on which webhooks can be registered. Eac |
GET | /hook_events/{subject_type} | List subscribable webhook types Returns a paginated list of all valid webhook events for the specified entity. |
GET | /pullrequests/{selected_user} | List pull requests for a user Returns all pull requests authored by the specified user. By default only open |
GET | /repositories | List public repositories Returns a paginated list of all public repositories. This endpoint also supports fil |
GET | /repositories/{workspace} | List repositories in a workspace Returns a paginated list of all repositories owned by the specified workspace |
GET | /repositories/{workspace}/{repo_slug} | Get a repository Returns the object describing this repository. Repositories |
POST | /repositories/{workspace}/{repo_slug} | Create a repository Creates a new repository. Note: In order to set the project for the newly created reposit |
PUT | /repositories/{workspace}/{repo_slug} | Update a repository Since this endpoint can be used to both update and to create a repository, the request bod |
DELETE | /repositories/{workspace}/{repo_slug} | Delete a repository Deletes the repository. This is an irreversible operation. This does not affect its forks |
GET | /repositories/{workspace}/{repo_slug}/branch-restrictions | List branch restrictions Returns a paginated list of all branch restrictions on the repository. Branch restric |
POST | /repositories/{workspace}/{repo_slug}/branch-restrictions | Create a branch restriction rule Creates a new branch restriction rule for a repository. `kind` describes wha |
GET | /repositories/{workspace}/{repo_slug}/branch-restrictions/{id} | Get a branch restriction rule Returns a specific branch restriction rule. Branch restrictions |
PUT | /repositories/{workspace}/{repo_slug}/branch-restrictions/{id} | Update a branch restriction rule Updates an existing branch restriction rule. Fields not present in the reque |
DELETE | /repositories/{workspace}/{repo_slug}/branch-restrictions/{id} | Delete a branch restriction rule Deletes an existing branch restriction rule. Branch restrictions |
GET | /repositories/{workspace}/{repo_slug}/branching-model | Get the branching model for a repository Return the branching model as applied to the repository. This view is |
GET | /repositories/{workspace}/{repo_slug}/branching-model/settings | Get the branching model config for a repository Return the branching model configuration for a repository. The |
PUT | /repositories/{workspace}/{repo_slug}/branching-model/settings | Update the branching model config for a repository Update the branching model configuration for a repository. |
GET | /repositories/{workspace}/{repo_slug}/commit/{commit} | Get a commit Returns the specified commit. Example: ``` $ curl https://api.bitbucket.org/2.0/repositories/bi |
POST | /repositories/{workspace}/{repo_slug}/commit/{commit}/approve | Approve a commit Approve the specified commit as the authenticated user. This operation is only available to |
DELETE | /repositories/{workspace}/{repo_slug}/commit/{commit}/approve | Unapprove a commit Redact the authenticated user's approval of the specified commit. This operation is only a |
GET | /repositories/{workspace}/{repo_slug}/commit/{commit}/comments | List a commit's comments Returns the commit's comments. This includes both global and inline comments. The d |
POST | /repositories/{workspace}/{repo_slug}/commit/{commit}/comments | Create comment for a commit Creates new comment on the specified commit. To post a reply to an existing comme |
GET | /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id} | Get a commit comment Returns the specified commit comment. Commits |
PUT | /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id} | Update a commit comment Used to update the contents of a comment. Only the content of the comment can be updat |
DELETE | /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id} | Delete a commit comment Deletes the specified commit comment. Note that deleting comments that have visible r |
GET | /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} | Get a commit application property Retrieve an [application property](/cloud/bitbucket/application-properties/) |
PUT | /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} | Update a commit application property Update an [application property](/cloud/bitbucket/application-properties/ |
DELETE | /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name} | Delete a commit application property Delete an [application property](/cloud/bitbucket/application-properties/ |
GET | /repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests | List pull requests that contain a commit Returns a paginated list of all pull requests as part of which this c |
GET | /repositories/{workspace}/{repo_slug}/commit/{commit}/reports | List reports Returns a paginated list of Reports linked to this commit. Reports Commits |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://bitbucket.org/api/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.