API Reference
NodePit Runner exposes a REST API that covers every operation available in the UI. Use it to automate workflows, integrate Runner into CI pipelines, or build tooling on top of it.
The full API reference is published as a Swagger UI:
Every running Runner instance also ships its own Swagger UI at /api/docs (e.g. http://localhost:8080/api/docs), reflecting the exact version you have deployed. The raw OpenAPI specification is available at /api/docs/json.
Authentication
The API supports two authentication schemes depending on the use case.
Personal access tokens — the standard way to authenticate external API calls. Tokens are scoped to project-level resources; they cannot access admin or profile endpoints. Pass the token using the ApiKey scheme:
Authorization: ApiKey <your-token>See Access Tokens for how to create a token and which scopes are available.
Admin API key — a static key set via the API_KEY environment variable in your Runner configuration. It grants access to executor management and run operations, and is primarily used by executors to register, send heartbeats, claim runs, and post logs. Pass it using the same ApiKey scheme:
Authorization: ApiKey <api-key>JWT bearer tokens — used internally by the Runner web UI after login. The Authorization: Bearer <token> scheme is accepted but tokens are short-lived (7 days) and not designed for external use.
Further integrations
NodePit Runner for KNIME is a KNIME extension that lets you interact with Runner directly from within KNIME Analytics Platform, both via dedicated nodes and through the KNIME Explorer panel.