Sign in
ForgeInstallation

Persist installation credentials and migrate workspace bindings

Persist installation credentials and migrate workspace bindings. Restricted to infrastructure API keys with global integration permissions.

put/atlassian/forge/installations/{installation_id}

Path parameters

installation_idstring required

installation id

Query parameters

app_idstring required

app id

environment_idstring required

environment id

Request body

installation_idstring required
app_idstring required
environment_idstring required
cloud_idstring
api_base_urlstring
base_urlstring
legacy_client_keystring
replaces_installation_idstring
system_tokenstring

Private app system token. Never store in workspace integration configuration.

token_expires_atinteger

Token expiry in milliseconds since the Unix epoch.

encryption_workspace_idstring

Server-managed. Workspace whose KMS key currently encrypts system_token; absent while the installation is unclaimed and the token sits under the shared unclaimed-installations key.

activeboolean

Server-managed installation state; an inactive identity cannot be reactivated.

Response

Success

installation_idstring required
app_idstring required
environment_idstring required
cloud_idstring
api_base_urlstring
base_urlstring
legacy_client_keystring
replaces_installation_idstring
system_tokenstring

Private app system token. Never store in workspace integration configuration.

token_expires_atinteger

Token expiry in milliseconds since the Unix epoch.

encryption_workspace_idstring

Server-managed. Workspace whose KMS key currently encrypts system_token; absent while the installation is unclaimed and the token sits under the shared unclaimed-installations key.

activeboolean

Server-managed installation state; an inactive identity cannot be reactivated.

Changes

Changed in 1 of the 32 revisions of this API.1