Update an API's state
/apiplatform/management/v1/apis/{apiId}/state
Updates the state of the {apiId}
API. Valid states are ALPHA
, BETA
, DEPRECATED
, RELEASED
, and RETIRED
(notice that state values are all uppercase).
Users requesting this resource must be assigned the API Manager roles and must be issued the Manage API grant for the specified API.
Request
- application/json
-
apiId: string
A unique ID referencing a specific API.
object
-
state:
string
The updated API state. Valid values are
ALPHA
,BETA
,DEPRECATED
,RELEASED
, andRETIRED
. -
stateComments(optional):
string
Comments about the API's state.
Response
- application/json
204 Response
400 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
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 update the state of an API 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 @update-state.json
https://example.com/apiplatform/management/v1/apis/{apiId}/state
{apiId}
is the unique ID for an API. To retrieve available API Ids, see Get APIs.
Example of Request Body
The following shows an example of the request body in JSON format, included with the request above in a file named update-state.json
.
{ "state": "DEPRECATED", "stateComments": "Deprecated in favor of version 2" }
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, 13 Mar 2017 09:47:57 GMT X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-000196d0 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0