Skip to navigation
Overview

API reference

Every Cargovision REST endpoint, generated from the OpenAPI specification.
View as Markdown

The reference is generated from the Cargovision OpenAPI specification. Each endpoint page lists its parameters, request and response schemas, and authentication scheme, and includes an API Explorer for sending live requests.

Base URL

https://api.cargovision.app/v1

The health probes /health and /ready are the only routes outside /v1.

Authentication

SchemeHeaderUsed by
bearerAuthAuthorization: Bearer <jwt>Operator, supervisor, and admin endpoints
apiKeyAuthX-API-Key: <key>Edge ingestion endpoints

Browsers can authenticate with the token session cookie instead of the bearer header. See Authentication.

Endpoint groups

GroupPathsAuth
User auth/v1/user/auth/*Public, except refresh
Containers and scans/v1/containers/*JWT
Evidence/v1/containers/{id}/evidenceJWT
Manifests/v1/manifests/*JWT
Devices (mobile push)/v1/devices/*JWT
Edge device/v1/edge/containers/*API key
Tracking/v1/tracking-data/*API key for writes, JWT for reads

Responses use the envelopes described in Responses and errors.