Delete Job


API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameDelete Job (Asynchronous API)

Deletes a deployment

Allowed Role(s)WM_USER
  • v2/jobs/jobId
  • v2/jobs/jobId?hide=true
  • cloudcenter-ccm-backend/api/v2/jobs/jobId
  • cloudcenter-ccm-backend/api/v2/jobs/jobId?hide=true
Sample Request
curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/jobs/920" 
curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v2/jobs/920" 

Introduced in CloudCenter 4.6

Modified in CloudCenter Suite 5.0.0

  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • This API returns a reference to a tracking ID that can be used to retrieve the delete operation.
  • Default = terminate and hide (if no variable is passed).
  • If hide = true and successful, then behavior is the same as terminate and hide.
  • If hide = false and successful, then  only terminate (without hiding).
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action:
  • action:
    actionparam: hide=true

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Response

The API starts bringing down the VMs launched for this deployment. The response to this API would be a reference to a resource that provides latest status of the operation.

 "id": "85614908-f9f9-4553-8d5e-56cda496f612", 
 "resource": "https://<HOST>:<PORT>/v1/operationStatus/85614908-f9f9-4553-8d5e-56cda496f612" 

This resource can be queried to get the latest status of the stop operation:

curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/operationStatus/85614908-f9f9-4553-8d5e-56cda496f612"

The server responds with the following message once the deployment is successfully deleted:


Request Attributes

  • DescriptionUnique, system-generated identifier for the job
  • Type: String

  • Description: Optional attribute that identifies if a deployment that is currently hidden should be included in this task.
  • Type: Boolean
    • true = (Default) Include hidden deployment in this task.
    • false = Do not include hidden deployment in this task

Response Attributes

  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
  • Description: Unique URL to access this resource.
  • Type: String
Terms & Conditions Privacy Statement Cookies Trademarks