List of Keys
Retrieve a sorted, filtered, paginated list of all keys.
Query parameters
Filter a collection by a string search
Filter the results by a partial search of display_name.
Filter a collection by a string search
Filter the results by exact match for provider.
Filter a collection by a string search
Filter the results by exact match for state.
Filter a collection by a string search
Filter the results by exact match for validation_phase.
Filter a collection by a string search
Filter keys by the cloud region where they are deployed.
Filter a collection by a string search
Filters results by a partial match on the key identifier: key_arn for AWS, key_id for Azure and GCP.
A pagination size for collection requests.
An opaque pagination token for collection requests.
Response
Key.
Example response
{
"metadata": {
"first": "https://api.confluent.cloud/byok/v1/keys",
"last": "https://api.confluent.cloud/byok/v1/keys?page_token=bcAOehAY8F16YD84Z1wT",
"prev": "https://api.confluent.cloud/byok/v1/keys?page_token=YIXRY97wWYmwzrax4dld",
"next": "https://api.confluent.cloud/byok/v1/keys?page_token=UvmDWOB1iwfAIBPj6EYb",
"total_size": 123
},
"data": [
{
"id": "dlz-f3a90de",
"metadata": {
"self": "https://api.confluent.cloud/byok/v1/keys/cck-12345",
"resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-12345",
"created_at": "2006-01-02T15:04:05-07:00",
"updated_at": "2006-01-02T15:04:05-07:00",
"deleted_at": "2006-01-02T15:04:05-07:00"
},
"key": {
"key_arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
"roles": [
"arn:aws:iam::123456789876:role/block_storage_manager",
"arn:aws:iam::987654321234:role/cc-kafka-1111aaaa-11aa-11aa-11aa-111111aaaaaa"
]
},
"display_name": "Key for billing cluster",
"provider": "AWS",
"state": "IN_USE",
"validation": {
"phase": "VALID",
"message": "Access to key denied.",
"since": "2024-03-20T15:30:00Z",
"region": "us-west-2"
}
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.