Application and Build Management APIs

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

Note: To use a namespace other than the default data plane namespace for 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 APIs, see Accessing the API Documentation with Swagger UI.

API for Listing Flogo Applications

Use the GET /v1/dp/apps API to retrieve a list of all Flogo applications from a data plane.

This API supports optional query parameters to filter the applications based on specified keys and values.

Optional Query Parameters:

Parameter Name Type Required Description
filterKey Query No A comma-separated list of columns to filter the result. For example: name, namespace, state, version, tag.
filterValue Query No A comma-separated list of values to filter the result. For example: my-app, my-ns, Running, 1.0.0, tag1.

API for Deleting an Application

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

Required and Optional API Parameters:

Parameter Name Type Required Description
appId Path Yes The application ID of the app to delete.
namespace Query No The namespace where the application is deployed. This parameter is required only if the application is running outside of the default data plane namespace.

API for Viewing Application Details

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

Required and Optional API Parameters:

Parameter Name Type Required Description
appId Path Yes The application ID of the app to view details for.
namespace Query No The namespace where the application is deployed. This parameter is required only if the application is running outside of the default data plane namespace.

API for Listing Application Instances

Use the GET /v1/dp/apps/{appId}/instances API to retrieve a list of application instances for a specified app Id.

Required and Optional API Parameters:

Parameter Name Type Required Description
appId Path Yes The application ID of the app instance.
namespace Query No The namespace where the application is deployed. This parameter is required only if the application is running outside of the default data plane namespace.

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.

Required and Optional API Parameters:

Parameter Name Type Required Description
appId Path Yes The application ID of the app to view its app endpoints.
namespace Query No The namespace where the application is deployed. This parameter is required only if the application is running outside of the default data plane namespace.

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 auto scaling option is configured.

Required and Optional API Parameters:

Parameter Name Type Required Description
appId Path Yes The application ID of the app to scale.
count Path Yes The number of count for scaling
namespace Query No The namespace where the application is deployed. This parameter is required only if the application is running outside of the default data plane namespace.

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.

Required and Optional API Parameters:

Parameter Name Type Required Description
appId Path Yes The application ID of the app to update the app properties.
namespace Query No The namespace where the application is deployed. This parameter is required only if the application is running outside of the default data plane namespace.
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 Listing Flogo Application Builds

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

This API supports optional query parameters to filter the builds based on specified keys and values. Additionally, it supports parameters to sort and order the output.

Optional Query Parameters:

Parameter Name Type Required Description
filterKey Query No A comma-separated list of columns to filter the result. For example: buildId, name.
filterValue Query No A comma-separated list of values to filter the result. For example: 0bb4dad, my-app-build.
sortBy Query No The name of the column to sort the result. For example: createdDate
orderBy Query No Specifies the order of the result. Available values: asc (ascending) and desc (descending).

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.

This API requires app.json or app.flogo binary file to build Flogo application. This API also supports optional query parameters for the baseVersion, OS, and arch.

Optional Query Parameters:

Parameter Name Type Required Description
baseversion Query No The TIBCO Flogo base version.
OS Query No

Compatible operating system for app binary.

Available values : linux, darwin, windows
arch Query No

Compatible system architecture for app binary.

Available values : amd64, 386

In the Request body section, click Choose File, browse to the App.json or App.flogo file, and click Open.

API for Importing an App Build

Use the PUT /v1/dp/builds API to import an app build into a data plane.

To import an app build, you need the app build .zip file.

In the Request body section, click Choose File, browse to the .zip file, and click Open.

API for Downloading an Application Executable

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

Required Parameters:

Parameter Name Type Required Description
buildId Path Yes The application build ID to download the application executable.

API for Deleting Application Builds

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

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

Required Parameters:

Parameter Name Type Required Description
buildId Path Yes The application build ID to delete the build.

API for Listing Flogo Applications from a Build ID

Use the GET /v1/dp/builds/{buildId}/apps API to retrieve a list of all TIBCO Flogo applications deployed using the specified build ID on a data plane.

This API requires a path parameter for the build ID and supports an optional query parameter to filter the applications by namespace.

Required and Optional API Parameters:

Parameter Name Type Required Description
buildId Path Yes The build ID for which you want to retrieve the list of applications.
namespace Query No The namespace to filter the list of Flogo applications.

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.

Required Path Parameter:

Parameter Name Type Required Description
buildId Path Yes The application build ID to export the app.json or app.flogo file.

API for Exporting an Application Build

Use the GET /v1/dp/builds/{buildId}/exportBuild API to export an application build executable of an existing build Id.

Required API Parameter:

Parameter Name Type Required Description
buildId Path Yes The application build ID to download the application build executable.

API for Retrieving Detailed Application Build Information

Use the GET /v1/dp/builds/{buildId}/info API to retrieve detailed information about a specific build, including the build OS, architecture, base version, build time, and more, for the specified build ID.

Required API Parameter:

Parameter Name Type Required Description
buildId Path Yes The build ID for which you want to retrieve detailed information.