Disabling Key-Rotation Schedule for DKE Endpoint

Use the post /v1/cckm/microsoft/dke/endpoints/{id}/disable-key-rotation-job API to disable a key-rotation schedule for a Microsoft DKE endpoint. You only need to specify the ID of the DKE endpoint from which to disable the associated key-rotation schedule.

After disabling a rotation schedule for a given DKE endpoint, the auto_rotate parameter is set to false and the label and job configuration ID parameters are removed from this endpoint.

Note

You can run this API regardless of the state of this endpoint.

Syntax

curl -k '<CCKM IP address>/api/v1/cckm/microsoft/dke/endpoints/<id>/disable-key-rotation-job' -X POST -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed

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.

Example Request

curl -k 'https://10.171.15.127/api/v1/cckm/microsoft/dke/endpoints/df16d580-2a45-425f-a093-6bb228d895a8/disable-key-rotation-job' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlZGVjZGEzNS01MjljLTRlMzQtODIyOS0yOWZiZTJkMmM5ZjgiLCJzdWIiOiJsb2NhbHw3ZThiMjZjMC01YmUyLTQ5NjEtOGJhNC1iMTI5NjZiMzZjNzYiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNjU5ZDJiOTQtMzJhMC00OWFlLTkxYTItZDMwNmYwMTEyNjNmIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjdhNTNkN2E5LTMyY2YtNDVlNC1iYmIyLTI3ZWM4NThiZWI0YiIsImlhdCI6MTY5NzU4Njg1OSwiZXhwIjoxNjk3NTg3MTU5fQ.oXLnfa8Ise6sQZwMTdwVp2Fzq6CoKHk07k9FA--3hN8' -H 'accept: application/json' --compressed

Example Response

{
    "id": "7bd11dd3-268d-4c06-917c-e7d190247aa0",
    "uri": "kylo:kylo:cckm:dke-endpoint:7bd11dd3-268d-4c06-917c-e7d190247aa0",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2023-10-12T02:42:18.833403Z",
    "updatedAt": "2023-10-12T18:10:29.903258Z",
    "name": "dke_endpoint_1",
    "description": "Dke Endpoint 1",
    "key_uri_hostname": "dke.thales.com",
    "key_uri": "https://dke.thales.com/api/v1/cckm/microsoft/dke-data-plane/endpoints/7bd11dd3-268d-4c06-917c-e7d190247aa0/keys/ks-fbd0bedb6e774c8a99ef4c59781fdcde8310567708b94a3a9db8a46e9fcd969d",
    "kek_name": "ks-fbd0bedb6e774c8a99ef4c59781fdcde8310567708b94a3a9db8a46e9fcd969d",
    "kek_id": "fbd0bedb6e774c8a99ef4c59781fdcde8310567708b94a3a9db8a46e9fcd969d",
    "kek_uuid": "cf042fce-c88a-429f-961a-7030919f79da",
    "meta": {
        "owner": "test",
        "purpose": "development"
    },
    "kek_version": "0",
    "key_type": "asymmetric",
    "algorithm": "RSA_DECRYPT_OAEP_2048_SHA256",
    "enable_success_audit_event": true,
    "auth_tenants": [
        "95180635-b494-4f57-b9ba-a250aeac741f"
    ],
    "auto_rotate": false,
    "status": "Enabled"
}

The sample output shows that the key rotation schedule for the DKE endpoint with the ID of df16d580-2a45-425f-a093-6bb228d895a8 is successfully disabled. The parameters label and job_config_id of 0a47cc10-e4ad-4bbc-8ab2-5fdce92841cb are removed from this endpoint and auto_rotate is set to false.

Response Codes

Response Code	Description
2xx	Success
4xx	Client errors
5xx	Server errors

Refer to HTTP status codes for details.

Suggest A Change