APIs for Provisioning Software and Connectors

You can find the following APIs in the 'Provisioned Software & Connectors' 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 Available Flogo Connectors on a Control Plane

Use the GET /v1/cp/connectors API to retrieve a list of all the Flogo Connectors available on a control plane.

This API requires no parameters.

API for Listing Provisioned Flogo Connectors on a Data Plane

Use the GET /v1/dp/connectors API to retrieve a list of the Flogo Connectors provisioned on a data plane.

This API requires no parameters.

API for Deleting Connector from a Data Plane

Use the DELETE /v1/dp/connectors/{connector}/{version} API to delete connectors from a data plane.

Note: Ensure the connector being deleted is not used by any other applications or builds.

Required API Parameters:

Parameter Name Type Required Description
connector Path Yes The unique ID of the connector you want to delete.
version Path Yes The specific version of the connector.

API for Provisioning Flogo Connectors to a Data Plane

Use the POST /v1/dp/connectors/{connector}/{version} API to provision a Flogo Connector to a data plane.

To provision a Flogo Connector, you need the Connector ID and Connector Version, which can be retrieved using the GET /v1/cp/connectors API.

Required API Parameters:

Parameter Name Type Required Description
connector Path Yes The unique ID of the connector.
version Path Yes The specific version of the connector.

API for Listing Connector Supplements Uploaded on a Data Plane

Use the GET /v1/dp/supplements API to retrieve a list of all the uploaded connector supplements on a data plane. This API returns the totalSupplements and the list of supplementCatalog.

This API requires no parameters.

API for Uploading Connector Supplement to a Data Plane

Use the POST /v1/dp/supplements/{connector} API to upload connector supplements to a data plane.

To upload a connector supplement, you need the connector supplement .zip file and Connector Id.

Required API Parameter:

Parameter Name Type Required Description
connector Path Yes

The type of connector for which you want to upload the supplement.

Supported values: OracleDatabase and IBM-MQ

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

Note:

  • For the Oracle Database connector, the supplement file must be named oracle.zip.

  • For the IBM-MQ connector, the supplement file must be named ibm-mq.tar.gz.

API for Deleting Connector Supplement from a Data Plane

Use the DELETE /v1/dp/supplements/{connector} API to delete connector supplements from a data plane.

Required API Parameter:

Parameter Name Type Required Description
connector Path Yes

The type of connector supplement you want to delete.

Supported values: OracleDatabase and IBM-MQ

API for Listing Custom Extensions Provisioned on a Data Plane

Use the GET /v1/dp/extension API to retrieve a list of all the custom extensions provisioned on a data plane. This API returns the totalExtensions and the list of extensionCatalog.

This API requires no parameters.

API for Uploading a Flogo Extension to a Data Plane

Use the POST /v1/dp/extension API to upload a Flogo extension to a data plane.

To upload a Flogo extension, you need the extension .zip file.

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

API for Deleting Extension from a Data Plane

Use the DELETE /v1/dp/extensions/{extension}/{version} API to delete an extension from a data plane.

Required API Parameters:

Parameter Name Type Required Description
extension Path Yes The unique ID of the extension you want to delete.
version Path Yes The specific version of the extension.

API for Listing Flogo Versions Available on a Control Plane

Use the GET /v1/cp/flogoversions API to retrieve a list of all the TIBCO Flogo versions available on a control plane. This API returns the list of available Flogo versions that can be provisioned to your data plane.

This API requires no parameters.

API for Listing Flogo Versions Provisioned on a Data Plane

Use the GET /v1/dp/flogoversions API to retrieve a list of all the TIBCO Flogo versions provisioned on a data plane. This returns the base versions and the list of base image tags.

This API requires no parameters.

API for Provisioning a Flogo Version to a Data Plane

Use the POST /v1/dp/flogoversions/{version} API to provision a Flogo version to a data plane.

To provision a Flogo version, you need the Flogo Version, which can be retrieved using the GET /v1/cp/flogoversions API.

Required API Parameter:

Parameter Name Type Required Description
version Path Yes The specific version of Flogo.

API for Deleting a Flogo Version from a Data Plane

Use the DELETE /v1/dp/flogoversions/{version} API to delete a Flogo version from a data plane.

Required API Parameter:

Parameter Name Type Required Description
version Path Yes The specific version of Flogo to delete.