Get Network Interface Settings

Get Network Interface Settings

Get network interface settings.

Request
URI
GET
https://{api_host}/appliance/settings/network/interfaces/{interface_name}
COPY
Path Parameters
string
interface_name
Required

The name of the network interface.

Authentication
This operation uses the following authentication methods.
Responses
200

The network interface settings.

Returns NetworkInterfaceInfoDrResponseEntity of type(s) application/json
This response body class contains all of the following: NetworkInterfaceInfo 
{
    "status": "string",
    "mac": "00:0C:29:94:BB:5A",
    "name": "nic0",
    "ipv4": {
        "address": "10.20.80.191",
        "default_gateway": "string",
        "assignment_mode": "string",
        "prefix": 0
    },
    "ipv6": {
        "autoconfigure": false,
        "dhcp": false,
        "default_gateway": "string",
        "addresses": [
            {
                "address": "fc00:10:20:83:20c:29ff:fe94:bb5a",
                "prefix": 64
            }
        ]
    },
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
Metadata
_meta
Optional

_meta


400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


On This Page
Network Operations
GET
Get All Network Interfaces Settings
GET
Get All Network Settings
GET
Get Network Dns Settings
GET
Get Network Interface Settings
PUT
Update Network Dns Settings
POST
Update Network Interface Settings