Develop against the shipped OrdinateDB surface

Overview

OrdinateDB exposes stored time-series data, its asset model, operational records, and administration workflows through APIs. Use them to integrate applications, automate management, read historical or live data, and build custom collectors.

Choose REST for request-and-response workflows, Server-Sent Events (SSE) for model-resolved live reads, WebSocket for direct live series updates, and gRPC for collector ingestion. This source-derived reference covers OrdinateDB v1 at revision 996452a.

Quick example

Start by checking that your installation is alive and discovering how it accepts human sign-in. Both calls are anonymous.

export ORDINATE_URL="http://localhost:8080"

curl "$ORDINATE_URL/v1/healthz"
# ok

curl "$ORDINATE_URL/v1/auth/methods"
# {"auth_mode":"enforced","login_methods":["local","oidc"]}

The example output illustrates the documented shape; the actual mode and methods come from your server. Continue with authentication, then use the endpoint index.

Reference

Start with authentication and wire conventions, then choose the transport or operation that matches your integration.