Skip to main content

Watchdog

The Watchdog is an automated monitoring system that observes SIM and pool behaviour and logs notable activity. Log entries are available both globally and scoped to individual SIMs or pools.

Base URL

https://app.zentarinetworks.com

Get Watchdog Logs

GET /api/watchdog/logs

Returns a paginated list of watchdog log entries across your estate. Optionally filter to a specific SIM or pool.

Query Parameters

ParameterTypeDefaultDescription
simIdinteger (int64)Filter to a specific SIM
poolIdintegerFilter to a specific pool
searchTermstringFilter by message content
datedatetimeFilter by date
levelintegerFilter by log level code
pageinteger1Page number
pageSizeinteger100Results per page (1–100)

Use GET /api/watchdog/metadata to get valid level values.

Response

{
"data": [
{
"id": 55,
"simId": 123456,
"poolId": 10,
"level": 1,
"message": "SIM exceeded 90% of pool allocation",
"date": "2025-06-01T09:15:00Z"
}
],
"pagination": {
"page": 1,
"pageSize": 100,
"totalItems": 1,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false
}
}

Log Entry Object

FieldTypeDescription
idintegerLog entry ID
simIdinteger (int64)?Associated SIM, if applicable
poolIdinteger?Associated pool, if applicable
levelintegerLog level code — see /api/watchdog/metadata
messagestringLog message
datedatetimeTimestamp

Watchdog Metadata

GET /api/watchdog/metadata

Returns human-readable labels for log level codes and watchdog mode codes.

Response

{
"logLevel": [
{ "code": 0, "description": "Info" },
{ "code": 1, "description": "Warning" },
{ "code": 2, "description": "Critical" }
],
"mode": [
{ "code": 0, "description": "Disabled" },
{ "code": 1, "description": "Monitor" },
{ "code": 2, "description": "Enforce" }
]
}

tip

SIM-scoped and pool-scoped watchdog logs are also accessible directly:

  • GET /api/sims/{id}/watchdog-logs — logs for a specific SIM
  • GET /api/pools/{id}/watchdog-logs — logs for a specific pool

Both support the same filtering parameters as this endpoint.