Search Monitors

The Search Monitors endpoint allows you to search and/or filter Monitors in your Garmingo Status instance.

Endpoint	Method	URL
/monitors/search	GET	https://garmingo.com/api/status/v1/monitors/search

Query Parameters

Parameter	Type	Description	Required	Default	Minimum	Maximum
limit	number	The maximum number of Monitors to return.	No	10	1	100
page	number	The page number of the Monitors to return.	No	1	1	∞
query	string	The search query to filter the Monitors.	No
status	online/offline	The status of the Monitors to return.	No
types	string[]	The types of the Monitors to return.	No
regions	string[]	The regions of the Monitors to return.	No

Response

The response is a JSON object with the following properties:

Property	Type	Description
success	boolean	Whether the request was successful.
data.monitors	Monitor[]	The list of Monitors.
data.count	number	The total number of Monitors.

Example

{
  "success": true,
  "data": {
    "monitors": [
      {
        "id": "5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b",
        "displayName": "My Monitor",
        "ttl": 60,
        "type": "http",
        "region": "eu-central",
        "enabled": true,
        "retries": 3,
        "keywords": ["my", "monitor"],
        "metadata": {
          "key": "value"
        },
        "settings": {
          "url": "https://example.com",
          "method": "GET",
          "headers": {
            "Authorization": "Bearer my-token"
          },
          "body": null
        },
        "lastCheck": "2021-01-01T00:00:00.000Z",
        "proxyType": "socks5",
        "proxyHost": "proxy.example.com",
        "proxyPort": 8080,
        "proxyUsername": "my-username",
        "proxyPassword": "my-password",
        "currentStatus": true
      }
    ],
    "count": 1
  }
}