orbotodocs
API & CLI

API & CLI

The REST API behind every surface, the orboto CLI, and the OQL query language.

orboto is API-first - the web app, the CLI, the MCP server and every integration all speak the same REST API with the same permissions.

The REST API

  • Interactive OpenAPI reference: https://<your-instance>/docs on any running instance - every route, schema and response, generated from the live server.
  • Authenticate with an API key (orb_*, minted in your profile or by an admin for bot accounts) sent as Authorization: Bearer <key>.
  • List endpoints use cursor pagination: pass ?cursor=<opaque>&limit=50, read items + nextCursor from the response.

For LLMs

These docs are machine-readable: /llms.txt is the index, /llms-full.txt the full text, and every page has a raw Markdown twin via the page-actions menu (Copy as Markdown, Open in ChatGPT/Claude).

Install the CLI

A single static binary over the whole API - install, configure, update.

CLI daily workflow

The full command set - tickets, sessions, bulk ops, generic verbs.

OQL query language

Typed ticket queries - filters, sorting, JQL flavor.

API cookbook

Create, query, attach, bulk-update, and consume webhooks.

Monitoring and health checks

Health endpoints to probe, metrics to scrape, and what your logs look like.

Install the CLI

Install, configure, and update the orboto CLI - a single static binary over the REST API.

On this page

The REST APIFor LLMs