Checking the Status of an App with the API

Check the status of asynchronous API calls to an apps endpoint, such as POST /v1/subscriptions/{subscriptionLocator}/apps, using the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/status method to determine when the asynchronous call has completed.

To check the status of an app 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/userinfo method 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}/apps method.

Make the asynchronous API call to create or modify an app.
Call the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/status method using the appId of the new or updated app.
You may need to make the status call more than once until you receive a response with complete status such as running or error.

{
  "status": "running",
  "message": "App is running",
  "instanceStatus": {
    "running": 1,
    "starting": 0,
    "failed": 0,
    "desired": 1,
    "vpn": 0
  }
}

TIBCO Cloud Integration - Connect has a separate API that allows you to manage objects for that capability. For more information on checking app status for TIBCO Cloud Integration - Connect apps, see the help for GET /v1/orgs/{orgId}/solutions/{solutionId} under Solutions in the TIBCO Cloud Integration - Connect Developer Portal.

Checking the Status of an App with the API

Related Topics