API 概要 - Arlet

Arlet API を使用すると、リポジトリの管理、コード分析の実行、コードの実行、インテグレーションの設定をプログラムで行うことができます。すべてのエンドポイントは HTTPS 上の JSON を使用します。

ベース URL

https://api.arlet.dev

すべてのリソースエンドポイントには /v1 プレフィックスが付きます。OAuth およびディスカバリーエンドポイントにはバージョンが付きません。

ほとんどのエンドポイントには Bearer トークンが必要です。Authorization ヘッダーに指定してください：

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.arlet.dev/v1/repositories

API キーはダッシュボードまたは API キーエンドポイントから作成・管理できます。

すべてのレスポンスは JSON を返します。成功したレスポンスには標準の HTTP ステータスコードが使用されます：

バリデーションエラーは 422 ステータスを返し、どのフィールドが失敗したかの詳細が含まれます：

{
  "detail": [
    {
      "loc": ["body", "field_name"],
      "msg": "description of the error",
      "type": "error_type"
    }
  ]
}

サイドバーを使用して、グループ別に整理されたすべての利用可能なエンドポイントを参照できます：