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:
Name | Data Type | Description |
---|---|---|
next_rotation | Integer | Timestamp (Unix time, in milliseconds) of the next key rotation. |
enabled | Boolean | Whether key rotation is enabled. |
frequency | Integer | How often the key is rotated. |
unit | String | Time unit for frequency ('d' for days, 'm' for months). |
hour | Integer | Hour (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
Name | Data Type | Description |
---|---|---|
_id | String | System-defined ID of the key rotation schedule. |
created | Integer | Timestamp of schedule creation (Unix time, ms). |
enabled | Boolean | Indicates if key rotation is active. |
err_count | Integer | Number of consecutive key rotation failures. |
err_msg | String | Error message from last failed rotation. |
frequency | Integer | Frequency of key rotation. |
hour | Integer | Hour (UTC) of scheduled key rotation. |
last_err | Integer | Timestamp of last failed key rotation. |
last_rotation | Integer | Timestamp of last successful key rotation. |
lastmod | Integer | Timestamp of last update to schedule. |
next_rotation | Integer | Timestamp of next scheduled key rotation. |
unit | String | Unit for rotation frequency (d for days, m for months). |