管理 REST API リファレンス

各 API を展開すると Path／Query パラメータ、Request Body、各 HTTP レスポンスのプロパティとネスト構造、型、必須／Nullable を確認できます。Controller と DTO の OpenAPI メタデータから生成されます。

先に Admin UI で System-to-System キーを発行する.

93 API 操作 · 28 件の操作に応答モデルを定義済み · v2.0.6 055aa695764f

API パス・メソッド・分類を検索

認証・アカウント `Auth`

GET /api/Auth/account

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

PUT /api/Auth/account

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`username`	`string`	はい	いいえ	最大文字数: 100
`email`	`string`	はい	いいえ	最大文字数: 320

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

PUT /api/Auth/account/password

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`currentPassword`	`string`	はい	いいえ	—
`newPassword`	`string`	はい	いいえ	最小文字数: 8

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/Auth/first-run

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/forgot-password

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`email`	`string`	はい	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/mfa/confirm

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`code`	`string`	はい	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/mfa/disable

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`code`	`string`	はい	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/mfa/setup

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/Auth/mfa/status

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/mfa/verify

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`code`	`string`	はい	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/Auth/oidc/callback

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/oidc/exchange

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`code`	`string`	はい	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/Auth/oidc/status

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/refresh-token

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/reset-password

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`token`	`string`	はい	いいえ	—
`newPassword`	`string`	はい	いいえ	最小文字数: 8

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

DELETE /api/Auth/sessions

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/Auth/sessions

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

DELETE /api/Auth/sessions/{sessionId}

認証: —

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`sessionId`	path	`string (uuid)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/sign-in

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`email`	`string`	はい	いいえ	—
`password`	`string`	はい	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/sign-out

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: いいえ

項目名	型	必須	null 許容	説明と制約
`<variant2>.refreshToken`	`string`	いいえ	はい	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Auth/sign-up

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`email`	`string`	はい	いいえ	—
`password`	`string`	はい	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

認証情報の状態 `Credential`

GET /api/Credential/status

認証: —

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

カスタム SQL ツール `CustomSqlTool`

GET /api/CustomSqlTool

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`[].id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	いいえ	いいえ	—
`[].description`	`string`	いいえ	いいえ	—
`[].sqlTemplate`	`string`	いいえ	いいえ	—
`[].type`	`string`	いいえ	いいえ	—
`[].parametersJson`	`string`	いいえ	はい	—
`[].dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`[].status`	`string`	いいえ	いいえ	—
`[].publishedRevisionId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`[].publishedIdentity`	`string`	いいえ	はい	—
`[].createdAt`	`string (date-time)`	いいえ	いいえ	—
`[].lastModifiedAt`	`string (date-time)`	いいえ	はい	—

POST /api/CustomSqlTool

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.create

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	いいえ	—
`sqlTemplate`	`string`	いいえ	いいえ	—
`type`	`string`	いいえ	いいえ	—
`parametersJson`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	いいえ	いいえ	—
`publishedRevisionId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	いいえ	はい	—
`createdAt`	`string (date-time)`	いいえ	いいえ	—
`lastModifiedAt`	`string (date-time)`	いいえ	はい	—

レスポンスモデル

`201` 作成完了

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	いいえ	—
`sqlTemplate`	`string`	いいえ	いいえ	—
`type`	`string`	いいえ	いいえ	—
`parametersJson`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	いいえ	いいえ	—
`publishedRevisionId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	いいえ	はい	—
`createdAt`	`string (date-time)`	いいえ	いいえ	—
`lastModifiedAt`	`string (date-time)`	いいえ	はい	—

`400` 不正なリクエスト

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

DELETE /api/CustomSqlTool/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.delete

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`204` 成功（本文なし）

レスポンス本文なし

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

GET /api/CustomSqlTool/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	いいえ	—
`sqlTemplate`	`string`	いいえ	いいえ	—
`type`	`string`	いいえ	いいえ	—
`parametersJson`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	いいえ	いいえ	—
`publishedRevisionId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	いいえ	はい	—
`createdAt`	`string (date-time)`	いいえ	いいえ	—
`lastModifiedAt`	`string (date-time)`	いいえ	はい	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

PUT /api/CustomSqlTool/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	いいえ	—
`sqlTemplate`	`string`	いいえ	いいえ	—
`type`	`string`	いいえ	いいえ	—
`parametersJson`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	いいえ	いいえ	—
`publishedRevisionId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	いいえ	はい	—
`createdAt`	`string (date-time)`	いいえ	いいえ	—
`lastModifiedAt`	`string (date-time)`	いいえ	はい	—

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	いいえ	—
`sqlTemplate`	`string`	いいえ	いいえ	—
`type`	`string`	いいえ	いいえ	—
`parametersJson`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	いいえ	いいえ	—
`publishedRevisionId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	いいえ	はい	—
`createdAt`	`string (date-time)`	いいえ	いいえ	—
`lastModifiedAt`	`string (date-time)`	いいえ	はい	—

`400` 不正なリクエスト

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

POST /api/CustomSqlTool/{id}/disable

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	いいえ	—
`sqlTemplate`	`string`	いいえ	いいえ	—
`type`	`string`	いいえ	いいえ	—
`parametersJson`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	いいえ	いいえ	—
`publishedRevisionId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	いいえ	はい	—
`createdAt`	`string (date-time)`	いいえ	いいえ	—
`lastModifiedAt`	`string (date-time)`	いいえ	はい	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

GET /api/CustomSqlTool/{id}/impact

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`toolId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`draftDbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`draftDatabaseName`	`string`	いいえ	はい	—
`publishedDbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`publishedDatabaseName`	`string`	いいえ	はい	—
`currentlyExposedToKeys`	`array<CustomSqlToolImpactKey>`	いいえ	いいえ	—
`currentlyExposedToKeys[].id`	`integer \| string (int32)`	はい	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`currentlyExposedToKeys[].name`	`string`	はい	いいえ	—
`currentlyExposedToKeys[].keyPrefix`	`string`	はい	いいえ	—
`wouldExposeToKeys`	`array<CustomSqlToolImpactKey>`	いいえ	いいえ	—
`wouldExposeToKeys[].id`	`integer \| string (int32)`	はい	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`wouldExposeToKeys[].name`	`string`	はい	いいえ	—
`wouldExposeToKeys[].keyPrefix`	`string`	はい	いいえ	—
`breakingChanges`	`array<string>`	いいえ	いいえ	—
`sqlChanged`	`boolean`	いいえ	いいえ	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

POST /api/CustomSqlTool/{id}/publish

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	いいえ	—
`sqlTemplate`	`string`	いいえ	いいえ	—
`type`	`string`	いいえ	いいえ	—
`parametersJson`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	いいえ	いいえ	—
`publishedRevisionId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	いいえ	はい	—
`createdAt`	`string (date-time)`	いいえ	いいえ	—
`lastModifiedAt`	`string (date-time)`	いいえ	はい	—

`400` 不正なリクエスト

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

`409` 競合

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

GET /api/CustomSqlTool/{id}/revisions

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`[].id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].customSqlToolId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].revisionNumber`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	いいえ	いいえ	—
`[].description`	`string`	いいえ	いいえ	—
`[].sqlTemplate`	`string`	いいえ	いいえ	—
`[].type`	`string`	いいえ	いいえ	—
`[].parametersJson`	`string`	いいえ	はい	—
`[].diffJson`	`string`	いいえ	いいえ	—
`[].publishedBy`	`string`	いいえ	はい	—
`[].publishedAt`	`string (date-time)`	いいえ	いいえ	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

POST /api/CustomSqlTool/{id}/rollback/{revisionId}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—
`revisionId`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	いいえ	—
`sqlTemplate`	`string`	いいえ	いいえ	—
`type`	`string`	いいえ	いいえ	—
`parametersJson`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	いいえ	いいえ	—
`publishedRevisionId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	いいえ	はい	—
`createdAt`	`string (date-time)`	いいえ	いいえ	—
`lastModifiedAt`	`string (date-time)`	いいえ	はい	—

`400` 不正なリクエスト

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

`409` 競合

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

POST /api/CustomSqlTool/test-execute

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/custom-tools.edit

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`toolId`	`integer \| string (int32)`	はい	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`parameters`	`object`	いいえ	はい	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

データベース管理 `DbManagement`

GET /api/DbManagement

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`[].id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	いいえ	いいえ	—
`[].sqlProvider`	`string`	いいえ	いいえ	—
`[].host`	`string`	いいえ	いいえ	—
`[].port`	`string`	いいえ	いいえ	—
`[].username`	`string`	いいえ	いいえ	—
`[].database`	`string`	いいえ	いいえ	—
`[].extraSettings`	`string`	いいえ	はい	—
`[].createdAt`	`string`	いいえ	いいえ	—
`[].createdBy`	`string`	いいえ	いいえ	—
`[].updatedAt`	`string`	いいえ	いいえ	—
`[].updatedBy`	`string`	いいえ	いいえ	—
`[].isBootstrapManaged`	`boolean`	いいえ	いいえ	—

POST /api/DbManagement

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management.create

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`name`	`string`	いいえ	いいえ	—
`sqlProvider`	`string`	いいえ	いいえ	—
`host`	`string`	いいえ	いいえ	—
`port`	`string`	いいえ	いいえ	—
`username`	`string`	いいえ	いいえ	—
`password`	`string`	いいえ	いいえ	—
`database`	`string`	いいえ	いいえ	—
`extraSettings`	`string`	いいえ	はい	—
`createdBy`	`string`	いいえ	いいえ	—
`updatedBy`	`string`	いいえ	いいえ	—

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`sqlProvider`	`string`	いいえ	いいえ	—
`host`	`string`	いいえ	いいえ	—
`port`	`string`	いいえ	いいえ	—
`username`	`string`	いいえ	いいえ	—
`database`	`string`	いいえ	いいえ	—
`extraSettings`	`string`	いいえ	はい	—
`createdAt`	`string`	いいえ	いいえ	—
`createdBy`	`string`	いいえ	いいえ	—
`updatedAt`	`string`	いいえ	いいえ	—
`updatedBy`	`string`	いいえ	いいえ	—
`isBootstrapManaged`	`boolean`	いいえ	いいえ	—

`400` 不正なリクエスト

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

DELETE /api/DbManagement/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management.delete

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`204` 成功（本文なし）

レスポンス本文なし

GET /api/DbManagement/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`sqlProvider`	`string`	いいえ	いいえ	—
`host`	`string`	いいえ	いいえ	—
`port`	`string`	いいえ	いいえ	—
`username`	`string`	いいえ	いいえ	—
`database`	`string`	いいえ	いいえ	—
`extraSettings`	`string`	いいえ	はい	—
`createdAt`	`string`	いいえ	いいえ	—
`createdBy`	`string`	いいえ	いいえ	—
`updatedAt`	`string`	いいえ	いいえ	—
`updatedBy`	`string`	いいえ	いいえ	—
`isBootstrapManaged`	`boolean`	いいえ	いいえ	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

PUT /api/DbManagement/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`name`	`string`	いいえ	いいえ	—
`sqlProvider`	`string`	いいえ	いいえ	—
`host`	`string`	いいえ	いいえ	—
`port`	`string`	いいえ	いいえ	—
`username`	`string`	いいえ	いいえ	—
`password`	`string`	いいえ	いいえ	—
`database`	`string`	いいえ	いいえ	—
`extraSettings`	`string`	いいえ	はい	—
`createdBy`	`string`	いいえ	いいえ	—
`updatedBy`	`string`	いいえ	いいえ	—

レスポンスモデル

`204` 成功（本文なし）

レスポンス本文なし

`400` 不正なリクエスト

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

GET /api/DbManagement/{id}/columns

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—
`schema`	query	`string`	いいえ	—
`table`	query	`string`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/DbManagement/{id}/schemas

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/DbManagement/{id}/tables

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—
`schema`	query	`string`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

セマンティックメタデータ `DbSemantic`

POST /api/DbSemantic

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management/semantic.edit

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	いいえ	はい	—
`tableName`	`string`	いいえ	いいえ	—
`columnName`	`string`	いいえ	はい	—
`description`	`string`	いいえ	はい	—
`displayName`	`string`	いいえ	はい	—
`synonyms`	`array<string>`	いいえ	はい	—

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	いいえ	はい	—
`tableName`	`string`	いいえ	いいえ	—
`columnName`	`string`	いいえ	はい	—
`description`	`string`	いいえ	はい	—
`displayName`	`string`	いいえ	はい	—
`synonyms`	`array<string>`	いいえ	いいえ	—
`createdAt`	`string`	いいえ	いいえ	—
`updatedAt`	`string`	いいえ	いいえ	—

GET /api/DbSemantic/{dbManagementId}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management/semantic.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`dbManagementId`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`[].id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].schemaName`	`string`	いいえ	はい	—
`[].tableName`	`string`	いいえ	いいえ	—
`[].columnName`	`string`	いいえ	はい	—
`[].description`	`string`	いいえ	はい	—
`[].displayName`	`string`	いいえ	はい	—
`[].synonyms`	`array<string>`	いいえ	いいえ	—
`[].createdAt`	`string`	いいえ	いいえ	—
`[].updatedAt`	`string`	いいえ	いいえ	—

GET /api/DbSemantic/{dbManagementId}/model

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management/semantic.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`dbManagementId`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`dbManagementId`	`integer \| string (int32)`	はい	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`entities`	`array<DbSemanticVM>`	はい	いいえ	—
`entities[].id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`entities[].dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`entities[].schemaName`	`string`	いいえ	はい	—
`entities[].tableName`	`string`	いいえ	いいえ	—
`entities[].columnName`	`string`	いいえ	はい	—
`entities[].description`	`string`	いいえ	はい	—
`entities[].displayName`	`string`	いいえ	はい	—
`entities[].synonyms`	`array<string>`	いいえ	いいえ	—
`entities[].createdAt`	`string`	いいえ	いいえ	—
`entities[].updatedAt`	`string`	いいえ	いいえ	—
`relationships`	`array<DbSemanticRelationshipModel>`	はい	いいえ	—
`relationships[].id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`relationships[].dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`relationships[].name`	`string`	いいえ	いいえ	—
`relationships[].sourceSchema`	`string`	いいえ	はい	—
`relationships[].sourceTable`	`string`	いいえ	いいえ	—
`relationships[].sourceColumn`	`string`	いいえ	いいえ	—
`relationships[].targetSchema`	`string`	いいえ	はい	—
`relationships[].targetTable`	`string`	いいえ	いいえ	—
`relationships[].targetColumn`	`string`	いいえ	いいえ	—
`relationships[].cardinality`	`string`	いいえ	いいえ	—
`relationships[].direction`	`string`	いいえ	いいえ	—
`relationships[].description`	`string`	いいえ	はい	—
`metrics`	`array<DbSemanticMetricModel>`	はい	いいえ	—
`metrics[].id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`metrics[].dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`metrics[].schemaName`	`string`	いいえ	はい	—
`metrics[].tableName`	`string`	いいえ	いいえ	—
`metrics[].name`	`string`	いいえ	いいえ	—
`metrics[].displayName`	`string`	いいえ	はい	—
`metrics[].description`	`string`	いいえ	はい	—
`metrics[].formula`	`string`	いいえ	いいえ	—
`metrics[].aggregation`	`string`	いいえ	いいえ	—
`metrics[].grain`	`string`	いいえ	はい	—
`metrics[].filter`	`string`	いいえ	はい	—
`metrics[].synonyms`	`array<string>`	いいえ	はい	—
`metrics[].executable`	`boolean`	いいえ	いいえ	—

DELETE /api/DbSemantic/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management/semantic.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/DbSemantic/metric

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management/semantic.edit

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	いいえ	はい	—
`tableName`	`string`	いいえ	いいえ	—
`name`	`string`	いいえ	いいえ	—
`displayName`	`string`	いいえ	はい	—
`description`	`string`	いいえ	はい	—
`formula`	`string`	いいえ	いいえ	—
`aggregation`	`string`	いいえ	いいえ	—
`grain`	`string`	いいえ	はい	—
`filter`	`string`	いいえ	はい	—
`synonyms`	`array<string>`	いいえ	はい	—
`executable`	`boolean`	いいえ	いいえ	—

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	いいえ	はい	—
`tableName`	`string`	いいえ	いいえ	—
`name`	`string`	いいえ	いいえ	—
`displayName`	`string`	いいえ	はい	—
`description`	`string`	いいえ	はい	—
`formula`	`string`	いいえ	いいえ	—
`aggregation`	`string`	いいえ	いいえ	—
`grain`	`string`	いいえ	はい	—
`filter`	`string`	いいえ	はい	—
`synonyms`	`array<string>`	いいえ	はい	—
`executable`	`boolean`	いいえ	いいえ	—

DELETE /api/DbSemantic/metric/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management/semantic.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/DbSemantic/relationship

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management/semantic.edit

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`sourceSchema`	`string`	いいえ	はい	—
`sourceTable`	`string`	いいえ	いいえ	—
`sourceColumn`	`string`	いいえ	いいえ	—
`targetSchema`	`string`	いいえ	はい	—
`targetTable`	`string`	いいえ	いいえ	—
`targetColumn`	`string`	いいえ	いいえ	—
`cardinality`	`string`	いいえ	いいえ	—
`direction`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	はい	—

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`sourceSchema`	`string`	いいえ	はい	—
`sourceTable`	`string`	いいえ	いいえ	—
`sourceColumn`	`string`	いいえ	いいえ	—
`targetSchema`	`string`	いいえ	はい	—
`targetTable`	`string`	いいえ	いいえ	—
`targetColumn`	`string`	いいえ	いいえ	—
`cardinality`	`string`	いいえ	いいえ	—
`direction`	`string`	いいえ	いいえ	—
`description`	`string`	いいえ	はい	—

DELETE /api/DbSemantic/relationship/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/db-management/semantic.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer \| string (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

管理 API キー `ManagementApiKeys`

GET /api/runtime/management-api-keys

認証: AdminBearer

必要な権限: /runtime/security.edit

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`[].id`	`integer \| string (int32)`	はい	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	はい	いいえ	—
`[].keyPrefix`	`string`	はい	いいえ	—
`[].permissions`	`array<string>`	はい	いいえ	—
`[].createdAt`	`string (date-time)`	はい	いいえ	—
`[].expiresAt`	`string (date-time)`	はい	いいえ	—
`[].lastUsedAt`	`string (date-time)`	はい	はい	—
`[].revokedAt`	`string (date-time)`	はい	はい	—
`[].createdBy`	`string`	はい	はい	—

POST /api/runtime/management-api-keys

認証: AdminBearer

必要な権限: /runtime/security.edit

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`name`	`string`	はい	いいえ	—
`expiresAt`	`string (date-time)`	はい	いいえ	—
`permissions`	`array<string>`	はい	いいえ	—

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`key`	`ManagementApiKeyView`	はい	いいえ	—
`key.id`	`integer \| string (int32)`	はい	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`key.name`	`string`	はい	いいえ	—
`key.keyPrefix`	`string`	はい	いいえ	—
`key.permissions`	`array<string>`	はい	いいえ	—
`key.createdAt`	`string (date-time)`	はい	いいえ	—
`key.expiresAt`	`string (date-time)`	はい	いいえ	—
`key.lastUsedAt`	`string (date-time)`	はい	はい	—
`key.revokedAt`	`string (date-time)`	はい	はい	—
`key.createdBy`	`string`	はい	はい	—
`plaintextKey`	`string`	はい	いいえ	—

`400` 不正なリクエスト

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

POST /api/runtime/management-api-keys/{id}/revoke

認証: AdminBearer

必要な権限: /runtime/security.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`204` 成功（本文なし）

レスポンス本文なし

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

POST /api/runtime/management-api-keys/{id}/rotate

認証: AdminBearer

必要な権限: /runtime/security.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`key`	`ManagementApiKeyView`	はい	いいえ	—
`key.id`	`integer \| string (int32)`	はい	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`key.name`	`string`	はい	いいえ	—
`key.keyPrefix`	`string`	はい	いいえ	—
`key.permissions`	`array<string>`	はい	いいえ	—
`key.createdAt`	`string (date-time)`	はい	いいえ	—
`key.expiresAt`	`string (date-time)`	はい	いいえ	—
`key.lastUsedAt`	`string (date-time)`	はい	はい	—
`key.revokedAt`	`string (date-time)`	はい	はい	—
`key.createdBy`	`string`	はい	はい	—
`plaintextKey`	`string`	はい	いいえ	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

`409` 競合

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

GET /api/runtime/management-api-keys/permissions

認証: AdminBearer

必要な権限: /runtime/security.edit

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`（リクエスト／レスポンス本文）`	`array<string>`	—	いいえ	—

クライアント設定 `McpClientConfig`

GET /api/runtime/client-config

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/mcp-keys.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`mcpEndpoint`	`string`	はい	いいえ	—

ユーザー管理 `Member`

GET /api/Member

認証: AdminBearer

必要な権限: /auth/user.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`Search`	query	`string`	いいえ	—
`IsActive`	query	`boolean`	いいえ	—
`RoleId`	query	`integer \| string (int32)`	いいえ	—
`Page`	query	`integer \| string (int32)`	いいえ	—
`PageSize`	query	`integer \| string (int32)`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Member

認証: AdminBearer

必要な権限: /auth/user.create

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`email`	`string`	はい	いいえ	—
`username`	`string`	いいえ	はい	—
`password`	`string`	はい	いいえ	—
`assignAllRoles`	`boolean`	いいえ	いいえ	—
`roleIds`	`array<integer \| string (int32)>`	いいえ	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

DELETE /api/Member/{id}

認証: AdminBearer

必要な権限: /auth/user.delete

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

PUT /api/Member/{id}/password-change-required

認証: AdminBearer

必要な権限: /auth/user.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`required`	`boolean`	いいえ	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

PUT /api/Member/{id}/roles

認証: AdminBearer

必要な権限: /auth/user.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`roleIds`	`array<integer \| string (int32)>`	いいえ	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

DELETE /api/Member/{id}/sessions

認証: AdminBearer

必要な権限: /auth/user.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

PUT /api/Member/{id}/status

認証: AdminBearer

必要な権限: /auth/user.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`isActive`	`boolean`	いいえ	いいえ	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

ロール・権限 `Role`

GET /api/Role

認証: AdminBearer

必要な権限: /auth/role.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/Role

認証: AdminBearer

必要な権限: /auth/role.create

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`name`	`string`	はい	いいえ	—
`description`	`string`	いいえ	はい	—
`permissionActions`	`array<PermissionActionSelection>`	いいえ	いいえ	—
`permissionActions[].permissionId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`permissionActions[].actionId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

DELETE /api/Role/{id}

認証: AdminBearer

必要な権限: /auth/role.delete

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—
`force`	query	`boolean`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

PUT /api/Role/{id}

認証: AdminBearer

必要な権限: /auth/role.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`name`	`string`	はい	いいえ	—
`description`	`string`	いいえ	はい	—
`permissionActions`	`array<PermissionActionSelection>`	いいえ	いいえ	—
`permissionActions[].permissionId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`permissionActions[].actionId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/Role/{id}/dependencies

認証: AdminBearer

必要な権限: /auth/role.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/Role/permission-action-templates

認証: AdminBearer

必要な権限: /auth/role.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

実行環境・アクセスキー `RuntimeAdmin`

GET /api/runtime/audit

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/audit.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`page`	query	`integer \| string (int32)`	いいえ	—
`pageSize`	query	`integer \| string (int32)`	いいえ	—
`action`	query	`string`	いいえ	—
`keyword`	query	`string`	いいえ	—
`from`	query	`string (date-time)`	いいえ	—
`to`	query	`string (date-time)`	いいえ	—
`result`	query	`string`	いいえ	—
`actor`	query	`string`	いいえ	—
`dbManagementId`	query	`integer \| string (int32)`	いいえ	—
`accessKeyId`	query	`integer \| string (int32)`	いいえ	—
`toolName`	query	`string`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/runtime/audit/daily-summary

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/audit.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`days`	query	`integer \| string (int32)`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/runtime/audit/export

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/audit.export

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`Page`	query	`integer \| string (int32)`	いいえ	—
`PageSize`	query	`integer \| string (int32)`	いいえ	—
`Action`	query	`string`	いいえ	—
`Keyword`	query	`string`	いいえ	—
`From`	query	`string (date-time)`	いいえ	—
`To`	query	`string (date-time)`	いいえ	—
`Result`	query	`string`	いいえ	—
`Actor`	query	`string`	いいえ	—
`DbManagementId`	query	`integer \| string (int32)`	いいえ	—
`AccessKeyId`	query	`integer \| string (int32)`	いいえ	—
`ToolName`	query	`string`	いいえ	—
`format`	query	`string`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/runtime/audit/retention

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/audit.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/runtime/audit/retention/dry-run

認証: AdminBearer

必要な権限: /runtime/audit.edit

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/runtime/audit/retention/execute

認証: AdminBearer

必要な権限: /runtime/audit.edit

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/runtime/mcp-keys

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/mcp-keys.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`[].id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	いいえ	いいえ	—
`[].keyPrefix`	`string`	いいえ	いいえ	—
`[].isActive`	`boolean`	いいえ	いいえ	—
`[].expiresAt`	`string (date-time)`	いいえ	はい	—
`[].lastUsedAt`	`string (date-time)`	いいえ	はい	—
`[].allowedTools`	`string`	いいえ	はい	—
`[].corsAllowedOrigins`	`string`	いいえ	はい	—
`[].sqlProvider`	`string`	いいえ	はい	—
`[].dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`[].dbManagementName`	`string`	いいえ	はい	—
`[].isExpired`	`boolean`	いいえ	いいえ	—
`[].isExpiringSoon`	`boolean`	いいえ	いいえ	—
`[].tableWhitelist`	`string`	いいえ	はい	—
`[].createdAt`	`string (date-time)`	いいえ	いいえ	—
`[].rateLimitMode`	`McpKeyRateLimitMode`	いいえ	いいえ	—
`[].permitLimitOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`[].windowSecondsOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`[].effectivePermitLimit`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`[].effectiveWindowSeconds`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`[].isBootstrapManaged`	`boolean`	いいえ	いいえ	—

POST /api/runtime/mcp-keys

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/mcp-keys.create

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`name`	`string`	いいえ	いいえ	—
`expiresAt`	`string (date-time)`	いいえ	はい	—
`allowedTools`	`string`	いいえ	はい	—
`corsAllowedOrigins`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	いいえ	はい	—
`rateLimitMode`	`McpKeyRateLimitMode`	いいえ	いいえ	—
`permitLimitOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`keyPrefix`	`string`	いいえ	いいえ	—
`plaintextKey`	`string`	いいえ	いいえ	—
`expiresAt`	`string (date-time)`	いいえ	はい	—
`allowedTools`	`string`	いいえ	はい	—
`corsAllowedOrigins`	`string`	いいえ	はい	—
`sqlProvider`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	いいえ	はい	—
`rateLimitMode`	`McpKeyRateLimitMode`	いいえ	いいえ	—
`permitLimitOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$

`400` 不正なリクエスト

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

PUT /api/runtime/mcp-keys/{id}

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/mcp-keys.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`name`	`string`	いいえ	いいえ	—
`expiresAt`	`string (date-time)`	いいえ	はい	—
`allowedTools`	`string`	いいえ	はい	—
`corsAllowedOrigins`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	いいえ	はい	—
`rateLimitMode`	`McpKeyRateLimitMode`	いいえ	いいえ	—
`permitLimitOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`keyPrefix`	`string`	いいえ	いいえ	—
`isActive`	`boolean`	いいえ	いいえ	—
`expiresAt`	`string (date-time)`	いいえ	はい	—
`lastUsedAt`	`string (date-time)`	いいえ	はい	—
`allowedTools`	`string`	いいえ	はい	—
`corsAllowedOrigins`	`string`	いいえ	はい	—
`sqlProvider`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`dbManagementName`	`string`	いいえ	はい	—
`isExpired`	`boolean`	いいえ	いいえ	—
`isExpiringSoon`	`boolean`	いいえ	いいえ	—
`tableWhitelist`	`string`	いいえ	はい	—
`createdAt`	`string (date-time)`	いいえ	いいえ	—
`rateLimitMode`	`McpKeyRateLimitMode`	いいえ	いいえ	—
`permitLimitOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`effectivePermitLimit`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`effectiveWindowSeconds`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`isBootstrapManaged`	`boolean`	いいえ	いいえ	—

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

POST /api/runtime/mcp-keys/{id}/clone

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/mcp-keys.create

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`name`	`string`	いいえ	いいえ	—
`expiresAt`	`string (date-time)`	いいえ	はい	—

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`keyPrefix`	`string`	いいえ	いいえ	—
`plaintextKey`	`string`	いいえ	いいえ	—
`expiresAt`	`string (date-time)`	いいえ	はい	—
`allowedTools`	`string`	いいえ	はい	—
`corsAllowedOrigins`	`string`	いいえ	はい	—
`sqlProvider`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	いいえ	はい	—
`rateLimitMode`	`McpKeyRateLimitMode`	いいえ	いいえ	—
`permitLimitOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

POST /api/runtime/mcp-keys/{id}/revoke

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/mcp-keys.revoke

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/runtime/mcp-keys/{id}/rotate

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/mcp-keys.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int32)`	はい	—

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`gracePeriodMinutes`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`expiresAt`	`string (date-time)`	いいえ	はい	—

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`id`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	いいえ	いいえ	—
`keyPrefix`	`string`	いいえ	いいえ	—
`plaintextKey`	`string`	いいえ	いいえ	—
`expiresAt`	`string (date-time)`	いいえ	はい	—
`allowedTools`	`string`	いいえ	はい	—
`corsAllowedOrigins`	`string`	いいえ	はい	—
`sqlProvider`	`string`	いいえ	はい	—
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	いいえ	はい	—
`rateLimitMode`	`McpKeyRateLimitMode`	いいえ	いいえ	—
`permitLimitOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$

`404` 見つかりません

項目名	型	必須	null 許容	説明と制約
`type`	`string`	いいえ	はい	—
`title`	`string`	いいえ	はい	—
`status`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	いいえ	はい	—
`instance`	`string`	いいえ	はい	—

GET /api/runtime/mcp-keys/available-tools

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/mcp-keys.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`dbManagementId`	query	`integer \| string (int32)`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/runtime/mcp-keys/test-db-connection

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/mcp-keys.create, /runtime/db-management.create, /runtime/db-management.edit

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`dbSettingMode`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$
`sqlProvider`	`null \| SqlAgentToolType`	いいえ	いいえ	—
`host`	`string`	いいえ	はい	—
`port`	`string`	いいえ	はい	—
`username`	`string`	いいえ	はい	—
`password`	`string`	いいえ	はい	—
`database`	`string`	いいえ	はい	—
`extraSettings`	`string`	いいえ	はい	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/runtime/operability/db-health

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/operability.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/runtime/operability/deliveries

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/operability.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`limit`	query	`integer \| string (int32)`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

POST /api/runtime/operability/deliveries/{id}/retry

認証: AdminBearer

必要な権限: /runtime/operability.edit

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`id`	path	`integer (int64)`	はい	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/runtime/operability/key-usage

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/operability.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`From`	query	`string (date-time)`	いいえ	—
`To`	query	`string (date-time)`	いいえ	—
`DbManagementId`	query	`integer \| string (int32)`	いいえ	—
`AccessKeyId`	query	`integer \| string (int32)`	いいえ	—
`ToolName`	query	`string`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

GET /api/runtime/operability/metrics

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/operability.view

パスとクエリのパラメータ

項目名	指定箇所	型	必須	説明と制約
`From`	query	`string (date-time)`	いいえ	—
`To`	query	`string (date-time)`	いいえ	—
`DbManagementId`	query	`integer \| string (int32)`	いいえ	—
`AccessKeyId`	query	`integer \| string (int32)`	いいえ	—
`ToolName`	query	`string`	いいえ	—

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

実行環境の診断 `RuntimeDoctor`

GET /api/runtime/operability/doctor

認証: AdminBearer / ManagementApiKey

必要な権限: /runtime/operability.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

項目名	型	必須	null 許容	説明と制約
`overallStatus`	`string`	はい	いいえ	—
`environment`	`string`	はい	いいえ	—
`deploymentMode`	`string`	はい	いいえ	—
`generatedAtUtc`	`string (date-time)`	はい	いいえ	—
`checks`	`array<RuntimeDoctorCheck>`	はい	いいえ	—
`checks[].id`	`string`	はい	いいえ	—
`checks[].category`	`string`	はい	いいえ	—
`checks[].status`	`string`	はい	いいえ	—
`checks[].title`	`string`	はい	いいえ	—
`checks[].detail`	`string`	はい	いいえ	—
`checks[].action`	`string`	いいえ	はい	—

セキュリティポリシー `SecurityPolicy`

GET /api/runtime/security

認証: AdminBearer

必要な権限: /runtime/security.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

PUT /api/runtime/security

認証: AdminBearer

必要な権限: /runtime/security.edit

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`queryMaxRows`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`queryTimeoutSeconds`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`requireWhereForUpdate`	`boolean`	いいえ	いいえ	—
`requireWhereForDelete`	`boolean`	いいえ	いいえ	—
`allowFullTableUpdate`	`boolean`	いいえ	いいえ	—
`allowFullTableDelete`	`boolean`	いいえ	いいえ	—
`dmlMaxAffectedRows`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`keyPermitLimit`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`keyWindowSeconds`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`maxConcurrentSql`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`updatedAt`	`string (date-time)`	いいえ	はい	—
`updatedBy`	`string`	いいえ	はい	—

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

SQL 解析 `SqlExplain`

POST /api/runtime/security/sql-explain

認証: AdminBearer

必要な権限: /runtime/security.view

パスとクエリのパラメータ

なし

リクエスト本文

application/json · 必須: はい

項目名	型	必須	null 許容	説明と制約
`dbManagementId`	`integer \| string (int32)`	いいえ	いいえ	形式: ^-?(?:0\|[1-9]\d*)$
`sql`	`string`	いいえ	いいえ	—
`statementType`	`string`	いいえ	いいえ	—
`sourceDialect`	`string`	いいえ	はい	—
`accessKeyId`	`integer \| string (int32)`	いいえ	はい	形式: ^-?(?:0\|[1-9]\d*)$

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

SQL 解析コンテキスト `SqlExplainContext`

GET /api/runtime/security/sql-explain/context

認証: AdminBearer

必要な権限: /runtime/security.view

パスとクエリのパラメータ

なし

リクエスト本文

なし

レスポンスモデル

`200` 成功

このレスポンスのモデルはサーバー側で未定義です

認証・アカウント Auth

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

200 成功

パスとクエリのパラメータ

リクエスト本文

レスポンスモデル

認証・アカウント `Auth`

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

`200` 成功

認証情報の状態 `Credential`

`200` 成功

カスタム SQL ツール `CustomSqlTool`

`200` 成功

`201` 作成完了

`400` 不正なリクエスト

`204` 成功（本文なし）

`404` 見つかりません

`200` 成功

`404` 見つかりません

`200` 成功

`400` 不正なリクエスト

`404` 見つかりません

`200` 成功

`404` 見つかりません

`200` 成功

`404` 見つかりません