VMware Cloud Director Infrastructure

This resource collection represents monitored VMware Cloud Director infrastructure.

Get Infrastucture Object Relations

Returns a collection resource representation of all obects in VMware Cloud Director infrastructure and their relations.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/objectRelations
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}

Get Relations of Infrastructure Object

Returns a resource representation of a VMware Cloud Director infrastructure object with the specified ID and its relations.

SecurityBearer
Request
path Parameters
objectId
required
integer <int64>
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/objectRelations/{objectId}
Request samples
Response samples
application/json
{
  • "objectId": 3,
  • "objectName": "VMware Cloud Director",
  • "objectType": "CloudDirectorInfrastructure",
  • "parentId": null,
  • "parentName": null,
  • "parentType": null
}

Get All Organizations

Returns a collection resource representation of all VMware Cloud Director organizations.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/organizations
Request samples
Response samples
application/json
{}

Get Organization

Returns a resource representation of a VMware Cloud Director organization with the specified ID.

SecurityBearer
Request
path Parameters
organizationId
required
integer <int64>
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/organizations/{organizationId}
Request samples
Response samples
application/json
{}

Get All Organization VDCs

Returns a collection resource representation of all organization VDCs.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/organizationVdcs
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}

Get Organization VDC

Returns a resource representation of an organization VDC with the specified ID.

SecurityBearer
Request
path Parameters
organizationVdcId
required
integer <int64>
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/organizationVdcs/{organizationVdcId}
Request samples
Response samples
application/json
{
  • "organizationVdcId": 1634,
  • "name": "amg2 VDC",
  • "allocationModel": "AllocationPool",
  • "cpuAllocationMhz": 420,
  • "cpuLimitMhz": 420,
  • "cpuUsedMhz": 0,
  • "memoryAllocationMb": 1957,
  • "memoryLimitMb": 1957,
  • "memoryUsedMb": 0,
  • "storageAllocationMb": 0,
  • "storageLimitMb": 9216000,
  • "storageUsedMb": 3072,
  • "networkPool": {
    },
  • "cloudDirectorId": 100,
  • "organizationId": 1619,
  • "providerVdcId": 1656
}

Get All Provider VDCs

Returns a collection resource representation of all provider VDCs.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/providerVdcs
Request samples
Response samples
application/json
{}

Get Provider VDC

Returns a resource representation of a provider VDC with the specified ID.

SecurityBearer
Request
path Parameters
providerVdcId
required
integer <int64>
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/providerVdcs/{providerVdcId}
Request samples
Response samples
application/json
{}

Get All Provider VDC Datastores

Returns a collection resource representation of all datastores that provide resources to provider VDCs.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/providerVdcs/datastores
Request samples
Response samples
application/json
{}

Get Provider VDC Datastore

Returns a resource representation of a datastore with the specified ID.

SecurityBearer
Request
path Parameters
datastoreId
required
integer <int64>
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/providerVdcs/datastores/{datastoreId}
Request samples
Response samples
application/json
{}

Get All vApps

Returns a collection resource representation of all vApps.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/vApps
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}

Get vApp

Returns a resource representation of a vApp with the specified ID.

SecurityBearer
Request
path Parameters
vAppId
required
integer <int64>
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/vApps/{vAppId}
Request samples
Response samples
application/json
{}

Get All VMs in vApps

Returns a collection resource representation of all VMs included in vApps.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/vApps/vms
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}

Get All VMs in vApp

Returns a collection resource representation of all VMs included in a vApp with the specified ID.

SecurityBearer
Request
path Parameters
vAppId
required
integer <int64>
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/vApps/{vAppId}/vms
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}

Get All VMware Cloud Director Servers

Returns a collection resource representation of all VMware Cloud Director servers.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/cloudDirectorServers
Request samples
Response samples
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}

Get VMware Cloud Director Server

Returns a resource representation of a VMware Cloud Director server with the specified ID.

SecurityBearer
Request
path Parameters
cloudDirectorServerId
required
integer <int64>
Responses
200

Success

403

Forbidden

get/api/v2.3/cloudDirector/cloudDirectorServers/{cloudDirectorServerId}
Request samples
Response samples
application/json
{
  • "cloudDirectorServerId": 100,
  • "name": "vcd103.tech.local",
  • "connectionState": "Connected",
  • "connectionError": null,
  • "version": "10.3.0.18295834"
}

Document updated 9/08/2025

Page content applies to build 13.0.0.5630