OPopenobserve
Synthetics

Update a synthetic

put/api/{org_id}/synthetics/{id}

Request

Path parameters

org_idstring required

Organization name

idstring required

Check ID

Query parameters

folderstring

Current folder ID of the synthetic (for RBAC)

Request body

alert_if_failsinteger

Alert only after this many consecutive failures (like alerts trigger_tolerance).

collect_rum_databoolean

Collect RUM data for browser checks (session replay / performance).

configunknown required
cooldown_minsinteger

Silence period (minutes) between repeated alert notifications.

created_atinteger
descriptionstring
destinationsstring[]

Alert destination names to notify on check failure.

enabledboolean required
environmentsstring[]

Environments this check runs against, by id.

folder_idstring

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.

idstring
last_check_status'passed' | 'warning' | 'failed' | 'unknown' | 'error'
last_triggered_atinteger

When the scheduler last fanned out this synthetic (microseconds). UI: "LAST CHECK".

locationsstring[] required
namestring required
next_run_atinteger

Pre-computed next fire time (microseconds). 0 = fire on first tick.

org_idstring
ownerstring nullable

Email of the user who created this synthetic. Set on create, never updated.

retriesinteger

Number of retries before marking a check failed (0 = no retry).

session_replayboolean

Enable session replay capture (browser checks only).

startinteger nullable

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.

tagsstring[]

User-defined tags for filtering/grouping (e.g. ["prod", "checkout"]).

targetstring required

Target URL (HTTP/Browser) or host:port (TCP/TLS/SSH).

templatestring nullable

Template override for this check's messages; null or "" uses the destination's.

type'http' | 'tcp' | 'tls' | 'ssh' | 'browser' required
tz_offsetinteger

UTC offset in minutes, used only when frequency.timezone is absent or unparseable.

updated_atinteger
wait_before_retry_secsinteger

Seconds to wait between retry attempts.

Response

Updated

alert_if_failsinteger

Alert only after this many consecutive failures (like alerts trigger_tolerance).

collect_rum_databoolean

Collect RUM data for browser checks (session replay / performance).

configunknown required
cooldown_minsinteger

Silence period (minutes) between repeated alert notifications.

created_atinteger
descriptionstring
destinationsstring[]

Alert destination names to notify on check failure.

enabledboolean required
environmentsstring[]

Environments this check runs against, by id.

folder_idstring

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.

idstring
last_check_status'passed' | 'warning' | 'failed' | 'unknown' | 'error'
last_triggered_atinteger

When the scheduler last fanned out this synthetic (microseconds). UI: "LAST CHECK".

locationsstring[] required
namestring required
next_run_atinteger

Pre-computed next fire time (microseconds). 0 = fire on first tick.

org_idstring
ownerstring nullable

Email of the user who created this synthetic. Set on create, never updated.

retriesinteger

Number of retries before marking a check failed (0 = no retry).

session_replayboolean

Enable session replay capture (browser checks only).

startinteger nullable

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.

tagsstring[]

User-defined tags for filtering/grouping (e.g. ["prod", "checkout"]).

targetstring required

Target URL (HTTP/Browser) or host:port (TCP/TLS/SSH).

templatestring nullable

Template override for this check's messages; null or "" uses the destination's.

type'http' | 'tcp' | 'tls' | 'ssh' | 'browser' required
tz_offsetinteger

UTC offset in minutes, used only when frequency.timezone is absent or unparseable.

updated_atinteger
wait_before_retry_secsinteger

Seconds to wait between retry attempts.

Changes

No recorded changes to this operation across all 1 revision of this API.