Compact an API
post
/apiplatform/management/v1/apis/{apiId}/compact
Compacts the given API.
Users invoking this action 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
200 Response
The API was compacted.
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 compact an API submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X POST
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
https://example.com//apiplatform/management/v1/apis/{apiId}/compact
{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 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Fri, 1 Mar 2017 06:33:50 GMT Content-Length: 21 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0002ac6f X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "iterations": [ "1", "2", "6", "8" ] }