Bitbucket

Bitbucket Pipelines API

Bitbucket Pipelines brings continuous delivery to Bitbucket Cloud, empowering teams with full branching to deployment visibility and faster feedback loops.

GitHub OpenAPI
Business capability
Continuous Integration Management BC-4210.10

Operations 68

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables List variables for a deployment environment · List variables for an environment #
Ask an LLM
“Which variables are set on my staging deployment environment?”
“Can I see the environment-level variables a deployment step will pick up?”
Tell an agent
List the variables on deployment environment {environment_uuid} in {workspace}/{repo_slug}.
Show me every environment-level variable for environment {environment_uuid} of repo {repo_slug}.
POST /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables Add a variable to a deployment environment · Create a variable for an environment #
Ask an LLM
“How do I add a secret just for my production deployment environment?”
“Can a deployment environment variable be marked as secured so its value is hidden?”
Tell an agent
Add variable {key} with value {value} to deployment environment {environment_uuid} in {workspace}/{repo_slug}.
Create a secured environment variable {key} on environment {environment_uuid} of repo {repo_slug} in {workspace}.
PUT /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid} Update a deployment environment variable · Update a variable for an environment #
Ask an LLM
“How do I change the value of an existing variable on a deployment environment?”
“Can I flip an environment variable I already created to secured?”
Tell an agent
Set environment variable {variable_uuid} on environment {environment_uuid} in {workspace}/{repo_slug} to {value}.
Rename deployment environment variable {variable_uuid} in environment {environment_uuid} to {key}; repo {workspace}/{repo_slug}.
DELETE /repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid} Remove a variable from a deployment environment · Delete a variable for an environment #
Ask an LLM
“How do I remove a variable that's only defined on one deployment environment?”
“What happens to a deployment environment when I delete one of its variables?”
Tell an agent destructive · confirm first
Delete variable {variable_uuid} from deployment environment {environment_uuid} in {workspace}/{repo_slug}.
Remove environment-level variable {variable_uuid} from environment {environment_uuid} of repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines List pipeline runs in a repository · List pipelines #
Ask an LLM
“Which pipelines have run on my main branch recently?”
“Can I filter a repo's pipeline runs by status or by what triggered them?”
Tell an agent
List pipelines in {workspace}/{repo_slug} for branch {branch}.
Show pipeline runs in {workspace}/{repo_slug} with status {status}, sorted by {sort}.
POST /repositories/{workspace}/{repo_slug}/pipelines Run a pipeline · Run a pipeline #
Ask an LLM
“How do I trigger a Bitbucket pipeline run from the API?”
“Can I kick off a pipeline on a branch and pass it custom variables?”
Tell an agent
Run a pipeline in {workspace}/{repo_slug} against target {target}.
Start a pipeline on {repo_slug} in {workspace} for target {target} with variables {variables}.
GET /repositories/{workspace}/{repo_slug}/pipelines-config/caches List a repository's pipeline caches · List caches #
Ask an LLM
“What dependency caches are my pipelines storing for this repo?”
“Can I see how big each pipeline cache is before clearing them?”
Tell an agent
List the pipeline caches for {workspace}/{repo_slug}.
Show all build caches stored for repo {repo_slug} in workspace {workspace}.
DELETE /repositories/{workspace}/{repo_slug}/pipelines-config/caches Clear pipeline caches by name · Delete caches #
Ask an LLM
“How do I wipe every version of the node cache for my pipelines?”
“Can I clear a cache by its name rather than by its UUID?”
Tell an agent destructive · confirm first
Delete all versions of pipeline cache {name} in {workspace}/{repo_slug}.
Clear the cache named {name} for repo {repo_slug} in {workspace}.
DELETE /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid} Delete a single pipeline cache · Delete a cache #
Ask an LLM
“How do I delete just one specific cache entry from my pipelines by its ID?”
“Is there a way to drop one corrupted pipeline cache without touching the others?”
Tell an agent destructive · confirm first
Delete pipeline cache {cache_uuid} from {workspace}/{repo_slug}.
Remove the single cache {cache_uuid} in repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri Get the download link for a pipeline cache · Get cache content URI #
Ask an LLM
“Where can I download the contents of a pipeline cache?”
“Can I get a URI to inspect what's inside a cached dependency archive?”
Tell an agent
Get the content URI for cache {cache_uuid} in {workspace}/{repo_slug}.
Give me the download link for pipeline cache {cache_uuid} of repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines-config/runners List self-hosted runners for a repository · Get repository runners #
Ask an LLM
“Which self-hosted runners are registered to this repository?”
“Can I see the status of runners attached at the repo level?”
Tell an agent
List the repository runners for {workspace}/{repo_slug}.
Show self-hosted runners registered on repo {repo_slug} in {workspace}.
POST /repositories/{workspace}/{repo_slug}/pipelines-config/runners Register a self-hosted runner on a repository · Create repository runner #
Ask an LLM
“How do I register a new self-hosted runner scoped to one repo?”
“Can I add a runner to a single repository instead of the whole workspace?”
Tell an agent
Create a repository runner for {workspace}/{repo_slug}.
Register a new self-hosted runner on repo {repo_slug} in workspace {workspace}.
GET /repositories/{workspace}/{repo_slug}/pipelines-config/runners/{runner_uuid} Get a repository runner · Get repository runner #
Ask an LLM
“What are the details and state of one repo-level runner?”
“Can I check whether a particular repository runner is online?”
Tell an agent
Get repository runner {runner_uuid} in {workspace}/{repo_slug}.
Show me the details of runner {runner_uuid} attached to repo {repo_slug}.
PUT /repositories/{workspace}/{repo_slug}/pipelines-config/runners/{runner_uuid} Update a repository runner · Update repository runner #
Ask an LLM
“How do I change the settings of a runner registered on a repo?”
“Can I rename or relabel an existing repository runner?”
Tell an agent
Update repository runner {runner_uuid} in {workspace}/{repo_slug}.
Modify the repo-level runner {runner_uuid} on {repo_slug}.
DELETE /repositories/{workspace}/{repo_slug}/pipelines-config/runners/{runner_uuid} Remove a repository runner · Delete repository runner #
Ask an LLM
“How do I unregister a self-hosted runner from a repository?”
“Can I delete a repo runner that is no longer in use?”
Tell an agent destructive · confirm first
Delete repository runner {runner_uuid} from {workspace}/{repo_slug}.
Unregister runner {runner_uuid} from repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid} Get a pipeline run · Get a pipeline #
Ask an LLM
“What is the status and duration of a specific pipeline run?”
“Can I see who triggered a pipeline and how many build seconds it used?”
Tell an agent
Get pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
Show the state of pipeline run {pipeline_uuid} for repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps List the steps of a pipeline run · List steps for a pipeline #
Ask an LLM
“Which steps did my pipeline run and which one failed?”
“Can I list every step in a pipeline with its status?”
Tell an agent
List the steps of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
Show all steps for pipeline run {pipeline_uuid} in repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid} Get one step of a pipeline run · Get a step of a pipeline #
Ask an LLM
“What happened in one particular step of my pipeline?”
“Can I see the timing and result of a single pipeline step?”
Tell an agent
Get step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
Show details for pipeline step {step_uuid} in run {pipeline_uuid} of repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log Download the log for a pipeline step · Get log file for a step #
Ask an LLM
“How do I fetch the build log for a failed pipeline step?”
“Can I read only part of a very large step log using a byte range?”
Tell an agent
Get the log for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
Download the full step log for {step_uuid} in pipeline run {pipeline_uuid}.
GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid} Get a build or service container log · Get the logs for the build container or a service container for a given step of… #
Ask an LLM
“How do I see the logs from a service container like a database running alongside my step?”
“Can I fetch the log of one specific container within a pipeline step?”
Tell an agent
Get container log {log_uuid} for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
Fetch the service container log {log_uuid} from step {step_uuid}.
GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports Summarize test results for a pipeline step · Get a summary of test reports for a given step of a pipeline #
Ask an LLM
“How many tests passed and failed in a pipeline step?”
“Can I get a test report summary for one step of my build?”
Tell an agent
Summarize the test reports for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
Show the test results summary for pipeline step {step_uuid}.
GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases List test cases run in a pipeline step · Get test cases for a given step of a pipeline #
Ask an LLM
“Which individual test cases ran in this pipeline step?”
“Can I list every test case and its outcome from a step's test report?”
Tell an agent
List the test cases for step {step_uuid} of pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
Show each test case executed in pipeline step {step_uuid}.
GET /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons Get the failure output for a test case · Get test case reasons (output) for a given test case in a step of a pipeline #
Ask an LLM
“Why did a specific test case fail in my pipeline?”
“Can I see the output and stack trace recorded for one test case?”
Tell an agent
Get the reasons for test case {test_case_uuid} in step {step_uuid} of pipeline {pipeline_uuid}, repo {workspace}/{repo_slug}.
Show the failure output for test case {test_case_uuid} in step {step_uuid}.
POST /repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline Stop a running pipeline · Stop a pipeline #
Ask an LLM
“How do I cancel a pipeline that is still running?”
“Does stopping a pipeline also halt its steps that haven't finished?”
Tell an agent destructive · confirm first
Stop pipeline {pipeline_uuid} in {workspace}/{repo_slug}.
Cancel the running pipeline {pipeline_uuid} on repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines_config Check whether Pipelines is enabled on a repo · Get configuration #
Ask an LLM
“Is Pipelines turned on for this repository?”
“Where can I view a repository's pipelines configuration settings?”
Tell an agent
Get the pipelines configuration for {workspace}/{repo_slug}.
Check if Pipelines is enabled on repo {repo_slug} in {workspace}.
PUT /repositories/{workspace}/{repo_slug}/pipelines_config Enable or disable Pipelines on a repo · Update configuration #
Ask an LLM
“How do I turn on Bitbucket Pipelines for a repository through the API?”
“Can I disable Pipelines for a repo without deleting its configuration?”
Tell an agent
Set pipelines enabled to {enabled} for {workspace}/{repo_slug}.
Turn on Pipelines for repo {repo_slug} in workspace {workspace}.
PUT /repositories/{workspace}/{repo_slug}/pipelines_config/build_number Set the next pipeline build number · Update the next build number #
Ask an LLM
“How do I bump the build number my next pipeline will get?”
“Can I reset the build counter to a lower number than the last build?”
Tell an agent
Set the next build number for {workspace}/{repo_slug} to {next}.
Bump repo {repo_slug}'s pipeline build counter so the next build is {next}.
POST /repositories/{workspace}/{repo_slug}/pipelines_config/schedules Schedule a pipeline to run on a cron · Create a schedule #
Ask an LLM
“How do I schedule a nightly pipeline run?”
“Can I set a cron pattern so a branch pipeline runs automatically?”
Tell an agent
Create a pipeline schedule in {workspace}/{repo_slug} for target {target} with cron {cron_pattern}.
Schedule the pipeline for {target} on repo {repo_slug} to run on {cron_pattern}.
GET /repositories/{workspace}/{repo_slug}/pipelines_config/schedules List scheduled pipelines · List schedules #
Ask an LLM
“Which pipelines are scheduled to run on a timer in this repo?”
“Can I see all the cron schedules configured for my pipelines?”
Tell an agent
List pipeline schedules for {workspace}/{repo_slug}.
Show every scheduled pipeline configured on repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} Get a pipeline schedule · Get a schedule #
Ask an LLM
“What cron pattern and target does one of my pipeline schedules use?”
“Can I check whether a particular schedule is currently enabled?”
Tell an agent
Get pipeline schedule {schedule_uuid} in {workspace}/{repo_slug}.
Show the settings of schedule {schedule_uuid} on repo {repo_slug}.
PUT /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} Pause or resume a pipeline schedule · Update a schedule #
Ask an LLM
“How do I temporarily pause a scheduled pipeline without deleting it?”
“Can I re-enable a pipeline schedule I turned off?”
Tell an agent
Set schedule {schedule_uuid} in {workspace}/{repo_slug} to enabled {enabled}.
Pause the pipeline schedule {schedule_uuid} on repo {repo_slug}.
DELETE /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid} Delete a pipeline schedule · Delete a schedule #
Ask an LLM
“How do I permanently remove a scheduled pipeline?”
“Can I delete a cron schedule that I no longer need?”
Tell an agent destructive · confirm first
Delete pipeline schedule {schedule_uuid} from {workspace}/{repo_slug}.
Remove the schedule {schedule_uuid} on repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions List runs triggered by a schedule · List executions of a schedule #
Ask an LLM
“Did my nightly scheduled pipeline actually run last night?”
“Can I see the history of executions for one pipeline schedule?”
Tell an agent
List executions of schedule {schedule_uuid} in {workspace}/{repo_slug}.
Show the run history for pipeline schedule {schedule_uuid} on repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair Get the pipelines SSH public key · Get SSH key pair #
Ask an LLM
“What public key do my pipelines use when connecting over SSH?”
“Can I retrieve the repo's pipelines SSH key without exposing the private key?”
Tell an agent
Get the pipelines SSH key pair for {workspace}/{repo_slug}.
Show the public SSH key configured for pipelines on repo {repo_slug}.
PUT /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair Set the SSH key pair used by pipelines · Update SSH key pair #
Ask an LLM
“How do I give my build container an SSH identity to reach a private server?”
“Can I replace the SSH key pair my pipelines use?”
Tell an agent
Set the pipelines SSH key pair for {workspace}/{repo_slug} with private key {private_key} and public key {public_key}.
Upload public key {public_key} and its private key {private_key} as the build SSH identity for repo {repo_slug}.
DELETE /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair Remove the pipelines SSH key pair · Delete SSH key pair #
Ask an LLM
“How do I remove the SSH key my pipelines use?”
“Can I revoke a repo's pipeline SSH identity if the key was leaked?”
Tell an agent destructive · confirm first
Delete the pipelines SSH key pair from {workspace}/{repo_slug}.
Remove the build SSH key pair on repo {repo_slug} in {workspace}.
GET /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts List pipeline SSH known hosts · List known hosts #
Ask an LLM
“Which hosts have I added as trusted known hosts for pipeline SSH?”
“Can I see the host fingerprints my builds trust?”
Tell an agent
List the pipelines known hosts for {workspace}/{repo_slug}.
Show all trusted SSH known hosts on repo {repo_slug}.
POST /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts Add a trusted SSH known host for pipelines · Create a known host #
Ask an LLM
“How do I add a server to my pipeline's known_hosts so SSH doesn't prompt?”
“Can I trust a new host's public key for builds in one repository?”
Tell an agent
Add known host {hostname} with public key {public_key} to {workspace}/{repo_slug}.
Trust host {hostname} for pipelines SSH on repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} Get a pipeline SSH known host · Get a known host #
Ask an LLM
“What fingerprint is stored for a specific known host in my pipelines?”
“Can I look up one known host entry by its ID?”
Tell an agent
Get known host {known_host_uuid} in {workspace}/{repo_slug}.
Show the stored public key for known host {known_host_uuid} on repo {repo_slug}.
PUT /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} Update a pipeline SSH known host · Update a known host #
Ask an LLM
“How do I update a known host after the server's SSH key changed?”
“Can I change the hostname on an existing known host entry?”
Tell an agent
Update known host {known_host_uuid} in {workspace}/{repo_slug} to public key {public_key}.
Change the hostname of known host {known_host_uuid} on repo {repo_slug} to {hostname}.
DELETE /repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid} Remove a pipeline SSH known host · Delete a known host #
Ask an LLM
“How do I stop my pipelines trusting a host I added before?”
“Can I delete a stale known host entry from a repo?”
Tell an agent destructive · confirm first
Delete known host {known_host_uuid} from {workspace}/{repo_slug}.
Remove trusted host {known_host_uuid} from repo {repo_slug}'s pipelines.
GET /repositories/{workspace}/{repo_slug}/pipelines_config/variables List a repository's pipeline variables · List variables for a repository #
Ask an LLM
“Which repository variables are available to all my pipeline steps?”
“Can I see the repo-level pipeline variables and which ones are secured?”
Tell an agent
List the repository pipeline variables for {workspace}/{repo_slug}.
Show all repo-level build variables on {repo_slug} in {workspace}.
POST /repositories/{workspace}/{repo_slug}/pipelines_config/variables Add a pipeline variable to a repository · Create a variable for a repository #
Ask an LLM
“How do I add an API token as a repository variable for my builds?”
“Can I create a secured repository variable so it's masked in logs?”
Tell an agent
Create repository variable {key} with value {value} in {workspace}/{repo_slug}.
Add a secured repo-level variable {key} to repo {repo_slug}.
GET /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} Get a repository pipeline variable · Get a variable for a repository #
Ask an LLM
“What is the key and secured flag of a specific repository variable?”
“Can I look up a single repo-level variable by its UUID?”
Tell an agent
Get repository variable {variable_uuid} in {workspace}/{repo_slug}.
Show repo-level variable {variable_uuid} on {repo_slug}.
PUT /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} Update a repository pipeline variable · Update a variable for a repository #
Ask an LLM
“How do I rotate the value of a repository-level pipeline variable?”
“Can I change a repo variable's name without recreating it?”
Tell an agent
Set repository variable {variable_uuid} in {workspace}/{repo_slug} to value {value}.
Rename repo-level variable {variable_uuid} on {repo_slug} to {key}.
DELETE /repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid} Delete a repository pipeline variable · Delete a variable for a repository #
Ask an LLM
“How do I remove a repository variable my builds no longer need?”
“Can I delete a repo-level pipeline variable by its UUID?”
Tell an agent destructive · confirm first
Delete repository variable {variable_uuid} from {workspace}/{repo_slug}.
Remove repo-level build variable {variable_uuid} on {repo_slug}.
GET /teams/{username}/pipelines_config/variables List a team's pipeline variables (deprecated) · List variables for an account #
Ask an LLM
“Which account-level pipeline variables are defined for my team on the old teams endpoint?”
“Can I still list team pipeline variables through the deprecated teams API?”
Tell an agent
List team pipeline variables for team {username} using the deprecated teams endpoint.
Show account-level variables for team {username}.
POST /teams/{username}/pipelines_config/variables Add a team pipeline variable (deprecated) · Create a variable for a user #
Ask an LLM
“How do I create an account-level variable for a team on the legacy teams endpoint?”
“Can I still add team pipeline variables via the deprecated API?”
Tell an agent
Create team variable {key} with value {value} for team {username}.
Add a secured account-level variable {key} to team {username} via the legacy endpoint.
GET /teams/{username}/pipelines_config/variables/{variable_uuid} Get a team pipeline variable (deprecated) · Get a variable for a team #
Ask an LLM
“What does a specific team-level pipeline variable contain on the old teams API?”
“Can I fetch one team variable by UUID through the deprecated endpoint?”
Tell an agent
Get team variable {variable_uuid} for team {username}.
Show team-level pipeline variable {variable_uuid} owned by {username} via the legacy endpoint.
PUT /teams/{username}/pipelines_config/variables/{variable_uuid} Update a team pipeline variable (deprecated) · Update a variable for a team #
Ask an LLM
“How do I change a team-level pipeline variable using the legacy teams endpoint?”
“Can I rotate a team variable's value on the deprecated API?”
Tell an agent
Set team variable {variable_uuid} for team {username} to value {value}.
Rename team-level variable {variable_uuid} of {username} to {key}.
DELETE /teams/{username}/pipelines_config/variables/{variable_uuid} Delete a team pipeline variable (deprecated) · Delete a variable for a team #
Ask an LLM
“How do I delete a team-level variable through the old teams endpoint?”
“Can I remove a team pipeline variable on the deprecated API?”
Tell an agent destructive · confirm first
Delete team variable {variable_uuid} from team {username}.
Remove team-level pipeline variable {variable_uuid} owned by {username} via the legacy endpoint.
GET /users/{selected_user}/pipelines_config/variables List a user's pipeline variables (deprecated) · List variables for a user #
Ask an LLM
“Which pipeline variables are defined at the personal user level?”
“Can I list a user account's pipeline variables on the deprecated users endpoint?”
Tell an agent
List user-level pipeline variables for {selected_user}.
Show the personal account variables for user {selected_user} via the legacy endpoint.
POST /users/{selected_user}/pipelines_config/variables Add a user pipeline variable (deprecated) · Create a variable for a user #
Ask an LLM
“How do I add a pipeline variable to my personal user account?”
“Can I still create user-level variables through the deprecated users API?”
Tell an agent
Create user variable {key} with value {value} for {selected_user}.
Add a secured personal pipeline variable {key} to user {selected_user}.
GET /users/{selected_user}/pipelines_config/variables/{variable_uuid} Get a user pipeline variable (deprecated) · Get a variable for a user #
Ask an LLM
“What does one of my personal user-level pipeline variables hold?”
“Can I fetch a single user variable by UUID on the legacy endpoint?”
Tell an agent
Get user variable {variable_uuid} for {selected_user}.
Show personal pipeline variable {variable_uuid} of user {selected_user}.
PUT /users/{selected_user}/pipelines_config/variables/{variable_uuid} Update a user pipeline variable (deprecated) · Update a variable for a user #
Ask an LLM
“How do I change the value of a personal user-level pipeline variable?”
“Can I mark an existing user variable as secured on the deprecated API?”
Tell an agent
Set user variable {variable_uuid} for {selected_user} to value {value}.
Rename personal variable {variable_uuid} of user {selected_user} to {key}.
DELETE /users/{selected_user}/pipelines_config/variables/{variable_uuid} Delete a user pipeline variable (deprecated) · Delete a variable for a user #
Ask an LLM
“How do I delete a pipeline variable from my personal user account?”
“Can I remove user-level variables through the old users endpoint?”
Tell an agent destructive · confirm first
Delete user variable {variable_uuid} from {selected_user}.
Remove personal pipeline variable {variable_uuid} of user {selected_user}.
GET /workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration Get the Pipelines OIDC discovery document · Get OpenID configuration for OIDC in Pipelines #
Ask an LLM
“What OpenID Connect configuration do my pipelines expose for cloud role federation?”
“Where is the issuer and discovery metadata for Pipelines OIDC tokens?”
Tell an agent
Get the OpenID configuration for Pipelines OIDC in workspace {workspace}.
Fetch the .well-known OIDC discovery document for {workspace}'s pipelines.
GET /workspaces/{workspace}/pipelines-config/identity/oidc/keys.json Get the signing keys for Pipelines OIDC tokens · Get keys for OIDC in Pipelines #
Ask an LLM
“Which public keys verify the OIDC tokens my pipelines issue?”
“Can I get the JWKS my resource server needs to trust Bitbucket Pipelines?”
Tell an agent
Get the OIDC signing keys for pipelines in workspace {workspace}.
Fetch the keys.json used to verify Pipelines tokens for {workspace}.
GET /workspaces/{workspace}/pipelines-config/runners List self-hosted runners for a workspace · Get workspace runners #
Ask an LLM
“Which self-hosted runners are shared across my whole workspace?”
“Can I see all workspace-level runners and their status?”
Tell an agent
List workspace runners in {workspace}.
Show every self-hosted runner shared across workspace {workspace}.
POST /workspaces/{workspace}/pipelines-config/runners Register a self-hosted runner for a workspace · Create workspace runner #
Ask an LLM
“How do I register a runner that every repository in the workspace can use?”
“Can I add a shared self-hosted runner at the workspace level?”
Tell an agent
Create a workspace runner in {workspace}.
Register a shared self-hosted runner for all repos in {workspace}.
GET /workspaces/{workspace}/pipelines-config/runners/{runner_uuid} Get a workspace runner · Get workspace runner #
Ask an LLM
“What's the current state of one shared workspace runner?”
“Can I look up a workspace-level runner by its UUID?”
Tell an agent
Get workspace runner {runner_uuid} in {workspace}.
Show details of shared runner {runner_uuid} in workspace {workspace}.
PUT /workspaces/{workspace}/pipelines-config/runners/{runner_uuid} Update a workspace runner · Update workspace runner #
Ask an LLM
“How do I change the labels on a shared workspace runner?”
“Can I edit a workspace-level runner's configuration?”
Tell an agent
Update workspace runner {runner_uuid} in {workspace}.
Modify shared runner {runner_uuid} belonging to workspace {workspace}.
DELETE /workspaces/{workspace}/pipelines-config/runners/{runner_uuid} Remove a workspace runner · Delete workspace runner #
Ask an LLM
“How do I unregister a runner shared across the workspace?”
“Can I delete a workspace-level runner we've decommissioned?”
Tell an agent destructive · confirm first
Delete workspace runner {runner_uuid} from {workspace}.
Unregister shared runner {runner_uuid} in workspace {workspace}.
GET /workspaces/{workspace}/pipelines-config/variables List a workspace's pipeline variables · List variables for a workspace #
Ask an LLM
“Which pipeline variables are shared by every repo in my workspace?”
“Can I see the workspace-level variables and whether they're secured?”
Tell an agent
List workspace pipeline variables in {workspace}.
Show every variable defined at the workspace level for {workspace}.
POST /workspaces/{workspace}/pipelines-config/variables Add a pipeline variable to a workspace · Create a variable for a workspace #
Ask an LLM
“How do I add a credential every repo's pipelines in the workspace can use?”
“Can I create a secured workspace-wide pipeline variable?”
Tell an agent
Create workspace variable {key} with value {value} in {workspace}.
Add a secured workspace-wide variable {key} to {workspace}.
GET /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} Get a workspace pipeline variable · Get variable for a workspace #
Ask an LLM
“What is stored in one specific workspace-level pipeline variable?”
“Can I fetch a workspace variable by its UUID?”
Tell an agent
Get workspace variable {variable_uuid} in {workspace}.
Show workspace-level variable {variable_uuid} for {workspace}.
PUT /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} Update a workspace pipeline variable · Update variable for a workspace #
Ask an LLM
“How do I rotate a secret stored as a workspace-level variable?”
“Can I rename a workspace variable that all repos share?”
Tell an agent
Set workspace variable {variable_uuid} in {workspace} to value {value}.
Rename workspace-level variable {variable_uuid} in {workspace} to {key}.
DELETE /workspaces/{workspace}/pipelines-config/variables/{variable_uuid} Delete a workspace pipeline variable · Delete a variable for a workspace #
Ask an LLM
“How do I remove a variable shared across the whole workspace?”
“Can I delete a workspace-level pipeline variable by UUID?”
Tell an agent destructive · confirm first
Delete workspace variable {variable_uuid} from {workspace}.
Remove workspace-wide variable {variable_uuid} in {workspace}.

Documentation

📖
Documentation
https://developer.atlassian.com/bitbucket/api/2/reference/
📖
Authentication
https://developer.atlassian.com/cloud/bitbucket/rest/intro/#authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/openapi/bitbucket-pipelines-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/asyncapi/bitbucket-cloud-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-schema/bitbucket-cloud-rest-api-repository-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-schema/bitbucket-cloud-rest-api-pullrequest-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-schema/bitbucket-cloud-rest-api-pipeline-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-schema/bitbucket-cloud-rest-api-commit-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-structure/bitbucket-cloud-rest-api-repository-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-structure/bitbucket-cloud-rest-api-pullrequest-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-structure/bitbucket-cloud-rest-api-pipeline-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/json-structure/bitbucket-cloud-rest-api-commit-structure.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/examples/bitbucket-cloud-rest-api-repository-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/examples/bitbucket-cloud-rest-api-pullrequest-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/examples/bitbucket-cloud-rest-api-pipeline-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/examples/bitbucket-cloud-rest-api-commit-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bitbucket:bitbucket-pipelines-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bitbucket-pipelines-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bitbucket Pipelines API
  description: 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.
  version: '2.0'
  termsOfService: https://www.atlassian.com/legal/customer-agreement
  contact:
    name: Bitbucket Support
    url: https://support.atlassian.com/bitbucket-cloud/
    email: support@bitbucket.org
servers:
- url: https://api.bitbucket.org/2.0
tags:


# --- truncated at 32 KB (266 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitbucket/refs/heads/main/openapi/bitbucket-pipelines-api-openapi.yml