Faultline API

openapi: 3.1.0
info:
  title: Faultline API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 4 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Faultline has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 1
    pages-with-code: 1
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://fltln.io/docs/cli-and-heartbeats
servers:
- url: https://api.fltln.io
paths:
  /hb/hb_AbC123:
    get:
      operationId: get_hb_hb_AbC123
      tags:
      - Hb
      summary: GET /hb/hb_AbC123
      x-source: https://fltln.io/docs/cli-and-heartbeats
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -fsS https://api.fltln.io/hb/hb_AbC123... Flag Default Meaning -t, --type heartbeat heartbeat, or http to create a URL
          monitor (with --url ) -i, --interval 60 Seconds between expected pings -g, --grace 60 Extra seconds before a missed ping counts as a
          failure -d, --description none Optional description Push syntax faultline push hb_AbC123... # bare token

          faultline push https://api.fltln.io/hb'
    post:
      operationId: post_hb_hb_AbC123
      tags:
      - Hb
      summary: POST /hb/hb_AbC123
      x-source: https://fltln.io/docs/cli-and-heartbeats
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl does the same job:

          0 3 * * * /usr/local/bin/backup.sh && curl -fsS -m 10 -X POST https://api.fltln.io/hb/hb_AbC123... For a daily job, set --interval 86400
          and a grace that covers your longest normal run, for example --grace 1800 . How do I monitor a queue worker? A long-running worker never
          exits, so ping from inside the loop on a timer. This catches a crashed process and also a loop that is'
  /health:
    get:
      operationId: get_health
      tags:
      - Health
      summary: CLI and heartbeat monitoring - Faultline Docs
      description: The ping URL also accepts a plain GET request to signal a successful heartbeat.
      x-source: https://fltln.io/docs/cli-and-heartbeats
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_health
      tags:
      - Health
      summary: POST /health
      x-source: https://fltln.io/docs/cli-and-heartbeats
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsS http://localhost:8080/health && faultline push \"$FAULTLINE_HEARTBEAT_TOKEN\" || exit 1 # docker-compose.yml, for\
          \ an image without Node.js (uses curl instead of the CLI)\nservices:\n worker:\n image: my-worker:latest\n environment:\n FAULTLINE_HEARTBEAT_URL:\
          \ https://api.fltln.io/hb/hb_AbC123...\n healthcheck:\n test: [\"CMD-SHELL\", \"curl -fsS http://localhost:8080/health && curl -fsS\
          \ -m 10 -X POST"
tags:
- name: Hb
- name: Health
components:
  securitySchemes:
    X-API-Key:
      type: apiKey
      in: header
      name: X-API-Key
      x-source: https://fltln.io/docs/mcp/
    Authorization:
      type: http
      scheme: bearer
      x-source: https://fltln.io/docs/mcp/
security:
- X-API-Key: []
- Authorization: []