How Do I Retrieve Details About a Specific Environment
You can retrieve details about a specific environment by using the VMware Cloud Director service API.
Prerequisites
- Verify that you are assigned the Provider Administrator or the Provider Support 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.
Procedure
- ♦
Run a GET request.
GET https://operatorUrl/environments/environmentUrn
Here operatorUrl is the operator URL, for example vcdc-operator-prod-us-west-2.vdp.vmware.com.
Results
The response returns information about the selected environment.
Example: Retrieve Details About a Single Environment
This example retrieves information about
a single
environment.
GET https://vcdc-operator-prod-us-west-2.vdp.vmware.com/environments/urn:vcdc:environment:00000000-0000-0000-0000-000000000000
Use the bearer token in the
Authorization
header of the request.
Authorization: Bearer eyJh…I1NiIs
The response returns information about the environment.
{ "id": "urn:vcdc:environment:00000000-0000-0000-0000-000000000000", "name": "California", "location": "us-west-2", "url": "https://vcdc-coordinator-prod-us-west-2.vdp.vmware.com", "service": "http://vcdc-coordinator-prod-us-west-rest-frontend.prod-us-west", "enabled": true, "initial": true }