API の概要

ワークスペースをコードから

ご自身のデプロイ向けの REST API で、名前付きの API キーで利用します。以下はすべて、サーバーが実際に適用している OpenAPI ドキュメントから生成しています。

99件の操作
18の分野
33種類のスコープ
251 人が持てるキーの数
認証

名前付きのキーを 1 つ、すべてのリクエストに

  • ワークスペースの設定 › API キーでキーを作成します。キーは obk_ で始まり、表示されるのは一度だけです。
  • キーは作成した人として動き、それ以上の権限は持ちません。その人の現在の役割とアクセス権がリクエストごとに確認されます。
  • 各キーは作成時に選んだスコープだけを持ち、有効期限を設定できます。
  • キーでキーを作成したり無効にしたりすることはできません。
curl -H "Authorization: Bearer $api_key" \
  https://<your-deployment>/api/me

制限

制限
1 つのアドレスからのキー認証失敗の上限(期間あたり)20
すべてのアドレスを合わせたキー認証失敗の上限(期間あたり)500
期間の長さ(分)10
キーに設定できる最長の有効期限(日)3650

上限を超えると、サーバーは Retry-After ヘッダー付きの 429 を返します。スクリプトの約束ごと、ページ送り、絞り込みは開発者向けページにあります。