Get All Network Settings

Get All Network Settings

Current appliance network settings.

Request
URI
GET
https://{api_host}/appliance/settings/network
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

The current network settings.

Returns NetworkInfoDataDrResponseEntity of type(s) application/json
This response body class contains all of the following: NetworkInfoData
{
    "dns": {
        "mode": "string",
        "hostname": "string",
        "servers": [
            {}
        ]
    },
    "interfaces": [
        {
            "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"
            }
        ]
    }
}
_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.


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.