ATatlassian
Addon

Get the client key of a Connect addon

Changed on

Get the client key of the Connect addon associated with a Forge app install via forgeAppId linkage.

This endpoint is part of the Connect -> Forge migration tooling. It is intended to be used by a Forge app using asApp().requestBitbucket() only. Prerequisite: app developer needs to register the linkage between their Connect and Forge app by setting forgeAppId in the Connect addon descriptor to app.id from Forge app manifest, then update the installations. If the request came from an installation of a registered Forge app, the client key of the linked Connect addon installed in the same workspace will be returned.

api.asApp().requestBitbucket(route`/2.0/addon/{addon-key}/client-key`)
get/addon/{addon_key}/client-key

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/addon/{addon_key}/client-key
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token
    • or HTTP basic
    • or API key in header Authorization

Response

The client key of the Connect addon linked to the Forge app installation where the request was made

Changes