[{"label":"Latest (v36.3)","version":"latest"},{"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 Interface

Description

Gets the interface with the unique identifier (URN)

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/interfaces/{id}
Copy

Path Parameters

Path Parameters

string
id Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns DefinedInterface of type(s) application/json;version=36.3
{
	"id": "urn:vcloud:interface:vmware.sddc:1.0.0",
	"name": "SDDC Interface",
	"nss": "myCustomEntity",
	"readonly": false,
	"vendor": "vmware",
	"version": "1.0.0"
}
string
id Optional

string
name Optional

string
nss Optional

A unique namespace associated with the interface.


boolean
readonly Optional

True if the entity type cannot be modified.


string
vendor Optional

The vendor name.


string
version Optional

The interface’s version. The version should follow semantic versioning rules.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/interfaces/{id}


[{"label":"Latest (v36.3)","version":"latest"},{"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
Defined Interface Operations
Feedback

Was this page helpful?