GET /platform/v1/key
Retrieves metadata for all keys that belong to a given MID. Data at Rest Encryption is a prerequisite for this feature.
URL Parameters
| Name | Type | Description | |
|---|---|---|---|
| x-request-id | string | Header parameter: Request ID for the request. Default Format: 11ee9b17-5734-4948-98d3-cb4b64e0171c | |
| x-mccs-user-context | string | Header parameter: Indicates the MCCS user context. Example: EID=111;MID=111;EmployeeId=111. | |
| x-mccs-keystore-provider | string | Header parameter: Specify a key store provider to use for an ImportKey or WrappingKey request. Examples: kms, keysecure, database. Default: keysecure. | |
| x-mccs-mac | string | Header parameter: Specify message authentication code for the request. |
Responses
| Status | Name | Type | Description |
|---|---|---|---|
| 200 | Successfully retrieved meta data for all keys for the current account | ||
| key | string | key Data | |
| value | integer | Format: int32. | |
| 500 | Unable to process the request | ||
| statusCode | integer | Format: int32. | |
| requestId | string | undefined | |
| message | string | undefined | |
| messageCode | string | undefined | |
| 503 | Database unavailable | ||
| statusCode | integer | Format: int32. | |
| requestId | string | undefined | |
| message | string | undefined | |
| messageCode | string | undefined |
Usage
Example Request
Example Response