Scaling an App with the API
Using the API you can scale an app to change the number of running instances for TIBCO BusinessWorks, TIBCO Flogo®, and Node.js apps. Scaling is also used to start an app that has no running instances, or stop an app by scaling it down to zero instances.
Note: This API method does not support Hybrid apps, which are deployed and run by a Hybrid agent on a remote server, not in the TIBCO Cloud.
To scale 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/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
POST /v1/subscriptions/{subscriptionLocator}/apps/{appId}/scalemethod to scale the number instances of an existing app to the count you specify. This is an asynchronous call. - Use the
GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/statusmethod to check whether or not the app has been successfully scaled.
TIBCO Cloud Integration - Connect has a separate API that allows you to manage objects for that capability. However, TIBCO Cloud Integration - Connect apps cannot be scaled and there is no corresponding information in the TIBCO Cloud Integration - Connect Developer Portal.
Role Requirements
- Admins can scale any app in their organization.
- Users can scale any app in their organization.
- Read-only users cannot scale any app.