CliQr is now part of Cisco Learn More About Cisco

Delete Tenant

Details

API Details
Name

Delete Tenant (asynchronous API)

Description
MethodDELETE
URI

v1/tenants/tenantId

CloudCenter ReleaseIntroduced in CloudCenter 4.2.
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The tenant deletion is successful only when the following conditions are completed:

    • All the running jobs must be terminated for all users – users cannot be deleted before the jobs are terminated.

    • All users in the tenant are deleted

  • All the sub tenants under the tenant must be deleted prior to issuing this API call. If any sub-tenant is not deleted, then a validation message states that you do this first.

ESB Headeraction: delete.tenants.tenantId

Example

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

Response

The server responds with the HTTP Response code 202 (see HTTP Location URL for additional context).

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

Response Attributes

None