🚧

Your Control Plane URL will vary

The Control Plane URL, denoted as YOUR_CP_URL for this API reference document is https://facetsdemo.console.facets.cloud.
Replace that with the Control Plane URL unique to your account.

API Endpoint

This API processes a POST request to trigger a selective release on a selected unique cluster.

https://{YOUR_CP_URL}/cc-ui/v1/clusters/{clusterId}/deployments/release/deployment/hotfix
  • This API endpoint has two path parameters, YOUR_CP_URL, and clusterId.
  • There is also a body parameter, resourceList.

Path parameters

  • YOUR_CP_URL of type String, is the Control Plane URL specific to your account.
  • clusterId of type String, is the unique ID for the environment where you want to make a release. You can find this ID in the Environment Overview screen in Facets UI.

Body parameters

resourceList is an Array of Objects, defined as:

  • resourceName of type string.

📘

NOTE:

resourceName should be the name of the application as defined under the application/instance path.

  • resourceType of type string, with the default value application.
{
  "resourceList": [
    {
      "resourceName": "name",
      "resourceType": "application"
    }
  ]
}

Authenticate your API request

To learn more about how to generate a basic authentication token for use with Facets API requests, check Authentication Setup.

📘

Facets API uses Basic Authentication.

Generate a Sample Request ➡️

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!