Update a gateway
put
/apiplatform/management/v1/gateways/{gwId}
Updates the {gwId}
gateway.
Users requesting this resource must be assigned Gateway Manager role and must be issued Manage Gateway grant for the specified gateway.
Request
Supported Media Types
- application/json
Path Parameters
-
gwId: string
A unique ID referencing a specific gateway.
Nested Schema : GatewayDef
Type:
Show Source
object
-
configuration(optional):
object configuration
-
description(optional):
string
The gateway's description.
-
firewall(optional):
object firewall
-
location(optional):
string
The gateway's location.
-
proxyUrls(optional):
array proxyUrls
-
releaseVersion(optional):
string
The gateway's release version. This property is used only at node registration time to seed the original release version of the node.
-
urls(optional):
array urls
Response
Supported Media Types
- application/json
204 Response
The gateway was updated.
400 Response
Bad request, indicates a problem with the input parameters.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
Unexpected error.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to update a gateway by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X PUT
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @update-gw.json
https://example.com/apiplatform/management/v1/gateways/{gwId}
{gwId}
is the unique of a gateway. To retrieve available gateway Ids, see Get gateways.
Example of Request Body
The following shows an example of the request body in JSON format, included with the request above in a file named update-gw.json
.
{ "name": "Development Gateway", "description": "Newer dev gateway", "urls": ["http://example.com:8001"] }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Thu, 16 Mar 2017 09:41:04 GMT X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-00026ed3 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0