How Do I Delete a VMware Cloud Director Instance

As a Provider Administrator, if you no longer need a VMware Cloud Director instance and you want to free up resources, you can delete the VMware Cloud Director instance from your environment.

Prerequisites

Verify that you are assigned the Provider Administrator role.
Obtain an API token from the organization you want to manage and exchange it for an access bearer token. Use the bearer token in the Authorization header when you run API calls. See How Do I Generate an API Token.
Obtain the environment ID (URN). See How Do I Retrieve the List of Environments in My Organization.
Obtain the VMware Cloud Director instance ID (URN). See How Do I Retrieve a List of All VMware Cloud Director Instances in Your Organization.

Procedure

♦ Run a DELETE request.
```
DELETE https://operatorUrl/environment/environmentUrn/instances/vcdInstanceUrn
```
Here operatorUrl is the operator URL, for example vcdc-operator-prod-us-west-2.vdp.vmware.com.

Results

You deleted the specified VMware Cloud Director instance.

Example: Delete a VMware Cloud Director Instance

This example deletes the VMware Cloud Director with ID (URN) urn:vcdc:task:22222222-2222-2222-2222-22222222222 from the environment with ID (URN) urn:vcdc:environment:00000000-0000-0000-0000-000000000000.

DELETE https://vcdc-operator-prod-us-west-2.vdp.vmware.com/environment/urn:vcdc:environment:3fccbd2a-003c-4303-8f1a-8569853236ac/instances/urn:vcdc:task:fadce89f-fef9-430b-bbdc-bfd3482c3796

Use the bearer token in the Authorization header of the request.

Authorization: 
Bearer eyJh…I1NiIs

The response returns the following information.

{
  "id": "urn:vcdc:task:22222222-2222-2222-2222-22222222222",
  "name": "Deleting instance VMware-Cloud-Director-test",
  "entityId": "urn:vcdc:vcdInstance:33333333-3333-3333-3333-33333333333",
  "entityName": "VMware-Cloud-Director-test",
  "ownerId": "urn:vcdc:organization:12345678-1234-1234-1234-123456789abc",
  "userId": "[email protected]",
  "steps": null,
  "status": "IN_PROGRESS",
  "startTime": null,
  "endTime": null,
  "queuedTime": "2020-06-10T10:06:22.068303Z",
  "message": "Instance delete started",
  "output": {}
}