Developer Documentation
Get Interfaces
Get information about a particular network interface.
Request
URLURL
https://{api_host}/rest/appliance/networking/interfaces/{interface_name}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Network interface, for example, "nic0". The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces. |
Response
Response
Response BodyResponse Body
200 OK returns
GetResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: Network interface information.
{
"value": {
"ipv4": {
"address": "string",
"configurable": false,
"default_gateway": "string",
"mode": "enum",
"prefix": 0
},
"ipv6": {
"addresses": [
{
"address": "string",
"origin": "enum",
"prefix": 0,
"status": "enum"
}
],
"autoconf": false,
"configurable": false,
"default_gateway": "string",
"dhcp": false
},
"mac": "string",
"name": "string",
"status": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| value | InterfacesInterfaceInfo |
Network interface information. |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Error | com.vmware.vapi.std.errors.not_found : if the specified interface is not found. | com.vmware.vapi.std.errors.error : Generic error |
| default | Error | Not available |
On This Page
Interfaces Operations
get
get
