Delete Deployment Environment

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameDelete Deployment Environment
Description

Deletes the specified Deployment environment

Allowed Role(s)WM_USER
MethodDELETE
URI

v1/environments/depEnvId

cloudcenter-ccm-backend/api/v1/environments/depEnvId

Sample Request
curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/environments/4"
curl -k -X DELETE -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/environments/4"
Release
  • Introduced in CloudCenter 3.2.5
  • Updated in CloudCenter 4.0
  • Enhanced in CloudCenter 4.2 to include the cloudId, totalDeployments, and costDetails attributes and to reflect a modified associatedClouds attribute.
  • Enhanced in CloudCenter 4.4 to reflect a modified associatedClouds attribute – see the Deployment Environments section for the relevant release for additional context. 
    • Includes the regionId of each associated cloud account.   
    • Contains new sections called cloudAssociationDefaults and default.  
  • Enhanced in CloudCenter 4.8.2 to include the extensionId attribute – see the Configuring ServiceNow Extensions section for the relevant release for additional context.

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.environments.depEnvId

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

Not applicable

Sample Response

The server responds with the HTTP Response code 204 No Content if the deletion of the deployment environment is successful.

Request Attributes

depEnvId
  • DescriptionUnique, system-generated identifier for the deployment environment. See the Deployment Environments section for the relevant release for additional details. This attribute is the same as the environmentId attribute.

  • Type: String

Required

Response Attributes

None

© 2017-2019 Cisco Systems, Inc. All rights reserved