Fetching SAP External Key Versions

Use the get /v1/cckm/sap/ekm/keys/{id}/versions API to fetch the list of SAP key versions for SAP HYOK. The results can be filtered using the query parameters.

Syntax

curl -k '<IP>/api/v1/cckm/sap/ekm/keys/{id}/versions?skip=0&limit=10' -H 'Authorization: Bearer AUTHTOKEN' --compressed

Request Parameters

Parameter	Type	Description
AUTHTOKEN	string	Authentication token.
id	string	ID of the SAP external key.

Request Query Parameters

Parameter	Type	Description
version_id	string	Filter the result by SAP external key version id.
key_id	string	ID of the SAP external key.
size	integer	Size of the SAP external key.
algorithm	string	Algorithm of the SAP external key.
source_key_tier	string	Filter the results by source key tier.
source_key_id	string	Filter the results by source key id.
source_key_name	string	Filter the results by source key name.
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.

Example Request

curl -k 'https://127.0.0.1/api/v1/cckm/sap/ekm/keys/asf45/versions?skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3MGRkZmM2Zi0xMTIxLTQwMmQtYjU5Zi04OWFiOGJlMjkyOWYiLCJzdWIiOiJsb2NhbHwzNWQ5ZjA1OC01ZGVhLTQwMWMtYTQwMC0zMTcyZTczZGY4ODciLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODM3Yzg0MGQtNzVkZC00YjRmLWEzMTgtNzljYjE2Y2EyNDhkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjE1MDEwM2NmLTk1MGItNGZlYi04MWNmLTZlNGUzZTI1ZWMwMiIsImlhdCI6MTcxNDM4NDE1NiwiZXhwIjoxNzE0Mzg0NDU2fQ.TXbj1OnD7mw6VhIvpPpzj6YOXvDaklWNJG9_dcyOhj267nYWdDg2SZyCy6ZtFKMPd9nTsitH9PfPFMuUoMeGyA' -H 'accept: application/json' --compressed

Example Response

{
    "skip": 0,
    "limit": 10,
    "total": 1,
    "resources": [
        {
            "id": "ead2da17-d1ef-49c8-96d3-1f5cc0f867eb",
            "uri": "kylo:kylo:cckm:sap-key-version:ead2da17-d1ef-49c8-96d3-1f5cc0f867eb",
            "account": "kylo:kylo:admin:accounts:kylo",
            "createdAt": "2024-04-09T04:06:16.897355Z",
            "updatedAt": "2024-04-09T04:06:16.896266Z",
            "key_id": "5742b69b-ff68-41ab-bea2-164c6036b6a0",
            "size": 256,
            "algorithm": "AES",
            "source_key_tier": "local",
            "source_key_id": "540e034ad7004ca298ecbca0f5dae0f9e8296db89956456d83847db4ddafca56",
            "source_key_name": "qwer"
        }
    ]
}

Response Codes

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

Refer to HTTP status codes for details.

Fetching SAP External Key Versions

Syntax

Request Parameters

Request Query Parameters

Example Request

Example Response

Response Codes

On this page

Suggest A Change