Gateway API
Read-only Gateway API for project key state, organization usage and limits, and safe request diagnostics.
Version 5 — Gateway API
Version 5 is an additive Gateway API. It does not replace Version 3 or Version 4, and those versions keep their existing authentication and request-signing behavior.
The initial V5 release is intentionally read-only. It lets an API project securely retrieve:
- Gateway key state for the authenticated project
- Organization usage and limits that belong to that project’s organization
- Safe request diagnostics, when the diagnostics provider is available
- The V5 OpenAPI description
Enabled per environment
V5 returns 404 VC_GATEWAY_DISABLED until it is enabled in the environment. Ask your DevKit administrator to enable it before integrating.
What is different from V4?
| Area | V4 | V5 Gateway |
|---|---|---|
| Signing profile | Existing V4 signing | DK-HMAC-V5-1 exact HMAC profile |
| Authority | V4 endpoint-specific | The authenticated API key resolves the project; clients cannot choose another project or organization |
| Initial scope | Existing product endpoints | Read-only project key state, organization usage/limits, and diagnostics |
| Key lifecycle | Existing API-management flow | Create, rotate, revoke, and show-once secrets are not in this initial V5 release |
| Request diagnostics | Existing behavior | Safe diagnostics only; unavailable providers return an empty, explicit result |
Available endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /api/v5/openapi.json | V5 OpenAPI document. No signature required. |
GET | /api/v5/keys | Gateway key state for the authenticated project. |
GET | /api/v5/usage | Usage and wallet data for the owning organization. |