Use the POST /serverSettings/systemKeys/rotate
endpoint to rotate the system keys. Upon rotation, previous key will be replaced by the current key, the current key will be replaced by the pending key, while the newly generated key replaces the pending key. Periodic rotation can ensure optimal security of your environment.
Code | Reason |
---|---|
201 | System Keys rotated. |
400 | The request was improperly formatted or contained invalid fields. |
422 | Validation error(s) occurred. |
SystemKeys
- Secrets that are used in cryptographic operations to generate and consume internal tokens
Property | Type | Description |
---|---|---|
current * | SystemKey | The current secret. |
pending * | SystemKey | The next secret. |
previous | SystemKey | Previously used secret. |
SystemKey
- A system key.
Property | Type | Description |
---|---|---|
creationDate | string | Creation time of the key. |
encryptedKeyData | string | The system key encrypted. |
keyData | string | The clear text system key base 64 encoded. The system key must be 32 bytes before base 64 encoding. |