Application Deployment Manager API#

Download the Application Deployment Manager API in OpenAPI YAML format

GET /v1/projects/{projectName}/appdeployment/clusters#

ListClusters

Gets a list of all cluster objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • labels (array) – Optional. A string array that filters cluster labels to be displayed ie color=blue,customer=intel. Labels separated by a comma.

  • orderBy (string) – Optional. Select field and order based on which cluster list will be sorted.

  • filter (string) – Optional. Selection criteria to list clusters.

  • pageSize (integer) – Optional. Select count of clusters to be listed per page.

  • offset (integer) – Optional. Offset is used to select the correct page from which clusters list will be displayed. (E.g If there are 10 clusters, page size is 2 and offset is set as 4, then the response will display clusters 5 and 6).

Status Codes:
GET /v1/projects/{projectName}/appdeployment/clusters/{clusterId}#

GetCluster

Gets a cluster object.

Parameters:

  • clusterId (string) – Required. The id of the cluster.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/appdeployment/deployments#

ListDeployments

Gets a list of all deployment objects.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • labels (array) – Optional. A string array that filters cluster labels to be displayed ie color=blue,customer=intel-corp. Labels separated by a comma.

  • orderBy (string) – Optional. Select field and order based on which Deployment list will be sorted.

  • filter (string) – Optional. Selection criteria to list Deployments.

  • pageSize (integer) – Optional. Select count of Deployment to be listed per page.

  • offset (integer) – Optional. Offset is used to select the correct page from which Deployment list will be displayed. (E.g If there are 10 Deployments, page size is 2 and offset is set as 4, then the response will display Deployment 5 and 6.)

Status Codes:
POST /v1/projects/{projectName}/appdeployment/deployments#

CreateDeployment

Creates a deployment object.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/appdeployment/deployments/{deplId}#

DeleteDeployment

Deletes a deployment object.

Parameters:

  • deplId (string) – Required. The id of the deployment to delete.

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • deleteType (string) – Required. Different delete types to handle parent and child lists, for dependency support. Available options: PARENT_ONLY, ALL.

Status Codes:
GET /v1/projects/{projectName}/appdeployment/deployments/{deplId}#

GetDeployment

Gets a deployment object.

Parameters:

  • deplId (string) – Required. The id of the deployment to get.

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/appdeployment/deployments/{deplId}#

UpdateDeployment

Updates a deployment object.

Parameters:

  • deplId (string) – Required. The id of the deployment to update.

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/appdeployment/deployments/{deplId}/clusters#

ListDeploymentClusters

Gets a list of all deployment cluster objects.

Parameters:

  • deplId (string) – Required. The id of the deployment to get.

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • orderBy (string) – Optional. Select field and order based on which Deployment cluster list will be sorted.

  • filter (string) – Optional. Selection criteria to list Deployment clusters.

  • pageSize (integer) – Optional. Select count of Deployment clusters to be listed per page.

  • offset (integer) – Optional. Offset is used to select the correct page from which Deployment clusters list will be displayed. (E.g If there are 10 Deployment clusters, page size is 2 and offset is set as 4, then the response will display Deployment clusters 5 and 6.)

Status Codes:
GET /v1/projects/{projectName}/deployments/clusters/{clusterId}#

ListDeploymentsPerCluster

Parameters:

  • clusterId (string)

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • labels (array) – Optional. A string array that filters cluster labels to be displayed ie color=blue,customer=intel-corp. Labels separated by a comma.

  • orderBy (string) – Optional. Select field and order based on which Deployment list will be sorted.

  • filter (string) – Optional. Selection criteria to list Deployments.

  • pageSize (integer) – Optional. Select count of Deployment to be listed per page.

  • offset (integer) – Optional. Offset is used to select the correct page from which Deployment list will be displayed. (E.g If there are 10 Deployments, page size is 2 and offset is set as 4, then the response will display Deployment 5 and 6.)

Status Codes:
GET /v1/projects/{projectName}/summary/deployments_status#

GetDeploymentsStatus

Gets all deployment clusters count status.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • labels (array) – Optional. A string array that filters cluster labels to be displayed ie color=blue,customer=intel-corp. Labels separated by a comma.

Status Codes:
GET /v1/projects/{projectName}/ui_extensions#

ListUIExtensions

Gets a list of all UIExtensions.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • serviceName (array) – Optional. A string array that filters service names to be displayed. Service names separated by a comma.

Status Codes: