Référence REST de l'administration

Développez une opération pour inspecter ses paramètres, les champs du corps de requête et ceux de chaque réponse, y compris les objets imbriqués, les types, les champs obligatoires et Nullable. Ces données proviennent des métadonnées OpenAPI des contrôleurs et DTO.

Commencer par créer une clé système à système depuis l’Admin UI.

93 opérations API · 28 opérations avec modèle de réponse · v2.0.6 055aa695764f

Rechercher un chemin, une méthode ou une catégorie

Authentification et comptes `Auth`

GET /api/Auth/account

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

PUT /api/Auth/account

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`username`	`string`	Oui	Non	Longueur maximale: 100
`email`	`string`	Oui	Non	Longueur maximale: 320

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

PUT /api/Auth/account/password

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`currentPassword`	`string`	Oui	Non	—
`newPassword`	`string`	Oui	Non	Longueur minimale: 8

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/Auth/first-run

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/forgot-password

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`email`	`string`	Oui	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/mfa/confirm

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`code`	`string`	Oui	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/mfa/disable

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`code`	`string`	Oui	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/mfa/setup

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/Auth/mfa/status

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/mfa/verify

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`code`	`string`	Oui	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/Auth/oidc/callback

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/oidc/exchange

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`code`	`string`	Oui	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/Auth/oidc/status

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/refresh-token

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/reset-password

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`token`	`string`	Oui	Non	—
`newPassword`	`string`	Oui	Non	Longueur minimale: 8

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

DELETE /api/Auth/sessions

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/Auth/sessions

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

DELETE /api/Auth/sessions/{sessionId}

Authentification: —

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`sessionId`	path	`string (uuid)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/sign-in

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`email`	`string`	Oui	Non	—
`password`	`string`	Oui	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/sign-out

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Non

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`<variant2>.refreshToken`	`string`	Non	Oui	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Auth/sign-up

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`email`	`string`	Oui	Non	—
`password`	`string`	Oui	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

État des identifiants `Credential`

GET /api/Credential/status

Authentification: —

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Outils SQL personnalisés `CustomSqlTool`

GET /api/CustomSqlTool

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`[].id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Non	Non	—
`[].description`	`string`	Non	Non	—
`[].sqlTemplate`	`string`	Non	Non	—
`[].type`	`string`	Non	Non	—
`[].parametersJson`	`string`	Non	Oui	—
`[].dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`[].status`	`string`	Non	Non	—
`[].publishedRevisionId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`[].publishedIdentity`	`string`	Non	Oui	—
`[].createdAt`	`string (date-time)`	Non	Non	—
`[].lastModifiedAt`	`string (date-time)`	Non	Oui	—

POST /api/CustomSqlTool

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.create

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`description`	`string`	Non	Non	—
`sqlTemplate`	`string`	Non	Non	—
`type`	`string`	Non	Non	—
`parametersJson`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Non	Non	—
`publishedRevisionId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Non	Oui	—
`createdAt`	`string (date-time)`	Non	Non	—
`lastModifiedAt`	`string (date-time)`	Non	Oui	—

Modèles de réponse

`201` Créé

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`description`	`string`	Non	Non	—
`sqlTemplate`	`string`	Non	Non	—
`type`	`string`	Non	Non	—
`parametersJson`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Non	Non	—
`publishedRevisionId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Non	Oui	—
`createdAt`	`string (date-time)`	Non	Non	—
`lastModifiedAt`	`string (date-time)`	Non	Oui	—

`400` Requête incorrecte

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

DELETE /api/CustomSqlTool/{id}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.delete

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`204` Succès, sans contenu

Réponse sans corps

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

GET /api/CustomSqlTool/{id}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`description`	`string`	Non	Non	—
`sqlTemplate`	`string`	Non	Non	—
`type`	`string`	Non	Non	—
`parametersJson`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Non	Non	—
`publishedRevisionId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Non	Oui	—
`createdAt`	`string (date-time)`	Non	Non	—
`lastModifiedAt`	`string (date-time)`	Non	Oui	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

PUT /api/CustomSqlTool/{id}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`description`	`string`	Non	Non	—
`sqlTemplate`	`string`	Non	Non	—
`type`	`string`	Non	Non	—
`parametersJson`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Non	Non	—
`publishedRevisionId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Non	Oui	—
`createdAt`	`string (date-time)`	Non	Non	—
`lastModifiedAt`	`string (date-time)`	Non	Oui	—

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`description`	`string`	Non	Non	—
`sqlTemplate`	`string`	Non	Non	—
`type`	`string`	Non	Non	—
`parametersJson`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Non	Non	—
`publishedRevisionId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Non	Oui	—
`createdAt`	`string (date-time)`	Non	Non	—
`lastModifiedAt`	`string (date-time)`	Non	Oui	—

`400` Requête incorrecte

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

POST /api/CustomSqlTool/{id}/disable

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`description`	`string`	Non	Non	—
`sqlTemplate`	`string`	Non	Non	—
`type`	`string`	Non	Non	—
`parametersJson`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Non	Non	—
`publishedRevisionId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Non	Oui	—
`createdAt`	`string (date-time)`	Non	Non	—
`lastModifiedAt`	`string (date-time)`	Non	Oui	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

GET /api/CustomSqlTool/{id}/impact

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`toolId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`draftDbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`draftDatabaseName`	`string`	Non	Oui	—
`publishedDbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`publishedDatabaseName`	`string`	Non	Oui	—
`currentlyExposedToKeys`	`array<CustomSqlToolImpactKey>`	Non	Non	—
`currentlyExposedToKeys[].id`	`integer \| string (int32)`	Oui	Non	Format: ^-?(?:0\|[1-9]\d*)$
`currentlyExposedToKeys[].name`	`string`	Oui	Non	—
`currentlyExposedToKeys[].keyPrefix`	`string`	Oui	Non	—
`wouldExposeToKeys`	`array<CustomSqlToolImpactKey>`	Non	Non	—
`wouldExposeToKeys[].id`	`integer \| string (int32)`	Oui	Non	Format: ^-?(?:0\|[1-9]\d*)$
`wouldExposeToKeys[].name`	`string`	Oui	Non	—
`wouldExposeToKeys[].keyPrefix`	`string`	Oui	Non	—
`breakingChanges`	`array<string>`	Non	Non	—
`sqlChanged`	`boolean`	Non	Non	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

POST /api/CustomSqlTool/{id}/publish

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`description`	`string`	Non	Non	—
`sqlTemplate`	`string`	Non	Non	—
`type`	`string`	Non	Non	—
`parametersJson`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Non	Non	—
`publishedRevisionId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Non	Oui	—
`createdAt`	`string (date-time)`	Non	Non	—
`lastModifiedAt`	`string (date-time)`	Non	Oui	—

`400` Requête incorrecte

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

`409` Conflit

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

GET /api/CustomSqlTool/{id}/revisions

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`[].id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].customSqlToolId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].revisionNumber`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Non	Non	—
`[].description`	`string`	Non	Non	—
`[].sqlTemplate`	`string`	Non	Non	—
`[].type`	`string`	Non	Non	—
`[].parametersJson`	`string`	Non	Oui	—
`[].diffJson`	`string`	Non	Non	—
`[].publishedBy`	`string`	Non	Oui	—
`[].publishedAt`	`string (date-time)`	Non	Non	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

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

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—
`revisionId`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`description`	`string`	Non	Non	—
`sqlTemplate`	`string`	Non	Non	—
`type`	`string`	Non	Non	—
`parametersJson`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Non	Non	—
`publishedRevisionId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Non	Oui	—
`createdAt`	`string (date-time)`	Non	Non	—
`lastModifiedAt`	`string (date-time)`	Non	Oui	—

`400` Requête incorrecte

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

`409` Conflit

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

POST /api/CustomSqlTool/test-execute

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/custom-tools.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`toolId`	`integer \| string (int32)`	Oui	Non	Format: ^-?(?:0\|[1-9]\d*)$
`parameters`	`object`	Non	Oui	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Gestion des bases de données `DbManagement`

GET /api/DbManagement

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`[].id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Non	Non	—
`[].sqlProvider`	`string`	Non	Non	—
`[].host`	`string`	Non	Non	—
`[].port`	`string`	Non	Non	—
`[].username`	`string`	Non	Non	—
`[].database`	`string`	Non	Non	—
`[].extraSettings`	`string`	Non	Oui	—
`[].createdAt`	`string`	Non	Non	—
`[].createdBy`	`string`	Non	Non	—
`[].updatedAt`	`string`	Non	Non	—
`[].updatedBy`	`string`	Non	Non	—
`[].isBootstrapManaged`	`boolean`	Non	Non	—

POST /api/DbManagement

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management.create

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`name`	`string`	Non	Non	—
`sqlProvider`	`string`	Non	Non	—
`host`	`string`	Non	Non	—
`port`	`string`	Non	Non	—
`username`	`string`	Non	Non	—
`password`	`string`	Non	Non	—
`database`	`string`	Non	Non	—
`extraSettings`	`string`	Non	Oui	—
`createdBy`	`string`	Non	Non	—
`updatedBy`	`string`	Non	Non	—

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`sqlProvider`	`string`	Non	Non	—
`host`	`string`	Non	Non	—
`port`	`string`	Non	Non	—
`username`	`string`	Non	Non	—
`database`	`string`	Non	Non	—
`extraSettings`	`string`	Non	Oui	—
`createdAt`	`string`	Non	Non	—
`createdBy`	`string`	Non	Non	—
`updatedAt`	`string`	Non	Non	—
`updatedBy`	`string`	Non	Non	—
`isBootstrapManaged`	`boolean`	Non	Non	—

`400` Requête incorrecte

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

DELETE /api/DbManagement/{id}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management.delete

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`204` Succès, sans contenu

Réponse sans corps

GET /api/DbManagement/{id}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`sqlProvider`	`string`	Non	Non	—
`host`	`string`	Non	Non	—
`port`	`string`	Non	Non	—
`username`	`string`	Non	Non	—
`database`	`string`	Non	Non	—
`extraSettings`	`string`	Non	Oui	—
`createdAt`	`string`	Non	Non	—
`createdBy`	`string`	Non	Non	—
`updatedAt`	`string`	Non	Non	—
`updatedBy`	`string`	Non	Non	—
`isBootstrapManaged`	`boolean`	Non	Non	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

PUT /api/DbManagement/{id}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`name`	`string`	Non	Non	—
`sqlProvider`	`string`	Non	Non	—
`host`	`string`	Non	Non	—
`port`	`string`	Non	Non	—
`username`	`string`	Non	Non	—
`password`	`string`	Non	Non	—
`database`	`string`	Non	Non	—
`extraSettings`	`string`	Non	Oui	—
`createdBy`	`string`	Non	Non	—
`updatedBy`	`string`	Non	Non	—

Modèles de réponse

`204` Succès, sans contenu

Réponse sans corps

`400` Requête incorrecte

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

GET /api/DbManagement/{id}/columns

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—
`schema`	query	`string`	Non	—
`table`	query	`string`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/DbManagement/{id}/schemas

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/DbManagement/{id}/tables

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—
`schema`	query	`string`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Métadonnées sémantiques `DbSemantic`

POST /api/DbSemantic

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management/semantic.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	Non	Oui	—
`tableName`	`string`	Non	Non	—
`columnName`	`string`	Non	Oui	—
`description`	`string`	Non	Oui	—
`displayName`	`string`	Non	Oui	—
`synonyms`	`array<string>`	Non	Oui	—

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	Non	Oui	—
`tableName`	`string`	Non	Non	—
`columnName`	`string`	Non	Oui	—
`description`	`string`	Non	Oui	—
`displayName`	`string`	Non	Oui	—
`synonyms`	`array<string>`	Non	Non	—
`createdAt`	`string`	Non	Non	—
`updatedAt`	`string`	Non	Non	—

GET /api/DbSemantic/{dbManagementId}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management/semantic.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`dbManagementId`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`[].id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].schemaName`	`string`	Non	Oui	—
`[].tableName`	`string`	Non	Non	—
`[].columnName`	`string`	Non	Oui	—
`[].description`	`string`	Non	Oui	—
`[].displayName`	`string`	Non	Oui	—
`[].synonyms`	`array<string>`	Non	Non	—
`[].createdAt`	`string`	Non	Non	—
`[].updatedAt`	`string`	Non	Non	—

GET /api/DbSemantic/{dbManagementId}/model

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management/semantic.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`dbManagementId`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`dbManagementId`	`integer \| string (int32)`	Oui	Non	Format: ^-?(?:0\|[1-9]\d*)$
`entities`	`array<DbSemanticVM>`	Oui	Non	—
`entities[].id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`entities[].dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`entities[].schemaName`	`string`	Non	Oui	—
`entities[].tableName`	`string`	Non	Non	—
`entities[].columnName`	`string`	Non	Oui	—
`entities[].description`	`string`	Non	Oui	—
`entities[].displayName`	`string`	Non	Oui	—
`entities[].synonyms`	`array<string>`	Non	Non	—
`entities[].createdAt`	`string`	Non	Non	—
`entities[].updatedAt`	`string`	Non	Non	—
`relationships`	`array<DbSemanticRelationshipModel>`	Oui	Non	—
`relationships[].id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`relationships[].dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`relationships[].name`	`string`	Non	Non	—
`relationships[].sourceSchema`	`string`	Non	Oui	—
`relationships[].sourceTable`	`string`	Non	Non	—
`relationships[].sourceColumn`	`string`	Non	Non	—
`relationships[].targetSchema`	`string`	Non	Oui	—
`relationships[].targetTable`	`string`	Non	Non	—
`relationships[].targetColumn`	`string`	Non	Non	—
`relationships[].cardinality`	`string`	Non	Non	—
`relationships[].direction`	`string`	Non	Non	—
`relationships[].description`	`string`	Non	Oui	—
`metrics`	`array<DbSemanticMetricModel>`	Oui	Non	—
`metrics[].id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`metrics[].dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`metrics[].schemaName`	`string`	Non	Oui	—
`metrics[].tableName`	`string`	Non	Non	—
`metrics[].name`	`string`	Non	Non	—
`metrics[].displayName`	`string`	Non	Oui	—
`metrics[].description`	`string`	Non	Oui	—
`metrics[].formula`	`string`	Non	Non	—
`metrics[].aggregation`	`string`	Non	Non	—
`metrics[].grain`	`string`	Non	Oui	—
`metrics[].filter`	`string`	Non	Oui	—
`metrics[].synonyms`	`array<string>`	Non	Oui	—
`metrics[].executable`	`boolean`	Non	Non	—

DELETE /api/DbSemantic/{id}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management/semantic.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/DbSemantic/metric

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management/semantic.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	Non	Oui	—
`tableName`	`string`	Non	Non	—
`name`	`string`	Non	Non	—
`displayName`	`string`	Non	Oui	—
`description`	`string`	Non	Oui	—
`formula`	`string`	Non	Non	—
`aggregation`	`string`	Non	Non	—
`grain`	`string`	Non	Oui	—
`filter`	`string`	Non	Oui	—
`synonyms`	`array<string>`	Non	Oui	—
`executable`	`boolean`	Non	Non	—

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	Non	Oui	—
`tableName`	`string`	Non	Non	—
`name`	`string`	Non	Non	—
`displayName`	`string`	Non	Oui	—
`description`	`string`	Non	Oui	—
`formula`	`string`	Non	Non	—
`aggregation`	`string`	Non	Non	—
`grain`	`string`	Non	Oui	—
`filter`	`string`	Non	Oui	—
`synonyms`	`array<string>`	Non	Oui	—
`executable`	`boolean`	Non	Non	—

DELETE /api/DbSemantic/metric/{id}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management/semantic.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/DbSemantic/relationship

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management/semantic.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`sourceSchema`	`string`	Non	Oui	—
`sourceTable`	`string`	Non	Non	—
`sourceColumn`	`string`	Non	Non	—
`targetSchema`	`string`	Non	Oui	—
`targetTable`	`string`	Non	Non	—
`targetColumn`	`string`	Non	Non	—
`cardinality`	`string`	Non	Non	—
`direction`	`string`	Non	Non	—
`description`	`string`	Non	Oui	—

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`sourceSchema`	`string`	Non	Oui	—
`sourceTable`	`string`	Non	Non	—
`sourceColumn`	`string`	Non	Non	—
`targetSchema`	`string`	Non	Oui	—
`targetTable`	`string`	Non	Non	—
`targetColumn`	`string`	Non	Non	—
`cardinality`	`string`	Non	Non	—
`direction`	`string`	Non	Non	—
`description`	`string`	Non	Oui	—

DELETE /api/DbSemantic/relationship/{id}

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/db-management/semantic.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer \| string (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Clés d'API d'administration `ManagementApiKeys`

GET /api/runtime/management-api-keys

Authentification: AdminBearer

Autorisation requise: /runtime/security.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`[].id`	`integer \| string (int32)`	Oui	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Oui	Non	—
`[].keyPrefix`	`string`	Oui	Non	—
`[].permissions`	`array<string>`	Oui	Non	—
`[].createdAt`	`string (date-time)`	Oui	Non	—
`[].expiresAt`	`string (date-time)`	Oui	Non	—
`[].lastUsedAt`	`string (date-time)`	Oui	Oui	—
`[].revokedAt`	`string (date-time)`	Oui	Oui	—
`[].createdBy`	`string`	Oui	Oui	—

POST /api/runtime/management-api-keys

Authentification: AdminBearer

Autorisation requise: /runtime/security.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`name`	`string`	Oui	Non	—
`expiresAt`	`string (date-time)`	Oui	Non	—
`permissions`	`array<string>`	Oui	Non	—

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`key`	`ManagementApiKeyView`	Oui	Non	—
`key.id`	`integer \| string (int32)`	Oui	Non	Format: ^-?(?:0\|[1-9]\d*)$
`key.name`	`string`	Oui	Non	—
`key.keyPrefix`	`string`	Oui	Non	—
`key.permissions`	`array<string>`	Oui	Non	—
`key.createdAt`	`string (date-time)`	Oui	Non	—
`key.expiresAt`	`string (date-time)`	Oui	Non	—
`key.lastUsedAt`	`string (date-time)`	Oui	Oui	—
`key.revokedAt`	`string (date-time)`	Oui	Oui	—
`key.createdBy`	`string`	Oui	Oui	—
`plaintextKey`	`string`	Oui	Non	—

`400` Requête incorrecte

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

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

Authentification: AdminBearer

Autorisation requise: /runtime/security.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`204` Succès, sans contenu

Réponse sans corps

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

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

Authentification: AdminBearer

Autorisation requise: /runtime/security.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`key`	`ManagementApiKeyView`	Oui	Non	—
`key.id`	`integer \| string (int32)`	Oui	Non	Format: ^-?(?:0\|[1-9]\d*)$
`key.name`	`string`	Oui	Non	—
`key.keyPrefix`	`string`	Oui	Non	—
`key.permissions`	`array<string>`	Oui	Non	—
`key.createdAt`	`string (date-time)`	Oui	Non	—
`key.expiresAt`	`string (date-time)`	Oui	Non	—
`key.lastUsedAt`	`string (date-time)`	Oui	Oui	—
`key.revokedAt`	`string (date-time)`	Oui	Oui	—
`key.createdBy`	`string`	Oui	Oui	—
`plaintextKey`	`string`	Oui	Non	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

`409` Conflit

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

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

Authentification: AdminBearer

Autorisation requise: /runtime/security.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`(corps de la requête ou réponse)`	`array<string>`	—	Non	—

Configuration des clients `McpClientConfig`

GET /api/runtime/client-config

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/mcp-keys.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`mcpEndpoint`	`string`	Oui	Non	—

Gestion des utilisateurs `Member`

GET /api/Member

Authentification: AdminBearer

Autorisation requise: /auth/user.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`Search`	query	`string`	Non	—
`IsActive`	query	`boolean`	Non	—
`RoleId`	query	`integer \| string (int32)`	Non	—
`Page`	query	`integer \| string (int32)`	Non	—
`PageSize`	query	`integer \| string (int32)`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Member

Authentification: AdminBearer

Autorisation requise: /auth/user.create

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`email`	`string`	Oui	Non	—
`username`	`string`	Non	Oui	—
`password`	`string`	Oui	Non	—
`assignAllRoles`	`boolean`	Non	Non	—
`roleIds`	`array<integer \| string (int32)>`	Non	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

DELETE /api/Member/{id}

Authentification: AdminBearer

Autorisation requise: /auth/user.delete

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

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

Authentification: AdminBearer

Autorisation requise: /auth/user.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`required`	`boolean`	Non	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

PUT /api/Member/{id}/roles

Authentification: AdminBearer

Autorisation requise: /auth/user.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`roleIds`	`array<integer \| string (int32)>`	Non	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

DELETE /api/Member/{id}/sessions

Authentification: AdminBearer

Autorisation requise: /auth/user.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

PUT /api/Member/{id}/status

Authentification: AdminBearer

Autorisation requise: /auth/user.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`isActive`	`boolean`	Non	Non	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Rôles et autorisations `Role`

GET /api/Role

Authentification: AdminBearer

Autorisation requise: /auth/role.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/Role

Authentification: AdminBearer

Autorisation requise: /auth/role.create

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`name`	`string`	Oui	Non	—
`description`	`string`	Non	Oui	—
`permissionActions`	`array<PermissionActionSelection>`	Non	Non	—
`permissionActions[].permissionId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`permissionActions[].actionId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

DELETE /api/Role/{id}

Authentification: AdminBearer

Autorisation requise: /auth/role.delete

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—
`force`	query	`boolean`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

PUT /api/Role/{id}

Authentification: AdminBearer

Autorisation requise: /auth/role.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`name`	`string`	Oui	Non	—
`description`	`string`	Non	Oui	—
`permissionActions`	`array<PermissionActionSelection>`	Non	Non	—
`permissionActions[].permissionId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`permissionActions[].actionId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/Role/{id}/dependencies

Authentification: AdminBearer

Autorisation requise: /auth/role.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/Role/permission-action-templates

Authentification: AdminBearer

Autorisation requise: /auth/role.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Exécution et clés d'accès `RuntimeAdmin`

GET /api/runtime/audit

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/audit.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`page`	query	`integer \| string (int32)`	Non	—
`pageSize`	query	`integer \| string (int32)`	Non	—
`action`	query	`string`	Non	—
`keyword`	query	`string`	Non	—
`from`	query	`string (date-time)`	Non	—
`to`	query	`string (date-time)`	Non	—
`result`	query	`string`	Non	—
`actor`	query	`string`	Non	—
`dbManagementId`	query	`integer \| string (int32)`	Non	—
`accessKeyId`	query	`integer \| string (int32)`	Non	—
`toolName`	query	`string`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/runtime/audit/daily-summary

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/audit.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`days`	query	`integer \| string (int32)`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/runtime/audit/export

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/audit.export

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`Page`	query	`integer \| string (int32)`	Non	—
`PageSize`	query	`integer \| string (int32)`	Non	—
`Action`	query	`string`	Non	—
`Keyword`	query	`string`	Non	—
`From`	query	`string (date-time)`	Non	—
`To`	query	`string (date-time)`	Non	—
`Result`	query	`string`	Non	—
`Actor`	query	`string`	Non	—
`DbManagementId`	query	`integer \| string (int32)`	Non	—
`AccessKeyId`	query	`integer \| string (int32)`	Non	—
`ToolName`	query	`string`	Non	—
`format`	query	`string`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/runtime/audit/retention

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/audit.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

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

Authentification: AdminBearer

Autorisation requise: /runtime/audit.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

POST /api/runtime/audit/retention/execute

Authentification: AdminBearer

Autorisation requise: /runtime/audit.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/runtime/mcp-keys

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/mcp-keys.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`[].id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Non	Non	—
`[].keyPrefix`	`string`	Non	Non	—
`[].isActive`	`boolean`	Non	Non	—
`[].expiresAt`	`string (date-time)`	Non	Oui	—
`[].lastUsedAt`	`string (date-time)`	Non	Oui	—
`[].allowedTools`	`string`	Non	Oui	—
`[].corsAllowedOrigins`	`string`	Non	Oui	—
`[].sqlProvider`	`string`	Non	Oui	—
`[].dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`[].dbManagementName`	`string`	Non	Oui	—
`[].isExpired`	`boolean`	Non	Non	—
`[].isExpiringSoon`	`boolean`	Non	Non	—
`[].tableWhitelist`	`string`	Non	Oui	—
`[].createdAt`	`string (date-time)`	Non	Non	—
`[].rateLimitMode`	`McpKeyRateLimitMode`	Non	Non	—
`[].permitLimitOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`[].windowSecondsOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`[].effectivePermitLimit`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`[].effectiveWindowSeconds`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`[].isBootstrapManaged`	`boolean`	Non	Non	—

POST /api/runtime/mcp-keys

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/mcp-keys.create

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`name`	`string`	Non	Non	—
`expiresAt`	`string (date-time)`	Non	Oui	—
`allowedTools`	`string`	Non	Oui	—
`corsAllowedOrigins`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Non	Oui	—
`rateLimitMode`	`McpKeyRateLimitMode`	Non	Non	—
`permitLimitOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`keyPrefix`	`string`	Non	Non	—
`plaintextKey`	`string`	Non	Non	—
`expiresAt`	`string (date-time)`	Non	Oui	—
`allowedTools`	`string`	Non	Oui	—
`corsAllowedOrigins`	`string`	Non	Oui	—
`sqlProvider`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Non	Oui	—
`rateLimitMode`	`McpKeyRateLimitMode`	Non	Non	—
`permitLimitOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$

`400` Requête incorrecte

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

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

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/mcp-keys.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`name`	`string`	Non	Non	—
`expiresAt`	`string (date-time)`	Non	Oui	—
`allowedTools`	`string`	Non	Oui	—
`corsAllowedOrigins`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Non	Oui	—
`rateLimitMode`	`McpKeyRateLimitMode`	Non	Non	—
`permitLimitOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`keyPrefix`	`string`	Non	Non	—
`isActive`	`boolean`	Non	Non	—
`expiresAt`	`string (date-time)`	Non	Oui	—
`lastUsedAt`	`string (date-time)`	Non	Oui	—
`allowedTools`	`string`	Non	Oui	—
`corsAllowedOrigins`	`string`	Non	Oui	—
`sqlProvider`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`dbManagementName`	`string`	Non	Oui	—
`isExpired`	`boolean`	Non	Non	—
`isExpiringSoon`	`boolean`	Non	Non	—
`tableWhitelist`	`string`	Non	Oui	—
`createdAt`	`string (date-time)`	Non	Non	—
`rateLimitMode`	`McpKeyRateLimitMode`	Non	Non	—
`permitLimitOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`effectivePermitLimit`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`effectiveWindowSeconds`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`isBootstrapManaged`	`boolean`	Non	Non	—

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

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

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/mcp-keys.create

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`name`	`string`	Non	Non	—
`expiresAt`	`string (date-time)`	Non	Oui	—

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`keyPrefix`	`string`	Non	Non	—
`plaintextKey`	`string`	Non	Non	—
`expiresAt`	`string (date-time)`	Non	Oui	—
`allowedTools`	`string`	Non	Oui	—
`corsAllowedOrigins`	`string`	Non	Oui	—
`sqlProvider`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Non	Oui	—
`rateLimitMode`	`McpKeyRateLimitMode`	Non	Non	—
`permitLimitOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

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

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/mcp-keys.revoke

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

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

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/mcp-keys.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int32)`	Oui	—

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`gracePeriodMinutes`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`expiresAt`	`string (date-time)`	Non	Oui	—

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`id`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Non	Non	—
`keyPrefix`	`string`	Non	Non	—
`plaintextKey`	`string`	Non	Non	—
`expiresAt`	`string (date-time)`	Non	Oui	—
`allowedTools`	`string`	Non	Oui	—
`corsAllowedOrigins`	`string`	Non	Oui	—
`sqlProvider`	`string`	Non	Oui	—
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Non	Oui	—
`rateLimitMode`	`McpKeyRateLimitMode`	Non	Non	—
`permitLimitOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$

`404` Introuvable

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`type`	`string`	Non	Oui	—
`title`	`string`	Non	Oui	—
`status`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Non	Oui	—
`instance`	`string`	Non	Oui	—

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

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/mcp-keys.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`dbManagementId`	query	`integer \| string (int32)`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

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

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/mcp-keys.create, /runtime/db-management.create, /runtime/db-management.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`dbSettingMode`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$
`sqlProvider`	`null \| SqlAgentToolType`	Non	Non	—
`host`	`string`	Non	Oui	—
`port`	`string`	Non	Oui	—
`username`	`string`	Non	Oui	—
`password`	`string`	Non	Oui	—
`database`	`string`	Non	Oui	—
`extraSettings`	`string`	Non	Oui	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/runtime/operability/db-health

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/operability.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/runtime/operability/deliveries

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/operability.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`limit`	query	`integer \| string (int32)`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

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

Authentification: AdminBearer

Autorisation requise: /runtime/operability.edit

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`id`	path	`integer (int64)`	Oui	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/runtime/operability/key-usage

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/operability.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`From`	query	`string (date-time)`	Non	—
`To`	query	`string (date-time)`	Non	—
`DbManagementId`	query	`integer \| string (int32)`	Non	—
`AccessKeyId`	query	`integer \| string (int32)`	Non	—
`ToolName`	query	`string`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

GET /api/runtime/operability/metrics

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/operability.view

Paramètres de chemin et de requête

Champ	Emplacement	Type	Obligatoire	Description et contraintes
`From`	query	`string (date-time)`	Non	—
`To`	query	`string (date-time)`	Non	—
`DbManagementId`	query	`integer \| string (int32)`	Non	—
`AccessKeyId`	query	`integer \| string (int32)`	Non	—
`ToolName`	query	`string`	Non	—

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Diagnostic de l'environnement `RuntimeDoctor`

GET /api/runtime/operability/doctor

Authentification: AdminBearer / ManagementApiKey

Autorisation requise: /runtime/operability.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`overallStatus`	`string`	Oui	Non	—
`environment`	`string`	Oui	Non	—
`deploymentMode`	`string`	Oui	Non	—
`generatedAtUtc`	`string (date-time)`	Oui	Non	—
`checks`	`array<RuntimeDoctorCheck>`	Oui	Non	—
`checks[].id`	`string`	Oui	Non	—
`checks[].category`	`string`	Oui	Non	—
`checks[].status`	`string`	Oui	Non	—
`checks[].title`	`string`	Oui	Non	—
`checks[].detail`	`string`	Oui	Non	—
`checks[].action`	`string`	Non	Oui	—

Politique de sécurité `SecurityPolicy`

GET /api/runtime/security

Authentification: AdminBearer

Autorisation requise: /runtime/security.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

PUT /api/runtime/security

Authentification: AdminBearer

Autorisation requise: /runtime/security.edit

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`queryMaxRows`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`queryTimeoutSeconds`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`requireWhereForUpdate`	`boolean`	Non	Non	—
`requireWhereForDelete`	`boolean`	Non	Non	—
`allowFullTableUpdate`	`boolean`	Non	Non	—
`allowFullTableDelete`	`boolean`	Non	Non	—
`dmlMaxAffectedRows`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`keyPermitLimit`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`keyWindowSeconds`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`maxConcurrentSql`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`updatedAt`	`string (date-time)`	Non	Oui	—
`updatedBy`	`string`	Non	Oui	—

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Analyse SQL `SqlExplain`

POST /api/runtime/security/sql-explain

Authentification: AdminBearer

Autorisation requise: /runtime/security.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

application/json · Obligatoire: Oui

Champ	Type	Obligatoire	Valeur nulle autorisée	Description et contraintes
`dbManagementId`	`integer \| string (int32)`	Non	Non	Format: ^-?(?:0\|[1-9]\d*)$
`sql`	`string`	Non	Non	—
`statementType`	`string`	Non	Non	—
`sourceDialect`	`string`	Non	Oui	—
`accessKeyId`	`integer \| string (int32)`	Non	Oui	Format: ^-?(?:0\|[1-9]\d*)$

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Contexte d'analyse SQL `SqlExplainContext`

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

Authentification: AdminBearer

Autorisation requise: /runtime/security.view

Paramètres de chemin et de requête

Aucun

Corps de la requête

Aucun

Modèles de réponse

`200` Succès

Le modèle de cette réponse n'est pas encore défini côté serveur

Authentification et comptes Auth

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

200 Succès

Paramètres de chemin et de requête

Corps de la requête

Modèles de réponse

Authentification et comptes `Auth`

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

`200` Succès

État des identifiants `Credential`

`200` Succès

Outils SQL personnalisés `CustomSqlTool`

`200` Succès

`201` Créé

`400` Requête incorrecte

`204` Succès, sans contenu

`404` Introuvable

`200` Succès

`404` Introuvable

`200` Succès

`400` Requête incorrecte

`404` Introuvable

`200` Succès

`404` Introuvable

`200` Succès

`404` Introuvable