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 Provisioned Flogo Connectors

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

This API requires no parameters.

METHOD Path Parameters
GET None

API for Uploading a Flogo Extension to a Data Plane

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

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

METHOD Path Parameters
POST None

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

API for Uploading Connector Supplement to a Data Plane

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

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

  • Connector Id: The type of connector for which you want to upload the supplement.

METHOD Path Parameters
POST

  • Parameters: connector Id (required)

    Type: String

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 the data plane.

To delete a connector supplement, you need the following parameter:

  • Connector Id: The type of connector supplement you want to delete.

METHOD Path Parameters
DELETE

  • Parameters: connector Id (required)

    Type: String

Supported values: OracleDatabase and IBM-MQ

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.

To delete a Flogo extension, you need the following parameters:

  • Extension Id: The unique ID of the extension you want to delete.

  • Extension Version: The specific version of the extension.

METHOD Path Parameters
DELETE

  • Parameters: extension (required)

    Type: String

  • Parameters: version (required)

    Type: String

API for Deleting Connector from a Data Plane

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

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

To delete a connector, you need the following parameters:

  • Connector Id: The unique ID of the connector you want to delete.

  • Connector Version: The specific version of the connector.

METHOD Path Parameters
DELETE

  • Parameters: connector (required)

    Type: String

  • Parameters: version (required)

    Type: String

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.

METHOD Path Parameters
GET None