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

Get All Network Settings

Description

Current appliance network settings.

Request

Request

URL

URL


get
https://{api_host}//appliance/settings/network
Copy

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns NetworkInfoDataDrResponseEntity of type application/json

The current network settings.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"dns": {
		"hostname": "string",
		"mode": "DHCP",
		"servers": [
			"string"
		]
	},
	"interfaces": [
		{
			"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"
		}
	]
}
_meta Optional

Response meta data. Contains data about the response payload data.

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


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/appliance/settings/network


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

Was this page helpful?