Skip to content

Monitor agent

Run the agent now

Run the agent now, outside its schedule. The response has the ID of the run's job.

POST/v1/monitors/{monitor_id}/agent/ticks

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

Path parameter

monitor_idstring
The ID of a monitor that has an agent.

Response

202The tick is queued. Follow it with Get a job. A tick is one run of the agent. A paused agent runs too: pausing stops the schedule only.

job_idstring
The ID of the tick's job.

Errors

StatusCodeWhen
401unauthorizedThe API key is missing or not valid.
403forbiddenThe API key cannot read monitors (a GET) or change them (the other methods).
404not_foundThe monitor is not in your key's project, or it has no agent.
409monitor_endedThe monitor has ended. What the agent found stays readable, but nothing can change.
409budget_exhaustedToday's budget for this monitor is spent. It resets at midnight UTC.
409tick_in_progressA tick is queued or running. Try again when it finishes.
429rate_limitedYour key or account sent too many requests. Wait for the seconds in Retry-After, then try again.

What each error means and what to do: Errors.

Was this page helpful?