Skip to main content
GET
List BYOK keys
Requires byok:read scope. Naturally idempotent.
Responses contain redacted metadata only — a masked key_prefix, never the provider secret. Submitted secrets can’t be retrieved through any endpoint.
Items may carry propagation_status: "pending" while a change to their provider takes effect (within about 5 minutes).
All parameters, request/response schemas, and examples are auto-generated from the OpenAPI specification.

Authorizations

Authorization
string
header
required

API key authentication. Keys start with ak_ prefix. Example: Authorization: Bearer ak_live_xxxxxxxxxxxx

Path Parameters

workspace_id
string<uuid>
required

Workspace identifier

Query Parameters

provider
string

Filter by provider identifier

Response

OK

object
enum<string>
required
Available options:
list
data
object[]
required
count
integer
required