Managing App Builds

This section describes all the APIs to manage the app builds for the TIBCO BusinessWorks Container Edition Capability.

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

API for Viewing Apps

Use the GET /v1/dp/apps API to return a list of all the TIBCO BusinessWorks Container Edition applications on the data plane.

METHOD Path Parameters
GET None

API for Deploying Apps

Use the POST /v1/dp/deploy API to deploy or upgrade a TIBCO BusinessWorks Container Edition application using the Build Id. You can override app properties, profile, engine variables, resource limits for the pod, replicas or autoscaling configuration, and network policy configurations when deploying or upgrading the app.

Note: To upgrade an existing application, the App Id is mandatory.
Caution: If you want to change one application property for an app, you need to provide all existing app properties along with their values for that app.

To deploy an app you need the namespace parameter

Namespace: The namespace where the application is deployed.

METHOD Path Parameters
POST

  • Parameters: namespace

  • Type: String

API for Creating Application Build

Use the POST /v1/dp/builds API to create a TIBCO BusinessWorks Container Edition application build.

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

  • Base 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.

  • Base Image Tag: The base image tag name details available for TIBCO BusinessWorks Container Edition. To find the list of all provisioned versions and their base image tags on the data plane, invoke the GET /v1/dp/bwceversions API.

 
METHOD Path Parameters
POST

  • Parameters: baseversion

  • Type: String

  • Parameters: baseimagetag

  • Type: String

API for Viewing Application builds

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

METHOD Path Parameters
GET None

API for Rebuilding Applications

Use the POST /v1/dp/builds/{buildId}/rebuild API to rebuild the TIBCO BusinessWorks Container Edition applications.

To rebuild the applications with a new version using an existing EAR file, provide the Build Id of an existing application build along with the TIBCO BusinessWorks Container Edition base versions, image tag, and the updated connector dependencies details.

To rebuild an app, you need the following parameters:

  • Base 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.

  • Base Image Tag: The base image tag name details available for TIBCO BusinessWorks Container Edition. To find the list of all provisioned versions and their base image tags on the data plane, invoke the GET /v1/dp/bwceversions API.

  • Build Id: The app Build Id. This can be retrieved using the GET /v1/dp/builds method.

METHOD Path Parameters
GET

  • Parameters: baseversion (required)

  • Type: String

  • Parameters: baseimagetag (required)

  • Type: String

  • Parameters: buildId (required)

  • Type: String

API for Exporting an EAR

Use the GET /v1/dp/builds/{buildId}/export API to export an EAR for an existing Build Id.

To export an EAR, you need the Build Id parameter

Build Id: The applications Build Id. This can be retrieved using the GET /v1/dp/builds method.

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. This can be retrieved using the GET /v1/dp/builds method.

METHOD Path Parameters
DELETE

  • Parameters: buildId (required)

  • Type: String

API for Viewing Application from Build Id

Use the GET /v1/dp/builds/{buildId}/apps API to return a list of all the TIBCO BusinessWorks Container Edition applications from the Build Id on the data plane.

To view an app from the Build Id, you need the following parameters:

  • Build Id: The applications Build Id. This can be retrieved using the GET /v1/dp/builds method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
GET

  • Parameters: buildId (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 for a App Id, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
GET

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Viewing Application Instances

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

To view the app details for a App Id, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
GET

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Updating Application properties for a specified App Id using Hot Update

Use the GET /v1/dp/apps/{appId}/hotupdate/refresh API to update the application properties without restarting the app instance, if the app is configured with Configuration or Credential Management Services.

To update the app properties for an application, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed. Namespace is required when the application is not deployed in the default 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. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
GET

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Changing the Application Endpoint to Private

Use the DELETE /v1/dp/apps/{appId}/endpoints/public API to change the applications endpoint to private. This API removes the Ingress resource from the application to make the endpoint private.

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

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
DELETE

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Changing the Application Endpoint to Public

Use the POST /v1/dp/apps/{appId}/endpoints/public API to change the applications endpoint to public. This API creates the Ingress resource with inputs such as class name, FQDN, and path prefix.

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

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
POST

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Updating Application Configurations

Use the PUT /v1/dp/apps/{appId} API to update the application configuration from the data plane. When you apply the configuration, the application restarts.

Caution: If you want to change one application property for an app, you need to provide all existing app properties along with their values for that app.

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

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

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. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
DELETE

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Scaling an Application

Use the PUT /v1/dp/apps/{appId}/scale 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. This can be retrieved using the GET /v1/dp/apps method.

  • Count: The number of count for scaling.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: count

  • Type: Integer

  • Parameters: namespace

  • Type: String

API for Updating or Creating Autoscaling Configuration for an Application

Use the PUT /v1/dp/apps/{appId}/autoscaling API to modify or create the autoscaling configuration instance for an application. You can provide the minimum and maximum replicas of the application, the CPU threshold, and memory threshold for the resource configuration.

To update or create autoscaling configuration for an app, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Deleting Autoscaling for an Application

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

To delete an app, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

METHOD Path Parameters
DELETE

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

API for Enabling or Disabling Service Mesh for an Application

Use the PUT /v1/dp/apps/{appId}/servicemesh API to enable or disable service mesh sidecar of a specified App Id.

To enable or disable service mesh for an app, you need the following parameters:

  • App Id: The application Id. This can be retrieved using the GET /v1/dp/apps method.

  • Namespace: The namespace where the application is deployed.

  • Enable: You can enable or disable service mesh using the True or False options.

METHOD Path Parameters
PUT

  • Parameters: appId (required)

  • Type: String

  • Parameters: namespace

  • Type: String

  • Parameters: enable (required)

  • Type: Boolean