Endpoints index

Every operation of both planes on one page, with links into ReDoc and the owning wiki page.

One line per operation, grouped as in ReDoc. This page is a coverage contract: the test suite fails if an operation exists in the API but is missing here.

Health — probes, no auth

Owning page: Errors and Conventions (availability section).

• GET /health/live — liveness: the process answers.
• GET /health/ready — readiness: database, catalog, encryption keyring.

Catalog — read-only, user plane

Owning pages: Vendors and Providers · Provider Schemas · Full Catalog.

• GET /v1/catalog — the whole visible tree, schemas included.
• GET /v1/vendors — vendors without providers.
• GET /v1/vendors/{vendor_code} — one vendor with provider summaries.
• GET /v1/providers — flat provider list with filters.
• GET /v1/providers/{provider_code} — one provider in full.
• GET /v1/providers/{provider_code}/technical-info — just the technical notes.

Credentials — your own records

Owning pages: Personal Credentials · Defaults and Lifecycle · Credential Status.

• POST /v1/credentials — store a new credential.
• GET /v1/credentials — list yours, masked.
• GET /v1/credentials/{credential_id} — one record, masked.
• PATCH /v1/credentials/{credential_id} — rename / reconfigure / rotate.
• POST /v1/credentials/{credential_id}/make-default — atomic default switch.
• POST /v1/credentials/{credential_id}/disable — pause, optional replacement promotion.
• POST /v1/credentials/{credential_id}/enable — resume (default not restored).
• DELETE /v1/credentials/{credential_id} — soft delete with recovery window.
• GET /v1/providers/{provider_code}/credential-status — what would I translate with.

Org credentials — the tenant's records, managers only

Owning page: Organization Credentials.

• POST /v1/org-credentials — store for the organization.
• GET /v1/org-credentials — the org inventory, masked.
• GET /v1/org-credentials/{credential_id} — one org record.
• PATCH /v1/org-credentials/{credential_id} — rename / reconfigure / rotate.
• POST /v1/org-credentials/{credential_id}/make-default — switch the org default.
• POST /v1/org-credentials/{credential_id}/disable — pause the shared key.
• POST /v1/org-credentials/{credential_id}/enable — resume it.
• DELETE /v1/org-credentials/{credential_id} — soft delete.

Admin — user-plane platform administration

Owning page: User Plane Admin.

• POST /v1/admin/platform-credentials — store the shared fallback.
• GET /v1/admin/platform-credentials — list platform keys.
• GET /v1/admin/platform-credentials/{credential_id} — one platform key.
• PATCH /v1/admin/platform-credentials/{credential_id} — rotate it.
• POST /v1/admin/platform-credentials/{credential_id}/make-default — switch the platform default.
• POST /v1/admin/platform-credentials/{credential_id}/disable — pause the fallback.
• POST /v1/admin/platform-credentials/{credential_id}/enable — resume it.
• DELETE /v1/admin/platform-credentials/{credential_id} — soft delete.
• GET /v1/admin/providers/{provider_code}/credential-usage — per-level counters, can-remove check.
• GET /v1/admin/audit-events — the audit trail for humans.

Internal — the resolve endpoint

Owning page: Resolve Chain.

• POST /internal/v1/credentials/resolve — the effective credential, plaintext included.

Internal admin — operator tooling, service plane

Owning pages: Internal Admin API · Reveal · Audit Events.

• GET /internal/v1/admin/providers — catalog with schemas for forms.
• GET /internal/v1/admin/providers/{provider_code} — provider detail, any status.
• GET /internal/v1/admin/providers/{provider_code}/credential-usage — per-level counters.
• GET /internal/v1/admin/credentials — all levels, filtered.
• POST /internal/v1/admin/credentials — create with an explicit owner.
• GET /internal/v1/admin/credentials/{credential_id} — one record by id.
• PATCH /internal/v1/admin/credentials/{credential_id} — rotate any credential.
• POST /internal/v1/admin/credentials/{credential_id}/make-default — default within the owner scope.
• POST /internal/v1/admin/credentials/{credential_id}/disable — pause any credential.
• POST /internal/v1/admin/credentials/{credential_id}/enable — resume it.
• POST /internal/v1/admin/credentials/{credential_id}/reveal — plaintext for a named operator.
• DELETE /internal/v1/admin/credentials/{credential_id} — soft delete any credential.
• GET /internal/v1/admin/audit-events — the audit trail for tooling.