APIKeys - TypeScript SDK
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.
(apiKeys)
Overview
API key management endpoints
Available Operations
- list - List API keys
- create - Create a new API key
- update - Update an API key
- delete - Delete an API key
- get - Get a single API key
- getCurrentKeyMetadata - Get current API key
list
List API keys
Example Usage
Standalone function
The standalone function version of this method:
React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
Parameters
Response
Promise<operations.ListResponse>
Errors
create
Create a new API key
Example Usage
Standalone function
The standalone function version of this method:
React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
Parameters
Response
Promise<operations.CreateKeysResponse>
Errors
update
Update an API key
Example Usage
Standalone function
The standalone function version of this method:
React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
Parameters
Response
Promise<operations.UpdateKeysResponse>
Errors
delete
Delete an API key
Example Usage
Standalone function
The standalone function version of this method:
React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
Parameters
Response
Promise<operations.DeleteKeysResponse>
Errors
get
Get a single API key
Example Usage
Standalone function
The standalone function version of this method:
React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
Parameters
Response
Promise<operations.GetKeyResponse>
Errors
getCurrentKeyMetadata
Get information on the API key associated with the current authentication session
Example Usage
Standalone function
The standalone function version of this method:
React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
Parameters
Response
Promise<operations.GetCurrentKeyResponse>