[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api
Get Network Interface Settings
DescriptionGet network interface settings.
Request
URLURL
https://{api_host}//appliance/settings/network/interfaces/{interface_name}
Path Parameters
Path Parameters
string
interface_name
Required
The name of the network interface.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
NetworkInterfaceInfoDrResponseEntity
of type application/json
The network interface settings.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"ipv4": {
"address": "10.20.80.191",
"assignment_mode": "DHCP",
"default_gateway": "string",
"prefix": 0
},
"ipv6": {
"addresses": [
{
"address": "fc00:10:20:83:20c:29ff:fe94:bb5a",
"prefix": 64
}
],
"autoconfigure": false,
"default_gateway": "string",
"dhcp": false
},
"mac": "00:0C:29:94:BB:5A",
"name": "nic0",
"status": "DOWN"
}
Errors
ResponseError
400
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
401
Unauthorized - the client must authenticate itself to get the requested response
ResponseError
403
Forbidden - not sufficient access rights to fulfill the request
404
Not Found - server cannot find the requested in URL resource
ResponseError
500
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
cURL Command
curl https://{api_host}/appliance/settings/network/interfaces/{interface_name}
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api
