Create Interface

Create Interface

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

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/interfaces
COPY
Request Body
DefinedInterface of type(s) application/json
Optional 
{
    "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.

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns DefinedInterface of type(s) application/json;version=38.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.


Availability
Added in 35.0
On This Page
Defined Interface Operations
POST
Create Interface
DELETE
Delete Interface
GET
Get Interface
GET
Query Interfaces
PUT
Update Interface