Application and Build Management APIs

This section describes all the APIs to manage the app builds for the TIBCO Flogo Capability.

Note: If you want to use a namespace different from the default data plane namespace for any APIs using the Namespace parameter, see Deploying App Outside Data Plane Namespace.

You can find the following APIs in the 'Apps and Builds' section of the TIBCO FLOGO® Capability APIs page. For instructions on how to access the TIBCO FLOGO® Capability APIs page, see Accessing the API Documentation with Swagger UI.

API for Deleting an Application

Use the DELETE /v1/dp/apps/{appId} API to delete an application from the data plane.

To delete an app, you need the following parameters:

  • App Id: The application Id.

  • Namespace: The namespace where the application is deployed. This parameter is not mandatory and is only required if the application is running outside of the default data plane namespace.

METHOD Path Parameters
DELETE

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Viewing Application details

Use the GET /v1/dp/apps/{appId}/details API to view the application details for a specified App Id.

To view the app details, you need the following parameters:

  • App Id: The application Id.

  • Namespace: The namespace where the application is deployed. This parameter is not mandatory and is only required if the application is running outside of the default data plane namespace.

METHOD Path Parameters
GET

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Viewing Application Endpoints 

Use the GET /v1/dp/apps/{appId}/endpoints API to return a list of both the public and private application endpoints for a specified App Id. This API returns details about a private or public endpoint and the Ingress configuration for the public endpoint.

To view the app endpoint details, you need the following parameters:

  • App Id: The application Id.

  • Namespace: The namespace where the application is deployed. This parameter is not mandatory and is only required if the application is running outside of the default data plane namespace.

METHOD Path Parameters
GET

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Scaling an Application

Use the PUT /v1/dp/apps/{appId}/scale/{count} API to scale the number of instances for an existing application to the count you specify.

Caution: Avoid using the scale operation when the autoscaling option is configured.

To scale an app, you need the following parameters:

  • App Id: The application Id.

  • Count: The number of count for scaling.

  • Namespace: The namespace where the application is deployed. This parameter is not mandatory and is only required if the application is running outside of the default data plane namespace.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: count (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Updating (Refreshing) Application Properties without Application Restart

Use the PUT /v1/dp/apps/{appId}/config/refresh API to update the application properties without restarting the app instance, if the app property reconfigure is enabled.

Before you begin

You must set the engine variable FLOGO_APP_PROP_RECONFIGURE to true to update the application configuration for that particular app.

To update the app properties, you need the following parameters:

  • App Id: The application Id.

  • Namespace: The namespace where the application is deployed. This parameter is not mandatory and is only required if the application is running outside of the default data plane namespace.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String
Note: The list of config in key value pairs to update the app properties must be identical to its counterpart (app property) in the Application Properties dialog in Flogo. If the parameter names do not match exactly, a warning message is displayed, and the app uses the default value that you configured for the property in Flogo.

API for Viewing Application builds

Use the GET /v1/dp/builds API to return a list of all the TIBCO Flogo application builds on the data plane.

This API requires no parameters.

METHOD Path Parameters
GET None

API for Building an Application Executable Using app.json or app.flogo File

Use the POST /v1/dp/builds API to build a TIBCO Flogo application executable.

To create an app executable, you need the following parameters:

  • Base Version: The TIBCO Flogo base version.

  • Operating System: Compatible operating system for app binary

  • app.json: The .json or .flogo file to upload.

 
METHOD Path Parameters
POST

  • Parameters: baseversion

  • Type: String

  • Parameters: OS

  • Type: String

  • Parameters: arch

  • Type: String

  • Parameters: app.json

  • Type: String

API for Downloading an Application Executable

Use the GET /v1/dp/builds/{buildId} API to download an application executable for an existing Build Id.

To download an application executable, you need the Build Id parameter.

Build Id: The applications Build Id.

METHOD Path Parameters
GET

  • Parameters: buildId (required)

  • Type: String

API for Deleting Application Builds

Use the DELETE /v1/dp/builds/{buildId} API to delete an application build.

Note: Ensure the application build being deleted is not used by any other application.

To delete an app build, you need the Build Id parameter.

Build Id: The applications Build Id.

METHOD Path Parameters
DELETE

  • Parameters: buildId (required)

  • Type: String

API for Exporting the app.json or app.flogo File

Use the GET /v1/dp/builds/{buildId}/export API to export the app.json or app.flogo file for an existing Build Id.

To export the file, you need the following parameters:

  • Build Id: The applications Build Id.

  • Namespace: The namespace where the application is deployed. This parameter is not mandatory and is only required if the application is running outside of the default data plane namespace.

METHOD Path Parameters
GET

  • Parameters: buildId (required)

  • Type: String

  • Parameters: namespace

  • Type: String