[{"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

Create Interface

Description

Creates a defined interface. The version must follow semantic versioning rules.

Request

URL

post

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

Copy

Request Body

DefinedInterface of type(s) application/json Required

Show optional properties

{
    "name": "SDDC Interface",
    "nss": "myCustomEntity",
    "vendor": "vmware",
    "version": "1.0.0"
}

{
    "id": "urn:vcloud:interface:vmware.sddc:1.0.0",
    "name": "SDDC Interface",
    "nss": "myCustomEntity",
    "readonly": false,
    "vendor": "vmware",
    "version": "1.0.0"
}

string

name Changed Required

string

nss Changed Required

A unique namespace associated with the interface.

string

vendor Changed Required

The vendor name.

string

version Changed Required

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

string

id Optional

boolean

readonly Optional

True if the entity type cannot be modified.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

201 Created

Returns DefinedInterface of type(s) application/json;version=37.2

{
    "id": "urn:vcloud:interface:vmware.sddc:1.0.0",
    "name": "SDDC Interface",
    "nss": "myCustomEntity",
    "readonly": false,
    "vendor": "vmware",
    "version": "1.0.0"
}

string

name Changed Required

string

nss Changed Required

A unique namespace associated with the interface.

string

vendor Changed Required

The vendor name.

string

version Changed Required

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

string

id Optional

boolean

readonly Optional

True if the entity type cannot be modified.

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"id":"urn:vcloud:interface:vmware.sddc:1.0.0","name":"SDDC Interface","nss":"myCustomEntity","readonly":false,"vendor":"vmware","version":"1.0.0"}' https://{api_host}/cloudapi/1.0.0/interfaces

vmware-cloud-director

Availability

Added in 35.0

Defined Interface Operations

post

Create Interface

delete

Delete Interface

get

Get Interface

get

Query Interfaces

put

Update Interface

Create Interface

Request

URL

Request Body

Authentication

ApiKeyAuth

Response

Response Body

201 Created

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

Availability

On This Page

Defined Interface Operations

Was this page helpful?