Pinning an App with the API

By using the API, you can pin a TIBCO Flogo® or TIBCO BusinessWorks app. Pinning an app gives you the ability to go back to a previous version of an app if there is an issue with the current version of the app.

Considerations

• If you pin an app and then later pin the same app again, the last pin overrides the previous pin. The last pinned version of an app is the version that is available to be restored.
• When you pin an app, the PIN CREATED action is recorded and displays in the App Details History tab for the selected app.
• Remote apps cannot be pinned.

To pin 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.

1. Use the POST /v1/subscriptions/{subscriptionLocator}/apps/{appId}/pin method to pin the current version of an app.
2. Use the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/pin method to see the pin for the selected app.

TIBCO Cloud Integration - Connect has a separate API that allows you to manage objects for that capability. The TIBCO Cloud Integration - Connect API can restore prior versions of flows within an app. For more information, see the help for GET /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId}/revisions and POST /v1/orgs/{orgId}/solutions/{solutionId}/maps/{mapId}/revert under Maps in the TIBCO Cloud Integration - Connect Developer Portal.

Role Requirements

Only Admin users can pin apps.

Related Topics

Viewing an App Pin with the API

Restoring a Pinned App with the API

Deleting an App Pin with the API