Attaching 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 add 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. - Access key ID — ID of the Hybrid agent access key to be used in the API method.
- Generate a Hybrid agent access key under your TIBCO Cloud Integration user settings. Be sure to copy it immediately and store it in a safe location. The key is only displayed once when it is generated. See Generating or Revoking Access Keys.
- Use the
PUT /v1/subscriptions/{subscriptionLocator}/apps/{appId}/env/tunnelkeymethod to attach the access key you generated to a specific app. This is an asynchronous call. - Include the appId of the app where you are attaching the access key.
- Include access key ID of the key you generated under your user settings.
- Use the
GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/statusmethod to check whether or not the app has been successfully rescaled. - Use the
GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}method to verify that the keys have been updated.
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