bitbucket-api

name	bitbucket-api
description	Bitbucket API skill. Use when working with Bitbucket for addon, hook_events, repositories. Covers 335 endpoints.
version	1.0.0
generator	lapsh

Bitbucket API

API version: 2.0

Auth

basic | OAuth2 | ApiKey Authorization in header

Base URL

https://api.bitbucket.org/2.0

Setup

1. Set your API key in the appropriate header
2. GET /addon/linkers -- verify access
3. POST /addon/linkers/{linker_key}/values -- create first values

Endpoints

335 endpoints across 8 groups. See references/api-spec.lap for full details.

addon

Method	Path	Description
DELETE	/addon	Delete an app
PUT	/addon	Update an installed app
GET	/addon/linkers	List linkers for an app
GET	/addon/linkers/{linker_key}	Get a linker for an app
DELETE	/addon/linkers/{linker_key}/values	Delete all linker values
GET	/addon/linkers/{linker_key}/values	List linker values for a linker
POST	/addon/linkers/{linker_key}/values	Create a linker value
PUT	/addon/linkers/{linker_key}/values	Update a linker value
DELETE	/addon/linkers/{linker_key}/values/{value_id}	Delete a linker value
GET	/addon/linkers/{linker_key}/values/{value_id}	Get a linker value

hook_events

Method	Path	Description
GET	/hook_events	Get a webhook resource
GET	/hook_events/{subject_type}	List subscribable webhook types

repositories

Method	Path	Description
GET	/repositories	List public repositories
GET	/repositories/{workspace}	List repositories in a workspace
DELETE	/repositories/{workspace}/{repo_slug}	Delete a repository
GET	/repositories/{workspace}/{repo_slug}	Get a repository
POST	/repositories/{workspace}/{repo_slug}	Create a repository
PUT	/repositories/{workspace}/{repo_slug}	Update a repository
GET	/repositories/{workspace}/{repo_slug}/branch-restrictions	List branch restrictions
POST	/repositories/{workspace}/{repo_slug}/branch-restrictions	Create a branch restriction rule
DELETE	/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}	Delete a branch restriction rule
GET	/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}	Get a branch restriction rule
PUT	/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}	Update a branch restriction rule
GET	/repositories/{workspace}/{repo_slug}/branching-model	Get the branching model for a repository
GET	/repositories/{workspace}/{repo_slug}/branching-model/settings	Get the branching model config for a repository
PUT	/repositories/{workspace}/{repo_slug}/branching-model/settings	Update the branching model config for a repository
GET	/repositories/{workspace}/{repo_slug}/commit/{commit}	Get a commit
DELETE	/repositories/{workspace}/{repo_slug}/commit/{commit}/approve	Unapprove a commit
POST	/repositories/{workspace}/{repo_slug}/commit/{commit}/approve	Approve a commit
GET	/repositories/{workspace}/{repo_slug}/commit/{commit}/comments	List a commit's comments
POST	/repositories/{workspace}/{repo_slug}/commit/{commit}/comments	Create comment for a commit
DELETE

snippets

Method	Path	Description
GET	/snippets	List snippets
POST	/snippets	Create a snippet
GET	/snippets/{workspace}	List snippets in a workspace
POST	/snippets/{workspace}	Create a snippet for a workspace
DELETE	/snippets/{workspace}/{encoded_id}	Delete a snippet
GET	/snippets/{workspace}/{encoded_id}	Get a snippet
PUT	/snippets/{workspace}/{encoded_id}	Update a snippet
GET	/snippets/{workspace}/{encoded_id}/comments	List comments on a snippet
POST	/snippets/{workspace}/{encoded_id}/comments	Create a comment on a snippet
DELETE	/snippets/{workspace}/{encoded_id}/comments/{comment_id}	Delete a comment on a snippet
GET	/snippets/{workspace}/{encoded_id}/comments/{comment_id}	Get a comment on a snippet
PUT	/snippets/{workspace}/{encoded_id}/comments/{comment_id}	Update a comment on a snippet
GET	/snippets/{workspace}/{encoded_id}/commits	List snippet changes
GET	/snippets/{workspace}/{encoded_id}/commits/{revision}	Get a previous snippet change
GET	/snippets/{workspace}/{encoded_id}/files/{path}	Get a snippet's raw file at HEAD
DELETE	/snippets/{workspace}/{encoded_id}/watch	Stop watching a snippet
GET	/snippets/{workspace}/{encoded_id}/watch	Check if the current user is watching a snippet
PUT	/snippets/{workspace}/{encoded_id}/watch	Watch a snippet
GET	/snippets/{workspace}/{encoded_id}/watchers	List users watching a snippet
DELETE	/snippets/{workspace}/{encoded_id}/{node_id}	Delete a previous revision of a snippet
GET	/snippets/{workspace}/{encoded_id}/{node_id}	Get a previous revision of a snippet

teams

Method	Path	Description
GET	/teams/{username}/pipelines_config/variables	List variables for an account
POST	/teams/{username}/pipelines_config/variables	Create a variable for a user
GET	/teams/{username}/pipelines_config/variables/{variable_uuid}	Get a variable for a team
PUT	/teams/{username}/pipelines_config/variables/{variable_uuid}	Update a variable for a team
DELETE	/teams/{username}/pipelines_config/variables/{variable_uuid}	Delete a variable for a team
GET	/teams/{username}/search/code	Search for code in a team's repositories

user

Method	Path	Description
GET	/user	Get current user
GET	/user/emails	List email addresses for current user
GET	/user/emails/{email}	Get an email address for current user
GET	/user/permissions/repositories	List repository permissions for a user
GET	/user/permissions/workspaces	List workspaces for the current user
GET	/user/workspaces	List workspaces for the current user
GET	/user/workspaces/{workspace}/permission	Get user permission on a workspace
GET	/user/workspaces/{workspace}/permissions/repositories	List repository permissions in a workspace for a user

users

Method	Path	Description
GET	/users/{selected_user}	Get a user
GET	/users/{selected_user}/gpg-keys	List GPG keys
POST	/users/{selected_user}/gpg-keys	Add a new GPG key
DELETE	/users/{selected_user}/gpg-keys/{fingerprint}	Delete a GPG key
GET	/users/{selected_user}/gpg-keys/{fingerprint}	Get a GPG key
GET	/users/{selected_user}/pipelines_config/variables	List variables for a user
POST	/users/{selected_user}/pipelines_config/variables	Create a variable for a user
GET	/users/{selected_user}/pipelines_config/variables/{variable_uuid}	Get a variable for a user
PUT	/users/{selected_user}/pipelines_config/variables/{variable_uuid}	Update a variable for a user
DELETE	/users/{selected_user}/pipelines_config/variables/{variable_uuid}	Delete a variable for a user
PUT	/users/{selected_user}/properties/{app_key}/{property_name}	Update a user application property
DELETE	/users/{selected_user}/properties/{app_key}/{property_name}	Delete a user application property
GET	/users/{selected_user}/properties/{app_key}/{property_name}	Get a user application property
GET	/users/{selected_user}/search/code	Search for code in a user's repositories
GET	/users/{selected_user}/ssh-keys	List SSH keys
POST	/users/{selected_user}/ssh-keys	Add a new SSH key
DELETE	/users/{selected_user}/ssh-keys/{key_id}	Delete a SSH key
GET	/users/{selected_user}/ssh-keys/{key_id}	Get a SSH key
PUT	/users/{selected_user}/ssh-keys/{key_id}	Update a SSH key

workspaces

Method	Path	Description
GET	/workspaces	List workspaces for user
GET	/workspaces/{workspace}	Get a workspace
GET	/workspaces/{workspace}/hooks	List webhooks for a workspace
POST	/workspaces/{workspace}/hooks	Create a webhook for a workspace
DELETE	/workspaces/{workspace}/hooks/{uid}	Delete a webhook for a workspace
GET	/workspaces/{workspace}/hooks/{uid}	Get a webhook for a workspace
PUT	/workspaces/{workspace}/hooks/{uid}	Update a webhook for a workspace
GET	/workspaces/{workspace}/members	List users in a workspace
GET	/workspaces/{workspace}/members/{member}	Get user membership for a workspace
GET	/workspaces/{workspace}/permissions	List user permissions in a workspace
GET	/workspaces/{workspace}/permissions/repositories	List all repository permissions for a workspace
GET	/workspaces/{workspace}/permissions/repositories/{repo_slug}	List a repository permissions for a workspace
GET	/workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration	Get OpenID configuration for OIDC in Pipelines
GET	/workspaces/{workspace}/pipelines-config/identity/oidc/keys.json	Get keys for OIDC in Pipelines
GET	/workspaces/{workspace}/pipelines-config/runners	Get workspace runners
POST	/workspaces/{workspace}/pipelines-config/runners	Create workspace runner
GET	/workspaces/{workspace}/pipelines-config/runners/{runner_uuid}	Get workspace runner
PUT	/workspaces/{workspace}/pipelines-config/runners/{runner_uuid}	Update workspace runner
DELETE	/workspaces/{workspace}/pipelines-config/runners/{runner_uuid}	Delete workspace runner
GET	/workspaces/{workspace}/pipelines-config/variables

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all linkers?" -> GET /addon/linkers
• "Get linker details?" -> GET /addon/linkers/{linker_key}
• "List all values?" -> GET /addon/linkers/{linker_key}/values
• "Create a value?" -> POST /addon/linkers/{linker_key}/values
• "Delete a value?" -> DELETE /addon/linkers/{linker_key}/values/{value_id}
• "Get value details?" -> GET /addon/linkers/{linker_key}/values/{value_id}
• "List all hook_events?" -> GET /hook_events
• "Get hook_event details?" -> GET /hook_events/{subject_type}
• "Search repositories?" -> GET /repositories
• "Search repositories?" -> GET /repositories/{workspace}
• "Delete a repository?" -> DELETE /repositories/{workspace}/{repo_slug}
• "Get repository details?" -> GET /repositories/{workspace}/{repo_slug}
• "Update a repository?" -> PUT /repositories/{workspace}/{repo_slug}
• "List all branch-restrictions?" -> GET /repositories/{workspace}/{repo_slug}/branch-restrictions
• "Create a branch-restriction?" -> POST /repositories/{workspace}/{repo_slug}/branch-restrictions
• "Delete a branch-restriction?" -> DELETE /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}
• "Get branch-restriction details?" -> GET /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}
• "Update a branch-restriction?" -> PUT /repositories/{workspace}/{repo_slug}/branch-restrictions/{id}
• "List all branching-model?" -> GET /repositories/{workspace}/{repo_slug}/branching-model
• "List all settings?" -> GET /repositories/{workspace}/{repo_slug}/branching-model/settings
• "Get commit details?" -> GET /repositories/{workspace}/{repo_slug}/commit/{commit}
• "Create a approve?" -> POST /repositories/{workspace}/{repo_slug}/commit/{commit}/approve
• "Search comments?" -> GET /repositories/{workspace}/{repo_slug}/commit/{commit}/comments
• "Create a comment?" -> POST /repositories/{workspace}/{repo_slug}/commit/{commit}/comments
• "Delete a comment?" -> DELETE /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}
• "Get comment details?" -> GET /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}
• "Update a comment?" -> PUT /repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}
• "Update a property?" -> PUT /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}
• "Delete a property?" -> DELETE /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}
• "Get property details?" -> GET /repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}
• "List all pullrequests?" -> GET /repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP