The Bitbucket Cloud REST API

Pipelines

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

List variables for an environment

GET /2.0/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables

Find deployment environment level variables.

Request

Path parameters

workspace Required

string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slug Required

string

The repository.

environment_uuid Required

string

The environment.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables' \
  --header 'Accept: application/json'

Responses

200

The retrieved deployment variables.

Content type	Value
application/json	Paginated Deployment Variables

Create a variable for an environment

POST /2.0/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables

Create a deployment environment level variable.

Request

Path parameters

workspace Required

string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slug Required

string

The repository.

environment_uuid Required

string

The environment.

Body parameters

Content type	Value
application/json	allOf [object, Deployment Variable]

Example

cURL

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "<string>",
  "uuid": "<string>",
  "key": "<string>",
  "value": "<string>",
  "secured": true
}'

Responses

201

404

409

The variable was created.

Content type	Value
application/json	allOf [object, Deployment Variable]

Header Parameters

Location

string

The URL of the newly created variable.

Update a variable for an environment

PUT /2.0/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}

Update a deployment environment level variable.

Request

Path parameters

workspace Required

string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slug Required

string

The repository.

environment_uuid Required

string

The environment.

variable_uuid Required

string

The UUID of the variable to update.

Body parameters

Content type	Value
application/json	allOf [object, Deployment Variable]

Example

cURL

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "<string>",
  "uuid": "<string>",
  "key": "<string>",
  "value": "<string>",
  "secured": true
}'

Responses

200

404

The deployment variable was updated.

Content type	Value
application/json	allOf [object, Deployment Variable]

Delete a variable for an environment

DELETE /2.0/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}

Delete a deployment environment level variable.

Request

Path parameters

workspace Required

string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slug Required

string

The repository.

environment_uuid Required

string

The environment.

variable_uuid Required

string

The UUID of the variable to delete.

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}'

Responses

204

404

The variable was deleted.

List caches

GET /2.0/repositories/{workspace}/{repo_slug}/pipelines-config/caches/

Retrieve the repository pipelines caches.

Request

Path parameters

workspace Required

string

The account.

repo_slug Required

string

The repository.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines-config/caches/' \
  --header 'Accept: application/json'

Responses

200

404

The list of caches for the given repository.

Content type	Value
application/json	Paginated Pipeline Cache

Delete a cache

DELETE /2.0/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}

Delete a repository cache.

Request

Path parameters

workspace Required

string

The account.

repo_slug Required

string

The repository.

cache_uuid Required

string

The UUID of the cache to delete.

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}'

Responses

204

404

The cache was deleted.

Get cache content URI

GET /2.0/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri

Retrieve the URI of the content of the specified cache.

Request

Path parameters

workspace Required

string

The account.

repo_slug Required

string

The repository.

cache_uuid Required

string

The UUID of the cache.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri' \
  --header 'Accept: application/json'