Each operation expands to show parameters, the request-body property table and response models, including nested fields, types, Required and Nullable. This is generated from the .NET Controller and DTO metadata, not manually retyped.
Start by creating a System-to-System key in the Admin UI.
Authentication and accounts Auth
GET /api/Auth/account
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
PUT /api/Auth/account
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
username | string | Yes | No | Maximum length: 100 |
email | string | Yes | No | Maximum length: 320 |
Response models
200 OK
Response model not declared by the controller
PUT /api/Auth/account/password
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
currentPassword | string | Yes | No | — |
newPassword | string | Yes | No | Minimum length: 8 |
Response models
200 OK
Response model not declared by the controller
GET /api/Auth/first-run
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/forgot-password
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
email | string | Yes | No | — |
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/mfa/confirm
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
code | string | Yes | No | — |
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/mfa/disable
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
code | string | Yes | No | — |
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/mfa/setup
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/Auth/mfa/status
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/mfa/verify
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
code | string | Yes | No | — |
Response models
200 OK
Response model not declared by the controller
GET /api/Auth/oidc/callback
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/oidc/exchange
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
code | string | Yes | No | — |
Response models
200 OK
Response model not declared by the controller
GET /api/Auth/oidc/login
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/Auth/oidc/status
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/refresh-token
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/reset-password
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
token | string | Yes | No | — |
newPassword | string | Yes | No | Minimum length: 8 |
Response models
200 OK
Response model not declared by the controller
DELETE /api/Auth/sessions
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/Auth/sessions
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
DELETE /api/Auth/sessions/{sessionId}
Authentication: —
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
sessionId | path | string (uuid) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/sign-in
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
email | string | Yes | No | — |
password | string | Yes | No | — |
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/sign-out
Authentication: —
Path and query parameters
None
Request body
application/json · Required: No
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
<variant2>.refreshToken | string | No | Yes | — |
Response models
200 OK
Response model not declared by the controller
POST /api/Auth/sign-up
Authentication: —
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
email | string | Yes | No | — |
password | string | Yes | No | — |
Response models
200 OK
Response model not declared by the controller
Credential status Credential
GET /api/Credential/status
Authentication: —
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
Custom SQL tools CustomSqlTool
GET /api/CustomSqlTool
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.view
Path and query parameters
None
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
[].id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].name | string | No | No | — |
[].description | string | No | No | — |
[].sqlTemplate | string | No | No | — |
[].type | string | No | No | — |
[].parametersJson | string | No | Yes | — |
[].dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].status | string | No | No | — |
[].publishedRevisionId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].publishedIdentity | string | No | Yes | — |
[].createdAt | string (date-time) | No | No | — |
[].lastModifiedAt | string (date-time) | No | Yes | — |
POST /api/CustomSqlTool
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.create
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
description | string | No | No | — |
sqlTemplate | string | No | No | — |
type | string | No | No | — |
parametersJson | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
status | string | No | No | — |
publishedRevisionId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
publishedIdentity | string | No | Yes | — |
createdAt | string (date-time) | No | No | — |
lastModifiedAt | string (date-time) | No | Yes | — |
Response models
201 Created
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
description | string | No | No | — |
sqlTemplate | string | No | No | — |
type | string | No | No | — |
parametersJson | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
status | string | No | No | — |
publishedRevisionId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
publishedIdentity | string | No | Yes | — |
createdAt | string (date-time) | No | No | — |
lastModifiedAt | string (date-time) | No | Yes | — |
400 Bad request
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
DELETE /api/CustomSqlTool/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.delete
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
204 No content
No response body
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
GET /api/CustomSqlTool/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
description | string | No | No | — |
sqlTemplate | string | No | No | — |
type | string | No | No | — |
parametersJson | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
status | string | No | No | — |
publishedRevisionId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
publishedIdentity | string | No | Yes | — |
createdAt | string (date-time) | No | No | — |
lastModifiedAt | string (date-time) | No | Yes | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
PUT /api/CustomSqlTool/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
description | string | No | No | — |
sqlTemplate | string | No | No | — |
type | string | No | No | — |
parametersJson | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
status | string | No | No | — |
publishedRevisionId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
publishedIdentity | string | No | Yes | — |
createdAt | string (date-time) | No | No | — |
lastModifiedAt | string (date-time) | No | Yes | — |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
description | string | No | No | — |
sqlTemplate | string | No | No | — |
type | string | No | No | — |
parametersJson | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
status | string | No | No | — |
publishedRevisionId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
publishedIdentity | string | No | Yes | — |
createdAt | string (date-time) | No | No | — |
lastModifiedAt | string (date-time) | No | Yes | — |
400 Bad request
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
POST /api/CustomSqlTool/{id}/disable
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
description | string | No | No | — |
sqlTemplate | string | No | No | — |
type | string | No | No | — |
parametersJson | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
status | string | No | No | — |
publishedRevisionId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
publishedIdentity | string | No | Yes | — |
createdAt | string (date-time) | No | No | — |
lastModifiedAt | string (date-time) | No | Yes | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
GET /api/CustomSqlTool/{id}/impact
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
toolId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
draftDbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
draftDatabaseName | string | No | Yes | — |
publishedDbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
publishedDatabaseName | string | No | Yes | — |
currentlyExposedToKeys | array<CustomSqlToolImpactKey> | No | No | — |
currentlyExposedToKeys[].id | integer | string (int32) | Yes | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
currentlyExposedToKeys[].name | string | Yes | No | — |
currentlyExposedToKeys[].keyPrefix | string | Yes | No | — |
wouldExposeToKeys | array<CustomSqlToolImpactKey> | No | No | — |
wouldExposeToKeys[].id | integer | string (int32) | Yes | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
wouldExposeToKeys[].name | string | Yes | No | — |
wouldExposeToKeys[].keyPrefix | string | Yes | No | — |
breakingChanges | array<string> | No | No | — |
sqlChanged | boolean | No | No | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
POST /api/CustomSqlTool/{id}/publish
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
description | string | No | No | — |
sqlTemplate | string | No | No | — |
type | string | No | No | — |
parametersJson | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
status | string | No | No | — |
publishedRevisionId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
publishedIdentity | string | No | Yes | — |
createdAt | string (date-time) | No | No | — |
lastModifiedAt | string (date-time) | No | Yes | — |
400 Bad request
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
409 Conflict
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
GET /api/CustomSqlTool/{id}/revisions
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
[].id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].customSqlToolId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].revisionNumber | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].name | string | No | No | — |
[].description | string | No | No | — |
[].sqlTemplate | string | No | No | — |
[].type | string | No | No | — |
[].parametersJson | string | No | Yes | — |
[].diffJson | string | No | No | — |
[].publishedBy | string | No | Yes | — |
[].publishedAt | string (date-time) | No | No | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
POST /api/CustomSqlTool/{id}/rollback/{revisionId}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
revisionId | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
description | string | No | No | — |
sqlTemplate | string | No | No | — |
type | string | No | No | — |
parametersJson | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
status | string | No | No | — |
publishedRevisionId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
publishedIdentity | string | No | Yes | — |
createdAt | string (date-time) | No | No | — |
lastModifiedAt | string (date-time) | No | Yes | — |
400 Bad request
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
409 Conflict
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
POST /api/CustomSqlTool/test-execute
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/custom-tools.edit
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
toolId | integer | string (int32) | Yes | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
parameters | object | No | Yes | — |
Response models
200 OK
Response model not declared by the controller
Database management DbManagement
GET /api/DbManagement
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management.view
Path and query parameters
None
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
[].id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].name | string | No | No | — |
[].sqlProvider | string | No | No | — |
[].host | string | No | No | — |
[].port | string | No | No | — |
[].username | string | No | No | — |
[].database | string | No | No | — |
[].extraSettings | string | No | Yes | — |
[].createdAt | string | No | No | — |
[].createdBy | string | No | No | — |
[].updatedAt | string | No | No | — |
[].updatedBy | string | No | No | — |
[].isBootstrapManaged | boolean | No | No | — |
POST /api/DbManagement
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management.create
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
name | string | No | No | — |
sqlProvider | string | No | No | — |
host | string | No | No | — |
port | string | No | No | — |
username | string | No | No | — |
password | string | No | No | — |
database | string | No | No | — |
extraSettings | string | No | Yes | — |
createdBy | string | No | No | — |
updatedBy | string | No | No | — |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
sqlProvider | string | No | No | — |
host | string | No | No | — |
port | string | No | No | — |
username | string | No | No | — |
database | string | No | No | — |
extraSettings | string | No | Yes | — |
createdAt | string | No | No | — |
createdBy | string | No | No | — |
updatedAt | string | No | No | — |
updatedBy | string | No | No | — |
isBootstrapManaged | boolean | No | No | — |
400 Bad request
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
DELETE /api/DbManagement/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management.delete
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
204 No content
No response body
GET /api/DbManagement/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
sqlProvider | string | No | No | — |
host | string | No | No | — |
port | string | No | No | — |
username | string | No | No | — |
database | string | No | No | — |
extraSettings | string | No | Yes | — |
createdAt | string | No | No | — |
createdBy | string | No | No | — |
updatedAt | string | No | No | — |
updatedBy | string | No | No | — |
isBootstrapManaged | boolean | No | No | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
PUT /api/DbManagement/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
name | string | No | No | — |
sqlProvider | string | No | No | — |
host | string | No | No | — |
port | string | No | No | — |
username | string | No | No | — |
password | string | No | No | — |
database | string | No | No | — |
extraSettings | string | No | Yes | — |
createdBy | string | No | No | — |
updatedBy | string | No | No | — |
Response models
204 No content
No response body
400 Bad request
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
GET /api/DbManagement/{id}/columns
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
schema | query | string | No | — |
table | query | string | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/DbManagement/{id}/schemas
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/DbManagement/{id}/tables
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
schema | query | string | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
Semantic metadata DbSemantic
POST /api/DbSemantic
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management/semantic.edit
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
schemaName | string | No | Yes | — |
tableName | string | No | No | — |
columnName | string | No | Yes | — |
description | string | No | Yes | — |
displayName | string | No | Yes | — |
synonyms | array<string> | No | Yes | — |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
schemaName | string | No | Yes | — |
tableName | string | No | No | — |
columnName | string | No | Yes | — |
description | string | No | Yes | — |
displayName | string | No | Yes | — |
synonyms | array<string> | No | No | — |
createdAt | string | No | No | — |
updatedAt | string | No | No | — |
GET /api/DbSemantic/{dbManagementId}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management/semantic.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
dbManagementId | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
[].id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].schemaName | string | No | Yes | — |
[].tableName | string | No | No | — |
[].columnName | string | No | Yes | — |
[].description | string | No | Yes | — |
[].displayName | string | No | Yes | — |
[].synonyms | array<string> | No | No | — |
[].createdAt | string | No | No | — |
[].updatedAt | string | No | No | — |
GET /api/DbSemantic/{dbManagementId}/model
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management/semantic.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
dbManagementId | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
dbManagementId | integer | string (int32) | Yes | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
entities | array<DbSemanticVM> | Yes | No | — |
entities[].id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
entities[].dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
entities[].schemaName | string | No | Yes | — |
entities[].tableName | string | No | No | — |
entities[].columnName | string | No | Yes | — |
entities[].description | string | No | Yes | — |
entities[].displayName | string | No | Yes | — |
entities[].synonyms | array<string> | No | No | — |
entities[].createdAt | string | No | No | — |
entities[].updatedAt | string | No | No | — |
relationships | array<DbSemanticRelationshipModel> | Yes | No | — |
relationships[].id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
relationships[].dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
relationships[].name | string | No | No | — |
relationships[].sourceSchema | string | No | Yes | — |
relationships[].sourceTable | string | No | No | — |
relationships[].sourceColumn | string | No | No | — |
relationships[].targetSchema | string | No | Yes | — |
relationships[].targetTable | string | No | No | — |
relationships[].targetColumn | string | No | No | — |
relationships[].cardinality | string | No | No | — |
relationships[].direction | string | No | No | — |
relationships[].description | string | No | Yes | — |
metrics | array<DbSemanticMetricModel> | Yes | No | — |
metrics[].id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
metrics[].dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
metrics[].schemaName | string | No | Yes | — |
metrics[].tableName | string | No | No | — |
metrics[].name | string | No | No | — |
metrics[].displayName | string | No | Yes | — |
metrics[].description | string | No | Yes | — |
metrics[].formula | string | No | No | — |
metrics[].aggregation | string | No | No | — |
metrics[].grain | string | No | Yes | — |
metrics[].filter | string | No | Yes | — |
metrics[].synonyms | array<string> | No | Yes | — |
metrics[].executable | boolean | No | No | — |
DELETE /api/DbSemantic/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management/semantic.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/DbSemantic/metric
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management/semantic.edit
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
schemaName | string | No | Yes | — |
tableName | string | No | No | — |
name | string | No | No | — |
displayName | string | No | Yes | — |
description | string | No | Yes | — |
formula | string | No | No | — |
aggregation | string | No | No | — |
grain | string | No | Yes | — |
filter | string | No | Yes | — |
synonyms | array<string> | No | Yes | — |
executable | boolean | No | No | — |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
schemaName | string | No | Yes | — |
tableName | string | No | No | — |
name | string | No | No | — |
displayName | string | No | Yes | — |
description | string | No | Yes | — |
formula | string | No | No | — |
aggregation | string | No | No | — |
grain | string | No | Yes | — |
filter | string | No | Yes | — |
synonyms | array<string> | No | Yes | — |
executable | boolean | No | No | — |
DELETE /api/DbSemantic/metric/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management/semantic.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/DbSemantic/relationship
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management/semantic.edit
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
sourceSchema | string | No | Yes | — |
sourceTable | string | No | No | — |
sourceColumn | string | No | No | — |
targetSchema | string | No | Yes | — |
targetTable | string | No | No | — |
targetColumn | string | No | No | — |
cardinality | string | No | No | — |
direction | string | No | No | — |
description | string | No | Yes | — |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
sourceSchema | string | No | Yes | — |
sourceTable | string | No | No | — |
sourceColumn | string | No | No | — |
targetSchema | string | No | Yes | — |
targetTable | string | No | No | — |
targetColumn | string | No | No | — |
cardinality | string | No | No | — |
direction | string | No | No | — |
description | string | No | Yes | — |
DELETE /api/DbSemantic/relationship/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/db-management/semantic.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer | string (int32) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
Management API keys ManagementApiKeys
GET /api/runtime/management-api-keys
Authentication: AdminBearer
Permission: /runtime/security.edit
Path and query parameters
None
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
[].id | integer | string (int32) | Yes | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].name | string | Yes | No | — |
[].keyPrefix | string | Yes | No | — |
[].permissions | array<string> | Yes | No | — |
[].createdAt | string (date-time) | Yes | No | — |
[].expiresAt | string (date-time) | Yes | No | — |
[].lastUsedAt | string (date-time) | Yes | Yes | — |
[].revokedAt | string (date-time) | Yes | Yes | — |
[].createdBy | string | Yes | Yes | — |
POST /api/runtime/management-api-keys
Authentication: AdminBearer
Permission: /runtime/security.edit
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
name | string | Yes | No | — |
expiresAt | string (date-time) | Yes | No | — |
permissions | array<string> | Yes | No | — |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
key | ManagementApiKeyView | Yes | No | — |
key.id | integer | string (int32) | Yes | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
key.name | string | Yes | No | — |
key.keyPrefix | string | Yes | No | — |
key.permissions | array<string> | Yes | No | — |
key.createdAt | string (date-time) | Yes | No | — |
key.expiresAt | string (date-time) | Yes | No | — |
key.lastUsedAt | string (date-time) | Yes | Yes | — |
key.revokedAt | string (date-time) | Yes | Yes | — |
key.createdBy | string | Yes | Yes | — |
plaintextKey | string | Yes | No | — |
400 Bad request
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
POST /api/runtime/management-api-keys/{id}/revoke
Authentication: AdminBearer
Permission: /runtime/security.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
None
Response models
204 No content
No response body
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
POST /api/runtime/management-api-keys/{id}/rotate
Authentication: AdminBearer
Permission: /runtime/security.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
key | ManagementApiKeyView | Yes | No | — |
key.id | integer | string (int32) | Yes | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
key.name | string | Yes | No | — |
key.keyPrefix | string | Yes | No | — |
key.permissions | array<string> | Yes | No | — |
key.createdAt | string (date-time) | Yes | No | — |
key.expiresAt | string (date-time) | Yes | No | — |
key.lastUsedAt | string (date-time) | Yes | Yes | — |
key.revokedAt | string (date-time) | Yes | Yes | — |
key.createdBy | string | Yes | Yes | — |
plaintextKey | string | Yes | No | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
409 Conflict
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
GET /api/runtime/management-api-keys/permissions
Authentication: AdminBearer
Permission: /runtime/security.edit
Path and query parameters
None
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
(body) | array<string> | — | No | — |
Client configuration McpClientConfig
GET /api/runtime/client-config
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/mcp-keys.view
Path and query parameters
None
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
mcpEndpoint | string | Yes | No | — |
Users Member
GET /api/Member
Authentication: AdminBearer
Permission: /auth/user.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
Search | query | string | No | — |
IsActive | query | boolean | No | — |
RoleId | query | integer | string (int32) | No | — |
Page | query | integer | string (int32) | No | — |
PageSize | query | integer | string (int32) | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/Member
Authentication: AdminBearer
Permission: /auth/user.create
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
email | string | Yes | No | — |
username | string | No | Yes | — |
password | string | Yes | No | — |
assignAllRoles | boolean | No | No | — |
roleIds | array<integer | string (int32)> | No | No | — |
Response models
200 OK
Response model not declared by the controller
DELETE /api/Member/{id}
Authentication: AdminBearer
Permission: /auth/user.delete
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
PUT /api/Member/{id}/password-change-required
Authentication: AdminBearer
Permission: /auth/user.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
required | boolean | No | No | — |
Response models
200 OK
Response model not declared by the controller
PUT /api/Member/{id}/roles
Authentication: AdminBearer
Permission: /auth/user.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
roleIds | array<integer | string (int32)> | No | No | — |
Response models
200 OK
Response model not declared by the controller
DELETE /api/Member/{id}/sessions
Authentication: AdminBearer
Permission: /auth/user.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
PUT /api/Member/{id}/status
Authentication: AdminBearer
Permission: /auth/user.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
isActive | boolean | No | No | — |
Response models
200 OK
Response model not declared by the controller
Roles and permissions Role
GET /api/Role
Authentication: AdminBearer
Permission: /auth/role.view
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/Role
Authentication: AdminBearer
Permission: /auth/role.create
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
name | string | Yes | No | — |
description | string | No | Yes | — |
permissionActions | array<PermissionActionSelection> | No | No | — |
permissionActions[].permissionId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
permissionActions[].actionId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
Response models
200 OK
Response model not declared by the controller
DELETE /api/Role/{id}
Authentication: AdminBearer
Permission: /auth/role.delete
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
force | query | boolean | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
PUT /api/Role/{id}
Authentication: AdminBearer
Permission: /auth/role.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
name | string | Yes | No | — |
description | string | No | Yes | — |
permissionActions | array<PermissionActionSelection> | No | No | — |
permissionActions[].permissionId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
permissionActions[].actionId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
Response models
200 OK
Response model not declared by the controller
GET /api/Role/{id}/dependencies
Authentication: AdminBearer
Permission: /auth/role.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/Role/permission-action-templates
Authentication: AdminBearer
Permission: /auth/role.view
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
Runtime and access keys RuntimeAdmin
GET /api/runtime/audit
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/audit.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
page | query | integer | string (int32) | No | — |
pageSize | query | integer | string (int32) | No | — |
action | query | string | No | — |
keyword | query | string | No | — |
from | query | string (date-time) | No | — |
to | query | string (date-time) | No | — |
result | query | string | No | — |
actor | query | string | No | — |
dbManagementId | query | integer | string (int32) | No | — |
accessKeyId | query | integer | string (int32) | No | — |
toolName | query | string | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/runtime/audit/daily-summary
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/audit.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
days | query | integer | string (int32) | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/runtime/audit/export
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/audit.export
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
Page | query | integer | string (int32) | No | — |
PageSize | query | integer | string (int32) | No | — |
Action | query | string | No | — |
Keyword | query | string | No | — |
From | query | string (date-time) | No | — |
To | query | string (date-time) | No | — |
Result | query | string | No | — |
Actor | query | string | No | — |
DbManagementId | query | integer | string (int32) | No | — |
AccessKeyId | query | integer | string (int32) | No | — |
ToolName | query | string | No | — |
format | query | string | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/runtime/audit/retention
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/audit.view
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/runtime/audit/retention/dry-run
Authentication: AdminBearer
Permission: /runtime/audit.edit
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/runtime/audit/retention/execute
Authentication: AdminBearer
Permission: /runtime/audit.edit
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/runtime/mcp-keys
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/mcp-keys.view
Path and query parameters
None
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
[].id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].name | string | No | No | — |
[].keyPrefix | string | No | No | — |
[].isActive | boolean | No | No | — |
[].expiresAt | string (date-time) | No | Yes | — |
[].lastUsedAt | string (date-time) | No | Yes | — |
[].allowedTools | string | No | Yes | — |
[].corsAllowedOrigins | string | No | Yes | — |
[].sqlProvider | string | No | Yes | — |
[].dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].dbManagementName | string | No | Yes | — |
[].isExpired | boolean | No | No | — |
[].isExpiringSoon | boolean | No | No | — |
[].tableWhitelist | string | No | Yes | — |
[].createdAt | string (date-time) | No | No | — |
[].rateLimitMode | McpKeyRateLimitMode | No | No | — |
[].permitLimitOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].windowSecondsOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].effectivePermitLimit | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].effectiveWindowSeconds | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
[].isBootstrapManaged | boolean | No | No | — |
POST /api/runtime/mcp-keys
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/mcp-keys.create
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
name | string | No | No | — |
expiresAt | string (date-time) | No | Yes | — |
allowedTools | string | No | Yes | — |
corsAllowedOrigins | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
tableWhitelist | string | No | Yes | — |
rateLimitMode | McpKeyRateLimitMode | No | No | — |
permitLimitOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
windowSecondsOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
keyPrefix | string | No | No | — |
plaintextKey | string | No | No | — |
expiresAt | string (date-time) | No | Yes | — |
allowedTools | string | No | Yes | — |
corsAllowedOrigins | string | No | Yes | — |
sqlProvider | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
tableWhitelist | string | No | Yes | — |
rateLimitMode | McpKeyRateLimitMode | No | No | — |
permitLimitOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
windowSecondsOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
400 Bad request
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
PUT /api/runtime/mcp-keys/{id}
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/mcp-keys.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
name | string | No | No | — |
expiresAt | string (date-time) | No | Yes | — |
allowedTools | string | No | Yes | — |
corsAllowedOrigins | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
tableWhitelist | string | No | Yes | — |
rateLimitMode | McpKeyRateLimitMode | No | No | — |
permitLimitOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
windowSecondsOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
keyPrefix | string | No | No | — |
isActive | boolean | No | No | — |
expiresAt | string (date-time) | No | Yes | — |
lastUsedAt | string (date-time) | No | Yes | — |
allowedTools | string | No | Yes | — |
corsAllowedOrigins | string | No | Yes | — |
sqlProvider | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
dbManagementName | string | No | Yes | — |
isExpired | boolean | No | No | — |
isExpiringSoon | boolean | No | No | — |
tableWhitelist | string | No | Yes | — |
createdAt | string (date-time) | No | No | — |
rateLimitMode | McpKeyRateLimitMode | No | No | — |
permitLimitOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
windowSecondsOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
effectivePermitLimit | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
effectiveWindowSeconds | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
isBootstrapManaged | boolean | No | No | — |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
POST /api/runtime/mcp-keys/{id}/clone
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/mcp-keys.create
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
name | string | No | No | — |
expiresAt | string (date-time) | No | Yes | — |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
keyPrefix | string | No | No | — |
plaintextKey | string | No | No | — |
expiresAt | string (date-time) | No | Yes | — |
allowedTools | string | No | Yes | — |
corsAllowedOrigins | string | No | Yes | — |
sqlProvider | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
tableWhitelist | string | No | Yes | — |
rateLimitMode | McpKeyRateLimitMode | No | No | — |
permitLimitOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
windowSecondsOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
POST /api/runtime/mcp-keys/{id}/revoke
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/mcp-keys.revoke
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/runtime/mcp-keys/{id}/rotate
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/mcp-keys.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int32) | Yes | — |
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
gracePeriodMinutes | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
expiresAt | string (date-time) | No | Yes | — |
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
id | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
name | string | No | No | — |
keyPrefix | string | No | No | — |
plaintextKey | string | No | No | — |
expiresAt | string (date-time) | No | Yes | — |
allowedTools | string | No | Yes | — |
corsAllowedOrigins | string | No | Yes | — |
sqlProvider | string | No | Yes | — |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
tableWhitelist | string | No | Yes | — |
rateLimitMode | McpKeyRateLimitMode | No | No | — |
permitLimitOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
windowSecondsOverride | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
404 Not found
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
type | string | No | Yes | — |
title | string | No | Yes | — |
status | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
detail | string | No | Yes | — |
instance | string | No | Yes | — |
GET /api/runtime/mcp-keys/available-tools
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/mcp-keys.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
dbManagementId | query | integer | string (int32) | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/runtime/mcp-keys/test-db-connection
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/mcp-keys.create, /runtime/db-management.create, /runtime/db-management.edit
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
dbSettingMode | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
dbManagementId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
sqlProvider | null | SqlAgentToolType | No | No | — |
host | string | No | Yes | — |
port | string | No | Yes | — |
username | string | No | Yes | — |
password | string | No | Yes | — |
database | string | No | Yes | — |
extraSettings | string | No | Yes | — |
Response models
200 OK
Response model not declared by the controller
GET /api/runtime/operability/db-health
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/operability.view
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/runtime/operability/deliveries
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/operability.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
limit | query | integer | string (int32) | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
POST /api/runtime/operability/deliveries/{id}/retry
Authentication: AdminBearer
Permission: /runtime/operability.edit
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
id | path | integer (int64) | Yes | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/runtime/operability/key-usage
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/operability.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
From | query | string (date-time) | No | — |
To | query | string (date-time) | No | — |
DbManagementId | query | integer | string (int32) | No | — |
AccessKeyId | query | integer | string (int32) | No | — |
ToolName | query | string | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
GET /api/runtime/operability/metrics
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/operability.view
Path and query parameters
| Property | Location | Type | Required | Description and constraints |
|---|---|---|---|---|
From | query | string (date-time) | No | — |
To | query | string (date-time) | No | — |
DbManagementId | query | integer | string (int32) | No | — |
AccessKeyId | query | integer | string (int32) | No | — |
ToolName | query | string | No | — |
Request body
None
Response models
200 OK
Response model not declared by the controller
Runtime diagnostics RuntimeDoctor
GET /api/runtime/operability/doctor
Authentication: AdminBearer / ManagementApiKey
Permission: /runtime/operability.view
Path and query parameters
None
Request body
None
Response models
200 OK
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
overallStatus | string | Yes | No | — |
environment | string | Yes | No | — |
deploymentMode | string | Yes | No | — |
generatedAtUtc | string (date-time) | Yes | No | — |
checks | array<RuntimeDoctorCheck> | Yes | No | — |
checks[].id | string | Yes | No | — |
checks[].category | string | Yes | No | — |
checks[].status | string | Yes | No | — |
checks[].title | string | Yes | No | — |
checks[].detail | string | Yes | No | — |
checks[].action | string | No | Yes | — |
Security policies SecurityPolicy
GET /api/runtime/security
Authentication: AdminBearer
Permission: /runtime/security.view
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller
PUT /api/runtime/security
Authentication: AdminBearer
Permission: /runtime/security.edit
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
queryMaxRows | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
queryTimeoutSeconds | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
requireWhereForUpdate | boolean | No | No | — |
requireWhereForDelete | boolean | No | No | — |
allowFullTableUpdate | boolean | No | No | — |
allowFullTableDelete | boolean | No | No | — |
dmlMaxAffectedRows | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
keyPermitLimit | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
keyWindowSeconds | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
maxConcurrentSql | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
updatedAt | string (date-time) | No | Yes | — |
updatedBy | string | No | Yes | — |
Response models
200 OK
Response model not declared by the controller
SQL explain SqlExplain
POST /api/runtime/security/sql-explain
Authentication: AdminBearer
Permission: /runtime/security.view
Path and query parameters
None
Request body
application/json · Required: Yes
| Property | Type | Required | Nullable | Description and constraints |
|---|---|---|---|---|
dbManagementId | integer | string (int32) | No | No | Pattern: ^-?(?:0|[1-9]\d*)$ |
sql | string | No | No | — |
statementType | string | No | No | — |
sourceDialect | string | No | Yes | — |
accessKeyId | integer | string (int32) | No | Yes | Pattern: ^-?(?:0|[1-9]\d*)$ |
Response models
200 OK
Response model not declared by the controller
SQL explain context SqlExplainContext
GET /api/runtime/security/sql-explain/context
Authentication: AdminBearer
Permission: /runtime/security.view
Path and query parameters
None
Request body
None
Response models
200 OK
Response model not declared by the controller