ScalixScalix Docs

Database API

SQL query execution and schema inspection

REST API endpoints for Database. 7 operations.

Detect database anomalies

plaintext
POST /api/v1/anomalies

Analyzes recent activity and returns a report of detected database anomalies.

Auth: Bearer API key

Responses

StatusDescription
200Anomaly report
401Missing or invalid API key
500Internal error

operationId: detectAnomalies

Translate natural language to SQL

plaintext
POST /api/v1/nl-to-sql

Generates a SQL statement from a natural-language description of the desired query.

Auth: Bearer API key

Responses

StatusDescription
200Generated SQL
401Missing or invalid API key
500Internal error

operationId: naturalLanguageToSql

Get query optimization suggestions

plaintext
POST /api/v1/optimize

Analyzes the tenant's database and returns indexing and query optimization suggestions.

Auth: Bearer API key

Responses

StatusDescription
200Optimization suggestions
401Missing or invalid API key
500Internal error

operationId: optimizeQuery

List recent query logs

plaintext
GET /api/v1/query-logs/{tenant_id}

Returns recent query-log entries for a tenant, newest first.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
tenant_idpathstringYesTenant id (UUID)
limitqueryinteger (int64)NoMax entries to return (default 100, max 1000)

Responses

StatusDescription
200Recent query log entries
401Missing or invalid API key
500Internal error

operationId: listQueryLogs

Get scaling suggestions

plaintext
GET /api/v1/scaling

Returns capacity and scaling recommendations for the tenant's database.

Auth: Bearer API key

Responses

StatusDescription
200Scaling suggestions
401Missing or invalid API key
500Internal error

operationId: getScalingSuggestions

Execute a SQL query

plaintext
POST /api/v1/sql

Runs a parameterized SQL statement against the tenant's database and returns the result set.

Auth: Bearer API key

Request body

application/json (required) — schema SqlRequest.

Responses

StatusDescription
200Query results
400Invalid SQL
401Missing or invalid API key
429Rate limit exceeded
500Internal error

operationId: executeSql

Execute a batch of SQL queries

plaintext
POST /api/v1/sql/batch

Runs multiple SQL statements in one request; each query executes independently and returns its own result set.

Auth: Bearer API key

Request body

application/json (required) — schema BatchSqlRequest.

Responses

StatusDescription
200Array of query results
401Missing or invalid API key
500Internal error

operationId: batchSql