Skip to main content
Last updated: July 23, 2026tiCrypt

API Keys

Prerequisites

Access Level:

Super-admin

Permission Requirements

  • . System Settings
    • View system settings (overrides for deployment)
  • . System Settings Administration
    • Edit (or create) system settings
    • Delete system settings (will default to deployment file)
note

API keys are used to authenticate programmatic access to tiCrypt. For available endpoints, request formats, and usage examples, see the REST API Reference.

Create a New API Key​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the API Keys in the left panel.
  4. Click the Create new API key button in the top right panel.
  5. In the pop-up, enter the key type, expiration date, and optional description. As of ver. 3.14.1 more than one key type can be selected.
  6. Click Create.
  7. In the new pop-up, click Copy.
  8. Paste the API key where necessary.
  9. Click Close.
caution

The key value is shown once, at creation. It is never stored by the server. If you lose it, delete the key and create a new one.

Key Types​

The key type determines which routes the key can reach. A request outside the key's types is rejected.

Key TypeGrants access to
DriveDrive routes
VMVM, image, hardware-setup, realm, and external-server routes
TeamTeam, team-quota, and team-usage routes
ProjectProject, project-membership, project-usage, and security routes
UserUser, profile, certification, managed-object, and permission routes

Choose the narrowest set of types that covers the job.

Multiple Types Per Key (as of ver. 3.14.1)​

Before 3.14.1 a key carried exactly one type, so work spanning resource types needed one key per type, each with its own expiration and rotation.

As of 3.14.1 the key type control accepts any combination of types. Select all five and one key reaches every route in the REST API, which is what the System Snapshot script expects.

Existing single-type keys are unaffected and keep working after the upgrade.

Read-Only Keys​

A key can be marked read-only at creation. Read-only keys are restricted to read and list operations; any request that changes state is rejected. Mark a key read-only whenever it is used for reporting, inventory, or monitoring.

A key with every type selected reaches the whole system, so pair it with read-only unless the job genuinely needs to write.

View an API Key​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the API Keys in the left panel.
  4. Select the API key to view.
  5. Click the View button in the top right panel.
  6. In the left panel, view the API key name, description, created and last modified dates.

Refresh the API Key List​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the API Keys in the left panel.
  4. Click the Refresh button in the top right panel.

Delete API Key(s)​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the API Keys in the left panel.
  4. Select the API key(s) to delete.
  5. Click the Delete button in the top right panel.
  6. In the prompt, click Delete.
caution

Deleting an API key is a permanent action and cannot be undone.