Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

OAuth 2.0 Client Credentials flow. The tokenUrl shown is for the production environment. For other environments, replace prod with the target environment name (e.g., auth.staging.oleria.io for staging).

Body

application/json
name
string
required
Required string length: 1 - 200
Example:

"Disabled MFA accounts"

query_string
string
required

The SQL text. Stored verbatim — not parsed or validated as SQL at save (it may be a draft or carry :placeholder parameters). SQL validity is checked at execution time via /v1/query/execute.

Required string length: 1 - 100000
Example:

"SELECT account_id, mfa_status FROM oleria_account WHERE mfa_status = :status"

model
string
default:oleria_identity

Semantic model the query targets. Optional — defaults to oleria_identity. Validated against the available models (/v1/schema/models) at save.

Example:

"oleria_identity"

description
string
Maximum string length: 2000
Example:

"Accounts where MFA is disabled"

Response

Saved query created.

A stored SQL query with authorship metadata.

query_id
string<uuid>
required

Opaque stable identifier. Clients key on this, never the name.

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required

Free-form label, unique within the tenant (case-insensitive).

Example:

"Disabled MFA accounts"

query_string
string
required

The stored SQL text.

Example:

"SELECT account_id, mfa_status FROM oleria_account WHERE mfa_status = :status"

model
string
required

Semantic model the query targets.

Example:

"oleria_identity"

created_by
object
required

The principal (user or service client) that created or last modified the saved query, identified by a stable, opaque id.

last_modified_by
object
required

The principal (user or service client) that created or last modified the saved query, identified by a stable, opaque id.

version
integer
required

Monotonic version — 1 on create, incremented on every update. Doubles as the optimistic-concurrency token on update.

Example:

3

created_at
string<date-time>
required
Example:

"2026-06-01T10:00:00Z"

last_modified_at
string<date-time>
required
Example:

"2026-06-04T09:30:00Z"

description
string

Optional free-form context about the query.

Example:

"Accounts where MFA is disabled — weekly review"