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

# Single-pane org health (fleet, queue, webhooks, scheduler). Requires health:read.



## OpenAPI

````yaml /api/openapi.yaml get /v1/health
openapi: 3.1.0
info:
  title: Warmr Cloud API
  version: '1.2'
  summary: Enqueue and read iPhone-fleet automation work (warmups + posts).
  description: >
    The business-facing REST surface for Warmr. **Bring-your-own-fleet**: API
    keys

    *enqueue* work and read org-scoped state; your own connected iPhones
    *execute* it.

    A server-side **airlock** prevents an API session from ever driving a
    device.


    Auth is a two-step flow: exchange a `wk_live_` API key at the exchange
    endpoint for a

    short-lived org session, then call `/v1` with `Authorization: Bearer
    <access_token>`.


    Every `/v1` response is wrapped in an envelope `{ "schema": "1.0", ... }`;
    errors are

    `{ "schema": "1.0", "error": { "code", "message", "data"? } }`. The exchange
    endpoint

    uses a flatter `{ "error": "<code>" }` body.


    NOTE: the public base URL is deployment-specific and is NOT asserted here.
    Replace the

    `app.warmr.so` / `<project-ref>` placeholders below with your deployment's
    values.
  license:
    name: UNLICENSED
servers:
  - url: https://{origin}
    description: Substitute your Warmr deployment origin. app.warmr.so is a placeholder.
    variables:
      origin:
        default: app.warmr.so
        description: Your Warmr deployment host, no scheme, e.g. app.example.com
security:
  - bearerAuth: []
tags:
  - name: auth
    description: Exchange an API key for an org session.
  - name: runs
    description: >-
      Enqueue and read units of automation work (warm_up or post); your
      connected iPhones execute them.
  - name: schedules
    description: >-
      Standing recurring post schedules (one account each). The materializer
      turns them into runs.
  - name: accounts
    description: Register and list the social account handles in your org.
  - name: content
    description: >-
      Signed direct-to-storage uploads for post clips (issue → upload →
      confirm).
  - name: usage
    description: Org storage and run counts for a billing period.
  - name: devices
    description: The iPhones your runner(s) have reported to the org.
  - name: webhooks
    description: >-
      Subscribe to run.completed / run.failed events and manage deliveries.
      Opt-in, secret-bearing (webhooks:read / webhooks:write).
  - name: keys
    description: >-
      List your org's API keys — metadata only, the secret is never returned.
      Opt-in keys:read.
  - name: health
    description: Lightweight org-scoped readiness probe. Opt-in health:read.
paths:
  /v1/health:
    get:
      tags:
        - health
      summary: >-
        Single-pane org health (fleet, queue, webhooks, scheduler). Requires
        health:read.
      operationId: getOrgHealth
      responses:
        '200':
          description: Org health snapshot.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthEnvelope'
        '401':
          $ref: '#/components/responses/Error'
components:
  schemas:
    HealthEnvelope:
      allOf:
        - $ref: '#/components/schemas/Envelope'
        - type: object
          required:
            - health
          properties:
            health:
              $ref: '#/components/schemas/OrgHealth'
    Envelope:
      type: object
      required:
        - schema
      properties:
        schema:
          type: string
          const: '1.0'
    OrgHealth:
      type: object
      properties:
        org_id:
          type: string
        fleet:
          type: object
          properties:
            devices_online:
              type: integer
            devices_total:
              type: integer
            last_heartbeat:
              type:
                - string
                - 'null'
        queue:
          type: object
          properties:
            queued:
              type: integer
            claimed:
              type: integer
            running:
              type: integer
        webhooks:
          type: object
          properties:
            pending:
              type: integer
            dead_lettered:
              type: integer
            pump_last_run_at:
              type:
                - string
                - 'null'
            pump_last_ok:
              type:
                - boolean
                - 'null'
        scheduler:
          type: object
          properties:
            active_schedules:
              type: integer
            last_materialized_through:
              type:
                - string
                - 'null'
    ErrorEnvelope:
      allOf:
        - $ref: '#/components/schemas/Envelope'
        - type: object
          required:
            - error
          properties:
            error:
              type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
                data: {}
  responses:
    Error:
      description: A /v1 error envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: The access_token from the exchange endpoint.

````