Delete an entitlement
delete
/apiplatform/management/v1/apis/{apiId}/entitlements/{entitlementId}
Removes the {entitlementId} entitlement from the {apiId} API.
User must have Plan Manager or API Manger roles and must have Manage API or Entitle API grants on the API and Manage Plan or Entitle API to Plan grants on the Plan.
.Request
Supported Media Types
- application/json
Path Parameters
-
apiId: string
A unique ID referencing a specific API.
-
entitlementId: string
A unique ID referencing a specific entitlement.
Response
Supported Media Types
- application/json
204 Response
The entitlement 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 entitlement from an API by submitting a DELETE request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -X DELETE
-H "Authorization: Bearer access_token"
"https://example.com/apiplatform/management/v1/apis/{apiId}/entitlements/{entitlementId}"
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, 12 Feb 2018 19:02:35 GMT X-oracle-dms-ecid: dd439614-7d4f-47ad-a1ea-a25a74ec9403-0000032d X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0