AES key management API

This API provides endpoints for rotating Advanced Encryption Standard ( AES) keys and retrieving and deleting inactive keys. Below, you'll find detailed descriptions of each endpoint, including the URL, accepted HTTP methods, possible response codes, and their meanings.

Rotate AES key

This endpoint is used to rotate the AES encryption key. Existing secrets will be re-encrypted with the new key.

• Method: POST

• URL: https://<HOSTNAME>:<PORT>/rest/secrets/1.0/keys/rotate

• Query parameters: None

• Request body: None

The response codes are:

• 200 OK: The AES key was rotated successfully.

• 401 Unauthorized: The user isn't authorized to perform the operation.

• 406 Not Acceptable: The rotation can't occur due to invalid conditions.

• 500 Internal Server Error: An unexpected error occurs when performing the operation.

The response body has the following format:

{
    "message": "<detailed_message>",
    "status": "<rotation_status>"
}

Get inactive AES keys

Once key rotation is completed, the old AES key becomes inactive. This endpoint retrieves a list of inactive AES keys.

• Method: GET

• URL: https://<HOSTNAME>:<PORT>/rest/secrets/1.0/keys/inactive

• Query parameters: None

• Request body: None

The response codes are:

• 200 OK: The inactive AES keys were retrieved successfully.

• 401 Unauthorized: The user isn't authorized to perform the operation.

• 500 Internal Server Error: An unexpected error occurs when performing the operation.

The response body has the following format:

{
    "inactiveKeys": [
        "<inactive_key_name>"
    ]
}

Delete inactive AES keys

Once key rotation is completed, the old AES key becomes inactive. This endpoint deletes all inactive AES keys.

• Method: DELETE

• URL: https://<HOSTNAME>:<PORT>/rest/secrets/1.0/keys/inactive

• Query parameters: None

• Request body: None

The response codes are:

• 200 OK: The inactive AES keys were deleted successfully.

• 401 Unauthorized: The user isn't authorized to perform the operation.

• 500 Internal Server Error: An unexpected error occurs when performing the operation.

The response body has the following format:

{
    "deletedKeys": [
        "<deleted_key_name>"
    ]
}

Frequently asked question (FAQ)