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 Deployments API

Teams are deploying code faster than ever, thanks to continuousdelivery practices and tools like Bitbucket Pipelines. BitbucketDeployments gives teams visibility into their deploymentenvironments and helps teams to track how far changes haveprogressed in their deployment pipeline.

Bitbucket Deployments API is one of 23 APIs that Bitbucket publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, and 8 JSON Schemas.

This API exposes 16 operations across 9 paths, and defines 26 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.

16 operations 9 paths 26 schemas 3 DELETE8 GET4 POST1 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 Deployments 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 16

Across 9 paths, the API surfaces 16 operations — 3 DELETE, 8 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Deployments 16

Teams are deploying code faster than ever, thanks to continuous delivery practices and tools like Bitbucket Pipelines. Bitbucket Deployments gives teams visibility into their depl…

GET
/repositories/{workspace}/{repo_slug}/deploy-keys
List repository deploy keys
2 params → 200403404
POST
/repositories/{workspace}/{repo_slug}/deploy-keys
Add a repository deploy key
2 params → 200400403404
DELETE
/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}
Delete a repository deploy key
3 params → 204403404
GET
/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}
Get a repository deploy key
3 params → 200403404
PUT
/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}
Update a repository deploy key
3 params → 200400403404
GET
/repositories/{workspace}/{repo_slug}/deployments
List deployments
getDeploymentsForRepository 2 params → 200
GET
/repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}
Get a deployment
getDeploymentForRepository 3 params → 200404
GET
/repositories/{workspace}/{repo_slug}/environments
List environments
getEnvironmentsForRepository 2 params → 200
POST
/repositories/{workspace}/{repo_slug}/environments
Create an environment
createEnvironment 3 params → 201404409
GET
/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}
Get an environment
getEnvironmentForRepository 3 params → 200404
DELETE
/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}
Delete an environment
deleteEnvironmentForRepository 3 params → 204404
POST
/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes
Update an environment
updateEnvironmentForRepository 3 params → 202404
GET
/workspaces/{workspace}/projects/{project_key}/deploy-keys
List project deploy keys
2 params → 200403404
POST
/workspaces/{workspace}/projects/{project_key}/deploy-keys
Create a project deploy key
2 params → 200400403404
DELETE
/workspaces/{workspace}/projects/{project_key}/deploy-keys/{key_id}
Delete a deploy key from a project
3 params → 204403404
GET
/workspaces/{workspace}/projects/{project_key}/deploy-keys/{key_id}
Get a project deploy key
3 params → 200403404

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are paginated_deployments (6 properties), paginated_project_deploy_keys (6 properties), paginated_environments (6 properties), paginated_deploy_keys (6 properties). Each schema is shown below with its type and property counts.

paginated_deploy_keys
object
A paginated list of deploy keys.
6 properties
base_commit
paginated_deployments
object
A paged list of deployments
6 properties
paginated_project_deploy_keys
object
A paginated list of project deploy keys.
6 properties
repository
deployment_environment
deployment
deployment_release
committer
author
ref
object
A ref object, representing a branch or tag in a repository.
4 properties 1 required
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
commit
link
object
A link to a resource related to this object.
2 properties
project_deploy_key
deploy_key
account
participant
account_links
object
Links related to an Account.
1 property
branch
team_links
deployment_state
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
paginated_environments
object
A paged list of environments
6 properties
team
project

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitbucket-deployments-api-openapi.yml Raw ↑

Other APIs Bitbucket publishes across the network.

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

This is an independent, third-party profile of Bitbucket Deployments 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.