The Bitbucket Cloud REST API

Developer Day is June 9th, 2022. Register now for free!

Other operations

Get a commit application property

GET /2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}

Retrieve an application property value stored against a commit.

OAuth scopes required:

NONE

Request

Path parameters

workspace Required

string

The repository container; either the workspace slug or the UUID in curly braces.

repo_slug Required

string

The repository.

commit Required

string

The commit.

app_key Required

string

The key of the Connect app.

property_name Required

string

The name of the property.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}' \
  --header 'Accept: application/json'

Responses

200

The value of the property.

Content type	Value
application/json	Application Property

Update a commit application property

PUT /2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}

Update an application property value stored against a commit.

OAuth scopes required:

NONE

Request

Path parameters

workspace Required

string

The repository container; either the workspace slug or the UUID in curly braces.

repo_slug Required

string

The repository.

commit Required

string

The commit.

app_key Required

string

The key of the Connect app.

property_name Required

string

The name of the property.

Body parameters

An application property. It is a caller defined JSON object that Bitbucket will store and return. The _attributes field at its top level can be used to control who is allowed to read and update the property. The keys of the JSON object must match an allowed pattern. For details, see Application properties.

_attributes

Array<string>

Valid values: public, read_only

Additional Properties

anything

Extra properties of any type may be provided to this object.

Example

cURL

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}' \
  --header 'Content-Type: application/json' \
  --data '{
  "_attributes": [
    "public"
  ]
}'

Responses

204

An empty response.

Delete a commit application property

DELETE /2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}

Delete an application property value stored against a commit.

OAuth scopes required:

NONE

Request

Path parameters

workspace Required

string

The repository container; either the workspace slug or the UUID in curly braces.

repo_slug Required

string

The repository.

commit Required

string

The commit.

app_key Required

string

The key of the Connect app.

property_name Required

string

The name of the property.

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}'

Responses

204

An empty response.

Get a repository application property

GET /2.0/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}

Retrieve an application property value stored against a repository.

OAuth scopes required:

NONE

Request

Path parameters

workspace Required

string

The repository container; either the workspace slug or the UUID in curly braces.

repo_slug Required

string

The repository.

app_key Required

string

The key of the Connect app.

property_name Required

string

The name of the property.

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

The value of the property.

Content type	Value
application/json	Application Property

Update a repository application property

PUT /2.0/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}

Update an application property value stored against a repository.

OAuth scopes required:

NONE

Request

Path parameters

workspace Required

string

The repository container; either the workspace slug or the UUID in curly braces.

repo_slug Required

string

The repository.

app_key Required

string

The key of the Connect app.

property_name Required

string

The name of the property.

Body parameters

_attributes

Array<string>

Valid values: public, read_only

Additional Properties

anything

Extra properties of any type may be provided to this object.

Example

cURL

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}' \
  --header 'Content-Type: application/json' \
  --data '{
  "_attributes": [
    "public"
  ]
}'

Responses

204

An empty response.

Delete a repository application property

DELETE /2.0/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}

Delete an application property value stored against a repository.

OAuth scopes required:

NONE

Request

Path parameters

workspace Required

string

The repository container; either the workspace slug or the UUID in curly braces.

repo_slug Required

string

The repository.

app_key Required

string

The key of the Connect app.

property_name Required

string

The name of the property.

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}'

Responses

204

An empty response.

Get a pull request application property

GET /2.0/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}

Retrieve an application property value stored against a pull request.

OAuth scopes required:

NONE

Request

Path parameters

workspace