Operation availability
Understand versioning, credential support, and deployment capabilities.
The Public API uses the /api/v1/public namespace. The endpoint reference and downloadable OpenAPI specification describe the contract; an operation can also depend on deployment capabilities, authorization, and plan access.
Capability labels
Each endpoint carries an x-neatlogs-operation-gate in OpenAPI and an availability note on its reference page.
| Contract label | Meaning |
|---|---|
always | Standard API surface, subject to authentication and authorization |
public-api-mutations | Managed mutation capability must be enabled |
service-account-token-mint | Token-minting capability must be enabled |
tier-c-compute | Additional compute or external integration capability must be enabled |
project-deletion-scheduling | Project-deletion scheduling requires its dedicated capability and supporting compute capability |
An unavailable operation may return 404 or an operation-specific availability problem. Treat it as a capability result; do not repeatedly retry it as a transient failure. Ask your organization administrator about access to a required workflow.
CLI schema discovery
The CLI reads the contract embedded in its installed release:
neatlogs schema list
neatlogs schema search trace
neatlogs schema show get_api_v1_public_tracesThese commands help discover schemas and capability labels. They do not query live deployment flags. Upgrade the CLI to obtain an updated embedded contract.
Supported deployments
The Public API and CLI support NeatLogs cloud deployments. Use the app origin for the intended environment and credentials issued by that environment. Enterprise self-hosted deployments are currently unsupported for this Public API and CLI surface.
Rollout checks on October 1, 2026
Package installation and command discovery do not verify the selected region's runtime. The current checks retain these prerequisites:
| Environment or workflow | Current prerequisite |
|---|---|
| US customer app | Bounded QA reads and owned reversible mutations have passed checks. Administrative and external-provider workflows still require their permissions, entitlements and controlled fixtures; Tier C compute remains disabled. |
| Keyword Search | The tested project lacks term-index generation readiness. Search can return 503 until project coverage and rollout readiness are verified. |
| Dev OAuth | The frontend configuration correction is deployed. Fresh browser and Device Flow login, denial, refresh, and revocation checks passed with CLI 0.1.0. |
| EU | Regional Public API foundation deployment and live acceptance remain prerequisites. An EU profile alone does not enable them. |
Guest review completion uses the retry guidance in API errors. A committed response and a completed review remain separate outcomes until completion processing succeeds.
Use the SDK documentation for trace ingestion. SDK ingest credentials, dashboard sessions, and Public API credentials have separate authorization policies.