Byok - Go SDK
Byok - Go SDK
The Go SDK and docs are currently in beta. Report issues on GitHub.
Overview
BYOK endpoints
Available Operations
- List - List BYOK provider credentials
- Create - Create a BYOK provider credential
- Delete - Delete a BYOK provider credential
- Get - Get a BYOK provider credential
- Update - Update a BYOK provider credential
List
List the bring-your-own-key (BYOK) provider credentials for the authenticated entity’s default workspace. Use the workspace_id query parameter to scope the result to a different workspace, or the provider query parameter to filter by upstream provider. Management key required.
Example Usage
Parameters
Response
*operations.ListBYOKKeysResponse, error
Errors
Create
Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. Defaults to the authenticated entity’s default workspace; use the workspace_id body field to scope to a different workspace. Management key required.
Example Usage
Parameters
Response
*components.CreateBYOKKeyResponse, error
Errors
Delete
Delete (soft-delete) a bring-your-own-key (BYOK) provider credential by its id. The encrypted key material is wiped and the record is marked as deleted. Management key required.
Example Usage
Parameters
Response
*components.DeleteBYOKKeyResponse, error
Errors
Get
Get a single bring-your-own-key (BYOK) provider credential by its id. Management key required.
Example Usage
Parameters
Response
*components.GetBYOKKeyResponse, error
Errors
Update
Update an existing bring-your-own-key (BYOK) provider credential by its id. Include the key field to rotate the raw provider API key in-place (the previous key material is overwritten). Management key required.
Example Usage
Parameters
Response
*components.UpdateBYOKKeyResponse, error