Managed Keys
List of managed keys.
Fetch managed keys with filter and pagination.
get/_fabric/{fabric}/_api/kms/managedkey
Request
- The document declares no server URL.
- Auth
- API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
fabricstring required
The name of the fabric.
Query parameters
namestring
The name of the manged key.
service'STORAGE' | 'SECRETS' | 'AUDIT'
The type of GND service used by the key.
managedKeyType'MACROMETA' | 'CMK'
Who manages the key, Macrometa or customer(CMK)
keyProvider'MACROMETA' | 'AWS'
The service that provides the root key.
offsetinteger
Number of managed keys to skip before displaying results. Default: 0
countinteger
The number of managed keys to return. Default: 50
sortBystring
Sort by field name.
order'ASC' | 'DESC'
Order the results ascending (ASC) or descending (DESC). Use with sortBy.
Response
Successfully fetched the list of managed keys.
Example response
{
"code": 200,
"result": {
"total": 100,
"count": 50,
"items": [
{
"id": "lPz8KjI2_yzYBgjkk2jlWA.IqXfBlY",
"name": "managed_key_1",
"managedKeyType": "CMK",
"keyProvider": "AWS",
"tenant": "_mm",
"fabric": "_system",
"createdAt": 1689020889736,
"updatedAt": 1689020889736,
"status": "ENABLED",
"description": "Customer's key."
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.