API Keys

API keys authenticate your requests and scope them to a single project. Manage their full lifecycle from the dashboard.

The key pair

Creating a key produces a Secret and a Publishable key together. Carrier OS stores only a display prefix and a SHA-256 hash — never the full secret — so the raw secret is shown exactly once, at creation.

Lifecycle

  • Active — the key works normally.
  • Disabled — temporarily turned off; requests are rejected, but you can re-enable it at any time.
  • Revoked — permanently killed. A revoked key can never be restored or re-enabled; create a new one instead.

Environments

Keys are tagged Development or Production, reflected in the prefix (_test_ vs _live_). This lets you keep test traffic and real traffic cleanly separated within a project.

See Generating API Keys for a step-by-step walkthrough, or use the key with the Carrier OS CLI.