Get Interface

Get Interface

Gets the interface with the unique identifier (URN)

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/interfaces/{id}
COPY
Path Parameters
string
id
Required

id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

name

string
id
Optional

id

string
version
Required

The interface's version. The version should follow semantic versioning rules. Versions with pre-release extension are not allowed.

string
vendor
Required

The vendor name.

string
nss
Required

A unique namespace associated with the interface.

boolean
readonly
Optional

True if the entity type cannot be modified.


Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object]
Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/interfaces/{id}
Availability
Added in 35.0
On This Page
Defined Interface Operations
GET
Query Interfaces
GET
Get Interface