Fetching SAP External Keys
Use the get /v1/cckm/sap/ekm/keys API to fetch the list of SAP external keys. The results can be filtered using the query parameters.
Syntax
curl -k '<IP>/api/v1/cckm/sap/ekm/keys?skip=0&limit=10&sort=updatedAt' -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authentication token. |
Request Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | ID of the SAP external key. |
| name | string | Name of the SAP external key. |
| cloud_name | string | Cloud name of the SAP external key. |
| keystore_id | string | ID of the SAP keystore. |
| size | integer | Size of the SAP external key. |
| blocked | boolean | Filter the result by blocked or unblocked state. |
| algorithm | string | Algorithm of the SAP external key. |
| sap_tenant_id | string | Tenant ID of the SAP tenant. |
| state | string | State of the SAP external key. |
| version_count | integer | Filter the result by SAP external key version count. |
| version_id | string | Filter the result by SAP external key version id. |
| 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/sap/ekm/keys?skip=0&limit=10&sort=updatedAt' -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlYmVjM2VkYi00YWExLTRkMzEtODNkMS05ZTI3YzI1ZjlkMTIiLCJzdWIiOiJsb2NhbHw5NWI3NmU3Yi0yNWE4LTQyYzYtYWFlNS01Yjg4NmI0NjA4MWUiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODM3Yzg0MGQtNzVkZC00YjRmLWEzMTgtNzljYjE2Y2EyNDhkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6Ijk2NjIxYWEzLTllMmMtNDNhMS1hYmZiLTU5Yjk1OWIwMzlhMyIsImlhdCI6MTcxMjIzMDg0NiwiZXhwIjoxNzEyMjMxMTQ2fQ.Qe3H91RFHCC3Z4kKyMYN7989ErwoeE4ZVTSe8pUx10QaH9G1XoPz1uqALVwNOaBgu1wNzCUZqAkjZu96zdHnKA' -H 'accept: application/json' --compressed
Example Response
{
"skip": 0,
"limit": 10,
"total": 1,
"resources": [
{
"id": "abbccb49-33aa-4f2e-b2bb-92ba821adb60",
"uri": "kylo:kylo:cckm:sap-key:sapekmkey-abbccb49-33aa-4f2e-b2bb-92ba821adb60",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2024-03-15T10:07:13.676645Z",
"updatedAt": "2024-03-15T10:07:13.671552Z",
"name": "SAPEKMKey",
"cloud_name": "sap",
"description": "This is sap external key",
"keystore_id": "edafcd7d-a40a-4da6-86a7-e76fdf768632",
"size": 256,
"state": "Enabled",
"algorithm": "AES",
"sap_tenant_id": "edafcd56d-a40a-4da6-84a7-e76fdf768456",
"source_key_tier": "local",
"blocked": false,
"auto_rotate": false,
"version_count": 1,
"version_id": "0397e4ed-d653-4329-811a-af84ab81f6c0"
}
]
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
