Rate this page:
The addon resource is intended to use used by Bitbucket Cloud Connect Apps, and only supports JWT authentication.
PUT /2.0/addon
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$ 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$ 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$ 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.
1 2 3
curl --request PUT \
--url 'https://api.bitbucket.org/2.0/addon' \
--header 'Authorization: Bearer <access_token>'Request has succeeded. The installation has been updated to the new descriptor.
DELETE /2.0/addon
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>"
1 2 3
curl --request DELETE \
--url 'https://api.bitbucket.org/2.0/addon' \
--header 'Authorization: Bearer <access_token>'Request has succeeded. The application has been deleted for the user.
GET /2.0/addon/linkers
Gets a list of all linkers for the authenticated application.
1 2 3
curl --request GET \
--url 'https://api.bitbucket.org/2.0/addon/linkers' \
--header 'Authorization: Bearer <access_token>'Successful.
A schema has not been defined for this response code.
GET /2.0/addon/linkers/{linker_key}
Gets a linker specified by linker_key
for the authenticated application.
string
The unique key of a linker module as defined in an application descriptor.
1 2 3
curl --request GET \
--url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}' \
--header 'Authorization: Bearer <access_token>'Successful.
A schema has not been defined for this response code.
GET /2.0/addon/linkers/{linker_key}/values
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.
string
The unique key of a linker module as defined in an application descriptor.
1 2 3
curl --request GET \
--url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values' \
--header 'Authorization: Bearer <access_token>'Successful.
A schema has not been defined for this response code.
PUT /2.0/addon/linkers/{linker_key}/values
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.
string
The unique key of a linker module as defined in an application descriptor.
1 2 3
curl --request PUT \
--url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values' \
--header 'Authorization: Bearer <access_token>'Successfully updated the linker values.
POST /2.0/addon/linkers/{linker_key}/values
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.
string
The unique key of a linker module as defined in an application descriptor.
1 2 3
curl --request POST \
--url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values' \
--header 'Authorization: Bearer <access_token>'Successfully created the linker value.
A schema has not been defined for this response code.
DELETE /2.0/addon/linkers/{linker_key}/values
Delete all linker values for the specified linker of the authenticated application.
string
The unique key of a linker module as defined in an application descriptor.
1 2 3
curl --request DELETE \
--url 'https://api.bitbucket.org/2.0/addon/linkers/{linker_key}/values' \
--header 'Authorization: Bearer <access_token>'Successfully deleted the linker values.
GET /2.0/addon/linkers/{linker_key}/values/{value_id}
Get a single linker value of the authenticated application.
string
The unique key of a linker module as defined in an application descriptor.
integer
The numeric ID of the linker value.
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>'Successful.
A schema has not been defined for this response code.
DELETE /2.0/addon/linkers/{linker_key}/values/{value_id}
Delete a single linker value of the authenticated application.
string
The unique key of a linker module as defined in an application descriptor.
integer
The numeric ID of the linker value.
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>'