Update Static Encryption Key Rotation Schedule

Defines or updates the rotation schedule for the static encryption key.

Request

Request Syntax:

POST /drm/key-rotation-schedule/create-or-update

Request Body Parameters:

NameData TypeDescription
next_rotationIntegerTimestamp (Unix time, in milliseconds) of the next key rotation.
enabledBooleanWhether key rotation is enabled.
frequencyIntegerHow often the key is rotated.
unitStringTime unit for frequency ('d' for days, 'm' for months).
hourIntegerHour (UTC) when the rotation occurs (0-23).

Sample Response:

{
    "owner": "abc33864a92b12a1a2a6cdg49b0a9534",
    "key_rotation_schedule": {
        "_id": "12770715bc29840c6h2fcc45b4c6463fc",
        "next_rotation": 1576470581706,
        "hour": 20,
        "created": 1571867701666,
        "enabled": true,
        "frequency": 1,
        "unit": "d"
    },
    "error": 0
}

Key Rotation Schedule Dictionary

NameData TypeDescription
_idStringSystem-defined ID of the key rotation schedule.
createdIntegerTimestamp of schedule creation (Unix time, ms).
enabledBooleanIndicates if key rotation is active.
err_countIntegerNumber of consecutive key rotation failures.
err_msgStringError message from last failed rotation.
frequencyIntegerFrequency of key rotation.
hourIntegerHour (UTC) of scheduled key rotation.
last_errIntegerTimestamp of last failed key rotation.
last_rotationIntegerTimestamp of last successful key rotation.
lastmodIntegerTimestamp of last update to schedule.
next_rotationIntegerTimestamp of next scheduled key rotation.
unitStringUnit for rotation frequency (d for days, m for months).