Network Update Network Gateway Pool Attributes

Network Update Network Gateway Pool Attributes

Updates the configurable attributes (name, description, and handOffType) of the specified gateway pool (by id or gatewayPoolId).

Privileges required:

UPDATE GATEWAY

Request
URI
POST
https://{api_host}/portal/rest/network/updateNetworkGatewayPoolAttributes
COPY
Request Body

Show optional properties

{
    "id": 0
}
{
    "networkId": 0,
    "enterpriseProxyId": 0,
    "id": 0,
    "gatewayPoolId": 0,
    "name": "string",
    "description": "string",
    "handOffType": "string",
    "ipV4Enabled": false,
    "ipV6Enabled": false
}
integer
networkId
Optional

networkId

integer
enterpriseProxyId
Optional

enterpriseProxyId

integer
id
Required

alias for gatewayPoolId

integer
gatewayPoolId
Optional

gatewayPoolId

string
name
Optional

name

string
description
Optional

description

string
handOffType
Optional

handOffType

Possible values are : NONE, ALLOW, ONLY,
boolean
ipV4Enabled
Optional

ipV4Enabled

boolean
ipV6Enabled
Optional

ipV6Enabled

Responses
200

Request was successfully processed

This response body class contains all of the following: Inlinenetwork_update_network_gateway_pool_attributes_result0 
{
    "rows": 1
}

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 '{"id:"integer"}' https://{api_host}/portal/rest/network/updateNetworkGatewayPoolAttributes
On This Page
Network Operations
POST
Network Remove Operator Config Assoc From All Enterprises
POST
Enterprise Get Default Operator Configuration
POST
Enterprise Get Enterprise Specific Operator Configs
POST
Enterprise Update Edge Image Management
POST
Enterprise Update Edge Image Management Multiple
POST
Network Delete Network Gateway Pool
POST
Network Get Network Gateways
POST
Network Insert Network Gateway Pool
POST
Network Update Network Gateway Pool Attributes