Delete an API
delete
/apiplatform/management/v1/apis/{apiId}
Deletes the {apiId}
API.
You can't delete an API if it is currently deployed to a gateway. Ensure you undeploy it from all gateways and that you have the proper grant before trying again.
Users requesting this resource must be assigned the API Manager role and must be issued the Manage API grant for the specified API.
Request
Supported Media Types
- application/json
Path Parameters
-
apiId: string
A unique ID referencing a specific API.
Response
Supported Media Types
- application/json
204 Response
The API was deleted.
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 delete an API from Oracle API Platform Cloud Service 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}
-
{apiId}
is the unique ID for an API. To retrieve available API IDs, see Get APIs.
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: Mon, 02 Jan 2017 18:08:42 GMT X-oracle-dms-ecid: Y2d180ChR00000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0