Edge Get Ha Interfaces

Edge Get Ha Interfaces

Returns standby and active HA interface details of an edge

Privileges required:

READ EDGE

Request
URI
POST
https://{api_host}/portal/rest/edge/getHaInterfaces
COPY
Request Body

Show optional properties

{
    "edgeLogicalId": "string"
}
{
    "edgeLogicalId": "string",
    "role": "string"
}
string
edgeLogicalId
Required

edgeLogicalId

string
role
Optional

role

Possible values are : ACTIVE, STANDBY,
Responses
200

Request was successfully processed

Returns Array of object of type(s) application/json 
[
    {
        "id": 0,
        "edgeId": 0,
        "interfaceName": "string",
        "ipAddress": "string",
        "ipV6Address": "string",
        "displayName": "string",
        "state": "string",
        "role": "string"
    }
]

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"edgeLogicalId:"string"}' https://{api_host}/portal/rest/edge/getHaInterfaces
On This Page
Edge Operations
POST
Edge Get Ha Interfaces