REST API
The base URL ishttp://<NODE_IP>:3009.
Watchdog proxies the corresponding SKALE Admin routes and wraps every response as follows:
data is null, error contains a message, and the response has a non-2xx HTTP
status. The successful responses below are illustrative. Values such as versions, addresses,
container state, chain names, and check results depend on the node.
Common endpoints
These endpoints are available on SKALE and FAIR nodes. The SGX endpoint is available only when the node is running in active mode.GET /api/v1/common/hardware
Returns the node’s CPU, memory, operating system, and storage information.
GET /api/v1/common/meta-info
Returns the installed SKALE Admin version and configured release streams.
GET /api/v1/common/btrfs
Returns whether the Btrfs kernel module is available.
GET /api/v1/common/sgx
Returns SGX connectivity and wallet version information. This endpoint is available only on active
nodes. Watchdog removes the upstream sgx_server_url and sgx_keyname fields before returning the
response.
GET /api/v1/common/check-report
Returns the complete SKALE Admin check-report object. If no report file exists, the object is empty:
GET /api/v1/common/endpoint
Returns status information for the node’s Ethereum endpoint.
syncing can be true, false, or null when the upstream sync check fails.
GET /api/v1/common/containers
Returns all containers reported by SKALE Admin, including stopped containers. The state value is
Docker’s container state object and may contain additional fields.
GET /api/v1/common/ssl
Returns details about the node’s installed SSL certificate.
data is {"is_empty": true}.
SKALE endpoints
Theschains, ima, and validator-nodes endpoints are available only in active mode. The other
endpoints are also available in passive mode.
GET /api/v1/skale/schains
Returns health-check results for every SKALE Chain running on the node.
GET /api/v1/skale/ima
Returns IMA health information for each SKALE Chain on the node.
GET /api/v1/skale/schain-containers-versions
Returns the skaled and IMA container versions.
GET /api/v1/skale/public-ip
Returns the node’s public IP address.
GET /api/v1/skale/validator-nodes
Returns the validator node ID, IP address, and Watchdog port reachability for each node.
FAIR endpoints
GET /api/v1/fair/chain-checks
Returns configuration and skaled health checks for a FAIR node.
exit_zero is normally false while the skaled container is running. It indicates whether a
stopped container exited with code zero.
GET /api/v1/fair/chain-record
Returns the FAIR chain record. Datetime fields from SKALE Admin are returned as Unix timestamps.
Caching and errors
- Send a JSON request body of
{"_no_cache": true}to force a cold fetch. - Response time is logged; caching reduces latency.
- Non-200 upstream responses are wrapped with the message in
errorand retain the upstream HTTP status.
