Deployment health and identity

GET/api/v1/health

The operator probe's stable v1 form: per-dependency checks (including whether CLI pairing can work on this deployment), plus which network and API version this deployment serves. A degraded dependency still answers 200 with status "degraded".

Parameters

None.

Example request

curl example

curl -s -H "Accept: application/json" "https://signet-web-pearl.vercel.app/api/v1/health"

@signet/sdk example

import { SignetClient } from '@signet/sdk';

const signet = new SignetClient({ baseUrl: 'https://signet-web-pearl.vercel.app' });
const result = await signet.getHealth();

Responses

200 · The health report. 200 even when degraded.

Fields of a 200 response
Field	Type	Description
data	object
apiVersion	"1"
checks	object
db	"up" \| "down" \| "skipped"
nonceStore	"up" \| "down" \| "memory"
pairing	"up" \| "down" \| "skipped"
rateLimitStore	"up" \| "down" \| "memory"
registry	"up" \| "down" \| "skipped"
network	string	The Stellar network this deployment is configured for.
networkPassphrase	string
status	"ok" \| "degraded"

429 · Rate limit exceeded.

500 · Internal server error.

Example response

Generated from the schema; real values differ.

example response

{
  "data": {
    "apiVersion": "1",
    "checks": {
      "db": "up",
      "nonceStore": "up",
      "pairing": "up",
      "rateLimitStore": "up",
      "registry": "up"
    },
    "network": "string",
    "networkPassphrase": "string",
    "status": "ok"
  }
}