Create a synthetic
Request
- Base URLhttps://api.openobserve.ai (the document declares no server; this is the origin it was published from)
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Organization name
Query parameters
Folder ID to create the synthetic in
Request body
Alert only after this many consecutive failures (like alerts trigger_tolerance).
Collect RUM data for browser checks (session replay / performance).
Silence period (minutes) between repeated alert notifications.
Alert destination names to notify on check failure.
Environments this check runs against, by id.
Folder this synthetic belongs to, as the public folder slug the API accepts and returns; it is resolved to the folders.id KSUID on write.
When the scheduler last fanned out this synthetic (microseconds). UI: "LAST CHECK".
Pre-computed next fire time (microseconds). 0 = fire on first tick.
Email of the user who created this synthetic. Set on create, never updated.
Number of retries before marking a check failed (0 = no retry).
Enable session replay capture (browser checks only).
Unix epoch microseconds — when to first run the check ("schedule later"). When set, the scheduler uses this as the initial next_run_at instead of firing immediately.
User-defined tags for filtering/grouping (e.g. ["prod", "checkout"]).
Target URL (HTTP/Browser) or host:port (TCP/TLS/SSH).
Template override for this check's messages; null or "" uses the destination's.
UTC offset in minutes, used only when frequency.timezone is absent or unparseable.
Seconds to wait between retry attempts.
Response
Created
Alert only after this many consecutive failures (like alerts trigger_tolerance).
Collect RUM data for browser checks (session replay / performance).
Silence period (minutes) between repeated alert notifications.
Alert destination names to notify on check failure.
Environments this check runs against, by id.
Folder this synthetic belongs to, as the public folder slug the API accepts and returns; it is resolved to the folders.id KSUID on write.
When the scheduler last fanned out this synthetic (microseconds). UI: "LAST CHECK".
Pre-computed next fire time (microseconds). 0 = fire on first tick.
Email of the user who created this synthetic. Set on create, never updated.
Number of retries before marking a check failed (0 = no retry).
Enable session replay capture (browser checks only).
Unix epoch microseconds — when to first run the check ("schedule later"). When set, the scheduler uses this as the initial next_run_at instead of firing immediately.
User-defined tags for filtering/grouping (e.g. ["prod", "checkout"]).
Target URL (HTTP/Browser) or host:port (TCP/TLS/SSH).
Template override for this check's messages; null or "" uses the destination's.
UTC offset in minutes, used only when frequency.timezone is absent or unparseable.
Seconds to wait between retry attempts.
Changes
No recorded changes to this operation across all 1 revision of this API.