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

Get Network Interface Settings

Description

Get network interface settings.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
interface_name Required

The name of the network interface.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns NetworkInterfaceInfoDrResponseEntity of type application/json

The network interface settings.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	}
}
_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


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 https://{api_host}/appliance/settings/network/interfaces/{interface_name}


Feedback

Was this page helpful?