MonitorsIcmp monitors
List ICMP Monitors
Lists ICMP monitors in an organization.
GET /api/icmp-monitors
Authentication
Requires a valid session.
- Header:
Authorization: Bearer <token>
Parameters
organizationId(Query, optional): Organization ID. Defaults to the current user's organization.customerId(Query, optional): Filter by customer ID.search(Query, optional): Search by monitor name, hostname, or customer.page(Query, optional): Page number (default: 1).perPage(Query, optional): Items per page (default: 50, max: 200).
cURL
curl "https://YOUR_DOMAIN/api/icmp-monitors?page=1&perPage=50" \
-H "Authorization: Bearer $TOKEN"Response
{
"items": [
{
"id": 123,
"organizationId": 1,
"customerId": 10,
"customerName": "Example Customer",
"name": "Core Router",
"hostname": "10.0.0.1",
"status": "active",
"checkInterval": 30,
"timeoutSeconds": 30,
"port": null,
"config": {
"packetSize": 56,
"count": 3
},
"notificationPhoneNumber": null,
"notificationEmail": null,
"lastCheckedAt": null,
"createdAt": "2026-02-26T12:00:00.000Z",
"updatedAt": "2026-02-26T12:00:00.000Z"
}
],
"total": 1,
"page": 1,
"perPage": 50
}Each item contains the ICMP monitor itself and a flat customerName, not a full embedded customer record.
Errors
400Invalid query parameters (e.g.organizationId,customerId)401Unauthorized403Forbidden