Edge Set Edge Hand Off Gateways

Edge Set Edge Hand Off Gateways

Sets the on-premise hand off gateways for the specified Edge (by edgeId). A primary and secondary gateway are defined. The primary is required, the secondary is optional. Moves all existing Edge-gateway hand-off relationships and replaces them with the specified primary and secondary gateways.

Privileges required:

UPDATE EDGE

Request
URI
POST
https://{api_host}/portal/rest/edge/setEdgeHandOffGateways
COPY
Request Body
{
    "edgeId": 0,
    "enterpriseId": 0,
    "gateways": {
        "primary": 0,
        "primaryIpsecDetail": {
            "ipsecGatewayAddress": "string",
            "strictHostCheck": false,
            "strictHostCheckDN": "string"
        },
        "secondary": 0,
        "secondaryIpsecDetail": "gateway_handoff_ipsec_gateway_detail Object"
    }
}
integer
edgeId
Optional

edgeId

integer
enterpriseId
Optional

enterpriseId

object
gateways
Optional

gateways

Responses
200

Request was successfully processed

Returns edge_set_edge_hand_off_gateways_result of type(s) application/json
This response body class contains all of the following: Inlineedge_set_edge_hand_off_gateways_result0 
"edge_set_edge_hand_off_gateways_result Object"

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 '{}' https://{api_host}/portal/rest/edge/setEdgeHandOffGateways
On This Page
All Operations
POST
Edge Delete Edge
POST
Edge Delete Edge Bgp Neighbor Records
POST
Edge Retry Wss Location Creation Job
POST
Edge Set Edge Enterprise Configuration
POST
Edge Set Edge Hand Off Gateways
POST
Edge Set Edge Operator Configuration
POST
Edge Unset Edge Operator Configuration