[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Get Defined Entities By Interface
DescriptionGets the collection of defined entities for the vCD-defined interface with the specified vendor, nss and version. The version can act as a wildcard. If only ‘1’ is specified as the version, all entity types with a major version of ‘1’ will be matched (e.g. 1.0.0, 1.1.2). If ‘1.0’ is specified, all entity types with a major version of ‘1’ and a minor version of ‘0’ will be included (e.g. 1.0.0, 1.0.1). If the full semver is specified, then no search will be performed.
Request
URLURL
https://{api_host}/cloudapi/1.0.0/entities/interfaces/{vendor}/{nss}/{version}
Path Parameters
Path Parameters
string
vendor
Required
string
nss
Required
string
version
Required
Query Parameters
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
integer
page
Required
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
DefinedEntities
of type(s) application/json;version=36.3
This response body class contains all of the following:
Page, InlineDefinedEntities1
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl https://{api_host}/cloudapi/1.0.0/entities/interfaces/{vendor}/{nss}/{version}?page=10&pageSize=10
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vcloud-multisite: true
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 35.0
On This Page
Defined Entity Operations
post
Create Metadata Entry
Changed
delete
delete
Delete Metadata Entry
Changed
get
get
Get Metadata File Content
Introduced
put
Update Metadata Entry
Changed
