API sequence monitoring
Configure ordered HTTP checks with variables and cleanup steps.
An API sequence monitor checks a transaction made of ordered HTTP steps—for example sign in, create an order, read it back, and clean it up. It shares the worker, scheduling, retry, region, proxy, custom-CA, and incident lifecycle of other monitors while adding variables, extraction, and per-step diagnostics.
Build a sequence
Set an optional base URL and add up to 20 main steps. A step can be reordered without losing its encrypted fields. Each step supports:
- GET, HEAD, POST, PUT, PATCH, DELETE, or OPTIONS;
- a relative or absolute URL, query parameters, and request headers;
- no body, JSON, text, or form body;
- accepted HTTP status range, redirect policy, TLS verification, and its own response-time budget;
- Continue if this step fails when later diagnostic steps should still execute.
Add up to five cleanup steps for logout or test-data removal. Cleanup runs after the main sequence whether it passed or failed, and cleanup failure is reported in diagnostics without changing the sequence's pass/fail result.
Variables and extraction
Define ordinary or secret starting variables and reference them as
{{variableName}} in step URLs, query values, headers, and bodies. A step can
extract a new value from a JSON pointer, response header, regular expression
capture group, status code, or body. Required extraction fails the step when no
value is found; optional extraction does not.
Mark credentials and sensitive extracted values secret. Secret variables are masked everywhere they would otherwise appear in diagnostics. Status validates that a placeholder is defined initially or extracted by an earlier step, so a sequence cannot save with a forward or missing reference.
Assertions
Assertions can read status code, a JSON pointer, header, body, or response time. Match modes are equals, not-equals, contains, not-contains, regular expression, exists, absent, less-than, and greater-than. A status range or step budget can fail independently of explicit assertions.
Test the draft in the monitor workbench. Diagnostics show every passed, failed, or skipped step, extracted non-secret variable names, assertion expected/actual values, response samples, and cleanup steps.
Security and portability
URLs, query/header values, bodies, secret starting variables, proxy credentials, and custom CA bundles use monitor envelope encryption and write-only markers. Clone, template, history, import, and export preserve the sequence. An explicit export is secret-bearing and must be handled as a credential. See Monitor credential security.