Management API
Authoring and administration API consumed by the OpenDBAPI web UI. Everything the UI does goes through it, so scripts can do the same.
- Base path:
/admin/api. The OpenAPI document is served at/admin/api/openapi.json. - Authenticate with a personal API token:
Authorization: Bearer odb_…. Browser sessions also send theX-XSRF-TOKENheader for writes. - Errors are RFC 9457 problems; see Errors.
- Published endpoints are not part of this API: each workspace documents its own at
/api/{workspace}/openapi.json.
84 paths, grouped by area.
activity
GET /admin/api/ws/{ws}/activity/log
Newest calls first; page with 'before' = ts of the last row
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
from | query | string (date-time) | no | |
to | query | string (date-time) | no | |
endpointId | query | string (uuid) | no | |
clientId | query | string | no | |
status | query | string | no | |
requestId | query | string | no | |
includeTryIt | query | boolean | no | |
before | query | string (date-time) | no | |
limit | query | integer (int32) | no |
Response 200: LogEntry[] (application/json)
GET /admin/api/ws/{ws}/activity/summary
Totals, calls per day, top and slowest endpoints, clients, addresses and errors; optionally one endpoint; Try-it calls hidden by default
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
from | query | string (date-time) | no | |
to | query | string (date-time) | no | |
includeTryIt | query | boolean | no | |
endpointId | query | string (uuid) | no |
Response 200: Summary (application/json)
alert-channels
GET /admin/api/ws/{ws}/alert-channels
Alert channels of the workspace
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: AlertChannel[] (application/json)
POST /admin/api/ws/{ws}/alert-channels
Add a webhook (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: SaveAlertChannel (application/json)
Response 201: AlertChannel (application/json)
PATCH /admin/api/ws/{ws}/alert-channels/{id}
Rename, change, enable or disable a webhook (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: SaveAlertChannel (application/json)
Response 200: AlertChannel (application/json)
DELETE /admin/api/ws/{ws}/alert-channels/{id}
Remove a webhook (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: no content
POST /admin/api/ws/{ws}/alert-channels/{id}:test
Send a test message now (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: AlertTestResult (application/json)
audit
GET /admin/api/audit
System-wide audit log, newest first (system admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
action | query | string | no | |
before | query | integer (int64) | no | |
limit | query | integer (int32) | no |
Response 200: AuditEntry[] (application/json)
GET /admin/api/ws/{ws}/audit
One workspace's audit log (workspace admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
action | query | string | no | |
before | query | integer (int64) | no | |
limit | query | integer (int32) | no |
Response 200: AuditEntry[] (application/json)
auth
POST /admin/api/auth/login
Sign in with a local account or an LDAP directory
Body: LoginRequest (application/json)
Response 200: no content
POST /admin/api/auth/logout
End the session
Response 200: no content
GET /admin/api/auth/providers
Sign-in methods to offer on the login page
Response 200: AuthProviders (application/json)
config
POST /admin/api/ws/{ws}/config:apply
Make the workspace match a YAML file in one transaction, then publish endpoints after their tests (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
environment | query | string | no | |
prune | query | boolean | no | |
publish | query | boolean | no | |
expectedDigest | query | string | no | Refuse with 409 plan_changed unless the plan still has this digest |
format | query | string | no |
Body: string (application/yaml)
Response 200: ConfigApplyResult (application/json)
POST /admin/api/ws/{ws}/config:plan
Compare a YAML file with the workspace without changing anything (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
environment | query | string | no | Maps logical datasource names |
prune | query | boolean | no | Delete what the file does not list |
publish | query | boolean | no | Publish endpoints whose metadata.state is live, disable those marked disabled |
format | query | string | no |
Body: string (application/yaml)
Response 200: ConfigPlan (application/json)
GET /admin/api/ws/{ws}/environments
Environments and their datasource bindings (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: ConfigEnvironment[] (/)
PUT /admin/api/ws/{ws}/environments/{name}
Create or replace an environment (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
name | path | string | yes |
Body: PutEnvironment (application/json)
Response 200: ConfigEnvironment (/)
DELETE /admin/api/ws/{ws}/environments/{name}
Delete an environment (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
name | path | string | yes |
Response 204: no content
data-policies
GET /admin/api/ws/{ws}/data-policies
Data policies, optionally of one datasource or endpoint
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
datasourceId | query | string (uuid) | no | |
endpointId | query | string (uuid) | no |
Response 200: DataPolicy[] (application/json)
POST /admin/api/ws/{ws}/data-policies
Add a mask or row filter (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: SaveDataPolicy (application/json)
Response 201: DataPolicy (application/json)
PATCH /admin/api/ws/{ws}/data-policies/{id}
Change a policy's column, mask, attribute or exemptions (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: SaveDataPolicy (application/json)
Response 200: DataPolicy (application/json)
DELETE /admin/api/ws/{ws}/data-policies/{id}
Remove a policy (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: no content
datasources
GET /admin/api/ws/{ws}/datasources
Datasources of the workspace (any member)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: DatasourceView[] (application/json)
POST /admin/api/ws/{ws}/datasources
Add a datasource (workspace admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: SaveDatasource (application/json)
Response 201: DatasourceView (application/json)
GET /admin/api/ws/{ws}/datasources/{id}
One datasource (any member)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: DatasourceView (application/json)
PATCH /admin/api/ws/{ws}/datasources/{id}
Change a datasource; omit password to keep it (workspace admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: SaveDatasource (application/json)
Response 200: DatasourceView (application/json)
DELETE /admin/api/ws/{ws}/datasources/{id}
Delete a datasource no endpoint uses (workspace admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: no content
POST /admin/api/ws/{ws}/datasources/{id}:test
Check a saved datasource can connect (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: DatasourceTestResult (application/json)
GET /admin/api/ws/{ws}/datasources/{id}/columns
Columns of one table (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes | |
schema | query | string | no | |
table | query | string | yes |
Response 200: TableColumn[] (application/json)
GET /admin/api/ws/{ws}/datasources/{id}/schemas
Schemas of the database, system ones left out (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: string[] (application/json)
GET /admin/api/ws/{ws}/datasources/{id}/tables
Tables and views of a schema, at most 2000 (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes | |
schema | query | string | no |
Response 200: Tables (application/json)
GET /admin/api/ws/{ws}/datasources/dialects
Supported databases, default ports and allowed driver properties
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: DialectInfo[] (application/json)
POST /admin/api/ws/{ws}/datasources/test
Try settings before saving them (workspace admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: TestDatasource (application/json)
Response 200: DatasourceTestResult (application/json)
endpoint-tests
GET /admin/api/ws/{ws}/endpoints/{endpointId}/tests
Test cases of an endpoint, with their last results
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
endpointId | path | string (uuid) | yes |
Response 200: EndpointTestCase[] (application/json)
POST /admin/api/ws/{ws}/endpoints/{endpointId}/tests
Add a test case (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
endpointId | path | string (uuid) | yes |
Body: SaveEndpointTest (application/json)
Response 201: EndpointTestCase (application/json)
POST /admin/api/ws/{ws}/endpoints/{endpointId}/tests:run
Run all test cases, or one, against the saved draft (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
endpointId | path | string (uuid) | yes | |
testId | query | string (uuid) | no |
Response 200: TestRunSummary (application/json)
PATCH /admin/api/ws/{ws}/endpoints/{endpointId}/tests/{testId}
Change a test case (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
endpointId | path | string (uuid) | yes | |
testId | path | string (uuid) | yes |
Body: SaveEndpointTest (application/json)
Response 200: EndpointTestCase (application/json)
DELETE /admin/api/ws/{ws}/endpoints/{endpointId}/tests/{testId}
Remove a test case (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
endpointId | path | string (uuid) | yes | |
testId | path | string (uuid) | yes |
Response 200: no content
endpoints
GET /admin/api/ws/{ws}/endpoints
Endpoints, optionally filtered; trashed=true lists the trash
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
state | query | string | no | |
groupId | query | string (uuid) | no | |
datasourceId | query | string (uuid) | no | |
q | query | string | no | |
trashed | query | boolean | no |
Response 200: EndpointSummary[] (application/json)
POST /admin/api/ws/{ws}/endpoints
Create a draft with a starter query (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: CreateEndpoint (application/json)
Response 201: EndpointDetail (application/json)
POST /admin/api/ws/{ws}/endpoints/{endpointId}/cache:clear
Forget the endpoint's cached answers on this server (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
endpointId | path | string (uuid) | yes |
Response 200: no content
GET /admin/api/ws/{ws}/endpoints/{id}
The draft and what is live
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: EndpointDetail (application/json)
PATCH /admin/api/ws/{ws}/endpoints/{id}
Save the draft; callers keep getting the live version (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: UpdateEndpoint (application/json)
Response 200: EndpointDetail (application/json)
DELETE /admin/api/ws/{ws}/endpoints/{id}
Delete for good; only from the trash (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: no content
POST /admin/api/ws/{ws}/endpoints/{id}:deprecate
Announce in responses that callers should move on (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: DeprecateRequest (application/json)
Response 200: EndpointSummary (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}:disable
Stop serving (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: EndpointSummary (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}:duplicate
Copy the draft as a new draft (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 201: EndpointDetail (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}:enable
Serve the live version again (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: EndpointSummary (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}:new-major
Copy the draft to a new route as the next major version (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: NewMajorRequest (application/json)
Response 201: EndpointDetail (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}:publish
Freeze the draft as a new version and serve it (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: PublishRequest (application/json)
Response 200: VersionView (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}:restore
Bring back from the trash, disabled (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: EndpointSummary (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}:trash
Move a draft or disabled endpoint to the trash (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: EndpointSummary (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}:undeprecate
Stop announcing deprecation (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: EndpointSummary (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}:validate
Check the saved draft as publish would (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: ValidationView (application/json)
PUT /admin/api/ws/{ws}/endpoints/{id}/group
Put the endpoint in a group, or in none; grants on the group apply at once, nothing is republished (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: MoveEndpoint (application/json)
Response 200: EndpointSummary (application/json)
GET /admin/api/ws/{ws}/endpoints/{id}/lineage
The major versions of this endpoint, oldest first
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: LineageMember[] (application/json)
GET /admin/api/ws/{ws}/endpoints/{id}/openapi.json
OpenAPI 3.1 document of one endpoint's live version
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: object (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}/preview
Run the on-screen draft with test values; always rolled back (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: PreviewRequest (application/json)
Response 200: PreviewResponse (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}/try
Call the live version through the serving pipeline (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: TryRequest (application/json)
Response 200: TryResponse (application/json)
GET /admin/api/ws/{ws}/endpoints/{id}/versions
Published versions, newest first
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: VersionView[] (application/json)
GET /admin/api/ws/{ws}/endpoints/{id}/versions/{version}
One published version
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes | |
version | path | integer (int32) | yes |
Response 200: VersionView (application/json)
POST /admin/api/ws/{ws}/endpoints/{id}/versions/{version}:rollback
Serve an older version; the draft is untouched (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes | |
version | path | integer (int32) | yes |
Response 200: EndpointSummary (application/json)
GET /admin/api/ws/{ws}/openapi.json
OpenAPI 3.1 document of every live endpoint
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: object (application/json)
groups
GET /admin/api/ws/{ws}/groups
Endpoint groups with their endpoint counts
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: ApiGroup[] (application/json)
POST /admin/api/ws/{ws}/groups
Create a group (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: SaveGroup (application/json)
Response 201: ApiGroup (application/json)
PATCH /admin/api/ws/{ws}/groups/{id}
Rename a group (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: SaveGroup (application/json)
Response 200: no content
DELETE /admin/api/ws/{ws}/groups/{id}
Delete a group; its endpoints become ungrouped and grants on it are revoked (author)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: no content
identityProviders
GET /admin/api/identity-providers
Every sign-in provider
Response 200: ProviderView[] (application/json)
POST /admin/api/identity-providers
Add an LDAP directory or OIDC issuer
Body: SaveProvider (application/json)
Response 201: ProviderView (application/json)
GET /admin/api/identity-providers/{id}
One sign-in provider
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes |
Response 200: ProviderView (application/json)
PATCH /admin/api/identity-providers/{id}
Change a provider; omit secret to keep it
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes |
Body: SaveProvider (application/json)
Response 200: ProviderView (application/json)
DELETE /admin/api/identity-providers/{id}
Remove a provider nobody has signed in through
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes |
Response 200: no content
POST /admin/api/identity-providers/{id}:test
Check connectivity; for LDAP optionally sign a test user in
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes |
Body: TestRequest (application/json)
Response 200: ProviderTestResult (application/json)
GET /admin/api/identity-providers/{id}/group-mappings
Directory group → role mappings
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes |
Response 200: MappingView[] (application/json)
PUT /admin/api/identity-providers/{id}/group-mappings
Replace all mappings; applied at each user's next sign-in
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes |
Body: MappingView[] (application/json)
Response 200: MappingView[] (application/json)
me
GET /admin/api/me
The signed-in user and their workspaces
Response 200: Me (application/json)
POST /admin/api/me/password
Change your own local password
Body: ChangePassword (application/json)
Response 200: no content
members
GET /admin/api/ws/{ws}/members
Members and their roles (any member)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: MemberView[] (application/json)
POST /admin/api/ws/{ws}/members
Add a user to the workspace (workspace admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: AddMember (application/json)
Response 201: MemberView (application/json)
PATCH /admin/api/ws/{ws}/members/{userId}
Change a member's role (workspace admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
userId | path | string (uuid) | yes |
Body: ChangeRole (application/json)
Response 200: MemberView (application/json)
DELETE /admin/api/ws/{ws}/members/{userId}
Remove a member (workspace admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
userId | path | string (uuid) | yes |
Response 200: no content
GET /admin/api/ws/{ws}/user-search
Find users to add (workspace admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
q | query | string | yes |
Response 200: UserMatch[] (application/json)
secrets
GET /admin/api/ws/{ws}/secrets
Managed secrets and where they are used, without values (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: ManagedSecret[] (application/json)
POST /admin/api/ws/{ws}/secrets
Store a secret; refer to it as secret:NAME (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: CreateSecret (application/json)
Response 201: ManagedSecret (application/json)
PATCH /admin/api/ws/{ws}/secrets/{name}
Describe a secret or replace its value (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
name | path | string | yes |
Body: UpdateSecret (application/json)
Response 200: ManagedSecret (application/json)
DELETE /admin/api/ws/{ws}/secrets/{name}
Delete a secret no datasource or alert channel uses (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
name | path | string | yes |
Response 200: no content
service-accounts
GET /admin/api/ws/{ws}/endpoints/{endpointId}/access
Service accounts that may call the endpoint, directly or through its group
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
endpointId | path | string (uuid) | yes |
Response 200: EndpointAccess[] (application/json)
GET /admin/api/ws/{ws}/service-accounts
Service accounts of the workspace
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: ServiceAccount[] (application/json)
POST /admin/api/ws/{ws}/service-accounts
Create a service account (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: SaveServiceAccount (application/json)
Response 201: ServiceAccountDetail (application/json)
GET /admin/api/ws/{ws}/service-accounts/{id}
A service account with its clients and grants
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: ServiceAccountDetail (application/json)
PATCH /admin/api/ws/{ws}/service-accounts/{id}
Rename, describe, disable or enable (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: SaveServiceAccount (application/json)
Response 200: ServiceAccountDetail (application/json)
DELETE /admin/api/ws/{ws}/service-accounts/{id}
Delete a service account, its clients and grants (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Response 200: no content
POST /admin/api/ws/{ws}/service-accounts/{id}/clients
Create an OAuth2 client; the secret is returned only here (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: CreateClient (application/json)
Response 201: NewClient (application/json)
POST /admin/api/ws/{ws}/service-accounts/{id}/clients/{clientRowId}:revoke
Revoke a client; its tokens stop working within seconds (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes | |
clientRowId | path | string (uuid) | yes |
Response 200: no content
POST /admin/api/ws/{ws}/service-accounts/{id}/clients/{clientRowId}:rotate
Replace a client's secret; the old one stops working at once, issued tokens run out (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes | |
clientRowId | path | string (uuid) | yes |
Response 200: NewClient (application/json)
PUT /admin/api/ws/{ws}/service-accounts/{id}/clients/{clientRowId}/security
Require request signatures and/or encrypt responses (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes | |
clientRowId | path | string (uuid) | yes |
Body: SaveClientSecurity (application/json)
Response 200: ClientSecurityResult (application/json)
PUT /admin/api/ws/{ws}/service-accounts/{id}/grants
Let the service account call an endpoint or every endpoint of a group (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes |
Body: SaveGrant (application/json)
Response 200: no content
DELETE /admin/api/ws/{ws}/service-accounts/{id}/grants/{resourceType}/{resourceId}
Remove a grant (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
id | path | string (uuid) | yes | |
resourceType | path | string | yes | |
resourceId | path | string (uuid) | yes |
Response 200: no content
serving-policy
GET /admin/api/ws/{ws}/serving-policy
Firewall and rate limits
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: ServingPolicy (application/json)
PUT /admin/api/ws/{ws}/serving-policy
Replace firewall and rate limits (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: ServingPolicy (application/json)
Response 200: ServingPolicy (application/json)
system
GET /admin/api/system/info
Version, run mode and the public serving base URL
Response 200: SystemInfo (application/json)
tokens
GET /admin/api/me/tokens
Your API tokens (never their secret)
Response 200: ApiToken[] (/)
POST /admin/api/me/tokens
Create an API token for automation; the secret is shown once
Body: CreateApiToken (application/json)
Response 201: CreatedApiToken (/)
DELETE /admin/api/me/tokens/{id}
Revoke one of your API tokens
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes |
Response 204: no content
transfer
GET /admin/api/ws/{ws}/export
The workspace as YAML documents, without secrets (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
format | query | string | no |
Response 200: string (application/yaml)
POST /admin/api/ws/{ws}/import/dbapi
Import DBAPI's api_config.json, group.json and datasource.json; dryRun reports without writing (admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes | |
dryRun | query | boolean | no |
Body: DbapiExport (application/json)
Response 200: ImportReport (application/json)
users
GET /admin/api/users
Every user
Response 200: UserView[] (application/json)
POST /admin/api/users
Create a local user
Body: CreateUser (application/json)
Response 201: UserView (application/json)
PATCH /admin/api/users/{id}
Edit, disable or promote a user
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes |
Body: UpdateUser (application/json)
Response 200: UserView (application/json)
POST /admin/api/users/{id}:reset-password
Set a new password for a local user
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes |
Body: ResetPassword (application/json)
Response 200: no content
workspaces
GET /admin/api/workspaces
Every workspace, archived included (system admin)
Response 200: WorkspaceView[] (application/json)
POST /admin/api/workspaces
Create a workspace with its first owner (system admin)
Body: CreateWorkspace (application/json)
Response 201: WorkspaceView (application/json)
GET /admin/api/workspaces/{ws}
One workspace (any member)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: WorkspaceView (application/json)
PATCH /admin/api/workspaces/{ws}
Rename or change quotas (workspace owner)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Body: UpdateWorkspace (application/json)
Response 200: WorkspaceView (application/json)
POST /admin/api/workspaces/{ws}:archive
Stop serving and hide a workspace (system admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: WorkspaceView (application/json)
POST /admin/api/workspaces/{ws}:restore
Bring an archived workspace back (system admin)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ws | path | string | yes |
Response 200: WorkspaceView (application/json)
Schemas
AddMember
| Field | Type | Required | Description |
|---|---|---|---|
role | owner | admin | script_author | author | viewer | yes | |
userId | string (uuid) | yes |
AlertChannel
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | yes | |
enabled | boolean | yes | |
id | string (uuid) | yes | |
kind | slack | teams | google_chat | webhook | yes | |
lastError | string | no | Why the last delivery failed; null when it worked |
lastSentAt | string (date-time) | no | |
name | string | yes | |
urlHost | string | yes | Host the webhook posts to |
AlertTestResult
| Field | Type | Required | Description |
|---|---|---|---|
error | string | no | |
ok | boolean | yes | |
status | integer (int32) | no |
Alerts
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes |
ApiGroup
| Field | Type | Required | Description |
|---|---|---|---|
endpointCount | integer (int32) | yes | |
grantCount | integer (int32) | yes | |
id | string (uuid) | yes | |
name | string | yes |
ApiToken
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | yes | |
expiresAt | string (date-time) | no | |
id | string (uuid) | yes | |
lastUsedAt | string (date-time) | no | |
name | string | yes | |
prefix | string | yes | First characters, to recognise the token |
workspace | string | no | Only this workspace; null means every workspace of the user |
AuditEntry
| Field | Type | Required | Description |
|---|---|---|---|
action | string | yes | |
detail | JsonNode | no | |
id | integer (int64) | yes | |
targetId | string | no | |
targetType | string | no | |
ts | string (date-time) | yes | |
username | string | no | |
workspaceId | string (uuid) | no |
AuthProviders
| Field | Type | Required | Description |
|---|---|---|---|
ldap | ProviderRef[] | yes | |
local | boolean | yes | |
oidc | ProviderRef[] | yes |
Cache
Result cache (spec §9.5)
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes | |
scope | client | shared | yes | |
ttlSeconds | integer (int32) | yes |
ChangePassword
| Field | Type | Required | Description |
|---|---|---|---|
currentPassword | string | yes | |
newPassword | string | yes |
ChangeRole
| Field | Type | Required | Description |
|---|---|---|---|
role | owner | admin | script_author | author | viewer | yes |
Client
| Field | Type | Required | Description |
|---|---|---|---|
clientId | string | yes | |
createdAt | string (date-time) | yes | |
expiresAt | string (date-time) | no | |
hmacRequired | boolean | yes | Requests must carry an HMAC signature (spec §8.2) |
id | string (uuid) | yes | |
lastUsedAt | string (date-time) | no | |
publicKey | string | no | RSA public key (PEM) responses are encrypted to |
responseEncrypt | boolean | yes | Responses are encrypted to the client's public key (spec §8.3) |
revokedAt | string (date-time) | no |
ClientSecurityResult
| Field | Type | Required | Description |
|---|---|---|---|
client | Client | yes | |
signingKey | string | no | Shown once when issued; store it now |
ConfigApplyResult
| Field | Type | Required | Description |
|---|---|---|---|
plan | ConfigPlan | yes | |
published | PublishOutcome[] | yes |
ConfigChange
| Field | Type | Required | Description |
|---|---|---|---|
action | create | update | delete | unchanged | skip | yes | |
details | string[] | yes | What differs, e.g. spec.task or publish |
kind | string | yes | |
name | string | yes |
ConfigEnvironment
| Field | Type | Required | Description |
|---|---|---|---|
bindings | object | yes | Logical datasource name in configuration files → datasource name in this workspace |
name | string | yes | |
updatedAt | string (date-time) | yes |
ConfigPlan
| Field | Type | Required | Description |
|---|---|---|---|
changes | ConfigChange[] | yes | |
counts | object | yes | Number of changes per action |
digest | string | yes | Identifies this plan; pass it to apply to refuse a workspace that changed since |
environment | string | no | |
prune | boolean | yes | |
publish | boolean | yes |
CreateApiToken
| Field | Type | Required | Description |
|---|---|---|---|
expiresInDays | integer (int32) | no | Days until it expires, 1–365; null never expires |
name | string | yes | |
workspace | string | no | Limit the token to this workspace (slug) |
CreateClient
| Field | Type | Required | Description |
|---|---|---|---|
expiresInDays | integer (int32) | no |
CreateEndpoint
| Field | Type | Required | Description |
|---|---|---|---|
access | string | yes | |
datasourceId | string (uuid) | yes | |
groupId | string (uuid) | no | |
method | string | yes | |
name | string | yes | |
path | string | yes |
CreateSecret
| Field | Type | Required | Description |
|---|---|---|---|
description | string | no | |
name | string | yes | |
value | string | yes | Write-only; never returned |
CreateUser
| Field | Type | Required | Description |
|---|---|---|---|
displayName | string | no | |
email | string | no | |
password | string | yes | |
systemAdmin | boolean | yes | |
username | string | yes |
CreateWorkspace
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
ownerUserId | string (uuid) | no | First owner; defaults to the caller |
slug | string | yes |
CreatedApiToken
| Field | Type | Required | Description |
|---|---|---|---|
secret | string | yes | Shown once; store it now |
token | ApiToken | yes |
DataPolicy
| Field | Type | Required | Description |
|---|---|---|---|
attribute | string | no | For kind row_filter: the service account attribute holding the allowed value(s) |
column | string | yes | |
createdAt | string (date-time) | yes | |
datasourceId | string (uuid) | no | |
endpointId | string (uuid) | no | |
exemptServiceAccounts | string (uuid)[] | yes | Service accounts this policy does not apply to |
id | string (uuid) | yes | |
kind | mask | row_filter | yes | |
mask | Mask | yes | |
updatedAt | string (date-time) | yes |
DatasourceTestResult
| Field | Type | Required | Description |
|---|---|---|---|
latencyMs | integer (int64) | no | |
message | string | yes | |
ok | boolean | yes | |
product | string | no | |
version | string | no |
DatasourceView
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | yes | |
database | string | no | Databases only |
description | string | no | |
dialect | POSTGRESQL | MYSQL | MARIADB | SQLSERVER | ORACLE | TRINO | STARROCKS | DORIS | CLICKHOUSE | no | Databases only |
hasPassword | boolean | yes | |
host | string | yes | |
http | HttpConfig | yes | |
id | string (uuid) | yes | |
lastTest | LastTest | yes | |
name | string | yes | |
passwordEnv | string | no | The env: or vault: reference when the password comes from outside |
passwordSecret | string | no | The managed secret holding the password, when it is one |
pool | PoolSettings | yes | |
port | integer (int32) | yes | |
properties | object | yes | |
readOnly | boolean | yes | |
type | jdbc | http | yes | |
updatedAt | string (date-time) | yes | |
username | string | no | Databases only |
Day
| Field | Type | Required | Description |
|---|---|---|---|
day | string (date) | yes | |
errors | integer (int64) | yes | |
requests | integer (int64) | yes |
DbapiExport
| Field | Type | Required | Description |
|---|---|---|---|
apis | JsonNode | no | |
datasources | JsonNode | no | |
groups | JsonNode | no |
DeprecateRequest
| Field | Type | Required | Description |
|---|---|---|---|
sunset | string (date-time) | no | When the endpoint will stop answering (Sunset header) |
DialectInfo
| Field | Type | Required | Description |
|---|---|---|---|
allowedProperties | string[] | yes | |
defaultPort | integer (int32) | yes | |
dialect | POSTGRESQL | MYSQL | MARIADB | SQLSERVER | ORACLE | TRINO | STARROCKS | DORIS | CLICKHOUSE | yes | |
passwordOptional | boolean | yes | Whether a datasource may have no password |
transactional | boolean | yes | Whether a rollback undoes writes: preview and transactions need it |
EndpointAccess
| Field | Type | Required | Description |
|---|---|---|---|
disabled | boolean | yes | |
name | string | yes | |
serviceAccountId | string (uuid) | yes | |
via | endpoint | group | yes |
EndpointDefinition
| Field | Type | Required | Description |
|---|---|---|---|
alerts | Alerts | yes | |
cache | Cache | yes | |
limits | Limits | yes | |
output | Output | yes | |
pagination | Pagination | yes | |
params | Param[] | yes | |
rules | Rule[] | yes | Checks on the bound parameters, run before the query (spec §13.1) |
streaming | Streaming | yes | |
task | Task | yes |
EndpointDetail
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | yes | |
definition | EndpointDefinition | yes | |
summary | EndpointSummary | yes |
EndpointSummary
| Field | Type | Required | Description |
|---|---|---|---|
access | private | public | yes | |
datasourceId | string (uuid) | no | |
deprecatedAt | string (date-time) | no | |
description | string | no | |
dirty | boolean | yes | |
groupId | string (uuid) | no | |
id | string (uuid) | yes | |
liveVersion | integer (int32) | no | |
major | integer (int32) | yes | Major version within its lineage (spec §16) |
method | string | yes | |
name | string | yes | |
path | string | yes | |
state | draft | live | disabled | yes | |
sunsetAt | string (date-time) | no | |
trashed | boolean | yes | |
updatedAt | string (date-time) | yes |
EndpointTestCase
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | yes | |
expect | TestExpectation | yes | |
id | string (uuid) | yes | |
lastResult | TestCaseResult | yes | |
name | string | yes | |
params | object | yes | Parameter values by name; page and size select a page |
serviceAccountId | string (uuid) | no | Call as this service account (grants, rules and data policies apply); null runs like preview |
updatedAt | string (date-time) | yes |
ExecutedSql
| Field | Type | Required | Description |
|---|---|---|---|
parameters | object[] | yes | |
sql | string | yes |
Finding
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | |
message | string | yes | |
severity | string | yes |
Firewall
| Field | Type | Required | Description |
|---|---|---|---|
entries | string[] | yes | |
mode | off | allow | deny | yes |
Grant
| Field | Type | Required | Description |
|---|---|---|---|
detail | string | no | Method and path, for an endpoint |
grantedAt | string (date-time) | yes | |
resourceId | string (uuid) | yes | |
resourceName | string | yes | |
resourceType | string | yes |
HttpCall
HTTP tasks: the request to the HTTP datasource
| Field | Type | Required | Description |
|---|---|---|---|
body | HttpField[] | no | JSON body fields: name and expression; none sends no body |
method | GET | POST | PUT | PATCH | DELETE | yes | |
path | string | yes | |
query | HttpField[] | no | Query string: name and expression; null values are left out |
resultPath | string | no | JSON Pointer to the rows, e.g. /data/items |
HttpConfig
HTTP APIs: required
| Field | Type | Required | Description |
|---|---|---|---|
auth | none | bearer | basic | header | yes | |
baseUrl | string | yes | |
connectTimeoutMs | integer (int32) | no | 250–60000 ms, default 10000 |
headerName | string | no | API key authentication only |
headers | object | no | |
username | string | no | Basic authentication only |
HttpField
JSON body fields: name and expression; none sends no body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
value | string | yes |
ImportReport
| Field | Type | Required | Description |
|---|---|---|---|
created | integer (int32) | yes | |
dryRun | boolean | yes | |
items | ImportedItem[] | yes | |
skipped | integer (int32) | yes |
ImportedItem
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | no | |
kind | string | yes | |
name | string | yes | |
notes | string[] | yes | |
result | created | existing | skipped | yes |
JsonNode
JsonPathCheck
| Field | Type | Required | Description |
|---|---|---|---|
equals | JsonNode | no | |
exists | boolean | no | |
path | string | yes |
KeysetKey
| Field | Type | Required | Description |
|---|---|---|---|
column | string | yes | |
descending | boolean | yes |
LastTest
Last connection test; null when never tested since the settings changed
| Field | Type | Required | Description |
|---|---|---|---|
at | string (date-time) | yes | |
message | string | yes | |
ok | boolean | yes |
Limits
| Field | Type | Required | Description |
|---|---|---|---|
maxRows | integer (int32) | yes | |
ratePerMinute | integer (int32) | no | Calls per minute across all callers; null = unlimited |
streamMaxRows | integer (int32) | no | Most rows a streamed response returns; null = maxRows |
timeoutSeconds | integer (int32) | yes |
LineageMember
| Field | Type | Required | Description |
|---|---|---|---|
deprecatedAt | string (date-time) | no | |
id | string (uuid) | yes | |
liveVersion | integer (int32) | no | |
major | integer (int32) | yes | |
method | string | yes | |
name | string | yes | |
path | string | yes | |
state | string | yes | |
sunsetAt | string (date-time) | no |
LogEntry
| Field | Type | Required | Description |
|---|---|---|---|
clientId | string | no | |
durationMs | integer (int32) | yes | |
endpointId | string (uuid) | no | |
endpointName | string | no | |
error | string | no | |
errorCode | string | no | |
id | string (uuid) | yes | |
ip | string | no | |
method | string | yes | |
path | string | yes | |
requestId | string | no | |
rows | integer (int32) | no | |
status | integer (int32) | yes | |
traceId | string | no | |
tryIt | boolean | yes | |
ts | string (date-time) | yes | |
version | integer (int32) | no |
LoginRequest
| Field | Type | Required | Description |
|---|---|---|---|
idpId | string (uuid) | no | Required when source is ldap |
password | string | yes | |
source | local | ldap | yes | |
username | string | yes |
ManagedSecret
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | yes | |
description | string | no | |
name | string | yes | |
updatedAt | string (date-time) | yes | |
usedBy | SecretUse[] | yes | Datasources and alert channels that use it |
MappingView
| Field | Type | Required | Description |
|---|---|---|---|
externalGroup | string | yes | |
managed | boolean | yes | |
role | system_admin | owner | admin | script_author | author | viewer | yes | |
workspace | string | no | Workspace slug; null only for system_admin |
Mask
| Field | Type | Required | Description |
|---|---|---|---|
keepEnd | integer (int32) | no | |
keepStart | integer (int32) | no | |
type | phone | email | partial | hash | nullify | yes |
Me
| Field | Type | Required | Description |
|---|---|---|---|
displayName | string | no | |
email | string | no | |
id | string (uuid) | yes | |
source | string | yes | |
systemAdmin | boolean | yes | |
username | string | yes | |
workspaces | MyWorkspace[] | yes |
MemberView
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | yes | |
displayName | string | no | |
email | string | no | |
fromMapping | boolean | yes | |
role | owner | admin | script_author | author | viewer | yes | |
source | string | yes | |
userId | string (uuid) | yes | |
username | string | yes |
MoveEndpoint
| Field | Type | Required | Description |
|---|---|---|---|
groupId | string (uuid) | no | The group to put the endpoint in; null for no group |
MyWorkspace
| Field | Type | Required | Description |
|---|---|---|---|
configLocked | boolean | yes | Managed by configuration files (spec §15.2) |
id | string (uuid) | yes | |
name | string | yes | |
role | owner | admin | script_author | author | viewer | yes | |
slug | string | yes |
Nest
| Field | Type | Required | Description |
|---|---|---|---|
collections | NestCollection[] | yes | |
key | string | yes |
NestCollection
| Field | Type | Required | Description |
|---|---|---|---|
as | string | yes | |
key | string | yes | |
prefix | string | yes |
NewClient
| Field | Type | Required | Description |
|---|---|---|---|
client | Client | yes | |
clientSecret | string | yes | Shown once; store it now |
NewMajorRequest
| Field | Type | Required | Description |
|---|---|---|---|
path | string | no | Defaults to v<N>/… from the current path |
Output
How rows are shaped in the response (spec §9.2)
| Field | Type | Required | Description |
|---|---|---|---|
naming | as_is | camelCase | yes | |
nest | Nest[] | no | |
shape | list | single | scalar | yes | |
types | object | no |
Pagination
| Field | Type | Required | Description |
|---|---|---|---|
count | boolean | yes | |
defaultSize | integer (int32) | yes | |
enabled | boolean | yes | |
keys | KeysetKey[] | no | |
maxSize | integer (int32) | yes | |
mode | offset | keyset | no |
Param
| Field | Type | Required | Description |
|---|---|---|---|
defaultValue | JsonNode | no | |
description | string | no | |
enumValues | string[] | no | |
in | path | query | header | body | yes | |
max | number | no | Numbers: largest value; text: longest length |
maxItems | integer (int32) | no | |
min | number | no | Numbers: smallest value; text: shortest length |
name | string | yes | |
pattern | string | no | Regular expression the value must match |
required | boolean | yes | |
type | string | bigint | double | decimal | boolean | date | datetime | array<string> | array<bigint> | array<double> | array<date> | yes |
PoolSettings
| Field | Type | Required | Description |
|---|---|---|---|
connectionTimeoutMs | integer (int32) | no | 250–60000 ms, default 10000 |
maximumPoolSize | integer (int32) | no | 1–50, default 10 |
minimumIdle | integer (int32) | no | default 0 |
PreviewRequest
| Field | Type | Required | Description |
|---|---|---|---|
definition | EndpointDefinition | yes | |
method | string | yes | |
page | integer (int32) | no | |
params | object | no | Test values by parameter name |
path | string | yes | |
size | integer (int32) | no |
PreviewResponse
| Field | Type | Required | Description |
|---|---|---|---|
affectedRows | integer (int64) | no | |
columns | ResultColumn[] | yes | |
durationMs | integer (int64) | yes | |
executed | ExecutedSql[] | yes | |
findings | Finding[] | yes | |
hasNext | boolean | no | |
rows | object[] | yes | |
total | integer (int64) | no | |
truncated | boolean | yes | |
value | object | no | Full-mode scripts: what the script returned |
ProviderRef
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | |
name | string | yes |
ProviderTestResult
| Field | Type | Required | Description |
|---|---|---|---|
messages | string[] | yes | |
ok | boolean | yes |
ProviderView
| Field | Type | Required | Description |
|---|---|---|---|
config | object | yes | Provider settings without secrets |
createdAt | string (date-time) | yes | |
enabled | boolean | yes | |
hasSecret | boolean | yes | |
id | string (uuid) | yes | |
name | string | yes | |
secretEnv | string | no | env: references are shown; sealed values are not |
type | ldap | oidc | yes | |
updatedAt | string (date-time) | yes |
PublishOutcome
| Field | Type | Required | Description |
|---|---|---|---|
endpoint | string | yes | |
message | string | no | |
result | published | disabled | tests_failed | failed | yes |
PublishRequest
| Field | Type | Required | Description |
|---|---|---|---|
note | string | no |
PutEnvironment
| Field | Type | Required | Description |
|---|---|---|---|
bindings | object | yes | Logical datasource name in configuration files → datasource name here |
RateLimits
| Field | Type | Required | Description |
|---|---|---|---|
perClientPerMinute | integer (int32) | no | |
perIpPerMinute | integer (int32) | no |
ResetPassword
| Field | Type | Required | Description |
|---|---|---|---|
password | string | yes |
ResultColumn
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
type | string | yes |
RowCountRange
| Field | Type | Required | Description |
|---|---|---|---|
max | integer (int32) | no | |
min | integer (int32) | no |
Rule
Checks on the bound parameters, run before the query (spec §13.1)
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
test | string | yes |
SaveAlertChannel
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes | |
kind | slack | teams | google_chat | webhook | yes | |
name | string | yes | |
url | string | no | Write-only; never returned |
SaveClientSecurity
| Field | Type | Required | Description |
|---|---|---|---|
hmacRequired | boolean | yes | |
publicKey | string | no | |
responseEncrypt | boolean | yes | |
rotateSigningKey | boolean | yes |
SaveDataPolicy
| Field | Type | Required | Description |
|---|---|---|---|
attribute | string | no | |
column | string | yes | |
datasourceId | string (uuid) | no | |
endpointId | string (uuid) | no | |
exemptServiceAccounts | string (uuid)[] | no | |
kind | mask | row_filter | yes | |
mask | Mask | yes |
SaveDatasource
| Field | Type | Required | Description |
|---|---|---|---|
database | string | no | Databases: required |
description | string | no | |
dialect | POSTGRESQL | MYSQL | MARIADB | SQLSERVER | ORACLE | TRINO | STARROCKS | DORIS | CLICKHOUSE | no | Databases: required |
host | string | no | Databases: required |
http | HttpConfig | no | |
name | string | yes | |
password | string | no | Plain password, token or API key (stored encrypted), or a secret:, env: or vault: reference; omit to keep the stored one |
pool | PoolSettings | no | |
port | integer (int32) | no | Default port of the dialect when empty |
properties | object | no | |
readOnly | boolean | yes | |
type | jdbc | http | no | Default jdbc |
username | string | no | Databases: required |
SaveEndpointTest
| Field | Type | Required | Description |
|---|---|---|---|
expect | TestExpectation | yes | |
name | string | yes | |
params | object | no | |
serviceAccountId | string (uuid) | no |
SaveGrant
| Field | Type | Required | Description |
|---|---|---|---|
resourceId | string (uuid) | yes | |
resourceType | string | yes |
SaveGroup
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes |
SaveProvider
| Field | Type | Required | Description |
|---|---|---|---|
config | object | yes | |
enabled | boolean | yes | |
name | string | yes | |
secret | string | no | Plain secret (sealed on save) or an env:NAME reference; omit to keep |
type | ldap | oidc | yes |
SaveServiceAccount
| Field | Type | Required | Description |
|---|---|---|---|
attributes | object | no | Replaces all attributes; null keeps them |
description | string | no | |
disabled | boolean | yes | |
name | string | yes |
SecretUse
Datasources and alert channels that use it
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | |
kind | datasource | alert_channel | yes | |
name | string | yes |
ServiceAccount
| Field | Type | Required | Description |
|---|---|---|---|
attributes | object | yes | Facts about the caller that row filters read (spec §12.2), values are strings, numbers, booleans or lists of them |
clientCount | integer (int32) | yes | |
createdAt | string (date-time) | yes | |
description | string | no | |
disabled | boolean | yes | |
grantCount | integer (int32) | yes | |
id | string (uuid) | yes | |
lastUsedAt | string (date-time) | no | |
name | string | yes |
ServiceAccountDetail
| Field | Type | Required | Description |
|---|---|---|---|
clients | Client[] | yes | |
grants | Grant[] | yes | |
summary | ServiceAccount | yes |
ServingPolicy
| Field | Type | Required | Description |
|---|---|---|---|
firewall | Firewall | yes | |
rateLimits | RateLimits | yes |
Statement
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
template | string | yes |
Streaming
| Field | Type | Required | Description |
|---|---|---|---|
allowed | boolean | yes | |
formats | ndjson | csv[] | yes |
Summary
| Field | Type | Required | Description |
|---|---|---|---|
activeClients | integer (int64) | yes | |
byDay | Day[] | yes | |
errors | integer (int64) | yes | |
p95Ms | number (double) | no | |
requests | integer (int64) | yes | |
slowestEndpoints | TopEndpoint[] | yes | Endpoints with the highest p95 latency, at least 5 calls each |
topClients | TopClient[] | yes | |
topEndpoints | TopEndpoint[] | yes | |
topErrors | TopError[] | yes | |
topIps | TopIp[] | yes |
SystemInfo
| Field | Type | Required | Description |
|---|---|---|---|
mode | string | yes | |
servingBaseUrl | string | yes | |
tokenUrl | string | yes | |
version | string | yes |
Table
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
remarks | string | yes | |
schema | string | yes | |
type | string | yes |
TableColumn
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
nullable | boolean | yes | |
position | integer (int32) | yes | |
size | integer (int32) | yes | |
type | string | yes |
Tables
| Field | Type | Required | Description |
|---|---|---|---|
items | Table[] | yes | |
truncated | boolean | yes |
Task
| Field | Type | Required | Description |
|---|---|---|---|
datasourceId | string (uuid) | no | |
language | groovy | no | |
mode | fragment | full | no | |
nodes | WorkflowNode[] | no | Workflow tasks: the nodes of the graph (spec §6.1) |
output | string | no | Workflow tasks: the node whose result is the answer; the last node when empty |
request | HttpCall | no | |
source | string | no | Script tasks: the Groovy source |
statements | Statement[] | yes | |
transaction | boolean | yes | |
type | sql | script | workflow | http | yes |
TestCaseResult
| Field | Type | Required | Description |
|---|---|---|---|
code | string | no | |
durationMs | integer (int64) | yes | |
failures | string[] | yes | |
name | string | yes | |
passed | boolean | yes | |
ranAt | string (date-time) | yes | |
rowCount | integer (int32) | no | |
status | integer (int32) | yes | |
testId | string (uuid) | yes |
TestDatasource
| Field | Type | Required | Description |
|---|---|---|---|
existingId | string (uuid) | no | Use this saved datasource's password when settings.password is empty |
settings | SaveDatasource | yes |
TestExpectation
| Field | Type | Required | Description |
|---|---|---|---|
jsonPath | JsonPathCheck[] | no | |
maxDurationMs | integer (int32) | no | |
rowCount | RowCountRange | yes | |
schemaMatchesLive | boolean | no | |
status | integer (int32) | no |
TestRequest
| Field | Type | Required | Description |
|---|---|---|---|
password | string | no | |
username | string | no |
TestRunSummary
| Field | Type | Required | Description |
|---|---|---|---|
failed | integer (int32) | yes | |
passed | integer (int32) | yes | |
results | TestCaseResult[] | yes |
TopClient
| Field | Type | Required | Description |
|---|---|---|---|
clientId | string | yes | |
errors | integer (int64) | yes | |
p95Ms | number (double) | no | |
requests | integer (int64) | yes | |
serviceAccount | string | no |
TopEndpoint
Endpoints with the highest p95 latency, at least 5 calls each
| Field | Type | Required | Description |
|---|---|---|---|
endpointId | string (uuid) | no | |
errors | integer (int64) | yes | |
method | string | yes | |
name | string | no | |
p95Ms | number (double) | no | |
path | string | yes | |
requests | integer (int64) | yes |
TopError
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | |
count | integer (int64) | yes |
TopIp
| Field | Type | Required | Description |
|---|---|---|---|
errors | integer (int64) | yes | |
ip | string | yes | |
requests | integer (int64) | yes |
TryRequest
| Field | Type | Required | Description |
|---|---|---|---|
page | integer (int32) | no | |
params | object | no | |
serviceAccountId | string (uuid) | no | |
size | integer (int32) | no |
TryResponse
| Field | Type | Required | Description |
|---|---|---|---|
body | JsonNode | no | |
curl | string | yes | |
durationMs | integer (int64) | yes | |
headers | object | yes | |
method | string | yes | |
serviceAccountName | string | no | |
status | integer (int32) | yes | |
text | string | no | |
url | string | yes |
UpdateEndpoint
| Field | Type | Required | Description |
|---|---|---|---|
access | string | yes | |
definition | EndpointDefinition | yes | |
description | string | no | |
groupId | string (uuid) | no | |
method | string | yes | |
name | string | yes | |
path | string | yes |
UpdateSecret
| Field | Type | Required | Description |
|---|---|---|---|
description | string | no | |
value | string | no | Write-only; never returned |
UpdateUser
| Field | Type | Required | Description |
|---|---|---|---|
disabled | boolean | no | |
displayName | string | no | |
email | string | no | |
systemAdmin | boolean | no |
UpdateWorkspace
| Field | Type | Required | Description |
|---|---|---|---|
configLocked | boolean | no | Manage the workspace through configuration files only |
name | string | no | |
quotas | object | no |
UserMatch
| Field | Type | Required | Description |
|---|---|---|---|
displayName | string | no | |
email | string | no | |
id | string (uuid) | yes | |
source | string | yes | |
username | string | yes |
UserView
| Field | Type | Required | Description |
|---|---|---|---|
createdAt | string (date-time) | yes | |
disabled | boolean | yes | |
displayName | string | no | |
email | string | no | |
id | string (uuid) | yes | |
lastLoginAt | string (date-time) | no | |
locked | boolean | yes | |
source | string | yes | |
systemAdmin | boolean | yes | |
username | string | yes |
ValidationView
| Field | Type | Required | Description |
|---|---|---|---|
detectedParameters | string[] | yes | |
findings | Finding[] | yes | |
ok | boolean | yes | |
outputColumns | ResultColumn[] | yes |
VersionView
| Field | Type | Required | Description |
|---|---|---|---|
access | string | yes | |
definition | EndpointDefinition | yes | |
live | boolean | yes | |
method | string | yes | |
note | string | no | |
path | string | yes | |
publishedAt | string (date-time) | yes | |
publishedBy | string | no | |
version | integer (int32) | yes |
WorkflowNode
Workflow tasks: the nodes of the graph (spec §6.1)
| Field | Type | Required | Description |
|---|---|---|---|
answer | string | no | end nodes: the expression whose value is the answer, e.g. add |
condition | string | no | decision nodes: the expression choosing yes or no |
dependsOn | string[] | no | Ids of earlier nodes; id:yes or id:no for a decision's branch |
endpointId | string (uuid) | no | api nodes: the endpoint of this workspace to call (its live version) |
id | string | yes | |
kind | sql | script | api | decision | end | yes | |
params | object | no | api nodes: parameter name → expression, e.g. name → name or id → user.id |
result | list | one | value | update | no | sql nodes: what the node's result is; list by default |
source | string | no | script nodes: a full-mode Groovy script |
template | string | no | sql nodes: the SQL template |
when | string | no | Run only when this expression holds, e.g. user != null |
x | integer (int32) | no | Position on the canvas |
y | integer (int32) | no | Position on the canvas |
WorkspaceView
| Field | Type | Required | Description |
|---|---|---|---|
archivedAt | string (date-time) | no | |
configLocked | boolean | yes | Managed by configuration files: endpoints and the like change through config:apply only (spec §15.2) |
createdAt | string (date-time) | yes | |
id | string (uuid) | yes | |
lockedByServer | boolean | yes | Locked by the server for every workspace (opendbapi.ui.read-only) |
name | string | yes | |
quotas | object | yes | |
slug | string | yes | |
status | string | yes |