API と認証

API キーで SteadyCron REST API を使用 — スコープ、有効期限、ダッシュボード・CLI・API の関係。

ダッシュボード、CLI、パブリック REST API はすべて同じエンドポイントで構築されています — UI でできることはすべて自動化できます。

API キー

プログラムによるアクセスには API キーを使用します。ダッシュボードで作成・管理します。

  • キーは作成時に1回だけ表示されます — 安全に保管してください。
  • キーには sc_ プレフィックスがあり、サーバー側ではハッシュとしてのみ保存されます。元の値は復元できません。
  • 各キーにはスコープがあります。
    • 読み取り専用 — ジョブ、実行、ping の一覧表示と読み取り。
    • フル — 読み取りに加え、作成・更新・一時停止・削除。
  • キーには有効期限を設定でき、いつでも無効化できます。

キーはベアラートークンとして渡します。

curl https://api.steadycron.com/v1/jobs \
  -H "Authorization: Bearer sc_..."

センシティブな操作

セキュリティのため、一部の操作はクッキーのみ（ダッシュボード認証）で実行可能で、API キーでは実行できません — API キー自体の管理、請求、アカウントレベルの設定が該当します。これにより漏洩したキーの影響範囲を限定します。

ハートビート ping は認証不要

ping エンドポイント（ping.steadycron.com）は API キーを使用しません — ping URL 内のユニークで推測不可能なトークンが認証情報です。これにより API キーを配布せずにどこからでも（シェルスクリプト、コンテナから）ping でき、ping の取り込みは別途レート制限されます。

OpenAPI

API は OpenAPI ドキュメントで説明されており、好みの言語で型付きクライアントを生成できます。

次のステップ