Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
When using a browser session for a mutation, send the current CSRF token in X-CSRF-Token with the same-site cookie. OAuth consent uses its documented form field.
Browser CSRF cookie value. Not required when an allowed machine management credential is used.
Idempotency-Key
Header
string; {"pattern":"^[A-Za-z0-9._~-]{16,128}$"}
No
Persist one identifier before the request and reuse it only for the same normalized payload and resource. Reusing it with different content returns 409.
Origin
Header
string; {"format":"uri"}
No
If present, must match the canonical HTTPS origin. Sec-Fetch-Site cross-site is rejected.
For type=http, HTTPMonitorConfig selects one to five authorized checking locations, IPv4/IPv6/dual-stack, confirmation counts and any/all/quorum. Four overall series retain their identities; each location needs three additional measurement series. Overall response time is the highest fresh location value and its status code belongs to that location; certificate days use the lowest fresh value. Public and explicitly allowlisted private HTTP targets use ports 80/443; localhost names and other ports are not supported. Job, workflow and ai_agent use JobMonitorConfig.
$.external_id
string; {"maxLength":128}
No
—
$.name
string; {"maxLength":128}
Yes
Human-readable resource name. Follow the listed length limit.
$.paused
boolean
No
Whether automatic monitor work is paused. Existing telemetry and historical data remain.
Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Language
string; {"enum":["en","de"]}
Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Idempotent-Replayed
JSON; {"const":"true"}
Present only when the original stored mutation result is replayed.
Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Language
string; {"enum":["en","de"]}
Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Idempotent-Replayed
JSON; {"const":"true"}
Present only when the original stored mutation result is replayed.
Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Language
string; {"enum":["en","de"]}
Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Language
string; {"enum":["en","de"]}
Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Language
string; {"enum":["en","de"]}
Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Language
string; {"enum":["en","de"]}
Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Language
string; {"enum":["en","de"]}
Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Language
string; {"enum":["en","de"]}
Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Language
string; {"enum":["en","de"]}
Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Save an Idempotency-Key before sending. Retry it only for the same target and unchanged request. A changed payload returns 409. Use this header only where the endpoint documents it.
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
Send the same selection and operation UUID with the preview version and confirmed=true. Existing HTTP checks that can change targets additionally require actions_confirmed=true. A configuration, allowance or selection change requires a new preview. All selected monitors change together or none change; retries do not repeat the action. External client intervals and cron schedules use their individual settings.
Select 1–100 monitors in one workspace and choose pause, resume, group assignment or collection interval. The preview lists the exact selection and account-wide daily consumption before and after the change. Reviewing changes nothing and reserves no capacity. Unsupported intervals or an increased allowance violation block the whole selection.