Skip to content

API Keys

API keys provide programmatic access to the HarborGuard API for CI/CD integrations and automation.

Creating an API Key

  1. Navigate to Settings > API Keys
  2. Click Create API Key
  3. Enter a name and select registry scopes
  4. Copy the key — it will only be shown once

Key Format

API keys use the prefix hg_ followed by a random string. Authenticate by including the key in the X-API-Key header or as a Bearer hg_... token.

Rotation & Revocation

Rotate keys periodically and revoke compromised keys immediately from the API keys settings page.

On this page