Approve or reject a deployment request
/apiplatform/management/v1/gateways/{gwId}/deployments/{depId}/state
Approves or rejects the {depId}
deployment request in REQUESTING
state for the {apiId}
API. If rejecting a deployment request, you can optionally describe the reason in the deploymentComments
attribute.
Users accessing this resource must be assigned the Gateway Manager role and must be issued the Manage Gateway grant for the gateway the API is deployed to.
Request
- application/json
-
depId: string
A unique ID referencing a specific deployment.
-
gwId: string
A unique ID referencing a specific gateway.
object
-
deploymentComments(optional):
string
Comments regarding the deployment's state.
-
deploymentState:
string
The deployment's state. Valid values are
REQUESTING
,APPROVED
, andREJECTED
.
Response
- application/json
200 Response
403 Response
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
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 approve or reject a deployment request 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 @deployment.json
https://example.com/apiplatform/management/v1/gateways/{gwId}/deployments/{depId}/state
-
{gwId}
is the unique of a gateway. To retrieve available gateway Ids, see Get gateways. -
{depId}
is the unique Id for a deployment. To retrieve available deployment Ids, see Get deployed APIs.
Example of Request Body
The following shows an example of the request body approving a deployment in JSON format, included with the request above in a file named deployment.json
.
{ "deploymentState":"APPROVED" }
Example of Request Body
The following shows an example of the request body rejecting a deployment in JSON format, included with the request above in a file named deployment.json
.
{ "deploymentState":"REJECTED", "deploymentComments": "Deployment rejected" }
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: Wed, 22 Mar 2017 09:11:10 GMT X-oracle-dms-ecid: 49d14691-2176-4c99-aed3-38438604f528-00001e79 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0