Fetching List of DKE Endpoints
Use the get /v1/cckm/microsoft/dke/endpoints API to fetch a list of the Microsoft DKE endpoints from CCKM. The results can be filtered using the query parameters.
Syntax
curl -k '<CCKM IP address>/api/v1/cckm/microsoft/dke/endpoints' -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
Request Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | DKE endpoint ID. |
| name | string | Name of the DKE endpoint. |
| algorithm | string | DKE endpoint algorithm. |
| status | string | The status of the DKE endpoint. |
| key_type | string | Type of key created by DKE endpoint. The only option currently supported is asymmetric. |
| key_uri | string | URI of key created by the DKE endpoint. |
| auth_tenants | string | List of IDs of authorized tenants for the DKE endpoint. |
| skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
| limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter) will be displayed in the output. |
| sort | string | Comma-delimited list of properties to sort the results. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/microsoft/dke/endpoints?skip=0&limit=10&sort=updatedAt' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1ZTc3Y2Q3NC0wMmVhLTRhNzYtODIzMi1hNDY4YTg1MGQwM2UiLCJzdWIiOiJsb2NhbHw0ODMyZDM4ZS04YzdhLTRiMjYtYTc5Ni1kNjk3NWQyOTg2ZGIiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDQ5MTdlZjctYjhmYi00NTFjLThhYTMtYzAxZDUxNjZkYmY4Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImViODNmNzFmLTg2MGItNGZhMy04ODZjLTM4ZGJkNzQyZDYwYiIsImlhdCI6MTY5MjgyMzE2MCwiZXhwIjoxNjkyODIzNDYwfQ.INuQJVq6VZeEz4RCOOsFCy68Go3rbkTNWNSTKW-2mkE' -H 'accept: application/json' --compressed
Example Response
{
"skip": "0,",
"limit": "10,",
"total": "2,",
"resources": [
{
"id": "913703f8-9c33-48e9-8d1a-9173b02850d5",
"uri": "kylo:kylo:cckm:dke-endpoint:913703f8-9c33-48e9-8d1a-9173b02850d5",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2024-10-07T08:12:59.389313Z",
"updatedAt": "2024-10-07T08:12:59.391166Z",
"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/913703f8-9c33-48e9-8d1a-9173b02850d5/keys/testkeyfinal",
"kek_name": "testkeyfinal",
"kek_id": "d1c4dae9a23a47b4994c9ed7ea317015ea2bff2b1e964f899edb8543078b2190",
"kek_uuid": "153c921f-15a4-48df-975d-979712aea376",
"meta": {
"size": "big",
"color": "blue"
},
"kek_version": "0",
"key_type": "asymmetric",
"algorithm": "RSA_DECRYPT_OAEP_2048_SHA256",
"enable_success_audit_event": true,
"auto_rotate": false,
"status": "Enabled",
"auth_tenants": [
"38dd2fc7-1cf7-496b-ad2e-7a6f4d011b2d"
],
"source_key_tier": "local"
},
{
"id": "1339d44c-e87b-4157-8f57-27eda33759c9",
"uri": "kylo:kylo:cckm:dke-endpoint:1339d44c-e87b-4157-8f57-27eda33759c9",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2024-10-09T04:24:36.807898Z",
"updatedAt": "2024-10-09T04:24:36.810719Z",
"name": "TestDKEEndpoint_002",
"description": "demo dke endpoint 2",
"key_uri_hostname": "localhost",
"key_uri": "https://localhost/api/v1/cckm/microsoft/dke-data-plane/endpoints/1339d44c-e87b-4157-8f57-27eda33759c9/keys/testkey2",
"kek_name": "testkey2",
"kek_id": "8dfd9ddbbd0246528eaa57c38c71f7904dea9a71634545af96848cb33e3a23b3",
"kek_uuid": "441ad4aa-606f-4eed-8b90-4284fdc11f89",
"meta": null,
"kek_version": "0",
"key_type": "asymmetric",
"algorithm": "RSA_DECRYPT_OAEP_2048_SHA256",
"enable_success_audit_event": true,
"auto_rotate": false,
"status": "Enabled",
"auth_tenants": [
"38dd2fc7-1cf7-496b-ad2e-7a6f4d011b2d"
]
}
]
}
The sample output shows two DKE endpoints listed--one with the endpoint ID of b724005d-e821-4a54-8f69-2199e1499898 and the other with the endpoint ID of f222ffdf-80e1-4fd5-8f17-1b60a26dba5d.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
