GET
/
monitor
/
curl --request GET \
  --url https://api.openstatus.dev/v1/monitor/
[
  {
    "active": true,
    "body": "Hello World",
    "description": "Documenso website",
    "headers": [
      {
        "key": "x-apikey",
        "value": "supersecrettoken"
      }
    ],
    "id": 123,
    "method": "GET",
    "name": "Documenso",
    "periodicity": "1m",
    "regions": [
      "ams"
    ],
    "url": "https://www.documenso.co"
  }
]

Get all your monitors in a single call.

Response

200 - application/json
active
boolean
default: false

If the monitor is active

body
string | null
default:

The body

description
string | null

The description of your monitor

headers
object[] | null

The headers of your request

id
number

The id of the monitor

method
enum<string>
default: GETrequired
Available options:
GET,
POST,
HEAD
name
string | null

The name of the monitor

periodicity
enum<string>
required

How often the monitor should run

Available options:
30s,
1m,
5m,
10m,
30m,
1h,
other
regions
enum<string>[]
required

The regions to use

Available options:
ams,
iad,
hkg,
jnb,
syd,
gru
url
string
required

The url to monitor