ZeroFare
Console Get started
Docs / API reference

Management API reference

The management plane is the frozen zerofare.management/v1 contract (OpenAPI 3.1). The console itself is a client of this API — anything the console does, you can do programmatically.

Two origins: the management API is served by both the console origin (https://150-136-150-135.sslip.io, for the console's management credential) and the gateway origin (:8443, for your API key). Auth is Authorization: Bearer … on both.

Conventions

  • Versioned. All paths live under /management/v1/; breaking changes ship as a new version, never in place.
  • Fail-closed. Unknown routes and missing credentials return an identical terse 401 — unauthenticated probing reveals nothing.
  • Idempotent mutations. Replays of the same management request return the original result (safe retries).
  • Cursor pagination on list endpoints; cursors are opaque and validated server-side.
  • Typed problems. Errors carry a stable code, message, and profile — e.g. NOT_FOUND, CONFLICT, UNAUTHENTICATED.

Endpoint index

Exact methods and paths from the frozen contract snapshot.

Identity & keys

Method Path Purpose
GET /management/v1/api-keys List your tenant's gateway API keys.
GET /management/v1/credentials List management credentials.
POST /management/v1/credentials Create a management credential.
DELETE /management/v1/credentials/{id} Revoke a credential.
GET /management/v1/sessions Inspect active sessions.
POST /management/v1/sessions/revoke-all Revoke all sessions (panic button).

Governance

Method Path Purpose
GET /management/v1/policies List routing/admission policies.
POST /management/v1/policies Draft a policy.
POST /management/v1/policies/{name}/promote Promote a draft to active.
GET /management/v1/quotas/{tenantId} Inspect tenant quotas.
GET /management/v1/subscriptions View plan state.
POST /management/v1/subscriptions/transition Change plan tier.
GET /management/v1/audit Query the audit log.
GET /management/v1/security-events Security-relevant events.
GET /management/v1/suspensions Account suspension state.
GET,POST /management/v1/abuse Abuse reports and reviews.
GET,POST /management/v1/appeals Appeals workflow.

Operations

Method Path Purpose
GET /management/v1/catalog Browse the model/catalog records.
POST /management/v1/catalog Publish a catalog record.
GET /management/v1/catalog/{id} Fetch one record.
DELETE /management/v1/catalog/{id} Retire a record.
GET /management/v1/jobs List async jobs.
POST /management/v1/jobs Enqueue a job.
GET /management/v1/jobs/{id} Job status.
GET /management/v1/cache Cache entries overview.
DELETE /management/v1/cache/{id} Evict a cache entry.
POST /management/v1/cache/purge Bulk purge (scoped).
GET /management/v1/decisions Decision records for your tenant.
GET,POST /management/v1/bundles Distribution bundles.

Trust & safety

Method Path Purpose
GET,POST /management/v1/emergency Emergency controls (kill switches).
POST /management/v1/exports Request a data export (audit trail).
POST /management/v1/deletions Request data deletion.
GET /management/v1/healthz Liveness (unauthenticated).

Example

# list keys with a management credential (console origin)
curl -s https://150-136-150-135.sslip.io/management/v1/api-keys \
  -H "Authorization: Bearer $ZEROFARE_MANAGEMENT_CREDENTIAL"

# transition plan tier
curl -s -X POST https://150-136-150-135.sslip.io/management/v1/subscriptions/transition \
  -H "Authorization: Bearer $ZEROFARE_MANAGEMENT_CREDENTIAL" \
  -H 'content-type: application/json' \
  -d '{"to":"pro"}'
The complete machine-readable contract ships in the repository at packages/public-contracts/snapshot/contracts/openapi/management.openapi.json — generate clients from it directly.