Secure keys REST API

Use this REST API to manage secure keys.

Get all secure keys

Table 1. Get all secure keys
REST API information Value Description
URI /admin/resources/secure_keys  
Method GET  
Returns 200 Returns a list of all secure keys
404 The secure key list was not found
500 Platform System Manager encountered an internal error while processing the request.

Returns a list of secure keys.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.

Response body


[
   {
      "state": "available"
      "updated_time": "Wed, 18 Apr 2012 14:09:48 GMT"
      "created_time": "Wed, 18 Apr 2012 14:09:48 GMT"
      "label_key": "pure8511"
      "secure_key":
"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAiUzFQ1fXe2iMgqhVS4ZvgQ9L+LbEuPSm4WUc
           
1AmkFXq+NbSpFlXUasxQGoo9+6xdSrzu7fyAS4z4IO279+TAUu6OoLbCO9N9jr8sfWmLz+ZsbuJ1U/Ww
           
1BPxCx/I+c0FMoHOV2QpsznBfGY8cbTzZcQADfshfgBFAx1puXre9sHPj5cR+0Qcu3x5RPJX9Tfluzhp
           
xZOEyXp3+8vds7rZv8hWL1LHkmRaLHX6v4JtlVitjjaaKYXV/u3sjdw9Q+ODNDZ9bSu+0HO0JepcFso8null"
      "label_text": "Secure Key"
      "key_type": "public"
      "id":
"/admin/resources/secure_keys/baa56ade-f3fd-42bb-9db5-5a93cf39ce55"
      "name": "IPAS"
   }
]
created_time
The time at which the object is created
id
The unique ID of the object in the system.
key_type
The type of the security key
label_key
Key for retrieving label for the security key
label_text
Default translated message text
name
The name of the security key
secure_key
The security key
state
The general availability of the object. If "pending" the object has been created but not activated. If "available" the object is active in the system.
updated_time
The time at which the object was last updated

Get a specific secure key

Table 2. Get a specific secure key
REST API information Value Description
URI /admin/resources/secure_keys/{id}  
Method GET  
Returns 200 The secure key was returned.
404 The secure key was not found
500 Platform System Manager encountered an internal error while processing the request.

Returns a single secure key identified by {id}.

You can use optional parameters to modify the response from the REST API call. For more information, see the Related information section.