Archiving a DKE Endpoint

Use the post v1/cckm/microsoft/dke/endpoints/{id}/archive API to change the state of a Microsoft DKE endpoint in CCKM to archived. The only operation supported on an endpoint in an archived state is post /v1/cckm/microsoft/dke/endpoints/{id}/disable-key-rotation-job. An endpoint in an archived state can only be viewed, recovered, or deleted.

An archived endpoint is available in a list DKE endpoints when running the get /v1/cckm/microsoft/dke/endpoints API.

Note

Running this API releases a CCKM license from the total CCKM license count.

Syntax

curl -k '<CCKM IP address>/api/v1/cckm/microsoft/dke/endpoints/{id}/archive' -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/0289f816-e22d-4bbb-b90c-08f37a3011e6/archive' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlZGVjZGEzNS01MjljLTRlMzQtODIyOS0yOWZiZTJkMmM5ZjgiLCJzdWIiOiJsb2NhbHw3ZThiMjZjMC01YmUyLTQ5NjEtOGJhNC1iMTI5NjZiMzZjNzYiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNGU3ZjMyYjUtNjVjMi00ODk3LTkyNTMtZDRjZTk5MDk4ZmJjIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImM3YzIwMTA2LTNlNWItNDZhNi1iOTFhLWM3NDI2YWE2NGI0NSIsImlhdCI6MTY5NzY3MDE1NiwiZXhwIjoxNjk3NjcwNDU2fQ.0Pj2ggSMw_LIcIFmHvA7jT8imS2VCvhSRGMXnHrcMwo' -H 'accept: application/json' --compressed

Example Response

{
    "id": "8fbd67ea-3925-4361-9326-c73a84ae872c",
    "uri": "kylo:kylo:cckm:dke-endpoint:8fbd67ea-3925-4361-9326-c73a84ae872c",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2023-06-23T02:58:31.192776Z",
    "updatedAt": "2023-06-23T02:58:31.192776Z",
    "name": "TestDKEEndpoint_001",
    "description": "demo dke endpoint 1",
    "key_uri_hostname": "dke.thales.com",
    "key_uri": "https://dke.thales.com/api/v1/cckm/microsoft/dke-data-plane/endpoints/8fbd67ea-3925-4361-9326-c73a84ae872c/keys/ks-e998720b0e8e4ccc9ecf6a6e125ccce16356ba90b31540478a4d23fed4216203",
    "kek_name": "ks-e998720b0e8e4ccc9ecf6a6e125ccce16356ba90b31540478a4d23fed4216203",
    "kek_id": "e998720b0e8e4ccc9ecf6a6e125ccce16356ba90b31540478a4d23fed4216203",
    "kek_uuid": "efc5544d-53bd-42ab-b582-d6985458f37c",
    "meta": {
        "color": "blue",
        "size": "big"
    },
    "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": "Archived"
}

The sample output shows that the DKE endpoint with the ID of 0289f816-e22d-4bbb-b90c-08f37a3011e6 is successfully archived and shows a status of Archived.

Response Codes

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

Refer to HTTP status codes for details.

Suggest A Change