OpenAPI explorer

The Core Hub REST API is described by an OpenAPI 3.0.3 document. Every deployment also serves its own interactive Swagger UI, bound to the exact version you are running.

The REST API is an advanced tool. If you want to fire an action, or a chain of actions, use Chronos webhooks — they ship with every deployment and cover start, stop, redo, snapshot, maintenance, Query Studio, and AI agent runs. See Events and Choose the right tool.

Open the live Swagger UI

This is the explorer you should use day to day: it reflects your deployment’s version and lets you execute real requests.

  1. Log in to the Control Plane in your browser, so the session can load the protected API definitions.

  2. Open https://COREHUBADDRESS/swagger, replacing COREHUBADDRESS with your server address. Use :443 when the reverse proxy is enabled, :1717 when it is disabled.

  3. Click Authorize and paste a JWT obtained from POST /authentication/login.

See Authentication for how to get that token.

Download the specification

The document that describes this release ships with the documentation:

Download openapi.yaml (OpenAPI 3.0.3)

Use it to:

  • Generate a typed client with OpenAPI Generator, oapi-codegen, or your language’s equivalent

  • Import into Postman or Insomnia as a starting collection — see also the MOLO17 Gluesync Workspace

  • Browse offline by pasting it into Swagger Editor

  • Validate requests in contract tests before they reach a live Core Hub

What it covers

Group Endpoints

Authentication

Log in for a JWT, change a password

Pipelines

List, create, read, and update pipelines

Agents

List unassigned agents, attach, detach, read, and list agents on a pipeline

Agent configuration

Dispatch host credentials, upsert and delete entity definitions, apply agent-specific settings

Pipeline configuration

Read the full configuration, push it to the agents

Discovery

Node capabilities, schemas, tables, and columns on a connected source

Sync commands

Start, stop, redo, and one-time snapshot — the operations Chronos webhooks already wrap

Metrics

Per-pipeline Prometheus exposition

The annotated reference, including request bodies, status-code semantics, and the 202 Accepted caveat, is on Core Hub REST API.

See also