Skip to content

Operations

Get a monitor

GET/v1/monitors/{monitor_id}

Send your API key as Authorization: Bearer. See Authentication. How each option works: Monitors.

Path parameter

monitor_idstring (UUID)
The ID of the monitor, from the response that created it.

Response

200

idstring (UUID)
The ID of the monitor.
querystring
What the monitor watches for.
frequencystring
How often Telem runs the query.
statusstringone of active, paused, ended
active: Telem runs the query on the schedule. paused: you paused it. ended: its end time passed, or its API key was revoked or expired, and it does not run again. A monitor that nobody polls stops its runs but still shows active: see Monitors.
session_idstring (UUID)
The session where Telem records your polls.
created_atstring (date-time)
When you created the monitor.
last_polled_atstring (date-time) or null
Your last poll or delivered webhook, or null.
expires_atstring (date-time) or null
When the monitor ends, or null without a ttl.
webhook_urlstring or null
Where Telem sends new results, or null.
webhook_secretstring or null
The secret to check webhook requests with. Only the response that sets webhook_url has it, so keep it.
agent_notestring or null
Only in the answer to a create: why the monitor agent did not start, or null. The monitor then runs without an agent.

Errors

StatusCodeWhen
401unauthorizedThe API key is missing or not valid.
403The API key has no access to monitors.
404not_foundThe monitor does not exist, or another API key created it.
429rate_limitedYour key went over its requests-per-minute cap, or Telem is busy. Wait for the seconds in Retry-After, then try again.
503unavailableTelem cannot run monitors now. Try again later.

What each error means and what to do: Errors.

Was this page helpful?