ZeroCopyZeroCopy

getHealth

POST
/

Check whether a SWQoS edge can send to an upcoming leader. Readiness does not guarantee that a transaction will land.

Authorization

headerx-api-key<token>

API key. Precedence: api-key query parameter, x-api-key header, then Authorization: Bearer. The first form present wins, even if empty or invalid. Bearer followed by a space is case-sensitive. Prefer a header to avoid URL logs.

Request Body

One JSON object, at most 65,536 bytes, received within 2 seconds. Batches are not supported. The method takes no params. The ZeroCopy Agent reports its own state.

application/json
  1. body
jsonrpc*"2.0"
Value in"2.0"
id?||

Optional request id, echoed exactly in the response. Null when absent or refused before the id could be read.

method*"getHealth"
Value in"getHealth"
params?unknown

Ignored when present.

Response Body

Returns ok when the edge can send to at least one upcoming leader, not when landing is guaranteed.

Refusals with HTTP 200, by error.data.reason:

application/json
  1. response
jsonrpc*"2.0"
Value in"2.0"
result*"ok"
Value in"ok"
id*||

Optional request id, echoed exactly in the response. Null when absent or refused before the id could be read.

Example Request
curl -X POST 'https://sol.zerocopy.sh' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "getHealth"
}'
Example Response
{
  "jsonrpc": "2.0",
  "result": "ok",
  "id": 1
}