Skip to main content
POST
Create a data diff monitor

Authorizations

Authorization
string
header
required

Use the 'Authorization' header with the format 'Key '

Body

application/json

A monitor definition. The as-code spec, with name required.

Named as the pre-fork schema was so the published OpenAPI component keeps its identifier; the fields are DiffMonitorSpec's, minus the removed features.

datadiff
DiffConfigSpec · object
required

The diff the monitor runs.

name
string
required

The name of the monitor.

alert
AlertSpec · object

What makes a run alert.

description
string | null

Free-text description.

enabled
boolean
default:true

Whether the schedule fires.

owner
string | null

Email of the monitor owner. Resolved best-effort — an address matching no user in the org leaves the owner unset rather than failing the call.

schedule
ScheduleSpec · object

When the monitor runs.

slug
string | null

Stable identifier, and the identity monitors-as-code reconciles on. Optional, but a monitor without one cannot be exported as YAML.

tags
string[]

Tags on the monitor.

Response

Successful Response

id
integer
required

Unique identifier for the created monitor.