Enabling Key-Rotation Schedule for DKE Endpoint
Use the post /v1/cckm/microsoft/dke/endpoints/{id}/enable-key-rotation-job
API to enable a key-rotation schedule for a Microsoft DKE endpoint. Specify the following:
- ID of the DKE endpoint
- ID of job scheduler associated with the rotation schedule
Create a DKE endpoint and job scheduler before enabling a key-rotation schedule.
As part of enabling a key-rotation schedule for a given DKE endpoint, the auto_rotate parameter in this endpoint is set to true
to reflect that key auto-rotation is now enabled. Also, the labels and job_config_id parameters are added to the endpoint to reflect the associated scheduled key rotation.
To create a job scheduler, use the post /v1/scheduler/job-configs
API using the operation parameter of cckm_key_rotation
along with the following request parameters:
- start_date
- run_at
- cloud_name of
Microsoft DKE
(as part of the cckm_key_rotation_params parameter)
For more information about post /v1/scheduler/job-configs
API, refer to Scheduling Key Rotation and Auto Rotation of Credentials.
Note
If the endpoint is in an archived state, you cannot run the post /v1/cckm/microsoft/dke/endpoints/{id}/enable-key-rotation-job
API on it.
Syntax
Here, {id}
is the ID of the DKE endpoint.
Request Parameter
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
id | string | ID of the DKE endpoint. |
job_config_id | string | ID of the scheduler job that will perform the rotation of the DKE endpoint. |
Example Request
Example Response
The sample output shows that the key-rotation schedule for the DKE endpoint with the ID of df16d580-2a45-425f-a093-6bb228d895a8
and the job_config_id of 0a47cc10-e4ad-4bbc-8ab2-5fdce92841cb
is successfully enabled. Note that the parameter of auto_rotate is set to true
.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.