[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-appliance-config-api

Update Network Interface Settings

Description

Update network interface settings. Changing the appliance IP address disconnects the current REST API connection.

Request

Request

URL

URL


post
https://{api_host}//appliance/settings/network/interfaces/{interface_name}
Copy

Path Parameters

Path Parameters

string
interface_name Required

The name of the network interface


Request Body

Request Body

UpdateNetworkInterfaceInfoSpec of mimetype application/json Optional

Updated the network interface settings.

{
	"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
	}
}
ipv4 Optional

IPv4 settings


ipv6 Optional

IPv6 settings

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

204 No Content

Network interface settings updated.

Errors

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

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"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}}' https://{api_host}/appliance/settings/network/interfaces/{interface_name}


Feedback

Was this page helpful?