spicrawl-com Health API

openapi: 3.2.0
info:
  title: Spicrawl Com Health API
  version: 1.0.0
  contact:
    name: Spicrawl support
    url: https://docs.spicrawl.com
  description: 'Operations tagged Health across 2 of this provider''s published API definitions: spicrawl-openapi.yaml, spicrawl-com-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.spicrawl.com
  description: Production
- url: http://localhost:8080
  description: Local development
security:
- bearerAuth: []
tags:
- name: Health
  description: Liveness and readiness probes.
paths:
  /healthz:
    get:
      tags:
      - Health
      operationId: healthLive
      summary: Liveness
      description: 'Outside `/v1` and unauthenticated. Answers 200 whenever the process can serve HTTP, and checks no

        dependency, so it stays 200 during a database or worker outage. Use `/readyz` to decide whether to

        send traffic.'
      security: []
      responses:
        '200':
          description: The process is alive.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthLive'
              examples:
                ok:
                  value:
                    status: ok
    servers:
    - url: https://api.spicrawl.com
      description: Production
    - url: http://localhost:8080
      description: Local development
  /readyz:
    get:
      tags:
      - Health
      operationId: healthReady
      summary: Readiness
      description: 'Outside `/v1` and unauthenticated. Checks Postgres, Redis (when configured) and each configured

        data-plane worker (`fetch`, `extract`, `render`) with a 2-second budget, and reports whether the

        process is draining. Returns 503 with the same body shape (not a Problem) when any check fails. Stop

        routing to this instance on 503; do not restart it.'
      security: []
      responses:
        '200':
          description: Ready for traffic.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthReady'
              examples:
                ready:
                  value:
                    status: ready
                    checks:
                      postgres: ok
                      redis: ok
                      fetch: ok
                      extract: ok
                      render: ok
        '503':
          description: Not ready. `checks` names what failed. This body is plain JSON, not a Problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthReady'
              examples:
                notReady:
                  value:
                    status: not_ready
                    checks:
                      postgres: ok
                      redis: unreachable
                      render: ok
                draining:
                  value:
                    status: not_ready
                    checks:
                      accepting: draining
                      postgres: ok
                      redis: ok
    servers:
    - url: https://api.spicrawl.com
      description: Production
    - url: http://localhost:8080
      description: Local development
components:
  schemas:
    HealthLive:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          const: ok
          description: Always `ok`.
    HealthReady:
      type: object
      required:
      - status
      - checks
      properties:
        status:
          type: string
          enum:
          - ready
          - not_ready
          description: '`ready` with HTTP 200; `not_ready` with HTTP 503.'
        checks:
          type: object
          description: 'Per-dependency result. Keys: `postgres`, `redis` (when configured), `fetch`, `extract`, `render` (configured workers), and `accepting` (present only as `draining` during shutdown).'
          properties:
            accepting:
              type: string
              const: draining
              description: Present only while the process is shutting down.
            postgres:
              type: string
              enum:
              - ok
              - unreachable
            redis:
              type: string
              enum:
              - ok
              - unreachable
          additionalProperties:
            type: string
            enum:
            - ok
            - unreachable
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: spicrawl_live_… | spicrawl_test_…
      description: '`Authorization: Bearer <key>`. Read the key from the `SPICRAWL_API_KEY` environment

        variable; never hard-code or log it. `spicrawl_test_…` keys can never spend live

        credits. Scopes: `scrape`, `batch`, `sessions` (granted by default), `browser`

        and `read` (granted deliberately). A missing scope is `403

        ERR::AUTH::INSUFFICIENT_SCOPE` naming the scope.

        '
    apiKeyQuery:
      type: apiKey
      in: query
      name: apikey
      description: 'The key as a query parameter. Only for clients that cannot set headers, such as

        a WebSocket upgrade from a browser-automation library. Prefer `bearerAuth` everywhere

        else, because URLs end up in logs.

        '
externalDocs:
  description: Guides and error reference
  url: https://docs.spicrawl.com
x-refined-from:
- spicrawl-openapi.yaml
- spicrawl-com-openapi.yaml