Data Tactical GroupStart free

Service

2 endpoints, generated from the API's own OpenAPI document. Liveness and this document.

GET /healthz

Liveness and vintage probe

Credentials: none. Operation id dataGetHealth.

Anonymous. Reports that the process is up, which credential mode it serves, the vintage it reads (and /v1-compat's), and the state of the admission gate, the sandbox gate and the scheduled jobs. It runs one probe query against the current vintage file on every call. Not rate limited, not metered. Takes no parameters; query parameters are ignored.

Responses

200 success

The process is up and its current vintage answered.

As application/json.

status"ok"always present
Always ok on a 200: the process is up and could open its current vintage.
serves"live" | "sandbox" | "both"always present
Which credential mode this process serves (TAIGAN_SERVES). A key of the other mode is refused 403 wrong_instance (base_url names the address that serves the key).
vintagestringalways present
The current vintage id of the scope this process probes: the live current vintage, or the sandbox one on a sandbox-only process.
compat_vintagestringalways present
The vintage the /v1-compat surface reads: vintage, unless a compat pin is configured.
compat_pinnedtrue
Present, and true, only when /v1-compat is pinned to a vintage (COMPAT_PIN_VINTAGE).
sandboxtrue
Present, and true, only on a sandbox-only process.
saluki"ok" | "bad"always present
Result of a one-row probe query against the current vintage file: ok when it answered as expected.
sandbox_loadobject
Absent on a live-only process. The sandbox's concurrent-query gate.
sandbox_load.in_flightintegeralways present
Sandbox queries running now. (at least 0)
sandbox_load.maxintegeralways present
The sandbox's concurrent-query maximum; past it, 429 sandbox_busy. (at least 0)
admissionobjectalways present
The global admission gate on data requests.
admission.in_flightintegeralways present
Data requests running now. (at least 0)
admission.queuedintegeralways present
Data requests waiting for a slot. (at least 0)
admission.maxintegeralways present
Concurrent data requests allowed (ADMISSION_MAX_CONCURRENT; 0 turns the gate off). (at least 0)
admission.queueintegeralways present
Queue places (ADMISSION_QUEUE). (at least 0)
admission.refused_totalintegeralways present
Requests refused 429 server_busy since the process started. (at least 0)
jobsobjectalways present
The scheduled jobs' last run (POL-8). A stale last_ok_at beside a fresh last_run_at, or a non-empty failed, is a job that keeps failing.
jobs.last_run_atstring (date-time) or nullalways present
When the jobs last ran; null before the first run since start.
jobs.last_ok_atstring (date-time) or nullalways present
When a run last finished with no job failed; null if none has.
jobs.failedarray of stringalways present
Names of the jobs that failed in the last run.

400 error

Bad request. Codes: bad_request (more than 50 query parameters).

As application/problem+json.

414 error

URI too long. Codes: uri_too_long (the request URL is longer than the configured maximum, 8,192 bytes by default).

As application/problem+json.

500 error

The process is up but cannot serve. Codes: internal_error (the current vintage file could not be opened or queried, or the configured compat pin is not in the store).

As application/problem+json.

Problem codes: bad_request (400), uri_too_long (414), internal_error (500). Every problem is a problem document.

GET /v2/openapi.json

This document as JSON

Credentials: none. Operation id dataGetOpenapi.

Anonymous. The OpenAPI 3.1 contract, parsed once at start-up from taigan/openapi.yaml and served as JSON. Not rate limited, not metered. Takes no parameters; query parameters are ignored.

Responses

200 success

The OpenAPI document.

As application/json.

400 error

Bad request. Codes: bad_request (more than 50 query parameters).

As application/problem+json.

414 error

URI too long. Codes: uri_too_long (the request URL is longer than the configured maximum, 8,192 bytes by default).

As application/problem+json.

Problem codes: bad_request (400), uri_too_long (414). Every problem is a problem document.

Generated from taigan/openapi.yaml at catahoula 77925fab712f(API document version 2.0).