Byok - TypeScript SDK
Byok - TypeScript SDK
The TypeScript 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
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<operations.ListBYOKKeysResponse>
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
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<models.CreateBYOKKeyResponse>
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
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<models.DeleteBYOKKeyResponse>
Errors
get
Get a single bring-your-own-key (BYOK) provider credential by its id. Management key required.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<models.GetBYOKKeyResponse>
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
Standalone function
The standalone function version of this method:
Parameters
Response
Promise<models.UpdateBYOKKeyResponse>