Update Network Interface Settings
Update network interface settings. Changing the appliance IP address disconnects the current REST API connection.
Request
URI
POST
https://{api_host}/appliance/settings/network/interfaces/{interface_name}
COPY
Path Parameters
string
interface_name
Required
The name of the network interface
Request Body
Updated the network interface settings.
UpdateNetworkInterfaceInfoSpec of type(s) application/json
Optional
{
"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
}
]
}
}
Responses
204
Network interface settings updated.
Operation doesn't return any data structure
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
error_code
string
message
Optional
message
string As uuid As uuid
op_id
Optional
op_id
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
error_code
string
message
Optional
message
string As uuid As uuid
op_id
Optional
op_id
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
error_code
string
message
Optional
message
string As uuid As uuid
op_id
Optional
op_id