How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitbucket Pipelines Pipelines API

Bitbucket Pipelines brings continuous delivery to BitbucketCloud, empowering teams with full branching to deploymentvisibility and faster feedback loops.

Bitbucket Pipelines Pipelines API is one of 23 APIs that Bitbucket Pipelines publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pipelines. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 68 operations across 37 paths, and defines 55 schemas. It is described by OpenAPI 2.0, at version 2.0.

Requests are made against the base URL https://api.bitbucket.org/2.0.

68 operations 37 paths 55 schemas 12 DELETE33 GET11 POST12 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.0
Base URL
https://api.bitbucket.org/2.0
Authentication
basic, OAuth 2.0, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Bitbucket Pipelines Pipelines API declares 3 security schemes for authenticating requests. It defines a basic scheme (basic). It supports OAuth 2.0 (oauth2) using the accessCode flow, exposing 26 scopes. An API key is passed in the header as Authorization (api_key).

  • basic — Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username a…
  • oauth2 — OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).
  • api_key — API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only availa…

Paths & Operations 68

Across 37 paths, the API surfaces 68 operations — 12 DELETE, 33 GET, 11 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.

Pipelines 68

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

GET
/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables
List variables for an environment
getDeploymentVariables 3 params → 200
POST
/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables
Create a variable for an environment
createDeploymentVariable 4 params → 201404409
PUT
/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}
Update a variable for an environment
updateDeploymentVariable 5 params → 200404
DELETE
/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}
Delete a variable for an environment
deleteDeploymentVariable 4 params → 204404
GET
/repositories/{workspace}/{repo_slug}/pipelines
List pipelines
getPipelinesForRepository 15 params → 200
POST
/repositories/{workspace}/{repo_slug}/pipelines
Run a pipeline
createPipelineForRepository 3 params → 201400404
GET
/repositories/{workspace}/{repo_slug}/pipelines-config/caches
List caches
getRepositoryPipelineCaches 2 params → 200404
DELETE
/repositories/{workspace}/{repo_slug}/pipelines-config/caches
Delete caches
deleteRepositoryPipelineCaches 3 params → 204404
DELETE
/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}
Delete a cache
deleteRepositoryPipelineCache 3 params → 204404
GET
/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri
Get cache content URI
getRepositoryPipelineCacheContentURI 3 params → 200404
GET
/repositories/{workspace}/{repo_slug}/pipelines-config/runners
Get repository runners
getRepositoryRunners 2 params → 200
POST
/repositories/{workspace}/{repo_slug}/pipelines-config/runners
Create repository runner
createRepositoryRunner 2 params → 200400409
GET
/repositories/{workspace}/{repo_slug}/pipelines-config/runners/{runner_uuid}
Get repository runner
getRepositoryRunner 3 params → 200404
PUT
/repositories/{workspace}/{repo_slug}/pipelines-config/runners/{runner_uuid}
Update repository runner
updateRepositoryRunner 3 params → 200404
DELETE
/repositories/{workspace}/{repo_slug}/pipelines-config/runners/{runner_uuid}
Delete repository runner
deleteRepositoryRunner 3 params → 204404
GET
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}
Get a pipeline
getPipelineForRepository 3 params → 200404
GET
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps
List steps for a pipeline
getPipelineStepsForRepository 3 params → 200
GET
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}
Get a step of a pipeline
getPipelineStepForRepository 4 params → 200404
GET
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log
Get log file for a step
getPipelineStepLogForRepository 4 params → 200304307404416
GET
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}
Get the logs for the build container or a service container for a given step of a pipeline.
getPipelineContainerLog 5 params → 200307404
GET
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports
Get a summary of test reports for a given step of a pipeline.
getPipelineTestReports 4 params → 200404
GET
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases
Get test cases for a given step of a pipeline.
getPipelineTestReportTestCases 4 params → 200404
GET
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons
Get test case reasons (output) for a given test case in a step of a pipeline.
getPipelineTestReportTestCaseReasons 5 params → 200404
POST
/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline
Stop a pipeline
stopPipeline 3 params → 204404400
GET
/repositories/{workspace}/{repo_slug}/pipelines_config
Get configuration
getRepositoryPipelineConfig 2 params → 200
PUT
/repositories/{workspace}/{repo_slug}/pipelines_config
Update configuration
updateRepositoryPipelineConfig 3 params → 200
PUT
/repositories/{workspace}/{repo_slug}/pipelines_config/build_number
Update the next build number
updateRepositoryBuildNumber 3 params → 200404400
POST
/repositories/{workspace}/{repo_slug}/pipelines_config/schedules
Create a schedule
createRepositoryPipelineSchedule 3 params → 201400401404
GET
/repositories/{workspace}/{repo_slug}/pipelines_config/schedules
List schedules
getRepositoryPipelineSchedules 2 params → 200404
GET
/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}
Get a schedule
getRepositoryPipelineSchedule 3 params → 200404
PUT
/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}
Update a schedule
updateRepositoryPipelineSchedule 4 params → 200404
DELETE
/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}
Delete a schedule
deleteRepositoryPipelineSchedule 3 params → 204404
GET
/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions
List executions of a schedule
getRepositoryPipelineScheduleExecutions 3 params → 200404
GET
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair
Get SSH key pair
getRepositoryPipelineSshKeyPair 2 params → 200404
PUT
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair
Update SSH key pair
updateRepositoryPipelineKeyPair 3 params → 200404
DELETE
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair
Delete SSH key pair
deleteRepositoryPipelineKeyPair 2 params → 204404
GET
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts
List known hosts
getRepositoryPipelineKnownHosts 2 params → 200
POST
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts
Create a known host
createRepositoryPipelineKnownHost 3 params → 201404409
GET
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}
Get a known host
getRepositoryPipelineKnownHost 3 params → 200404
PUT
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}
Update a known host
updateRepositoryPipelineKnownHost 4 params → 200404
DELETE
/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}
Delete a known host
deleteRepositoryPipelineKnownHost 3 params → 204404
GET
/repositories/{workspace}/{repo_slug}/pipelines_config/variables
List variables for a repository
getRepositoryPipelineVariables 2 params → 200
POST
/repositories/{workspace}/{repo_slug}/pipelines_config/variables
Create a variable for a repository
createRepositoryPipelineVariable 3 params → 201404409
GET
/repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}
Get a variable for a repository
getRepositoryPipelineVariable 3 params → 200404
PUT
/repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}
Update a variable for a repository
updateRepositoryPipelineVariable 4 params → 200404
DELETE
/repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}
Delete a variable for a repository
deleteRepositoryPipelineVariable 3 params → 204404
GET
/teams/{username}/pipelines_config/variablesdeprecated
List variables for an account
getPipelineVariablesForTeam 1 param → 200
POST
/teams/{username}/pipelines_config/variablesdeprecated
Create a variable for a user
createPipelineVariableForTeam 2 params → 201404409
GET
/teams/{username}/pipelines_config/variables/{variable_uuid}deprecated
Get a variable for a team
getPipelineVariableForTeam 2 params → 200404
PUT
/teams/{username}/pipelines_config/variables/{variable_uuid}deprecated
Update a variable for a team
updatePipelineVariableForTeam 3 params → 200404
DELETE
/teams/{username}/pipelines_config/variables/{variable_uuid}deprecated
Delete a variable for a team
deletePipelineVariableForTeam 2 params → 204404
GET
/users/{selected_user}/pipelines_config/variablesdeprecated
List variables for a user
getPipelineVariablesForUser 1 param → 200
POST
/users/{selected_user}/pipelines_config/variablesdeprecated
Create a variable for a user
createPipelineVariableForUser 2 params → 201404409
GET
/users/{selected_user}/pipelines_config/variables/{variable_uuid}deprecated
Get a variable for a user
getPipelineVariableForUser 2 params → 200404
PUT
/users/{selected_user}/pipelines_config/variables/{variable_uuid}deprecated
Update a variable for a user
updatePipelineVariableForUser 3 params → 200404
DELETE
/users/{selected_user}/pipelines_config/variables/{variable_uuid}deprecated
Delete a variable for a user
deletePipelineVariableForUser 2 params → 204404
GET
/workspaces/{workspace}/pipelines-config/identity/oidc/.well-known/openid-configuration
Get OpenID configuration for OIDC in Pipelines
getOIDCConfiguration 1 param → 200404
GET
/workspaces/{workspace}/pipelines-config/identity/oidc/keys.json
Get keys for OIDC in Pipelines
getOIDCKeys 1 param → 200404
GET
/workspaces/{workspace}/pipelines-config/runners
Get workspace runners
getWorkspaceRunners 1 param → 200
POST
/workspaces/{workspace}/pipelines-config/runners
Create workspace runner
createWorkspaceRunner 1 param → 200400409
GET
/workspaces/{workspace}/pipelines-config/runners/{runner_uuid}
Get workspace runner
getWorkspaceRunner 2 params → 200404
PUT
/workspaces/{workspace}/pipelines-config/runners/{runner_uuid}
Update workspace runner
updateWorkspaceRunner 2 params → 200404
DELETE
/workspaces/{workspace}/pipelines-config/runners/{runner_uuid}
Delete workspace runner
deleteWorkspaceRunner 2 params → 204404
GET
/workspaces/{workspace}/pipelines-config/variables
List variables for a workspace
getPipelineVariablesForWorkspace 1 param → 200
POST
/workspaces/{workspace}/pipelines-config/variables
Create a variable for a workspace
createPipelineVariableForWorkspace 2 params → 201404409
GET
/workspaces/{workspace}/pipelines-config/variables/{variable_uuid}
Get variable for a workspace
getPipelineVariableForWorkspace 2 params → 200404
PUT
/workspaces/{workspace}/pipelines-config/variables/{variable_uuid}
Update variable for a workspace
updatePipelineVariableForWorkspace 3 params → 200404
DELETE
/workspaces/{workspace}/pipelines-config/variables/{variable_uuid}
Delete a variable for a workspace
deletePipelineVariableForWorkspace 2 params → 204404

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are paginated_pipeline_known_hosts (6 properties), paginated_pipeline_caches (6 properties), paginated_pipeline_runners (6 properties), paginated_pipeline_steps (6 properties). Each schema is shown below with its type and property counts.

pipeline_cache_content_uri
object
A representation of the location of pipeline cache content.
1 property
paginated_pipeline_runners
object
A paged list of runners.
6 properties
project
pipeline_state
paginated_pipeline_schedules
object
A paged list of schedules
6 properties
base_commit
pipeline_schedule
paginated_pipeline_steps
object
A paged list of pipeline steps.
6 properties
pipeline_selector
pipeline_command
object
An executable pipeline command.
2 properties
paginated_pipeline_schedule_executions
object
A paged list of the executions of a schedule.
6 properties
account
branch
pipeline_schedule_post_request_body
pipeline_variable
paginated_pipeline_known_hosts
object
A paged list of known hosts.
6 properties
pipeline_runner_state
pipeline_runner_oauth_client
participant
paginated_pipelines
object
A paged list of pipelines
6 properties
pipelines_config
team_links
paginated_deployment_variable
object
A paged list of deployment variables.
6 properties
ref
object
A ref object, representing a branch or tag in a repository.
4 properties 1 required
paginated_pipeline_caches
object
A paged list of pipeline caches
6 properties
pipeline_ref_target
pipeline_trigger
pipeline_build_number
pipelines_pipeline_links
pipeline_step_state
pipeline_schedule_put_request_body
pipeline_cache
author
pipeline_target
error
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
2 properties 1 required
pipeline_runner_version
pipeline_schedule_execution
pipeline_ssh_public_key
committer
pipelines_links_section_href
pipeline_configuration_source
object
Information about the source of the pipeline configuration
2 properties 2 required
account_links
object
Links related to an Account.
1 property
pipeline_ssh_key_pair
pipeline_step
paginated_pipeline_variables
object
A paged list of variables.
6 properties
pipeline
deployment_variable
pipeline_known_host
pipeline_image
object
The definition of a Docker image that can be used for a Bitbucket Pipelines step execution context.
4 properties
commit
repository
link
object
A link to a resource related to this object.
2 properties
team
pipeline_runner
object
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitbucket-pipelines-pipelines-api-openapi.yml Raw ↑

Other APIs Bitbucket Pipelines publishes across the network.

Bitbucket Pipelines Addon API
Bitbucket Pipelines Branch restrictions API
Bitbucket Pipelines Branching model API
Bitbucket Pipelines Commit statuses API
Bitbucket Pipelines Commits API
Bitbucket Pipelines Deployments API
Bitbucket Pipelines Downloads API
Bitbucket Pipelines GPG API
Bitbucket Pipelines Issue tracker API
Bitbucket Pipelines Projects API
Bitbucket Pipelines properties API
Bitbucket Pipelines Pullrequests API
Where this information came from

This is an independent, third-party profile of Bitbucket Pipelines Pipelines API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.