ShieldGate Docs

Gateway & identity

API keys

Machine credentials for automation against the control plane.

Goal

Issue API keys for CI/CD or gateways that call /api/v1 or validate at the edge.

Prerequisites

  • apikeys.read / apikeys.write.

Steps

  1. Open Advanced → API keys.
  2. Create a key; copy the secret once.
  3. Use header form Authorization: ApiKey sg_… against the API.
  4. For route gateway auth, reference API-key validation as configured in Gateway authentication.

Verify

  • API call with the key succeeds for permitted operations.
  • Revoked keys fail promptly.

Tips

  • Prefer short-lived automation keys and rotate on staff changes.
  • Never commit keys to git.