Get Monitor by Name
AI-generatedSummary
Fetch a monitor by its name.
Inputs
- monitorName (required) — The name of the monitor to fetch (e.g. "S1 Germany", "US Ashburn")
- additionalFields — Optional fields to include in the output; defaults to including downtime history.
Output shape
array of items, each containing a json object with the monitor data and a pairedItem metadata object
Returns an error if the monitor name is not found; respects the
continueOnFailsetting; optionally omits thedailyMinutesDownfield whenincludeDowntimeis disabled.
Examples
Example 1: Retrieve status for a monitor named "S1 Germany".
Operation: Get Monitor by Name; Monitor Name: "S1 Germany"; Additional Fields: default (includes downtime history).
Example 2: Fetch a monitor and exclude downtime history.
Operation: Get Monitor by Name; Monitor Name: "US Ashburn"; Additional Fields: {"includeDowntime": false}