Skip to main content

API Keys

The API Keys page lets you create and manage credentials for programmatic access to the VeloDB Cloud management API. API key permissions follow the organization role assigned at creation time. They apply only to Management API operations and do not include direct warehouse access.

api-keys

Create an API key​

Click + Create API Key in the top-right corner. A dialog appears with the following fields:

  • Name (required): A label to help you identify the key later.
  • Role (required): The organization role assigned to the key at creation time. It determines which Management API operations the key can perform.
  • Expiration (required): How long the key remains valid. Choose 30 days, 90 days, 1 year, Custom (select any date), or Never.

Click Confirm to generate the key. Copy and securely store the API key immediately. It is shown only once, when created.

api-keys-create

Manage existing keys​

The API Keys list shows every key in the organization with the following columns:

ColumnDescription
NameThe label you gave the key.
Key IDA masked identifier (for example, key_*****) that you can copy.
RoleThe organization role assigned at creation time.
StatusEnabled or Disabled.
Last UsedTimestamp of the most recent successful API call, or – if never used.
Expires AtThe date and time the key expires.

The Actions column provides three controls per key:

  • Edit (pencil icon): Rename the key or update its expiration.
  • Enable / Disable (toggle): Temporarily block or restore access without deleting the key.
  • Delete (trash icon): Permanently remove the key. This action cannot be undone.

Security checklist​

  1. Assign the least-privileged role that permits the API key to perform its intended administrative task.
  2. Set an expiration date unless your organization has approved a non-expiring key.
  3. Immediately store the API key in an approved secrets manager. The key is displayed only once at creation and cannot be retrieved later.
  4. Review Last Used and Expires At regularly. Disable a key to revoke access temporarily. Delete it only when it is no longer needed.

Use the Management API​

For the full list of available endpoints, request/response schemas, and interactive examples, refer to the VeloDB Cloud Management API Reference.