Cancel or delete a deployment
/apiplatform/management/v1/apis/{apiId}/deployments/{depId}
Cancels the {depId}
deployment in REQUESTING
state or deletes the {depId}
deployment in REJECTED
state for the {apiId}
API.
Users requesting this resource must be assigned the API Manager, or Gateway Manager role and must be issued the Deploy to Gateway or Request Deployment to Gateway grant for the gateway. Users must also be issued the Deploy API grant for the deployment they want to cancel or delete.
Request
- application/json
-
apiId: string
A unique ID referencing a specific API.
-
depId: string
A unique ID referencing a specific deployment.
Response
- application/json
204 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 cancel the deployment or delete the deployment for the API by submitting a DELETE request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X DELETE
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/apis/{apiId}/deployments/{depId}
-
{apiId}
is the unique ID for an API. To retrieve available API IDs, see Get APIs. -
{depId}
is the unique ID for a deployment. To retrieve available deployment IDs, see Get API deployments.
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:28:07 GMT X-oracle-dms-ecid: 49d14691-2176-4c99-aed3-38438604f528-00001e89 X-oracle-dms-rid: 0 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0