Delete Deployment

Details

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

Delete a deployment – this API returns a reference to a tracking ID that can be used to retrieve the delete operation

Allowed Role(s)WM_USER
MethodDELETE
URI
  • v1/jobs
  • v1/ jobs?appDetails=true&status=running

  • cloudcenter-ccm-backend/api/v1/jobs
  • cloudcenter-ccm-backend/api/v1/ jobs?appDetails=true&status=running

Sample Request
curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/jobs/920" 
curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/jobs/920" 
Release
  • CloudCenter 3.x and 4.x
  • Enhanced in CloudCenter 4.2 to list both jobs and deployments as jobs

Modified in CloudCenter Suite 5.0.0

Notes
  • 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.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: delete.jobs.jobId


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>/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

Response Attributes

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

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String
status
  • Description: Status of the operation. See the Deployment and VM States section for the relevant release to view a list of all job operations.

  • Type: Enumeration

    EnumerationDescription
    SUBMITTEDThe operation has been submitted
    RUNNINGThe operation is currently in progress
    SUCCESSThe operation succeeded
    FAILThe operation failed
© 2017-2019 Cisco Systems, Inc. All rights reserved