Cloud

Bitbucket Cloud / Reference / REST APIs

Addon

The addon resource is intended to use used by Bitbucket Cloud Connect Apps, and only supports JWT authentication.

Operations

PUT/addon DEL/addon GET/addon/linkers GET/addon/linkers/{linker_key}GET/addon/linkers/{linker_key}/values PUT/addon/linkers/{linker_key}/values POST/addon/linkers/{linker_key}/values DEL/addon/linkers/{linker_key}/values GET/addon/linkers/{linker_key}/values/{value_id}DEL/addon/linkers/{linker_key}/values/{value_id}

PUT

Update an installed app

Updates the application installation for the user.

This endpoint is intended to be used by Bitbucket Connect apps and only supports JWT authentication -- that is how Bitbucket identifies the particular installation of the app. Developers with applications registered in the "Develop Apps" section of Bitbucket need not use this endpoint as updates for those applications can be sent out via the UI of that section.

Passing an empty body will update the installation using the existing descriptor URL.


1
2
3
4
$ curl -X PUT https://api.bitbucket.org/2.0/addon \
  -H "Authorization: JWT <JWT Token>" \
  --header "Content-Type: application/json" \
  --data '{}'

The new descriptor for the installation can be also provided in the body directly.


1
2
3
4
$ curl -X PUT https://api.bitbucket.org/2.0/addon \
  -H "Authorization: JWT <JWT Token>" \
  --header "Content-Type: application/json" \
  --data '{"descriptor": $NEW_DESCRIPTOR}'

In both these modes the URL of the descriptor cannot be changed. To change the descriptor location and upgrade an installation the request must be made exclusively with a descriptor_url.


1
2
3
4
$ curl -X PUT https://api.bitbucket.org/2.0/addon \
 -H "Authorization: JWT <JWT Token>" \
 --header "Content-Type: application/json" \
 --data '{"descriptor_url": $NEW_URL}'

The descriptor_url must exactly match the marketplace registration that Atlassian has for the application. Contact your Atlassian developer advocate to update this registration. Once the registration has been updated you may call this resource for each installation.

Note that the scopes of the application cannot be increased in the new descriptor nor reduced to none.

Request

This request has no parameters.

Responses

Request has succeeded. The installation has been updated to the new descriptor.

PUT/addon

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'https://api.bitbucket.org/2.0/addon' \
  --header 'Authorization: Bearer <access_token>'

DEL

Delete an app

Deletes the application for the user.

This endpoint is intended to be used by Bitbucket Connect apps and only supports JWT authentication -- that is how Bitbucket identifies the particular installation of the app. Developers with applications registered in the "Develop Apps" section of Bitbucket Marketplace need not use this endpoint as updates for those applications can be sent out via the UI of that section.


1
2
$ curl -X DELETE https://api.bitbucket.org/2.0/addon \
  -H "Authorization: JWT <JWT Token>"

Request

This request has no parameters.

Responses

Request has succeeded. The application has been deleted for the user.

DEL/addon

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.bitbucket.org/2.0/addon' \
  --header 'Authorization: Bearer <access_token>'

GET

List linkers for an app

Gets a list of all linkers for the authenticated application.

Request

This request has no parameters.

Responses

Successful.

GET/addon/linkers

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.bitbucket.org/2.0/addon/linkers' \
  --header 'Authorization: Bearer <access_token>'

GET

Get a linker for an app

Gets a linker specified by linker_key for the authenticated application.

Request

Path parameters

linker_key

string

Required

Responses

Successful.

GET/addon/linkers/{linker_key}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}' \
  --header 'Authorization: Bearer <access_token>'

GET

List linker values for a linker

Gets a list of all linker values for the specified linker of the authenticated application.

A linker value lets applications supply values to modify its regular expression.

The base regular expression must use a Bitbucket-specific match group (?K) which will be translated to ([\w\-]+). A value must match this pattern.

Request

Path parameters

linker_key

string

Required

Responses

Successful.

GET/addon/linkers/{linker_key}/values

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values' \
  --header 'Authorization: Bearer <access_token>'

PUT

Update a linker value

Bulk update linker values for the specified linker of the authenticated application.

A linker value lets applications supply values to modify its regular expression.

The base regular expression must use a Bitbucket-specific match group (?K) which will be translated to ([\w\-]+). A value must match this pattern.

Request

Path parameters

linker_key

string

Required

Responses

Successfully updated the linker values.

PUT/addon/linkers/{linker_key}/values

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values' \
  --header 'Authorization: Bearer <access_token>'

POST

Create a linker value

Creates a linker value for the specified linker of authenticated application.

A linker value lets applications supply values to modify its regular expression.

The base regular expression must use a Bitbucket-specific match group (?K) which will be translated to ([\w\-]+). A value must match this pattern.

Request

Path parameters

linker_key

string

Required

Responses

Successfully created the linker value.

POST/addon/linkers/{linker_key}/values

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values' \
  --header 'Authorization: Bearer <access_token>'

DEL

Delete all linker values

Delete all linker values for the specified linker of the authenticated application.

Request

Path parameters

linker_key

string

Required

Responses

Successfully deleted the linker values.

DEL/addon/linkers/{linker_key}/values

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values' \
  --header 'Authorization: Bearer <access_token>'

GET

Get a linker value

Get a single linker value of the authenticated application.

Request

Path parameters

linker_key

string

Required

value_id

integer

Required

Responses

Successful.

GET/addon/linkers/{linker_key}/values/{value_id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values/{value_id}' \
  --header 'Authorization: Bearer <access_token>'

DEL

Delete a linker value

Delete a single linker value of the authenticated application.

Request

Path parameters

linker_key

string

Required

value_id

integer

Required

Responses

Successfully deleted the linker value.

DEL/addon/linkers/{linker_key}/values/{value_id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values/{value_id}' \
  --header 'Authorization: Bearer <access_token>'