An API reference, inside the app

OL DataIQ now documents its REST API on a page of its own. Open API Reference in the top navigation to find a getting-started guide and an interactive explorer for every endpoint the server exposes.

The getting-started section covers the basics a client needs before its first call. It explains the base URL and the headers every request needs, and gives a ready-to-run curl example. It also sets out the core concepts behind the endpoints: connections, working modes and the OL-Integration artifacts. Authentication gets its own section, because DataIQ picks its identity provider at runtime (Hub IAM / Auth0, Keycloak, or none). That makes it a property of each deployment, not of the build. The page shows how to ask a running instance which provider it uses, through /api/v1/config/public, before a client tries to sign in.

The explorer lists every endpoint, grouped by area: Meta, Query, Saved Queries, Metadata, Schema, Hub, CoreIQ, MongoDB, Settings and Admin. Each operation shows its request and response schemas and has a "Try it out" button. The explorer sends your current sign-in token automatically, and only to this deployment's own API host. The same OpenAPI v3 document is served at /openapi.json, so you can import it into Postman, Bruno or a code generator.

The list stays in step with the server. A build-time check walks the server's actual route table and fails the build if a route is missing from the document, or listed there but no longer served. A short final section covers the two endpoints the explorer deliberately leaves out: /openapi.json itself and the MCP tool server at /api/v1/mcp.