Gateway Update Gateway Attributes
Updates gateway attributes (name, ipAddress, on-premise parametrization, and description) and associated site attributes 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",
"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"
}
integer
id
Required
id
string
name
Optional
name
string
description
Optional
description
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"Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"id:"integer"}' https://{api_host}/portal/rest/gateway/updateGatewayAttributes