health

Basic health check

Returns {"status":"ok"} (or its Protobuf equivalent) whenever the HTTP server is accepting connections. Performs no I/O and never queries downstream dependencies.

Content negotiation: Send Accept: application/x-protobuf to receive a Protobuf-encoded BasicHealthResponse; omit or send any other value for JSON.

get/health

Request

Base URL
https://utxo-indexer.api.umbraprivacy.com
Auth
none declared
TypeScript
https://skmtc.dev/umbra-defi/apis/umbra-indexer-read-service/docs/health/get.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Accept'application/json' | 'application/x-protobuf'

Response format selector. Set to application/x-protobuf for Protobuf encoding; any other value (or absent) returns JSON.

Response

Service is accepting connections.

statusstring required

Always "ok" when the HTTP server is accepting connections.

Example response

{
  "status": "ok"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.