Admin REST API-Referenz

Öffnen Sie einen Endpunkt, um Path-/Query-Parameter, Request Body und Response-Modelle samt verschachtelten Feldern, Typen, Pflichtstatus und Nullable einzusehen. Die Daten stammen aus den OpenAPI-Metadaten der echten Controller und DTOs.

Zuerst einen System-to-System-Schlüssel in der Admin UI ausstellen.

93 API-Operationen · 28 Operationen mit definiertem Antwortmodell · v2.0.6 055aa695764f

API-Pfad, Methode oder Kategorie suchen

Authentifizierung und Konten `Auth`

GET /api/Auth/account

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

PUT /api/Auth/account

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`username`	`string`	Ja	Nein	Maximale Länge: 100
`email`	`string`	Ja	Nein	Maximale Länge: 320

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

PUT /api/Auth/account/password

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`currentPassword`	`string`	Ja	Nein	—
`newPassword`	`string`	Ja	Nein	Minimale Länge: 8

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/Auth/first-run

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/forgot-password

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`email`	`string`	Ja	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/mfa/confirm

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`code`	`string`	Ja	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/mfa/disable

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`code`	`string`	Ja	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/mfa/setup

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/Auth/mfa/status

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/mfa/verify

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`code`	`string`	Ja	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/Auth/oidc/callback

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/oidc/exchange

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`code`	`string`	Ja	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/Auth/oidc/status

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/refresh-token

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/reset-password

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`token`	`string`	Ja	Nein	—
`newPassword`	`string`	Ja	Nein	Minimale Länge: 8

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

DELETE /api/Auth/sessions

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/Auth/sessions

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

DELETE /api/Auth/sessions/{sessionId}

Authentifizierung: —

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`sessionId`	path	`string (uuid)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/sign-in

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`email`	`string`	Ja	Nein	—
`password`	`string`	Ja	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/sign-out

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Nein

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`<variant2>.refreshToken`	`string`	Nein	Ja	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Auth/sign-up

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`email`	`string`	Ja	Nein	—
`password`	`string`	Ja	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

Status der Zugangsdaten `Credential`

GET /api/Credential/status

Authentifizierung: —

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

Benutzerdefinierte SQL-Werkzeuge `CustomSqlTool`

GET /api/CustomSqlTool

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`[].id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Nein	Nein	—
`[].description`	`string`	Nein	Nein	—
`[].sqlTemplate`	`string`	Nein	Nein	—
`[].type`	`string`	Nein	Nein	—
`[].parametersJson`	`string`	Nein	Ja	—
`[].dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`[].status`	`string`	Nein	Nein	—
`[].publishedRevisionId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`[].publishedIdentity`	`string`	Nein	Ja	—
`[].createdAt`	`string (date-time)`	Nein	Nein	—
`[].lastModifiedAt`	`string (date-time)`	Nein	Ja	—

POST /api/CustomSqlTool

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.create

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`description`	`string`	Nein	Nein	—
`sqlTemplate`	`string`	Nein	Nein	—
`type`	`string`	Nein	Nein	—
`parametersJson`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Nein	Nein	—
`publishedRevisionId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Nein	Ja	—
`createdAt`	`string (date-time)`	Nein	Nein	—
`lastModifiedAt`	`string (date-time)`	Nein	Ja	—

Antwortmodelle

`201` Erstellt

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`description`	`string`	Nein	Nein	—
`sqlTemplate`	`string`	Nein	Nein	—
`type`	`string`	Nein	Nein	—
`parametersJson`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Nein	Nein	—
`publishedRevisionId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Nein	Ja	—
`createdAt`	`string (date-time)`	Nein	Nein	—
`lastModifiedAt`	`string (date-time)`	Nein	Ja	—

`400` Ungültige Anfrage

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

DELETE /api/CustomSqlTool/{id}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.delete

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`204` Erfolgreich, ohne Inhalt

Antwort ohne Inhalt

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

GET /api/CustomSqlTool/{id}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`description`	`string`	Nein	Nein	—
`sqlTemplate`	`string`	Nein	Nein	—
`type`	`string`	Nein	Nein	—
`parametersJson`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Nein	Nein	—
`publishedRevisionId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Nein	Ja	—
`createdAt`	`string (date-time)`	Nein	Nein	—
`lastModifiedAt`	`string (date-time)`	Nein	Ja	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

PUT /api/CustomSqlTool/{id}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`description`	`string`	Nein	Nein	—
`sqlTemplate`	`string`	Nein	Nein	—
`type`	`string`	Nein	Nein	—
`parametersJson`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Nein	Nein	—
`publishedRevisionId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Nein	Ja	—
`createdAt`	`string (date-time)`	Nein	Nein	—
`lastModifiedAt`	`string (date-time)`	Nein	Ja	—

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`description`	`string`	Nein	Nein	—
`sqlTemplate`	`string`	Nein	Nein	—
`type`	`string`	Nein	Nein	—
`parametersJson`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Nein	Nein	—
`publishedRevisionId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Nein	Ja	—
`createdAt`	`string (date-time)`	Nein	Nein	—
`lastModifiedAt`	`string (date-time)`	Nein	Ja	—

`400` Ungültige Anfrage

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

POST /api/CustomSqlTool/{id}/disable

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`description`	`string`	Nein	Nein	—
`sqlTemplate`	`string`	Nein	Nein	—
`type`	`string`	Nein	Nein	—
`parametersJson`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Nein	Nein	—
`publishedRevisionId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Nein	Ja	—
`createdAt`	`string (date-time)`	Nein	Nein	—
`lastModifiedAt`	`string (date-time)`	Nein	Ja	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

GET /api/CustomSqlTool/{id}/impact

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`toolId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`draftDbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`draftDatabaseName`	`string`	Nein	Ja	—
`publishedDbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`publishedDatabaseName`	`string`	Nein	Ja	—
`currentlyExposedToKeys`	`array<CustomSqlToolImpactKey>`	Nein	Nein	—
`currentlyExposedToKeys[].id`	`integer \| string (int32)`	Ja	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`currentlyExposedToKeys[].name`	`string`	Ja	Nein	—
`currentlyExposedToKeys[].keyPrefix`	`string`	Ja	Nein	—
`wouldExposeToKeys`	`array<CustomSqlToolImpactKey>`	Nein	Nein	—
`wouldExposeToKeys[].id`	`integer \| string (int32)`	Ja	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`wouldExposeToKeys[].name`	`string`	Ja	Nein	—
`wouldExposeToKeys[].keyPrefix`	`string`	Ja	Nein	—
`breakingChanges`	`array<string>`	Nein	Nein	—
`sqlChanged`	`boolean`	Nein	Nein	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

POST /api/CustomSqlTool/{id}/publish

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`description`	`string`	Nein	Nein	—
`sqlTemplate`	`string`	Nein	Nein	—
`type`	`string`	Nein	Nein	—
`parametersJson`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Nein	Nein	—
`publishedRevisionId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Nein	Ja	—
`createdAt`	`string (date-time)`	Nein	Nein	—
`lastModifiedAt`	`string (date-time)`	Nein	Ja	—

`400` Ungültige Anfrage

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

`409` Konflikt

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

GET /api/CustomSqlTool/{id}/revisions

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`[].id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].customSqlToolId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].revisionNumber`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Nein	Nein	—
`[].description`	`string`	Nein	Nein	—
`[].sqlTemplate`	`string`	Nein	Nein	—
`[].type`	`string`	Nein	Nein	—
`[].parametersJson`	`string`	Nein	Ja	—
`[].diffJson`	`string`	Nein	Nein	—
`[].publishedBy`	`string`	Nein	Ja	—
`[].publishedAt`	`string (date-time)`	Nein	Nein	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

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

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—
`revisionId`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`description`	`string`	Nein	Nein	—
`sqlTemplate`	`string`	Nein	Nein	—
`type`	`string`	Nein	Nein	—
`parametersJson`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`status`	`string`	Nein	Nein	—
`publishedRevisionId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`publishedIdentity`	`string`	Nein	Ja	—
`createdAt`	`string (date-time)`	Nein	Nein	—
`lastModifiedAt`	`string (date-time)`	Nein	Ja	—

`400` Ungültige Anfrage

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

`409` Konflikt

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

POST /api/CustomSqlTool/test-execute

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/custom-tools.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`toolId`	`integer \| string (int32)`	Ja	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`parameters`	`object`	Nein	Ja	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

Datenbankverwaltung `DbManagement`

GET /api/DbManagement

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`[].id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Nein	Nein	—
`[].sqlProvider`	`string`	Nein	Nein	—
`[].host`	`string`	Nein	Nein	—
`[].port`	`string`	Nein	Nein	—
`[].username`	`string`	Nein	Nein	—
`[].database`	`string`	Nein	Nein	—
`[].extraSettings`	`string`	Nein	Ja	—
`[].createdAt`	`string`	Nein	Nein	—
`[].createdBy`	`string`	Nein	Nein	—
`[].updatedAt`	`string`	Nein	Nein	—
`[].updatedBy`	`string`	Nein	Nein	—
`[].isBootstrapManaged`	`boolean`	Nein	Nein	—

POST /api/DbManagement

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management.create

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`name`	`string`	Nein	Nein	—
`sqlProvider`	`string`	Nein	Nein	—
`host`	`string`	Nein	Nein	—
`port`	`string`	Nein	Nein	—
`username`	`string`	Nein	Nein	—
`password`	`string`	Nein	Nein	—
`database`	`string`	Nein	Nein	—
`extraSettings`	`string`	Nein	Ja	—
`createdBy`	`string`	Nein	Nein	—
`updatedBy`	`string`	Nein	Nein	—

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`sqlProvider`	`string`	Nein	Nein	—
`host`	`string`	Nein	Nein	—
`port`	`string`	Nein	Nein	—
`username`	`string`	Nein	Nein	—
`database`	`string`	Nein	Nein	—
`extraSettings`	`string`	Nein	Ja	—
`createdAt`	`string`	Nein	Nein	—
`createdBy`	`string`	Nein	Nein	—
`updatedAt`	`string`	Nein	Nein	—
`updatedBy`	`string`	Nein	Nein	—
`isBootstrapManaged`	`boolean`	Nein	Nein	—

`400` Ungültige Anfrage

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

DELETE /api/DbManagement/{id}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management.delete

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`204` Erfolgreich, ohne Inhalt

Antwort ohne Inhalt

GET /api/DbManagement/{id}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`sqlProvider`	`string`	Nein	Nein	—
`host`	`string`	Nein	Nein	—
`port`	`string`	Nein	Nein	—
`username`	`string`	Nein	Nein	—
`database`	`string`	Nein	Nein	—
`extraSettings`	`string`	Nein	Ja	—
`createdAt`	`string`	Nein	Nein	—
`createdBy`	`string`	Nein	Nein	—
`updatedAt`	`string`	Nein	Nein	—
`updatedBy`	`string`	Nein	Nein	—
`isBootstrapManaged`	`boolean`	Nein	Nein	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

PUT /api/DbManagement/{id}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`name`	`string`	Nein	Nein	—
`sqlProvider`	`string`	Nein	Nein	—
`host`	`string`	Nein	Nein	—
`port`	`string`	Nein	Nein	—
`username`	`string`	Nein	Nein	—
`password`	`string`	Nein	Nein	—
`database`	`string`	Nein	Nein	—
`extraSettings`	`string`	Nein	Ja	—
`createdBy`	`string`	Nein	Nein	—
`updatedBy`	`string`	Nein	Nein	—

Antwortmodelle

`204` Erfolgreich, ohne Inhalt

Antwort ohne Inhalt

`400` Ungültige Anfrage

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

GET /api/DbManagement/{id}/columns

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—
`schema`	query	`string`	Nein	—
`table`	query	`string`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/DbManagement/{id}/schemas

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/DbManagement/{id}/tables

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—
`schema`	query	`string`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

Semantische Metadaten `DbSemantic`

POST /api/DbSemantic

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management/semantic.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	Nein	Ja	—
`tableName`	`string`	Nein	Nein	—
`columnName`	`string`	Nein	Ja	—
`description`	`string`	Nein	Ja	—
`displayName`	`string`	Nein	Ja	—
`synonyms`	`array<string>`	Nein	Ja	—

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	Nein	Ja	—
`tableName`	`string`	Nein	Nein	—
`columnName`	`string`	Nein	Ja	—
`description`	`string`	Nein	Ja	—
`displayName`	`string`	Nein	Ja	—
`synonyms`	`array<string>`	Nein	Nein	—
`createdAt`	`string`	Nein	Nein	—
`updatedAt`	`string`	Nein	Nein	—

GET /api/DbSemantic/{dbManagementId}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management/semantic.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`dbManagementId`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`[].id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].schemaName`	`string`	Nein	Ja	—
`[].tableName`	`string`	Nein	Nein	—
`[].columnName`	`string`	Nein	Ja	—
`[].description`	`string`	Nein	Ja	—
`[].displayName`	`string`	Nein	Ja	—
`[].synonyms`	`array<string>`	Nein	Nein	—
`[].createdAt`	`string`	Nein	Nein	—
`[].updatedAt`	`string`	Nein	Nein	—

GET /api/DbSemantic/{dbManagementId}/model

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management/semantic.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`dbManagementId`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`dbManagementId`	`integer \| string (int32)`	Ja	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`entities`	`array<DbSemanticVM>`	Ja	Nein	—
`entities[].id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`entities[].dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`entities[].schemaName`	`string`	Nein	Ja	—
`entities[].tableName`	`string`	Nein	Nein	—
`entities[].columnName`	`string`	Nein	Ja	—
`entities[].description`	`string`	Nein	Ja	—
`entities[].displayName`	`string`	Nein	Ja	—
`entities[].synonyms`	`array<string>`	Nein	Nein	—
`entities[].createdAt`	`string`	Nein	Nein	—
`entities[].updatedAt`	`string`	Nein	Nein	—
`relationships`	`array<DbSemanticRelationshipModel>`	Ja	Nein	—
`relationships[].id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`relationships[].dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`relationships[].name`	`string`	Nein	Nein	—
`relationships[].sourceSchema`	`string`	Nein	Ja	—
`relationships[].sourceTable`	`string`	Nein	Nein	—
`relationships[].sourceColumn`	`string`	Nein	Nein	—
`relationships[].targetSchema`	`string`	Nein	Ja	—
`relationships[].targetTable`	`string`	Nein	Nein	—
`relationships[].targetColumn`	`string`	Nein	Nein	—
`relationships[].cardinality`	`string`	Nein	Nein	—
`relationships[].direction`	`string`	Nein	Nein	—
`relationships[].description`	`string`	Nein	Ja	—
`metrics`	`array<DbSemanticMetricModel>`	Ja	Nein	—
`metrics[].id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`metrics[].dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`metrics[].schemaName`	`string`	Nein	Ja	—
`metrics[].tableName`	`string`	Nein	Nein	—
`metrics[].name`	`string`	Nein	Nein	—
`metrics[].displayName`	`string`	Nein	Ja	—
`metrics[].description`	`string`	Nein	Ja	—
`metrics[].formula`	`string`	Nein	Nein	—
`metrics[].aggregation`	`string`	Nein	Nein	—
`metrics[].grain`	`string`	Nein	Ja	—
`metrics[].filter`	`string`	Nein	Ja	—
`metrics[].synonyms`	`array<string>`	Nein	Ja	—
`metrics[].executable`	`boolean`	Nein	Nein	—

DELETE /api/DbSemantic/{id}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management/semantic.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/DbSemantic/metric

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management/semantic.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	Nein	Ja	—
`tableName`	`string`	Nein	Nein	—
`name`	`string`	Nein	Nein	—
`displayName`	`string`	Nein	Ja	—
`description`	`string`	Nein	Ja	—
`formula`	`string`	Nein	Nein	—
`aggregation`	`string`	Nein	Nein	—
`grain`	`string`	Nein	Ja	—
`filter`	`string`	Nein	Ja	—
`synonyms`	`array<string>`	Nein	Ja	—
`executable`	`boolean`	Nein	Nein	—

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`schemaName`	`string`	Nein	Ja	—
`tableName`	`string`	Nein	Nein	—
`name`	`string`	Nein	Nein	—
`displayName`	`string`	Nein	Ja	—
`description`	`string`	Nein	Ja	—
`formula`	`string`	Nein	Nein	—
`aggregation`	`string`	Nein	Nein	—
`grain`	`string`	Nein	Ja	—
`filter`	`string`	Nein	Ja	—
`synonyms`	`array<string>`	Nein	Ja	—
`executable`	`boolean`	Nein	Nein	—

DELETE /api/DbSemantic/metric/{id}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management/semantic.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/DbSemantic/relationship

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management/semantic.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`sourceSchema`	`string`	Nein	Ja	—
`sourceTable`	`string`	Nein	Nein	—
`sourceColumn`	`string`	Nein	Nein	—
`targetSchema`	`string`	Nein	Ja	—
`targetTable`	`string`	Nein	Nein	—
`targetColumn`	`string`	Nein	Nein	—
`cardinality`	`string`	Nein	Nein	—
`direction`	`string`	Nein	Nein	—
`description`	`string`	Nein	Ja	—

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`sourceSchema`	`string`	Nein	Ja	—
`sourceTable`	`string`	Nein	Nein	—
`sourceColumn`	`string`	Nein	Nein	—
`targetSchema`	`string`	Nein	Ja	—
`targetTable`	`string`	Nein	Nein	—
`targetColumn`	`string`	Nein	Nein	—
`cardinality`	`string`	Nein	Nein	—
`direction`	`string`	Nein	Nein	—
`description`	`string`	Nein	Ja	—

DELETE /api/DbSemantic/relationship/{id}

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/db-management/semantic.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer \| string (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

Management-API-Schlüssel `ManagementApiKeys`

GET /api/runtime/management-api-keys

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/security.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`[].id`	`integer \| string (int32)`	Ja	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Ja	Nein	—
`[].keyPrefix`	`string`	Ja	Nein	—
`[].permissions`	`array<string>`	Ja	Nein	—
`[].createdAt`	`string (date-time)`	Ja	Nein	—
`[].expiresAt`	`string (date-time)`	Ja	Nein	—
`[].lastUsedAt`	`string (date-time)`	Ja	Ja	—
`[].revokedAt`	`string (date-time)`	Ja	Ja	—
`[].createdBy`	`string`	Ja	Ja	—

POST /api/runtime/management-api-keys

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/security.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`name`	`string`	Ja	Nein	—
`expiresAt`	`string (date-time)`	Ja	Nein	—
`permissions`	`array<string>`	Ja	Nein	—

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`key`	`ManagementApiKeyView`	Ja	Nein	—
`key.id`	`integer \| string (int32)`	Ja	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`key.name`	`string`	Ja	Nein	—
`key.keyPrefix`	`string`	Ja	Nein	—
`key.permissions`	`array<string>`	Ja	Nein	—
`key.createdAt`	`string (date-time)`	Ja	Nein	—
`key.expiresAt`	`string (date-time)`	Ja	Nein	—
`key.lastUsedAt`	`string (date-time)`	Ja	Ja	—
`key.revokedAt`	`string (date-time)`	Ja	Ja	—
`key.createdBy`	`string`	Ja	Ja	—
`plaintextKey`	`string`	Ja	Nein	—

`400` Ungültige Anfrage

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

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

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/security.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`204` Erfolgreich, ohne Inhalt

Antwort ohne Inhalt

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

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

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/security.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`key`	`ManagementApiKeyView`	Ja	Nein	—
`key.id`	`integer \| string (int32)`	Ja	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`key.name`	`string`	Ja	Nein	—
`key.keyPrefix`	`string`	Ja	Nein	—
`key.permissions`	`array<string>`	Ja	Nein	—
`key.createdAt`	`string (date-time)`	Ja	Nein	—
`key.expiresAt`	`string (date-time)`	Ja	Nein	—
`key.lastUsedAt`	`string (date-time)`	Ja	Ja	—
`key.revokedAt`	`string (date-time)`	Ja	Ja	—
`key.createdBy`	`string`	Ja	Ja	—
`plaintextKey`	`string`	Ja	Nein	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

`409` Konflikt

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

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

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/security.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`(Anfrage- oder Antwortinhalt)`	`array<string>`	—	Nein	—

Client-Konfiguration `McpClientConfig`

GET /api/runtime/client-config

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/mcp-keys.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`mcpEndpoint`	`string`	Ja	Nein	—

Benutzerverwaltung `Member`

GET /api/Member

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/user.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`Search`	query	`string`	Nein	—
`IsActive`	query	`boolean`	Nein	—
`RoleId`	query	`integer \| string (int32)`	Nein	—
`Page`	query	`integer \| string (int32)`	Nein	—
`PageSize`	query	`integer \| string (int32)`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Member

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/user.create

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`email`	`string`	Ja	Nein	—
`username`	`string`	Nein	Ja	—
`password`	`string`	Ja	Nein	—
`assignAllRoles`	`boolean`	Nein	Nein	—
`roleIds`	`array<integer \| string (int32)>`	Nein	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

DELETE /api/Member/{id}

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/user.delete

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

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

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/user.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`required`	`boolean`	Nein	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

PUT /api/Member/{id}/roles

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/user.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`roleIds`	`array<integer \| string (int32)>`	Nein	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

DELETE /api/Member/{id}/sessions

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/user.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

PUT /api/Member/{id}/status

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/user.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`isActive`	`boolean`	Nein	Nein	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

Rollen und Berechtigungen `Role`

GET /api/Role

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/role.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/Role

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/role.create

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`name`	`string`	Ja	Nein	—
`description`	`string`	Nein	Ja	—
`permissionActions`	`array<PermissionActionSelection>`	Nein	Nein	—
`permissionActions[].permissionId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`permissionActions[].actionId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

DELETE /api/Role/{id}

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/role.delete

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—
`force`	query	`boolean`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

PUT /api/Role/{id}

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/role.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`name`	`string`	Ja	Nein	—
`description`	`string`	Nein	Ja	—
`permissionActions`	`array<PermissionActionSelection>`	Nein	Nein	—
`permissionActions[].permissionId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`permissionActions[].actionId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/Role/{id}/dependencies

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/role.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/Role/permission-action-templates

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /auth/role.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

Laufzeitumgebung und Zugangsschlüssel `RuntimeAdmin`

GET /api/runtime/audit

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/audit.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`page`	query	`integer \| string (int32)`	Nein	—
`pageSize`	query	`integer \| string (int32)`	Nein	—
`action`	query	`string`	Nein	—
`keyword`	query	`string`	Nein	—
`from`	query	`string (date-time)`	Nein	—
`to`	query	`string (date-time)`	Nein	—
`result`	query	`string`	Nein	—
`actor`	query	`string`	Nein	—
`dbManagementId`	query	`integer \| string (int32)`	Nein	—
`accessKeyId`	query	`integer \| string (int32)`	Nein	—
`toolName`	query	`string`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/runtime/audit/daily-summary

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/audit.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`days`	query	`integer \| string (int32)`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/runtime/audit/export

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/audit.export

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`Page`	query	`integer \| string (int32)`	Nein	—
`PageSize`	query	`integer \| string (int32)`	Nein	—
`Action`	query	`string`	Nein	—
`Keyword`	query	`string`	Nein	—
`From`	query	`string (date-time)`	Nein	—
`To`	query	`string (date-time)`	Nein	—
`Result`	query	`string`	Nein	—
`Actor`	query	`string`	Nein	—
`DbManagementId`	query	`integer \| string (int32)`	Nein	—
`AccessKeyId`	query	`integer \| string (int32)`	Nein	—
`ToolName`	query	`string`	Nein	—
`format`	query	`string`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/runtime/audit/retention

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/audit.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

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

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/audit.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

POST /api/runtime/audit/retention/execute

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/audit.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/runtime/mcp-keys

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/mcp-keys.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`[].id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`[].name`	`string`	Nein	Nein	—
`[].keyPrefix`	`string`	Nein	Nein	—
`[].isActive`	`boolean`	Nein	Nein	—
`[].expiresAt`	`string (date-time)`	Nein	Ja	—
`[].lastUsedAt`	`string (date-time)`	Nein	Ja	—
`[].allowedTools`	`string`	Nein	Ja	—
`[].corsAllowedOrigins`	`string`	Nein	Ja	—
`[].sqlProvider`	`string`	Nein	Ja	—
`[].dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`[].dbManagementName`	`string`	Nein	Ja	—
`[].isExpired`	`boolean`	Nein	Nein	—
`[].isExpiringSoon`	`boolean`	Nein	Nein	—
`[].tableWhitelist`	`string`	Nein	Ja	—
`[].createdAt`	`string (date-time)`	Nein	Nein	—
`[].rateLimitMode`	`McpKeyRateLimitMode`	Nein	Nein	—
`[].permitLimitOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`[].windowSecondsOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`[].effectivePermitLimit`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`[].effectiveWindowSeconds`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`[].isBootstrapManaged`	`boolean`	Nein	Nein	—

POST /api/runtime/mcp-keys

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/mcp-keys.create

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`name`	`string`	Nein	Nein	—
`expiresAt`	`string (date-time)`	Nein	Ja	—
`allowedTools`	`string`	Nein	Ja	—
`corsAllowedOrigins`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Nein	Ja	—
`rateLimitMode`	`McpKeyRateLimitMode`	Nein	Nein	—
`permitLimitOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`keyPrefix`	`string`	Nein	Nein	—
`plaintextKey`	`string`	Nein	Nein	—
`expiresAt`	`string (date-time)`	Nein	Ja	—
`allowedTools`	`string`	Nein	Ja	—
`corsAllowedOrigins`	`string`	Nein	Ja	—
`sqlProvider`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Nein	Ja	—
`rateLimitMode`	`McpKeyRateLimitMode`	Nein	Nein	—
`permitLimitOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$

`400` Ungültige Anfrage

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

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

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/mcp-keys.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`name`	`string`	Nein	Nein	—
`expiresAt`	`string (date-time)`	Nein	Ja	—
`allowedTools`	`string`	Nein	Ja	—
`corsAllowedOrigins`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Nein	Ja	—
`rateLimitMode`	`McpKeyRateLimitMode`	Nein	Nein	—
`permitLimitOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`keyPrefix`	`string`	Nein	Nein	—
`isActive`	`boolean`	Nein	Nein	—
`expiresAt`	`string (date-time)`	Nein	Ja	—
`lastUsedAt`	`string (date-time)`	Nein	Ja	—
`allowedTools`	`string`	Nein	Ja	—
`corsAllowedOrigins`	`string`	Nein	Ja	—
`sqlProvider`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`dbManagementName`	`string`	Nein	Ja	—
`isExpired`	`boolean`	Nein	Nein	—
`isExpiringSoon`	`boolean`	Nein	Nein	—
`tableWhitelist`	`string`	Nein	Ja	—
`createdAt`	`string (date-time)`	Nein	Nein	—
`rateLimitMode`	`McpKeyRateLimitMode`	Nein	Nein	—
`permitLimitOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`effectivePermitLimit`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`effectiveWindowSeconds`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`isBootstrapManaged`	`boolean`	Nein	Nein	—

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

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

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/mcp-keys.create

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`name`	`string`	Nein	Nein	—
`expiresAt`	`string (date-time)`	Nein	Ja	—

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`keyPrefix`	`string`	Nein	Nein	—
`plaintextKey`	`string`	Nein	Nein	—
`expiresAt`	`string (date-time)`	Nein	Ja	—
`allowedTools`	`string`	Nein	Ja	—
`corsAllowedOrigins`	`string`	Nein	Ja	—
`sqlProvider`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Nein	Ja	—
`rateLimitMode`	`McpKeyRateLimitMode`	Nein	Nein	—
`permitLimitOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

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

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/mcp-keys.revoke

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

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

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/mcp-keys.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int32)`	Ja	—

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`gracePeriodMinutes`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`expiresAt`	`string (date-time)`	Nein	Ja	—

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`id`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`name`	`string`	Nein	Nein	—
`keyPrefix`	`string`	Nein	Nein	—
`plaintextKey`	`string`	Nein	Nein	—
`expiresAt`	`string (date-time)`	Nein	Ja	—
`allowedTools`	`string`	Nein	Ja	—
`corsAllowedOrigins`	`string`	Nein	Ja	—
`sqlProvider`	`string`	Nein	Ja	—
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`tableWhitelist`	`string`	Nein	Ja	—
`rateLimitMode`	`McpKeyRateLimitMode`	Nein	Nein	—
`permitLimitOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`windowSecondsOverride`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$

`404` Nicht gefunden

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`type`	`string`	Nein	Ja	—
`title`	`string`	Nein	Ja	—
`status`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`detail`	`string`	Nein	Ja	—
`instance`	`string`	Nein	Ja	—

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

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/mcp-keys.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`dbManagementId`	query	`integer \| string (int32)`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

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

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/mcp-keys.create, /runtime/db-management.create, /runtime/db-management.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`dbSettingMode`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`dbManagementId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$
`sqlProvider`	`null \| SqlAgentToolType`	Nein	Nein	—
`host`	`string`	Nein	Ja	—
`port`	`string`	Nein	Ja	—
`username`	`string`	Nein	Ja	—
`password`	`string`	Nein	Ja	—
`database`	`string`	Nein	Ja	—
`extraSettings`	`string`	Nein	Ja	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/runtime/operability/db-health

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/operability.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/runtime/operability/deliveries

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/operability.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`limit`	query	`integer \| string (int32)`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

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

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/operability.edit

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`id`	path	`integer (int64)`	Ja	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/runtime/operability/key-usage

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/operability.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`From`	query	`string (date-time)`	Nein	—
`To`	query	`string (date-time)`	Nein	—
`DbManagementId`	query	`integer \| string (int32)`	Nein	—
`AccessKeyId`	query	`integer \| string (int32)`	Nein	—
`ToolName`	query	`string`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

GET /api/runtime/operability/metrics

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/operability.view

Pfad- und Abfrageparameter

Feld	Position	Typ	Pflichtfeld	Beschreibung und Einschränkungen
`From`	query	`string (date-time)`	Nein	—
`To`	query	`string (date-time)`	Nein	—
`DbManagementId`	query	`integer \| string (int32)`	Nein	—
`AccessKeyId`	query	`integer \| string (int32)`	Nein	—
`ToolName`	query	`string`	Nein	—

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

Laufzeitdiagnose `RuntimeDoctor`

GET /api/runtime/operability/doctor

Authentifizierung: AdminBearer / ManagementApiKey

Erforderliche Berechtigung: /runtime/operability.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`overallStatus`	`string`	Ja	Nein	—
`environment`	`string`	Ja	Nein	—
`deploymentMode`	`string`	Ja	Nein	—
`generatedAtUtc`	`string (date-time)`	Ja	Nein	—
`checks`	`array<RuntimeDoctorCheck>`	Ja	Nein	—
`checks[].id`	`string`	Ja	Nein	—
`checks[].category`	`string`	Ja	Nein	—
`checks[].status`	`string`	Ja	Nein	—
`checks[].title`	`string`	Ja	Nein	—
`checks[].detail`	`string`	Ja	Nein	—
`checks[].action`	`string`	Nein	Ja	—

Sicherheitsrichtlinien `SecurityPolicy`

GET /api/runtime/security

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/security.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

PUT /api/runtime/security

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/security.edit

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`queryMaxRows`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`queryTimeoutSeconds`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`requireWhereForUpdate`	`boolean`	Nein	Nein	—
`requireWhereForDelete`	`boolean`	Nein	Nein	—
`allowFullTableUpdate`	`boolean`	Nein	Nein	—
`allowFullTableDelete`	`boolean`	Nein	Nein	—
`dmlMaxAffectedRows`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`keyPermitLimit`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`keyWindowSeconds`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`maxConcurrentSql`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`updatedAt`	`string (date-time)`	Nein	Ja	—
`updatedBy`	`string`	Nein	Ja	—

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

SQL-Analyse `SqlExplain`

POST /api/runtime/security/sql-explain

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/security.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

application/json · Pflichtfeld: Ja

Feld	Typ	Pflichtfeld	Nullwert zulässig	Beschreibung und Einschränkungen
`dbManagementId`	`integer \| string (int32)`	Nein	Nein	Muster: ^-?(?:0\|[1-9]\d*)$
`sql`	`string`	Nein	Nein	—
`statementType`	`string`	Nein	Nein	—
`sourceDialect`	`string`	Nein	Ja	—
`accessKeyId`	`integer \| string (int32)`	Nein	Ja	Muster: ^-?(?:0\|[1-9]\d*)$

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

SQL-Analysekontext `SqlExplainContext`

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

Authentifizierung: AdminBearer

Erforderliche Berechtigung: /runtime/security.view

Pfad- und Abfrageparameter

Keine

Anfrageinhalt

Keine

Antwortmodelle

`200` Erfolgreich

Für diese Antwort ist serverseitig noch kein Modell definiert

Authentifizierung und Konten Auth

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

200 Erfolgreich

Pfad- und Abfrageparameter

Anfrageinhalt

Antwortmodelle

Authentifizierung und Konten `Auth`

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

`200` Erfolgreich

Status der Zugangsdaten `Credential`

`200` Erfolgreich

Benutzerdefinierte SQL-Werkzeuge `CustomSqlTool`

`200` Erfolgreich

`201` Erstellt

`400` Ungültige Anfrage

`204` Erfolgreich, ohne Inhalt

`404` Nicht gefunden

`200` Erfolgreich

`404` Nicht gefunden

`200` Erfolgreich

`400` Ungültige Anfrage

`404` Nicht gefunden

`200` Erfolgreich

`404` Nicht gefunden

`200` Erfolgreich

`404` Nicht gefunden