Gateway Update Gateway Attributes

Gateway Update Gateway Attributes

Updates gateway attributes (name, ipAddress, on-premise parametrization, and description) and associated site attributes and syslog settings for the specified gateway (by id).

Privileges required:

UPDATE GATEWAY

Request
URI
POST
https://{api_host}/portal/rest/gateway/updateGatewayAttributes
COPY
Request Body

Show optional properties

{
    "id": 0
}
{
    "id": 0,
    "name": "string",
    "description": "string",
    "site": {
        "id": 0,
        "created": "string",
        "name": "string",
        "logicalId": "string",
        "contactName": "string",
        "contactPhone": "string",
        "contactMobile": "string",
        "contactEmail": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string",
        "lat": "number",
        "lon": "number",
        "timezone": "string",
        "locale": "string",
        "shippingSameAsLocation": 0,
        "shippingContactName": "string",
        "shippingAddress": "string",
        "shippingAddress2": "string",
        "shippingCity": "string",
        "shippingState": "string",
        "shippingCountry": "string",
        "shippingPostalCode": "string",
        "modified": "string"
    },
    "ipsecGatewayDetail": "gateway_handoff_detail Object",
    "handOffDetail": "gateway_handoff_detail Object",
    "roles": "gateway_roles_object Object",
    "syslog": "gateway_syslog_settings Object",
    "nsdPortabilityEnabled": false,
    "popConfig": "gateway_pop_config Object"
}
integer
id
Required

id

string
name
Optional

name

string
description
Optional

description

site
site
Optional

site

gateway_handoff_detail
ipsecGatewayDetail
Optional

ipsecGatewayDetail

gateway_handoff_detail
handOffDetail
Optional

handOffDetail

gateway_roles_object
roles
Optional

roles

gateway_syslog_settings
syslog
Optional

syslog

boolean
nsdPortabilityEnabled
Optional

nsdPortabilityEnabled

gateway_pop_config
popConfig
Optional

popConfig

Responses
200

Request was successfully processed

Returns gateway_update_gateway_attributes_result of type(s) application/json
This response body class contains all of the following: Inlinegateway_update_gateway_attributes_result0 
"gateway_update_gateway_attributes_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 '{"id:"integer"}' https://{api_host}/portal/rest/gateway/updateGatewayAttributes
On This Page
Gateway Operations
POST
Gateway Delete Gateway
POST
Gateway Gateway Provision
POST
Gateway Get Gateway Edge Assignments
POST
Gateway Set Bastion State
POST
Gateway Set Gateway Enterprise Proxy
POST
Gateway Update Gateway Attributes
POST
Gateway Property Delete Replacement Gateway Property
POST
Gateway Property Get Gateway Properties
POST
Network Set Replacement Gateway
POST
Migration Verify Nsd Tunnels
POST
Network Get Eligible Replacement Gateways
POST
Gateway Get Gateway Csr
POST
Gateway Get Gateway Pending Csrs
POST
Gateway Insert Gateway Certificate