API ReferenceByok

Get a BYOK provider credential

Get a single bring-your-own-key (BYOK) provider credential by its id. Defaults to the authenticated entity’s default workspace; use the workspace_id query parameter to scope to a different workspace. Management key required.

Authentication

AuthorizationBearer
API key as bearer token in Authorization header

Path parameters

idstringRequiredformat: "uuid"

The BYOK credential ID (UUID).

Query parameters

workspace_idstringOptionalformat: "uuid"
Optional workspace ID. Defaults to the authenticated entity's default workspace.

Response

BYOK credential details
dataobject
The BYOK credential.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error