Update application key
/apiplatform/management/v1/applications/{appId}/key
Updates the key for the {appId}
the application. You can generate a new key by omitting the key attribute from the request body payload (sending {}
as the request body) or specify a key to use by sending it in the key attribute in the request body. Note that application keys must be unique.
Users requesting this resource must be assigned the API Manager, Plan Manager or Application Developer role and must be issued the Manage Application grant for the specified application.
Request
- application/json
-
appId: string
A unique ID referencing a specific application.
Response
- application/json
200 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 set a custom application key for the application specified by the {appId}
path parameter 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 @key.json
https://example.com/apiplatform/management/v1/applications/{appId}/key
{appId}
is the unique Id for an application. To retrieve available application Ids, see Get Applications.
Example of Request Body
The following example shows an example of the request body in JSON format (included with the request above in a file named key.json
) , including a new application key.
{ "key": "12345678" }
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: Mon, 02 Jan 2017 19:43:51 GMT Content-length: 25 Content-type: application/json X-oracle-dms-ecid: Fq12G0VNV00000000 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, including the custom application key.
{ "key": "123456789" }