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. Each API key inherits the permissions of its selected organization role. API keys apply only to Management API operations and cannot be used to access databases directly.

You must be an Organization Admin to access the API Keys page and manage API keys.

Open the API Keys page​

  1. Log in to the VeloDB Cloud console.
  2. In the upper-left corner, click the organization name to open the Organization Overview page.
  3. In the left navigation pane, click API Keys.

Create an API key​

  1. On the API Keys page, click Create API key. If the organization has no API keys, use the button in the empty state. Otherwise, use the button in the top-right corner.

  2. In the New API key dialog, configure the following fields:

    • Name (required): Enter a name of up to 128 characters.
    • Role (required): Select the organization role whose permissions the key inherits.
    • Expiration (required): Select 30 days, 90 days, 1 year, Custom, or Never. The default is 30 days. If you select Custom, enter a date that is not in the past.

  3. Click Confirm. The API key created dialog displays the complete key.

  4. Copy the key or download it as velodb-api-key.json, then store it securely. You cannot view the complete key again after closing the dialog.

  5. Click Done.

Find and review API keys​

Use the Search by name or ID field to find a key. To narrow the list, filter by Enabled, Disabled, or Expired status.

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

ColumnDescription
Name / IDThe key name and its ID. Copy the ID to identify the key in logs. The ID alone cannot authenticate a request.
RoleThe organization role whose permissions the key inherits.
StatusEnabled, Disabled, or Expired.
Created AtThe date and time when the key is created.
Last usedThe date and time of the most recent API call, or - if the key has not been used.
ActionsControls for enabling or disabling, editing, and deleting the key.

The Created At and Last used columns display timestamps in the time zone shown in their headings.

Manage existing keys​

Use the controls in the Actions column:

  • Enable or disable: Use the toggle to temporarily revoke or restore access for a key with Enabled or Disabled status.
  • Edit: Click the pencil icon to change the key's name, role, or expiration, then click Save. Changing the role changes the permissions available to the key.
  • Delete: Click the trash icon, review the confirmation, and click Confirm. Deleting a key permanently removes access for every system that uses it.

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 the Status, Last used, and expiration information 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.