Skip to main content

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 the X-XSRF-TOKEN header 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

ParameterInTypeRequiredDescription
wspathstringyes
fromquerystring (date-time)no
toquerystring (date-time)no
endpointIdquerystring (uuid)no
clientIdquerystringno
statusquerystringno
requestIdquerystringno
includeTryItquerybooleanno
beforequerystring (date-time)no
limitqueryinteger (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

ParameterInTypeRequiredDescription
wspathstringyes
fromquerystring (date-time)no
toquerystring (date-time)no
includeTryItquerybooleanno
endpointIdquerystring (uuid)no

Response 200: Summary (application/json)

alert-channels​

GET /admin/api/ws/{ws}/alert-channels​

Alert channels of the workspace

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: AlertChannel[] (application/json)

POST /admin/api/ws/{ws}/alert-channels​

Add a webhook (admin)

ParameterInTypeRequiredDescription
wspathstringyes

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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Body: SaveAlertChannel (application/json)

Response 200: AlertChannel (application/json)

DELETE /admin/api/ws/{ws}/alert-channels/{id}​

Remove a webhook (admin)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: no content

POST /admin/api/ws/{ws}/alert-channels/{id}:test​

Send a test message now (admin)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: AlertTestResult (application/json)

audit​

GET /admin/api/audit​

System-wide audit log, newest first (system admin)

ParameterInTypeRequiredDescription
actionquerystringno
beforequeryinteger (int64)no
limitqueryinteger (int32)no

Response 200: AuditEntry[] (application/json)

GET /admin/api/ws/{ws}/audit​

One workspace's audit log (workspace admin)

ParameterInTypeRequiredDescription
wspathstringyes
actionquerystringno
beforequeryinteger (int64)no
limitqueryinteger (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)

ParameterInTypeRequiredDescription
wspathstringyes
environmentquerystringno
prunequerybooleanno
publishquerybooleanno
expectedDigestquerystringnoRefuse with 409 plan_changed unless the plan still has this digest
formatquerystringno

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)

ParameterInTypeRequiredDescription
wspathstringyes
environmentquerystringnoMaps logical datasource names
prunequerybooleannoDelete what the file does not list
publishquerybooleannoPublish endpoints whose metadata.state is live, disable those marked disabled
formatquerystringno

Body: string (application/yaml)

Response 200: ConfigPlan (application/json)

GET /admin/api/ws/{ws}/environments​

Environments and their datasource bindings (admin)

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: ConfigEnvironment[] (/)

PUT /admin/api/ws/{ws}/environments/{name}​

Create or replace an environment (admin)

ParameterInTypeRequiredDescription
wspathstringyes
namepathstringyes

Body: PutEnvironment (application/json)

Response 200: ConfigEnvironment (/)

DELETE /admin/api/ws/{ws}/environments/{name}​

Delete an environment (admin)

ParameterInTypeRequiredDescription
wspathstringyes
namepathstringyes

Response 204: no content

data-policies​

GET /admin/api/ws/{ws}/data-policies​

Data policies, optionally of one datasource or endpoint

ParameterInTypeRequiredDescription
wspathstringyes
datasourceIdquerystring (uuid)no
endpointIdquerystring (uuid)no

Response 200: DataPolicy[] (application/json)

POST /admin/api/ws/{ws}/data-policies​

Add a mask or row filter (admin)

ParameterInTypeRequiredDescription
wspathstringyes

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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Body: SaveDataPolicy (application/json)

Response 200: DataPolicy (application/json)

DELETE /admin/api/ws/{ws}/data-policies/{id}​

Remove a policy (admin)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: no content

datasources​

GET /admin/api/ws/{ws}/datasources​

Datasources of the workspace (any member)

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: DatasourceView[] (application/json)

POST /admin/api/ws/{ws}/datasources​

Add a datasource (workspace admin)

ParameterInTypeRequiredDescription
wspathstringyes

Body: SaveDatasource (application/json)

Response 201: DatasourceView (application/json)

GET /admin/api/ws/{ws}/datasources/{id}​

One datasource (any member)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: DatasourceView (application/json)

PATCH /admin/api/ws/{ws}/datasources/{id}​

Change a datasource; omit password to keep it (workspace admin)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: no content

POST /admin/api/ws/{ws}/datasources/{id}:test​

Check a saved datasource can connect (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: DatasourceTestResult (application/json)

GET /admin/api/ws/{ws}/datasources/{id}/columns​

Columns of one table (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes
schemaquerystringno
tablequerystringyes

Response 200: TableColumn[] (application/json)

GET /admin/api/ws/{ws}/datasources/{id}/schemas​

Schemas of the database, system ones left out (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes
schemaquerystringno

Response 200: Tables (application/json)

GET /admin/api/ws/{ws}/datasources/dialects​

Supported databases, default ports and allowed driver properties

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: DialectInfo[] (application/json)

POST /admin/api/ws/{ws}/datasources/test​

Try settings before saving them (workspace admin)

ParameterInTypeRequiredDescription
wspathstringyes

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

ParameterInTypeRequiredDescription
wspathstringyes
endpointIdpathstring (uuid)yes

Response 200: EndpointTestCase[] (application/json)

POST /admin/api/ws/{ws}/endpoints/{endpointId}/tests​

Add a test case (author)

ParameterInTypeRequiredDescription
wspathstringyes
endpointIdpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
endpointIdpathstring (uuid)yes
testIdquerystring (uuid)no

Response 200: TestRunSummary (application/json)

PATCH /admin/api/ws/{ws}/endpoints/{endpointId}/tests/{testId}​

Change a test case (author)

ParameterInTypeRequiredDescription
wspathstringyes
endpointIdpathstring (uuid)yes
testIdpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
endpointIdpathstring (uuid)yes
testIdpathstring (uuid)yes

Response 200: no content

endpoints​

GET /admin/api/ws/{ws}/endpoints​

Endpoints, optionally filtered; trashed=true lists the trash

ParameterInTypeRequiredDescription
wspathstringyes
statequerystringno
groupIdquerystring (uuid)no
datasourceIdquerystring (uuid)no
qquerystringno
trashedquerybooleanno

Response 200: EndpointSummary[] (application/json)

POST /admin/api/ws/{ws}/endpoints​

Create a draft with a starter query (author)

ParameterInTypeRequiredDescription
wspathstringyes

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)

ParameterInTypeRequiredDescription
wspathstringyes
endpointIdpathstring (uuid)yes

Response 200: no content

GET /admin/api/ws/{ws}/endpoints/{id}​

The draft and what is live

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: EndpointDetail (application/json)

PATCH /admin/api/ws/{ws}/endpoints/{id}​

Save the draft; callers keep getting the live version (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: no content

POST /admin/api/ws/{ws}/endpoints/{id}:deprecate​

Announce in responses that callers should move on (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Body: DeprecateRequest (application/json)

Response 200: EndpointSummary (application/json)

POST /admin/api/ws/{ws}/endpoints/{id}:disable​

Stop serving (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: EndpointSummary (application/json)

POST /admin/api/ws/{ws}/endpoints/{id}:duplicate​

Copy the draft as a new draft (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 201: EndpointDetail (application/json)

POST /admin/api/ws/{ws}/endpoints/{id}:enable​

Serve the live version again (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: EndpointSummary (application/json)

POST /admin/api/ws/{ws}/endpoints/{id}:undeprecate​

Stop announcing deprecation (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: EndpointSummary (application/json)

POST /admin/api/ws/{ws}/endpoints/{id}:validate​

Check the saved draft as publish would (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Body: TryRequest (application/json)

Response 200: TryResponse (application/json)

GET /admin/api/ws/{ws}/endpoints/{id}/versions​

Published versions, newest first

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: VersionView[] (application/json)

GET /admin/api/ws/{ws}/endpoints/{id}/versions/{version}​

One published version

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes
versionpathinteger (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes
versionpathinteger (int32)yes

Response 200: EndpointSummary (application/json)

GET /admin/api/ws/{ws}/openapi.json​

OpenAPI 3.1 document of every live endpoint

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: object (application/json)

groups​

GET /admin/api/ws/{ws}/groups​

Endpoint groups with their endpoint counts

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: ApiGroup[] (application/json)

POST /admin/api/ws/{ws}/groups​

Create a group (author)

ParameterInTypeRequiredDescription
wspathstringyes

Body: SaveGroup (application/json)

Response 201: ApiGroup (application/json)

PATCH /admin/api/ws/{ws}/groups/{id}​

Rename a group (author)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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

ParameterInTypeRequiredDescription
idpathstring (uuid)yes

Response 200: ProviderView (application/json)

PATCH /admin/api/identity-providers/{id}​

Change a provider; omit secret to keep it

ParameterInTypeRequiredDescription
idpathstring (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

ParameterInTypeRequiredDescription
idpathstring (uuid)yes

Response 200: no content

POST /admin/api/identity-providers/{id}:test​

Check connectivity; for LDAP optionally sign a test user in

ParameterInTypeRequiredDescription
idpathstring (uuid)yes

Body: TestRequest (application/json)

Response 200: ProviderTestResult (application/json)

GET /admin/api/identity-providers/{id}/group-mappings​

Directory group → role mappings

ParameterInTypeRequiredDescription
idpathstring (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

ParameterInTypeRequiredDescription
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: MemberView[] (application/json)

POST /admin/api/ws/{ws}/members​

Add a user to the workspace (workspace admin)

ParameterInTypeRequiredDescription
wspathstringyes

Body: AddMember (application/json)

Response 201: MemberView (application/json)

PATCH /admin/api/ws/{ws}/members/{userId}​

Change a member's role (workspace admin)

ParameterInTypeRequiredDescription
wspathstringyes
userIdpathstring (uuid)yes

Body: ChangeRole (application/json)

Response 200: MemberView (application/json)

DELETE /admin/api/ws/{ws}/members/{userId}​

Remove a member (workspace admin)

ParameterInTypeRequiredDescription
wspathstringyes
userIdpathstring (uuid)yes

Response 200: no content

Find users to add (workspace admin)

ParameterInTypeRequiredDescription
wspathstringyes
qquerystringyes

Response 200: UserMatch[] (application/json)

secrets​

GET /admin/api/ws/{ws}/secrets​

Managed secrets and where they are used, without values (admin)

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: ManagedSecret[] (application/json)

POST /admin/api/ws/{ws}/secrets​

Store a secret; refer to it as secret:NAME (admin)

ParameterInTypeRequiredDescription
wspathstringyes

Body: CreateSecret (application/json)

Response 201: ManagedSecret (application/json)

PATCH /admin/api/ws/{ws}/secrets/{name}​

Describe a secret or replace its value (admin)

ParameterInTypeRequiredDescription
wspathstringyes
namepathstringyes

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)

ParameterInTypeRequiredDescription
wspathstringyes
namepathstringyes

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

ParameterInTypeRequiredDescription
wspathstringyes
endpointIdpathstring (uuid)yes

Response 200: EndpointAccess[] (application/json)

GET /admin/api/ws/{ws}/service-accounts​

Service accounts of the workspace

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: ServiceAccount[] (application/json)

POST /admin/api/ws/{ws}/service-accounts​

Create a service account (admin)

ParameterInTypeRequiredDescription
wspathstringyes

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

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes

Response 200: ServiceAccountDetail (application/json)

PATCH /admin/api/ws/{ws}/service-accounts/{id}​

Rename, describe, disable or enable (admin)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes
clientRowIdpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes
clientRowIdpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes
clientRowIdpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes
idpathstring (uuid)yes
resourceTypepathstringyes
resourceIdpathstring (uuid)yes

Response 200: no content

serving-policy​

GET /admin/api/ws/{ws}/serving-policy​

Firewall and rate limits

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: ServingPolicy (application/json)

PUT /admin/api/ws/{ws}/serving-policy​

Replace firewall and rate limits (admin)

ParameterInTypeRequiredDescription
wspathstringyes

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

ParameterInTypeRequiredDescription
idpathstring (uuid)yes

Response 204: no content

transfer​

GET /admin/api/ws/{ws}/export​

The workspace as YAML documents, without secrets (admin)

ParameterInTypeRequiredDescription
wspathstringyes
formatquerystringno

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)

ParameterInTypeRequiredDescription
wspathstringyes
dryRunquerybooleanno

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

ParameterInTypeRequiredDescription
idpathstring (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

ParameterInTypeRequiredDescription
idpathstring (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)

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: WorkspaceView (application/json)

PATCH /admin/api/workspaces/{ws}​

Rename or change quotas (workspace owner)

ParameterInTypeRequiredDescription
wspathstringyes

Body: UpdateWorkspace (application/json)

Response 200: WorkspaceView (application/json)

POST /admin/api/workspaces/{ws}:archive​

Stop serving and hide a workspace (system admin)

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: WorkspaceView (application/json)

POST /admin/api/workspaces/{ws}:restore​

Bring an archived workspace back (system admin)

ParameterInTypeRequiredDescription
wspathstringyes

Response 200: WorkspaceView (application/json)

Schemas​

AddMember​

FieldTypeRequiredDescription
roleowner | admin | script_author | author | vieweryes
userIdstring (uuid)yes

AlertChannel​

FieldTypeRequiredDescription
createdAtstring (date-time)yes
enabledbooleanyes
idstring (uuid)yes
kindslack | teams | google_chat | webhookyes
lastErrorstringnoWhy the last delivery failed; null when it worked
lastSentAtstring (date-time)no
namestringyes
urlHoststringyesHost the webhook posts to

AlertTestResult​

FieldTypeRequiredDescription
errorstringno
okbooleanyes
statusinteger (int32)no

Alerts​

FieldTypeRequiredDescription
enabledbooleanyes

ApiGroup​

FieldTypeRequiredDescription
endpointCountinteger (int32)yes
grantCountinteger (int32)yes
idstring (uuid)yes
namestringyes

ApiToken​

FieldTypeRequiredDescription
createdAtstring (date-time)yes
expiresAtstring (date-time)no
idstring (uuid)yes
lastUsedAtstring (date-time)no
namestringyes
prefixstringyesFirst characters, to recognise the token
workspacestringnoOnly this workspace; null means every workspace of the user

AuditEntry​

FieldTypeRequiredDescription
actionstringyes
detailJsonNodeno
idinteger (int64)yes
targetIdstringno
targetTypestringno
tsstring (date-time)yes
usernamestringno
workspaceIdstring (uuid)no

AuthProviders​

FieldTypeRequiredDescription
ldapProviderRef[]yes
localbooleanyes
oidcProviderRef[]yes

Cache​

Result cache (spec §9.5)

FieldTypeRequiredDescription
enabledbooleanyes
scopeclient | sharedyes
ttlSecondsinteger (int32)yes

ChangePassword​

FieldTypeRequiredDescription
currentPasswordstringyes
newPasswordstringyes

ChangeRole​

FieldTypeRequiredDescription
roleowner | admin | script_author | author | vieweryes

Client​

FieldTypeRequiredDescription
clientIdstringyes
createdAtstring (date-time)yes
expiresAtstring (date-time)no
hmacRequiredbooleanyesRequests must carry an HMAC signature (spec §8.2)
idstring (uuid)yes
lastUsedAtstring (date-time)no
publicKeystringnoRSA public key (PEM) responses are encrypted to
responseEncryptbooleanyesResponses are encrypted to the client's public key (spec §8.3)
revokedAtstring (date-time)no

ClientSecurityResult​

FieldTypeRequiredDescription
clientClientyes
signingKeystringnoShown once when issued; store it now

ConfigApplyResult​

FieldTypeRequiredDescription
planConfigPlanyes
publishedPublishOutcome[]yes

ConfigChange​

FieldTypeRequiredDescription
actioncreate | update | delete | unchanged | skipyes
detailsstring[]yesWhat differs, e.g. spec.task or publish
kindstringyes
namestringyes

ConfigEnvironment​

FieldTypeRequiredDescription
bindingsobjectyesLogical datasource name in configuration files → datasource name in this workspace
namestringyes
updatedAtstring (date-time)yes

ConfigPlan​

FieldTypeRequiredDescription
changesConfigChange[]yes
countsobjectyesNumber of changes per action
digeststringyesIdentifies this plan; pass it to apply to refuse a workspace that changed since
environmentstringno
prunebooleanyes
publishbooleanyes

CreateApiToken​

FieldTypeRequiredDescription
expiresInDaysinteger (int32)noDays until it expires, 1–365; null never expires
namestringyes
workspacestringnoLimit the token to this workspace (slug)

CreateClient​

FieldTypeRequiredDescription
expiresInDaysinteger (int32)no

CreateEndpoint​

FieldTypeRequiredDescription
accessstringyes
datasourceIdstring (uuid)yes
groupIdstring (uuid)no
methodstringyes
namestringyes
pathstringyes

CreateSecret​

FieldTypeRequiredDescription
descriptionstringno
namestringyes
valuestringyesWrite-only; never returned

CreateUser​

FieldTypeRequiredDescription
displayNamestringno
emailstringno
passwordstringyes
systemAdminbooleanyes
usernamestringyes

CreateWorkspace​

FieldTypeRequiredDescription
namestringyes
ownerUserIdstring (uuid)noFirst owner; defaults to the caller
slugstringyes

CreatedApiToken​

FieldTypeRequiredDescription
secretstringyesShown once; store it now
tokenApiTokenyes

DataPolicy​

FieldTypeRequiredDescription
attributestringnoFor kind row_filter: the service account attribute holding the allowed value(s)
columnstringyes
createdAtstring (date-time)yes
datasourceIdstring (uuid)no
endpointIdstring (uuid)no
exemptServiceAccountsstring (uuid)[]yesService accounts this policy does not apply to
idstring (uuid)yes
kindmask | row_filteryes
maskMaskyes
updatedAtstring (date-time)yes

DatasourceTestResult​

FieldTypeRequiredDescription
latencyMsinteger (int64)no
messagestringyes
okbooleanyes
productstringno
versionstringno

DatasourceView​

FieldTypeRequiredDescription
createdAtstring (date-time)yes
databasestringnoDatabases only
descriptionstringno
dialectPOSTGRESQL | MYSQL | MARIADB | SQLSERVER | ORACLE | TRINO | STARROCKS | DORIS | CLICKHOUSEnoDatabases only
hasPasswordbooleanyes
hoststringyes
httpHttpConfigyes
idstring (uuid)yes
lastTestLastTestyes
namestringyes
passwordEnvstringnoThe env: or vault: reference when the password comes from outside
passwordSecretstringnoThe managed secret holding the password, when it is one
poolPoolSettingsyes
portinteger (int32)yes
propertiesobjectyes
readOnlybooleanyes
typejdbc | httpyes
updatedAtstring (date-time)yes
usernamestringnoDatabases only

Day​

FieldTypeRequiredDescription
daystring (date)yes
errorsinteger (int64)yes
requestsinteger (int64)yes

DbapiExport​

FieldTypeRequiredDescription
apisJsonNodeno
datasourcesJsonNodeno
groupsJsonNodeno

DeprecateRequest​

FieldTypeRequiredDescription
sunsetstring (date-time)noWhen the endpoint will stop answering (Sunset header)

DialectInfo​

FieldTypeRequiredDescription
allowedPropertiesstring[]yes
defaultPortinteger (int32)yes
dialectPOSTGRESQL | MYSQL | MARIADB | SQLSERVER | ORACLE | TRINO | STARROCKS | DORIS | CLICKHOUSEyes
passwordOptionalbooleanyesWhether a datasource may have no password
transactionalbooleanyesWhether a rollback undoes writes: preview and transactions need it

EndpointAccess​

FieldTypeRequiredDescription
disabledbooleanyes
namestringyes
serviceAccountIdstring (uuid)yes
viaendpoint | groupyes

EndpointDefinition​

FieldTypeRequiredDescription
alertsAlertsyes
cacheCacheyes
limitsLimitsyes
outputOutputyes
paginationPaginationyes
paramsParam[]yes
rulesRule[]yesChecks on the bound parameters, run before the query (spec §13.1)
streamingStreamingyes
taskTaskyes

EndpointDetail​

FieldTypeRequiredDescription
createdAtstring (date-time)yes
definitionEndpointDefinitionyes
summaryEndpointSummaryyes

EndpointSummary​

FieldTypeRequiredDescription
accessprivate | publicyes
datasourceIdstring (uuid)no
deprecatedAtstring (date-time)no
descriptionstringno
dirtybooleanyes
groupIdstring (uuid)no
idstring (uuid)yes
liveVersioninteger (int32)no
majorinteger (int32)yesMajor version within its lineage (spec §16)
methodstringyes
namestringyes
pathstringyes
statedraft | live | disabledyes
sunsetAtstring (date-time)no
trashedbooleanyes
updatedAtstring (date-time)yes

EndpointTestCase​

FieldTypeRequiredDescription
createdAtstring (date-time)yes
expectTestExpectationyes
idstring (uuid)yes
lastResultTestCaseResultyes
namestringyes
paramsobjectyesParameter values by name; page and size select a page
serviceAccountIdstring (uuid)noCall as this service account (grants, rules and data policies apply); null runs like preview
updatedAtstring (date-time)yes

ExecutedSql​

FieldTypeRequiredDescription
parametersobject[]yes
sqlstringyes

Finding​

FieldTypeRequiredDescription
codestringyes
messagestringyes
severitystringyes

Firewall​

FieldTypeRequiredDescription
entriesstring[]yes
modeoff | allow | denyyes

Grant​

FieldTypeRequiredDescription
detailstringnoMethod and path, for an endpoint
grantedAtstring (date-time)yes
resourceIdstring (uuid)yes
resourceNamestringyes
resourceTypestringyes

HttpCall​

HTTP tasks: the request to the HTTP datasource

FieldTypeRequiredDescription
bodyHttpField[]noJSON body fields: name and expression; none sends no body
methodGET | POST | PUT | PATCH | DELETEyes
pathstringyes
queryHttpField[]noQuery string: name and expression; null values are left out
resultPathstringnoJSON Pointer to the rows, e.g. /data/items

HttpConfig​

HTTP APIs: required

FieldTypeRequiredDescription
authnone | bearer | basic | headeryes
baseUrlstringyes
connectTimeoutMsinteger (int32)no250–60000 ms, default 10000
headerNamestringnoAPI key authentication only
headersobjectno
usernamestringnoBasic authentication only

HttpField​

JSON body fields: name and expression; none sends no body

FieldTypeRequiredDescription
namestringyes
valuestringyes

ImportReport​

FieldTypeRequiredDescription
createdinteger (int32)yes
dryRunbooleanyes
itemsImportedItem[]yes
skippedinteger (int32)yes

ImportedItem​

FieldTypeRequiredDescription
idstring (uuid)no
kindstringyes
namestringyes
notesstring[]yes
resultcreated | existing | skippedyes

JsonNode​

JsonPathCheck​

FieldTypeRequiredDescription
equalsJsonNodeno
existsbooleanno
pathstringyes

KeysetKey​

FieldTypeRequiredDescription
columnstringyes
descendingbooleanyes

LastTest​

Last connection test; null when never tested since the settings changed

FieldTypeRequiredDescription
atstring (date-time)yes
messagestringyes
okbooleanyes

Limits​

FieldTypeRequiredDescription
maxRowsinteger (int32)yes
ratePerMinuteinteger (int32)noCalls per minute across all callers; null = unlimited
streamMaxRowsinteger (int32)noMost rows a streamed response returns; null = maxRows
timeoutSecondsinteger (int32)yes

LineageMember​

FieldTypeRequiredDescription
deprecatedAtstring (date-time)no
idstring (uuid)yes
liveVersioninteger (int32)no
majorinteger (int32)yes
methodstringyes
namestringyes
pathstringyes
statestringyes
sunsetAtstring (date-time)no

LogEntry​

FieldTypeRequiredDescription
clientIdstringno
durationMsinteger (int32)yes
endpointIdstring (uuid)no
endpointNamestringno
errorstringno
errorCodestringno
idstring (uuid)yes
ipstringno
methodstringyes
pathstringyes
requestIdstringno
rowsinteger (int32)no
statusinteger (int32)yes
traceIdstringno
tryItbooleanyes
tsstring (date-time)yes
versioninteger (int32)no

LoginRequest​

FieldTypeRequiredDescription
idpIdstring (uuid)noRequired when source is ldap
passwordstringyes
sourcelocal | ldapyes
usernamestringyes

ManagedSecret​

FieldTypeRequiredDescription
createdAtstring (date-time)yes
descriptionstringno
namestringyes
updatedAtstring (date-time)yes
usedBySecretUse[]yesDatasources and alert channels that use it

MappingView​

FieldTypeRequiredDescription
externalGroupstringyes
managedbooleanyes
rolesystem_admin | owner | admin | script_author | author | vieweryes
workspacestringnoWorkspace slug; null only for system_admin

Mask​

FieldTypeRequiredDescription
keepEndinteger (int32)no
keepStartinteger (int32)no
typephone | email | partial | hash | nullifyyes

Me​

FieldTypeRequiredDescription
displayNamestringno
emailstringno
idstring (uuid)yes
sourcestringyes
systemAdminbooleanyes
usernamestringyes
workspacesMyWorkspace[]yes

MemberView​

FieldTypeRequiredDescription
createdAtstring (date-time)yes
displayNamestringno
emailstringno
fromMappingbooleanyes
roleowner | admin | script_author | author | vieweryes
sourcestringyes
userIdstring (uuid)yes
usernamestringyes

MoveEndpoint​

FieldTypeRequiredDescription
groupIdstring (uuid)noThe group to put the endpoint in; null for no group

MyWorkspace​

FieldTypeRequiredDescription
configLockedbooleanyesManaged by configuration files (spec §15.2)
idstring (uuid)yes
namestringyes
roleowner | admin | script_author | author | vieweryes
slugstringyes

Nest​

FieldTypeRequiredDescription
collectionsNestCollection[]yes
keystringyes

NestCollection​

FieldTypeRequiredDescription
asstringyes
keystringyes
prefixstringyes

NewClient​

FieldTypeRequiredDescription
clientClientyes
clientSecretstringyesShown once; store it now

NewMajorRequest​

FieldTypeRequiredDescription
pathstringnoDefaults to v<N>/… from the current path

Output​

How rows are shaped in the response (spec §9.2)

FieldTypeRequiredDescription
namingas_is | camelCaseyes
nestNest[]no
shapelist | single | scalaryes
typesobjectno

Pagination​

FieldTypeRequiredDescription
countbooleanyes
defaultSizeinteger (int32)yes
enabledbooleanyes
keysKeysetKey[]no
maxSizeinteger (int32)yes
modeoffset | keysetno

Param​

FieldTypeRequiredDescription
defaultValueJsonNodeno
descriptionstringno
enumValuesstring[]no
inpath | query | header | bodyyes
maxnumbernoNumbers: largest value; text: longest length
maxItemsinteger (int32)no
minnumbernoNumbers: smallest value; text: shortest length
namestringyes
patternstringnoRegular expression the value must match
requiredbooleanyes
typestring | bigint | double | decimal | boolean | date | datetime | array<string> | array<bigint> | array<double> | array<date>yes

PoolSettings​

FieldTypeRequiredDescription
connectionTimeoutMsinteger (int32)no250–60000 ms, default 10000
maximumPoolSizeinteger (int32)no1–50, default 10
minimumIdleinteger (int32)nodefault 0

PreviewRequest​

FieldTypeRequiredDescription
definitionEndpointDefinitionyes
methodstringyes
pageinteger (int32)no
paramsobjectnoTest values by parameter name
pathstringyes
sizeinteger (int32)no

PreviewResponse​

FieldTypeRequiredDescription
affectedRowsinteger (int64)no
columnsResultColumn[]yes
durationMsinteger (int64)yes
executedExecutedSql[]yes
findingsFinding[]yes
hasNextbooleanno
rowsobject[]yes
totalinteger (int64)no
truncatedbooleanyes
valueobjectnoFull-mode scripts: what the script returned

ProviderRef​

FieldTypeRequiredDescription
idstring (uuid)yes
namestringyes

ProviderTestResult​

FieldTypeRequiredDescription
messagesstring[]yes
okbooleanyes

ProviderView​

FieldTypeRequiredDescription
configobjectyesProvider settings without secrets
createdAtstring (date-time)yes
enabledbooleanyes
hasSecretbooleanyes
idstring (uuid)yes
namestringyes
secretEnvstringnoenv: references are shown; sealed values are not
typeldap | oidcyes
updatedAtstring (date-time)yes

PublishOutcome​

FieldTypeRequiredDescription
endpointstringyes
messagestringno
resultpublished | disabled | tests_failed | failedyes

PublishRequest​

FieldTypeRequiredDescription
notestringno

PutEnvironment​

FieldTypeRequiredDescription
bindingsobjectyesLogical datasource name in configuration files → datasource name here

RateLimits​

FieldTypeRequiredDescription
perClientPerMinuteinteger (int32)no
perIpPerMinuteinteger (int32)no

ResetPassword​

FieldTypeRequiredDescription
passwordstringyes

ResultColumn​

FieldTypeRequiredDescription
namestringyes
typestringyes

RowCountRange​

FieldTypeRequiredDescription
maxinteger (int32)no
mininteger (int32)no

Rule​

Checks on the bound parameters, run before the query (spec §13.1)

FieldTypeRequiredDescription
messagestringyes
teststringyes

SaveAlertChannel​

FieldTypeRequiredDescription
enabledbooleanyes
kindslack | teams | google_chat | webhookyes
namestringyes
urlstringnoWrite-only; never returned

SaveClientSecurity​

FieldTypeRequiredDescription
hmacRequiredbooleanyes
publicKeystringno
responseEncryptbooleanyes
rotateSigningKeybooleanyes

SaveDataPolicy​

FieldTypeRequiredDescription
attributestringno
columnstringyes
datasourceIdstring (uuid)no
endpointIdstring (uuid)no
exemptServiceAccountsstring (uuid)[]no
kindmask | row_filteryes
maskMaskyes

SaveDatasource​

FieldTypeRequiredDescription
databasestringnoDatabases: required
descriptionstringno
dialectPOSTGRESQL | MYSQL | MARIADB | SQLSERVER | ORACLE | TRINO | STARROCKS | DORIS | CLICKHOUSEnoDatabases: required
hoststringnoDatabases: required
httpHttpConfigno
namestringyes
passwordstringnoPlain password, token or API key (stored encrypted), or a secret:, env: or vault: reference; omit to keep the stored one
poolPoolSettingsno
portinteger (int32)noDefault port of the dialect when empty
propertiesobjectno
readOnlybooleanyes
typejdbc | httpnoDefault jdbc
usernamestringnoDatabases: required

SaveEndpointTest​

FieldTypeRequiredDescription
expectTestExpectationyes
namestringyes
paramsobjectno
serviceAccountIdstring (uuid)no

SaveGrant​

FieldTypeRequiredDescription
resourceIdstring (uuid)yes
resourceTypestringyes

SaveGroup​

FieldTypeRequiredDescription
namestringyes

SaveProvider​

FieldTypeRequiredDescription
configobjectyes
enabledbooleanyes
namestringyes
secretstringnoPlain secret (sealed on save) or an env:NAME reference; omit to keep
typeldap | oidcyes

SaveServiceAccount​

FieldTypeRequiredDescription
attributesobjectnoReplaces all attributes; null keeps them
descriptionstringno
disabledbooleanyes
namestringyes

SecretUse​

Datasources and alert channels that use it

FieldTypeRequiredDescription
idstring (uuid)yes
kinddatasource | alert_channelyes
namestringyes

ServiceAccount​

FieldTypeRequiredDescription
attributesobjectyesFacts about the caller that row filters read (spec §12.2), values are strings, numbers, booleans or lists of them
clientCountinteger (int32)yes
createdAtstring (date-time)yes
descriptionstringno
disabledbooleanyes
grantCountinteger (int32)yes
idstring (uuid)yes
lastUsedAtstring (date-time)no
namestringyes

ServiceAccountDetail​

FieldTypeRequiredDescription
clientsClient[]yes
grantsGrant[]yes
summaryServiceAccountyes

ServingPolicy​

FieldTypeRequiredDescription
firewallFirewallyes
rateLimitsRateLimitsyes

Statement​

FieldTypeRequiredDescription
idstringyes
templatestringyes

Streaming​

FieldTypeRequiredDescription
allowedbooleanyes
formatsndjson | csv[]yes

Summary​

FieldTypeRequiredDescription
activeClientsinteger (int64)yes
byDayDay[]yes
errorsinteger (int64)yes
p95Msnumber (double)no
requestsinteger (int64)yes
slowestEndpointsTopEndpoint[]yesEndpoints with the highest p95 latency, at least 5 calls each
topClientsTopClient[]yes
topEndpointsTopEndpoint[]yes
topErrorsTopError[]yes
topIpsTopIp[]yes

SystemInfo​

FieldTypeRequiredDescription
modestringyes
servingBaseUrlstringyes
tokenUrlstringyes
versionstringyes

Table​

FieldTypeRequiredDescription
namestringyes
remarksstringyes
schemastringyes
typestringyes

TableColumn​

FieldTypeRequiredDescription
namestringyes
nullablebooleanyes
positioninteger (int32)yes
sizeinteger (int32)yes
typestringyes

Tables​

FieldTypeRequiredDescription
itemsTable[]yes
truncatedbooleanyes

Task​

FieldTypeRequiredDescription
datasourceIdstring (uuid)no
languagegroovyno
modefragment | fullno
nodesWorkflowNode[]noWorkflow tasks: the nodes of the graph (spec §6.1)
outputstringnoWorkflow tasks: the node whose result is the answer; the last node when empty
requestHttpCallno
sourcestringnoScript tasks: the Groovy source
statementsStatement[]yes
transactionbooleanyes
typesql | script | workflow | httpyes

TestCaseResult​

FieldTypeRequiredDescription
codestringno
durationMsinteger (int64)yes
failuresstring[]yes
namestringyes
passedbooleanyes
ranAtstring (date-time)yes
rowCountinteger (int32)no
statusinteger (int32)yes
testIdstring (uuid)yes

TestDatasource​

FieldTypeRequiredDescription
existingIdstring (uuid)noUse this saved datasource's password when settings.password is empty
settingsSaveDatasourceyes

TestExpectation​

FieldTypeRequiredDescription
jsonPathJsonPathCheck[]no
maxDurationMsinteger (int32)no
rowCountRowCountRangeyes
schemaMatchesLivebooleanno
statusinteger (int32)no

TestRequest​

FieldTypeRequiredDescription
passwordstringno
usernamestringno

TestRunSummary​

FieldTypeRequiredDescription
failedinteger (int32)yes
passedinteger (int32)yes
resultsTestCaseResult[]yes

TopClient​

FieldTypeRequiredDescription
clientIdstringyes
errorsinteger (int64)yes
p95Msnumber (double)no
requestsinteger (int64)yes
serviceAccountstringno

TopEndpoint​

Endpoints with the highest p95 latency, at least 5 calls each

FieldTypeRequiredDescription
endpointIdstring (uuid)no
errorsinteger (int64)yes
methodstringyes
namestringno
p95Msnumber (double)no
pathstringyes
requestsinteger (int64)yes

TopError​

FieldTypeRequiredDescription
codestringyes
countinteger (int64)yes

TopIp​

FieldTypeRequiredDescription
errorsinteger (int64)yes
ipstringyes
requestsinteger (int64)yes

TryRequest​

FieldTypeRequiredDescription
pageinteger (int32)no
paramsobjectno
serviceAccountIdstring (uuid)no
sizeinteger (int32)no

TryResponse​

FieldTypeRequiredDescription
bodyJsonNodeno
curlstringyes
durationMsinteger (int64)yes
headersobjectyes
methodstringyes
serviceAccountNamestringno
statusinteger (int32)yes
textstringno
urlstringyes

UpdateEndpoint​

FieldTypeRequiredDescription
accessstringyes
definitionEndpointDefinitionyes
descriptionstringno
groupIdstring (uuid)no
methodstringyes
namestringyes
pathstringyes

UpdateSecret​

FieldTypeRequiredDescription
descriptionstringno
valuestringnoWrite-only; never returned

UpdateUser​

FieldTypeRequiredDescription
disabledbooleanno
displayNamestringno
emailstringno
systemAdminbooleanno

UpdateWorkspace​

FieldTypeRequiredDescription
configLockedbooleannoManage the workspace through configuration files only
namestringno
quotasobjectno

UserMatch​

FieldTypeRequiredDescription
displayNamestringno
emailstringno
idstring (uuid)yes
sourcestringyes
usernamestringyes

UserView​

FieldTypeRequiredDescription
createdAtstring (date-time)yes
disabledbooleanyes
displayNamestringno
emailstringno
idstring (uuid)yes
lastLoginAtstring (date-time)no
lockedbooleanyes
sourcestringyes
systemAdminbooleanyes
usernamestringyes

ValidationView​

FieldTypeRequiredDescription
detectedParametersstring[]yes
findingsFinding[]yes
okbooleanyes
outputColumnsResultColumn[]yes

VersionView​

FieldTypeRequiredDescription
accessstringyes
definitionEndpointDefinitionyes
livebooleanyes
methodstringyes
notestringno
pathstringyes
publishedAtstring (date-time)yes
publishedBystringno
versioninteger (int32)yes

WorkflowNode​

Workflow tasks: the nodes of the graph (spec §6.1)

FieldTypeRequiredDescription
answerstringnoend nodes: the expression whose value is the answer, e.g. add
conditionstringnodecision nodes: the expression choosing yes or no
dependsOnstring[]noIds of earlier nodes; id:yes or id:no for a decision's branch
endpointIdstring (uuid)noapi nodes: the endpoint of this workspace to call (its live version)
idstringyes
kindsql | script | api | decision | endyes
paramsobjectnoapi nodes: parameter name → expression, e.g. name → name or id → user.id
resultlist | one | value | updatenosql nodes: what the node's result is; list by default
sourcestringnoscript nodes: a full-mode Groovy script
templatestringnosql nodes: the SQL template
whenstringnoRun only when this expression holds, e.g. user != null
xinteger (int32)noPosition on the canvas
yinteger (int32)noPosition on the canvas

WorkspaceView​

FieldTypeRequiredDescription
archivedAtstring (date-time)no
configLockedbooleanyesManaged by configuration files: endpoints and the like change through config:apply only (spec §15.2)
createdAtstring (date-time)yes
idstring (uuid)yes
lockedByServerbooleanyesLocked by the server for every workspace (opendbapi.ui.read-only)
namestringyes
quotasobjectyes
slugstringyes
statusstringyes