Query Interfaces

Query Interfaces

Gets the collection of interfaces defined in the vCD instance. Allows collection refinement through traditional FIQL-based filtering

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/interfaces
COPY
Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

integer
page
Required

Page to fetch, zero offset.

integer
pageSize
Required

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns DefinedInterfaces of type(s) application/json;version=38.0
This response body class contains all of the following: Page , InlineDefinedInterfaces1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "name": "SDDC Interface",
            "id": "urn:vcloud:interface:vmware.sddc:1.0.0",
            "version": "1.0.0",
            "vendor": "vmware",
            "nss": "myCustomEntity",
            "readonly": false
        }
    ]
}

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