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

Atlassian Deployments API

The Deployments API from Atlassian — 9 operation(s) for deployments.

Atlassian Deployments API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 16 operations across 9 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://api.bitbucket.org/2.0.

16 operations 9 paths 25 schemas 3 DELETE8 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://api.bitbucket.org/2.0
Authentication
HTTP Basic, OAuth 2.0, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Atlassian Deployments API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basic). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 24 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
Atlassian List Repository Deploy Keys
atlassianListRepositoryDeployKeys 2 params → 200403404
POST
/repositories/{workspace}/{repo_slug}/deploy-keys
Atlassian Add A Repository Deploy Key
atlassianAddARepositoryDeployKey 2 params → 200400403404
DELETE
/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}
Atlassian Delete A Repository Deploy Key
atlassianDeleteARepositoryDeployKey 3 params → 204403404
GET
/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}
Atlassian Get A Repository Deploy Key
atlassianGetARepositoryDeployKey 3 params → 200403404
PUT
/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}
Atlassian Update A Repository Deploy Key
atlassianUpdateARepositoryDeployKey 3 params → 200400403404
GET
/repositories/{workspace}/{repo_slug}/deployments
Atlassian List Deployments
atlassianGetdeploymentsforrepository 2 params → 200
GET
/repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}
Atlassian Get A Deployment
atlassianGetdeploymentforrepository 3 params → 200404
GET
/repositories/{workspace}/{repo_slug}/environments
Atlassian List Environments
atlassianGetenvironmentsforrepository 2 params → 200
POST
/repositories/{workspace}/{repo_slug}/environments
Atlassian Create An Environment
atlassianCreateenvironment 2 params body → 201404409
GET
/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}
Atlassian Get An Environment
atlassianGetenvironmentforrepository 3 params → 200404
DELETE
/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}
Atlassian Delete An Environment
atlassianDeleteenvironmentforrepository 3 params → 204404
POST
/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes
Atlassian Update An Environment
atlassianUpdateenvironmentforrepository 3 params → 202404
GET
/workspaces/{workspace}/projects/{project_key}/deploy-keys
Atlassian List Project Deploy Keys
atlassianListProjectDeployKeys 2 params → 200403404
POST
/workspaces/{workspace}/projects/{project_key}/deploy-keys
Atlassian Create A Project Deploy Key
atlassianCreateAProjectDeployKey 2 params → 200400403404
DELETE
/workspaces/{workspace}/projects/{project_key}/deploy-keys/{key_id}
Atlassian Delete A Deploy Key From A Project
atlassianDeleteADeployKeyFromAProject 3 params → 204403404
GET
/workspaces/{workspace}/projects/{project_key}/deploy-keys/{key_id}
Atlassian Get A Project Deploy Key
atlassianGetAProjectDeployKey 3 params → 200403404

Schemas 25

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-deployments-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

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