ViaFrei API (1.0.0-draft)

Download OpenAPI specification:

Keyed, read-only access to live German mobility context. This document is generated from the code.

service

Health, readiness and service metadata.

Liveness

The process runs and answers. Never touches storage (FR-SVC-004).

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Readiness

Storage answers within the readiness timeout and publishes a compatible read contract (FR-SVC-004).

Responses

Response samples

Content type
application/json
{
  • "checks": {
    },
  • "status": "ready"
}

Service metadata

The API version, the build revision and the read-contract version.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "links": {},
  • "meta": {
    }
}