Managing Provisioned Software and Plug-ins

This section displays all the APIs available to manage the provisioned software and plug-ins for the TIBCO BusinessWorks Container Edition Capability.

API for Viewing the Provisioned TIBCO BusinessWorks Container Edition Versions

Use the GET /v1/dp/bwceversions API to return a list of all the TIBCO BusinessWorks Container Edition versions provisioned on the data plane. This returns the base versions and the list of base image tags.

METHOD Path Parameters
GET

None

API for Updating the TIBCO BusinessWorks Container Edition Version Tags

Use the PUT /v1/dp/bwceversions/{versions}tags for updating TIBCO BusinessWorks Container Edition the version tags.

To update the tags you need the Version parameter

Version: The TIBCO BusinessWorks Container Edition base versions.

METHOD Path Parameters
PUT

  • Parameters: version (required)

  • Type: String

API for Provisioning TIBCO BusinessWorks Container Edition

Use the POST /v1/dp/bwceversions/{version} API to provision TIBCO BusinessWorks Container Edition on the data plane.

To delete an application build you need the Version parameter

Version: The TIBCO BusinessWorks Container Edition base versions.

METHOD Path Parameters
POST

  • Parameters: version (required)

  • Type: String

API for Deleting TIBCO BusinessWorks Container Edition

Use the DELETE /v1/dp/bwceversions/{version} API to delete TIBCO BusinessWorks Container Edition from the data plane.

Note: Ensure the TIBCO BusinessWorks Container Edition versions being deleted is not used by any other applications or builds.

To delete an application build you need the Version parameter

Version: The TIBCO BusinessWorks Container Edition base versions. To find the list of all provisioned versions on the data plane invoke the GET /v1/dp/bwceversions API.

METHOD Path Parameters
DELETE

  • Parameters: version (required)

  • Type: String

API for Viewing the Provisioned Connectors

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

METHOD Path Parameters
GET None

API for Provisioning Connectors

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

To provision a connector, you need the following parameters:

  • Connector: The Connector Id

  • Version: The connector version

METHOD Path Parameters
DELETE

  • Parameters: connector (required)

  • Type: String

  • Parameters: version (required)

  • Type: String

API for Deleting Connectors

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:

  • Version: The connector version

  • Connector: The Connector Id

METHOD Path Parameters
DELETE

  • Parameters: connector (required)

  • Type: String

  • Parameters: version (required)

  • Type: String

API for Updating Connector Tags

Use the PUT /v1/dp/connectors/{connector}/{version}/tags API to update connector tags from the data plane.

To update a connector tag, you need the following parameters:

  • Version: The connector version

  • Connector: The Connector Id

METHOD Path Parameters
DELETE

  • Parameters: connector (required)

  • Type: String

  • Parameters: version (required)

  • Type: String

API for Viewing the Namespaces

Use the GET /v1/dp/namespaces API to return a list of all the namespaces on the data plane.

METHOD Path Parameters
GET

None

API for Viewing the Provisioned Supplements

Use the GET /v1/dp/supplements API to return a list of all the supplements provisioned on the data plane.

METHOD Path Parameters
GET

None

API for Uploading Supplements

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

To upload supplements, you need the Connector parameter

Connector: The Connector Id

METHOD Path Parameters
GET

  • Parameters: connector (required)

  • Type: String

API for Deleting Connector Supplements

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

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

To delete a connector, you need the Connector parameter

Connector: The Connector Id

METHOD Path Parameters
DELETE

  • Parameters: connector (required)

  • Type: String

API for Updating Supplement Tags

Use the PUT /v1/dp/supplements/{connector/tags} API to update the supplement tags.

To update the supplement tags, you need the Connector parameter

Connector: The Connector Id

METHOD Path Parameters
PUT

  • Parameters: connector (required)

  • Type: String