// removed jquery ui css and js

Delete Job

Details

API Details
NameDelete Job (Asynchronous API)
DescriptionDelete a deployment. This API returns a reference to a tracking ID that can be used to retrieve the delete operation.
MethodDELETE
URI
  • /v2/jobs/jobId
  • /v2/jobs/jobId?hide=true
CloudCenter ReleaseIntroduced in CloudCenter 4.6
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • Default = terminate and hide ( if no variable is passed). See Termination for additional context.
  • If hide = true and successful, then behavior is the same as terminate and hide.
  • If hide = false and successful, then  only terminate (without hiding).
ESB Header
  • action: delete.jobs.jobId
  • action: delete.jobs.jobId
    actionparam: hide=true

Example

curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs/920" 

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>/v1/operationStatus/85614908-f9f9-4553-8d5e-56cda496f612"

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

{
 "status":"SUCCESS",
 "resource":"https://<HOST>:<PORT>"
}

Request Attributes

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

hide
  • 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

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

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String