API

runlot 컨트롤 플레인의 REST API입니다. 경로 78개와 작업 107개를 제공합니다.

このページの基準ソースは proto/openapi.yaml です。ドキュメントのビルド時にそのソースから内容を生成します。

リクエストの方法

すべてのリクエストに Bearer トークンが必要です。runlot login で保存したトークンは ~/.runlot/credentials.json で確認できます。

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

API のバージョンは 1.0.0 で、仕様は OpenAPI 3.1.0 に従います。

失敗したレスポンスはすべて同じ構造を使います。プログラムでは code の値で処理し、人が読む message は変更される可能性があるため分岐条件に使わないでください。全一覧はエラーコードで確認してください。

{ "error": { "code": "not_found", "message": "프로젝트를 찾을 수 없습니다" } }

リクエスト本文とレスポンスの構造はスキーマで確認してください。