runlot
ReferenceAPI

API

The REST API for the runlot control plane. It provides 86 paths and 119 operations.

The source of truth for this page is proto/openapi.yaml. The docs build generates this content from that source.

How to make requests

Every request requires a bearer token. You can find the token saved by runlot login in ~/.runlot/credentials.json.

curl -H "Authorization: Bearer $RUNLOT_TOKEN" \
  https://api.runlot.io/v1/orgs

The API version is 1.0.0, and the specification follows OpenAPI 3.1.0.

Error response format

All failed responses use the same structure. In your program, handle them by the code value; the human-readable message can change, so do not use it as a branch condition. See the full list in Error codes.

{ "error": { "code": "not_found", "message": "Project not found" } }

API categories

See the request body and response structure in Schemas.

On this page