GET /health and GET /ready

GET

health

curl --request GET \
  --url https://mcr.peaq.xyz/health

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mcr.peaq.xyz/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://mcr.peaq.xyz/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://mcr.peaq.xyz/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

GET /health

GET /health

A lightweight liveness probe. Returns 200 while the process runs, unless the caller is over the rate limit (429). Does not check connectivity or contract readiness.

Response

200 OK

Field	Type	Description
`status`	string	Always `"ok"` when the process is running

Error responses

Status	Condition
429	The caller is over the rate limit. The body is `{"error": "Rate limit exceeded: 90 per 1 minute"}` and the response carries a `Retry-After` header.

Example

curl "${PEAQOS_MCR_API_URL:-https://mcr.peaq.xyz}/health"

const PEAQOS_MCR_API_URL = process.env.PEAQOS_MCR_API_URL ?? "https://mcr.peaq.xyz";
const response = await fetch(`${PEAQOS_MCR_API_URL}/health`);
const data = await response.json();
console.log(data.status); // "ok"

import os

import requests

PEAQOS_MCR_API_URL = os.environ.get("PEAQOS_MCR_API_URL", "https://mcr.peaq.xyz")

response = requests.get(f"{PEAQOS_MCR_API_URL}/health")
data = response.json()
print(data["status"])  # "ok"

Response

{
  "status": "ok"
}

GET /ready

GET /ready

A readiness probe. Verifies that the Economics 2.0 (MachineRegistry, MachineStateAndSync, MachineSubscription, EventRegistry, AdminFlags) are callable through the RPC and, when the server runs Verify, that the Verify service is ready. Returns 200 when all checks pass and 503 when any check fails.

Response

200 OK (all contracts ready)

Field	Type	Description
`status`	string	`"ready"`
`rpc_connected`	boolean	`true` when the server is initialised and the contract probe ran. An unreachable RPC node shows up as `false` contract fields.
`contracts.machine_registry`	boolean	MachineRegistry contract callable
`contracts.machine_state_and_sync`	boolean	MachineStateAndSync contract callable
`contracts.machine_subscription`	boolean	MachineSubscription contract callable
`contracts.event_registry`	boolean	EventRegistry contract callable
`contracts.admin_flags`	boolean	AdminFlags contract callable. Returns `true` when the contract address is not configured. AdminFlags is optional, so the readiness probe skips the call and reports ready.
`contracts.verify`	boolean	Verify service ready. Present when the server runs Verify (it does on `mcr.peaq.xyz`); `false` makes the probe answer `503`.
`solana_indexer`	object or null	Liveness of the Solana event indexer. `null` when the server runs no indexer. Informational only: it never changes `status`.
`solana_indexer.last_poll_age_seconds`	integer or null	Seconds since the indexer last polled. `null` if it has never polled.
`solana_indexer.last_success_age_seconds`	integer or null	Seconds since the indexer last polled successfully. `null` if it has never succeeded.
`operator_index`	object or null	Position and freshness of the ownership index behind GET /operator/{did}/machines. `null` only in the not-initialised response; an unreachable RPC node leaves it populated and turns the contract fields `false`. Informational only: it never changes `status`. If the index cannot be read, every field below is `null`.
`operator_index.synced_to_block`	integer or null	Last peaq block the index has applied
`operator_index.head_block`	integer or null	Finalized block as the index worker last read it, not read fresh for this request. `null` before the worker’s first round
`operator_index.blocks_behind`	integer or null	`head_block - synced_to_block`, never below `0`. `null` while `head_block` is unknown
`operator_index.last_advanced_age_seconds`	integer or null	Seconds since the index last applied new ownership data. `null` until it first advances. It grows on a quiet chain with nothing to apply, so it is not a liveness signal
`operator_index.head_observed_age_seconds`	integer or null	Seconds since the worker last read the chain head. `null` before the worker’s first round. The operator listing answers `503` once this exceeds ten poll intervals (about ten minutes)
`operator_index.last_poll_age_seconds`	integer or null	Seconds since the worker last started a round. `null` before the first round. If this is stale, the worker has stopped; if it is fresh while `head_observed_age_seconds` is stale, the worker cannot reach the RPC node

503 Service Unavailable (one or more checks failed) The response body has the same shape as the 200 response, but status is "not_ready" and one or more boolean fields are false.

Status	Condition
503	Any contract unreachable, RPC failure, or services not initialised

Two failure modes produce a 503:

Services not initialised (server started without its contract addresses): every field is false, including rpc_connected and contracts.admin_flags, and solana_indexer and operator_index are null.
Initialised but a check failed (RPC down, contract unreachable): only the failing contract fields are false. contracts.admin_flags stays true when no AdminFlags address is configured, so it never blocks readiness.

Example

curl "${PEAQOS_MCR_API_URL:-https://mcr.peaq.xyz}/ready"

const PEAQOS_MCR_API_URL = process.env.PEAQOS_MCR_API_URL ?? "https://mcr.peaq.xyz";
const response = await fetch(`${PEAQOS_MCR_API_URL}/ready`);
const data = await response.json();
if (response.ok) {
  console.log("Service ready");
} else {
  console.log("Not ready:", data.contracts);
}

import os

import requests

PEAQOS_MCR_API_URL = os.environ.get("PEAQOS_MCR_API_URL", "https://mcr.peaq.xyz")

response = requests.get(f"{PEAQOS_MCR_API_URL}/ready")
data = response.json()
if response.status_code == 200:
    print("Service ready")
else:
    print("Not ready:", data["contracts"])

Response (healthy)

{
  "status": "ready",
  "rpc_connected": true,
  "contracts": {
    "machine_registry": true,
    "machine_state_and_sync": true,
    "machine_subscription": true,
    "event_registry": true,
    "admin_flags": true,
    "verify": true
  },
  "solana_indexer": {
    "last_poll_age_seconds": 20,
    "last_success_age_seconds": 20
  },
  "operator_index": {
    "synced_to_block": 11880328,
    "head_block": 11880328,
    "blocks_behind": 0,
    "last_advanced_age_seconds": 58,
    "head_observed_age_seconds": 58,
    "last_poll_age_seconds": 58
  }
}

Response (not initialised)

{
  "status": "not_ready",
  "rpc_connected": false,
  "solana_indexer": null,
  "operator_index": null,
  "contracts": {
    "machine_registry": false,
    "machine_state_and_sync": false,
    "machine_subscription": false,
    "event_registry": false,
    "admin_flags": false
  }
}

API reference overview lists all available endpoints and common error patterns.

⌘I

GET /health and GET /ready

curl --request GET \
  --url https://mcr.peaq.xyz/health

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mcr.peaq.xyz/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://mcr.peaq.xyz/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://mcr.peaq.xyz/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

​GET /health

​Response

​Error responses

​Example

​GET /ready

​Response

​Example

​Related endpoints

GET /health

Response

Error responses

Example

GET /ready

Response

Example

Related endpoints