Detaching App Access Keys with the API
If you are using the Hybrid agent with apps that connect to on-premise systems, those apps require access keys. In this scenario, both the Hybrid agent and the associated app are installed and run locally. Use the API to add or remove Hybrid agent access keys for an app. Hybrid agent access keys are generated in the user interface under Settings > Proxy Agent access keys.
To detach access keys you need the following:
- Subscription Locator — The Subscription Locator of the Organization you want to access. To find Subscription Locators for your organizations use the
GET /v1/userinfomethod to return a list of all of the organizations for your OAuth Token with their Subscription Locators. You can use 0 as the Subscription Locator for the organization that owns the OAuth token. - App ID — ID of the app to be accessed, which can be retrieved using the
GET /v1/subscriptions/{subscriptionLocator}/appsmethod.
- Use the
DELETE /v1/subscriptions/{subscriptionLocator}/apps/{appId}/env/tunnelkeymethod to remove the access key from a specific app. This is an asynchronous call. - Include the appId of the app from which you are detaching the access key.
- Use the
GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/statusmethod to check whether or not the app has been successfully scaled. - Use the
GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}method to verify that the key has been removed.
When Hybrid agent access keys are added or removed from an app, the app is rescaled.
Related Topics
Managing Environment Controls with the TIBCO Cloud™ Integration API