メインコンテンツまでスキップ
バージョン: 26.x

API Keys

API Keys lets you create and manage programmatic access credentials for the VeloDB Cloud management API. API key permissions follow the role assigned at creation time; they do not include direct database 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 permission level the key will carry. The three built-in options are:

    RoleWhat it can do
    Organization AdminPerform all administrative activities for the organization: organization management, access control, billing, and more.
    Warehouse AdminManage warehouses (create, view, modify, delete) and hold admin-role permissions for databases.
    Warehouse ViewerRead-only access to all warehouses. No database permissions are granted by default; database credentials are required for direct database access.
  • Expiration (required) — how long the key remains valid. Choose from 30 days, 90 days, 1 year, Custom (pick any date), or Never.

Click Confirm to generate the key. Copy and store the key value immediately — it is shown only once.

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 (e.g. sk-b****V59R) you can copy.
RoleThe role assigned at creation.
StatusEnabled (active) or Disabled (blocked).
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.