digna REST API 2026.11¶

digna REST API を使うと、独自のツールやパイプラインから HTTP と JSON で digna を操作できます。 プロジェクトとインスペクション結果の読み取り、データソース・データセット・属性の管理、そしてデータロードの 完了時などにインスペクションを開始できます。Python SDK も同じ API を使用しています。

このページでは、すべてのリクエストに共通する事項を説明します。各リソースのページには、エンドポイントごとに パラメーター、リクエストボディ、レスポンス、スキーマが記載されています。

ベース URL¶

この API は digna バックエンドの一部です。すべてのパスは、バックエンドのアドレスに続く /v1 で始まります。

https://digna.example.com/v1/projects

バックエンドのアドレスはダッシュボードが使用するものと同じで、dashboard/dashboard_config.toml の [api] セクションにある baseUrl です。呼び出し元と digna が同じマシン上にない場合は、必ず HTTPS を使用してください。すべてのリクエストに API キーが含まれるためです。

認証¶

すべてのリクエストは、digna ユーザーの API キーを Authorization ヘッダーで送信します。

Authorization: Bearer <api key>

キーを作成するには、ダッシュボードの左下にあるユーザープロファイルを開き、API Keys、続いて Add API Key をクリックして、キーをコピーします。キーが表示されるのは一度だけです。同じキーは digna MCP Server でも使用できます。

リクエストは、キーの所有ユーザーの権限で実行されます。作成、変更、削除にはそのプロジェクトでの編集者ロールが 必要です。ロールがない場合、リクエストは 403 とメッセージ You don't have permission to edit this project で拒否されます。

リクエストの送信¶

export DIGNA_API_KEY='<api key>'
curl https://digna.example.com/v1/projects -H "Authorization: Bearer $DIGNA_API_KEY"

レスポンスは JSON です。リストは JSON 配列として返されます。リクエストボディも JSON で、 Content-Type: application/json を付けて送信します。

上限とフィルター¶

リスト系のエンドポイントが返す項目は最大 limit 件です。既定値は 200 件、上限は 5000 件です。この範囲外の 値は 400 で拒否されます。オフセットやページトークンはないため、代わりにフィルターでリストを絞り込んで ください。たとえば project_id、data_source_id、インスペクションステータスでは start_date と end_date を使用します。

60 秒を超えるリクエストは 408 Request Timeout でキャンセルされます。

エラー¶

エラーレスポンスには、コードとメッセージを含む JSON ボディが付きます。

{
  "code": "NOT_FOUND",
  "message": "Data set not found"
}

401 の message は、キーの何が問題かを示します。

インスペクションの実行¶

一般的な統合では、データロードの完了時にインスペクションを開始し、その完了を待ってから結果を読み取ります。

1. POST /v1/inspection-requests でインスペクションを開始します。 レスポンスにはリクエストの id が含まれます。
2. GET /v1/inspection-requests/{inspection_request_id} で進行状況を追跡します。 status は PENDING から RUNNING を経て COMPLETED に進むか、FAILED、ABORTED、 CANCELLED のいずれかで終了します。値が変わらなくなるまで、数秒ごとに問い合わせてください。
3. 検査した日付について GET /v1/inspection-statuses/data-sources で結果を読み取ります。 各項目には全体の status として 0 (OK)、1 (警告)、2 (重大)、-1 (ステータスなし) の いずれかがあり、さらにモジュールごとのステータスと、合格・不確定・不合格のチェック数が含まれます。

curl -X POST https://digna.example.com/v1/inspection-requests \
  -H "Authorization: Bearer $DIGNA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "project_id": 1,
    "include_all_data_sources": true,
    "data_source_ids": [],
    "start_date": "2026-11-06",
    "end_date": "2026-11-06",
    "mode": "DAILY",
    "weekly_mode_weekdays": [],
    "monthly_mode_days": [],
    "use_notification": true
  }'

OpenAPI ドキュメント¶

すべての digna インストールは、この API を OpenAPI 3.1 ドキュメントで記述しており、それに対して リクエストを試せる対話型の Swagger UI も提供しています。

Release 2026.11 のドキュメントはこちらからも入手できます: openapi.json。これを使って、 他の言語のクライアントを生成できます。