Skip to main content
GET
/
v1
/
monitors
/
{monitor_id}
Get Monitor
curl --request GET \
  --url https://api.olostep.com/v1/monitors/{monitor_id} \
  --header 'Authorization: Bearer <token>'
{
  "team_id": "<string>",
  "monitor_id": "<string>",
  "status": "<string>",
  "agent_id": "<string>",
  "fda_id": "<string>",
  "schedule_id": "<string>",
  "schedule_name": "<string>",
  "query": "<string>",
  "url": "<string>",
  "frequency": "hourly",
  "cron_expression": "<string>",
  "notification_channel": "email",
  "notification_target": "<string>",
  "metadata": {},
  "error_message": "<string>",
  "created_at": 123,
  "updated_at": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Path Parameters

​
monitor_id
string
required

Unique monitor identifier. Must start with monitor_.

Pattern: ^monitor_

Response

Monitor retrieved successfully.

​
team_id
string
​
monitor_id
string

Unique monitor identifier.

​
status
string

Monitor lifecycle status.

​
agent_id
string | null
​
fda_id
string | null
​
schedule_id
string | null
​
schedule_name
string | null
​
query
string
​
url
string<uri> | null
​
frequency
enum<string>
Available options:
hourly,
daily,
weekly
​
cron_expression
string | null
​
notification_channel
enum<string>
Available options:
email,
webhook
​
notification_target
string
​
metadata
object
​
error_message
string | null
​
created_at
integer

Unix timestamp.

​
updated_at
integer

Unix timestamp.