> ## Documentation Index
> Fetch the complete documentation index at: https://celoref.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Health



## OpenAPI

````yaml /openapi.json get /healthz
openapi: 3.1.0
info:
  title: Arkognito relayer API
  version: arkognito-relayer/1
  description: >-
    HTTP API of an Arkognito relayer and, when it runs with ISSUER=on, the
    blind-token issuer. All bodies are JSON unless noted. CORS is open. Relayers
    do not log request IPs or bodies.
  license:
    name: MIT
    url: https://github.com/soumyacodes007/Arkognito/blob/main/LICENSE
servers:
  - url: https://relay-1.example.com
    description: Your relayer
  - url: http://localhost:8787
    description: Local relayer
security: []
tags:
  - name: Relayer
    description: Submit records and follow their status.
  - name: Issuer
    description: Daily issuer keys and blind token issuance (relayers with ISSUER=on).
  - name: Operations
    description: Health and Oblivious HTTP.
paths:
  /healthz:
    get:
      tags:
        - Operations
      summary: Health
      operationId: getHealth
      responses:
        '200':
          description: Healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
components:
  schemas:
    Health:
      type: object
      properties:
        ok:
          type: boolean
        address:
          $ref: '#/components/schemas/Address'
        queue:
          type: integer
        batches:
          type: integer
        lastFlushBlock:
          type: string
        heartbeat:
          $ref: '#/components/schemas/Hex'
          description: Entity key of the relayer's heartbeat.
        lastBeat:
          type: integer
          description: Unix milliseconds.
        balanceGlm:
          type: number
        doubleSpendsDetected:
          type: integer
    Address:
      type: string
      pattern: ^0x[0-9a-fA-F]{40}$
      examples:
        - '0x1111111111111111111111111111111111111111'
    Hex:
      type: string
      pattern: ^0x[0-9a-fA-F]*$

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.