Get monitors

GET /api/synthetics/monitors
Api key auth Basic auth

Get a list of monitors. You must have read privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

Query parameters

  • filter string

    Additional filtering criteria.

  • locations string | array

    The locations to filter by.

  • monitorTypes string | array

    The monitor types to filter.

  • page integer

    The page number for paginated results.

  • per_page integer

    The number of items to return per page.

  • projects string | array

    The projects to filter by.

  • query string

    A free-text query string.

  • schedules array | string

    The schedules to filter by.

  • sortField string

    The field to sort the results by.

    Values are name, createdAt, updatedAt, or status.

  • sortOrder string

    The sort order.

    Values are asc or desc.

  • status array | string

    The status to filter by.

  • tags string | array

    Tags to filter monitors.

Responses

  • 200 application/json

    A successful response.
GET /api/synthetics/monitors 
curl \
 --request GET 'https://localhost:5601/api/synthetics/monitors' \
 --header "Authorization: $API_KEY"
Response examples (200)
A successful response from `GET /api/synthetics/monitors?tags=prod&monitorTypes=http&locations=us-east-1&projects=project1&status=up`. 
{
    "page": 1,
    "total": 24,
    "monitors": [
        {
            "type": "icmp",
            "enabled": false,
            "alert": {
                "status": {
                    "enabled": true
                },
                "tls": {
                    "enabled": true
                }
            },
            "schedule": {
                "number": "3",
                "unit": "m"
            },
            "config_id": "e59142e5-1fe3-4aae-b0b0-19d6345e65a1",
            "timeout": "16",
            "name": "8.8.8.8:80",
            "locations": [
                {
                    "id": "us_central",
                    "label": "North America - US Central",
                    "geo": {
                        "lat": 41.25,
                        "lon": -95.86
                    },
                    "isServiceManaged": true
                }
            ],
            "namespace": "default",
            "origin": "ui",
            "id": "e59142e5-1fe3-4aae-b0b0-19d6345e65a1",
            "max_attempts": 2,
            "wait": "7",
            "revision": 3,
            "mode": "all",
            "ipv4": true,
            "ipv6": true,
            "created_at": "2023-11-07T09:57:04.152Z",
            "updated_at": "2023-12-04T19:19:34.039Z",
            "host": "8.8.8.8:80"
        }
    ],
    "absoluteTotal": 24,
    "perPage": 10,
}