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
Path Parameters
Body ()
Root Schema : UpdateGatewayRequest
Match All
Show Source
Nested Schema : GatewayDef
Type: object
Show Source
Nested Schema : configuration
Type: object
Show Source
Nested Schema : firewall
Type: object
Show Source
Nested Schema : proxyUrls
Type: array
Show Source
Nested Schema : urls
Type: array
Show Source
Back to Top

Response

Supported Media Types

204 Response

The gateway was updated.

400 Response

Bad request, indicates a problem with the input parameters.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source

403 Response

Forbidden.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source

500 Response

Unexpected error.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source
Back to Top

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 
-u apicsadmin:password
-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
Back to Top