monit-rs Ingestion API

openapi: 3.2.0
info:
  title: Monit Rs Ingestion API
  version: 2026.08.30
  contact:
    name: monit.rs support
    url: https://monit.rs/contact
    email: support@monit.rs
  license:
    name: Data licensed for direct reuse; see terms
    url: https://monit.rs/terms
  termsOfService: https://monit.rs/terms
  x-logo:
    url: https://monit.rs/logo.png
    backgroundColor: '#0f172a'
    altText: monit.rs
  x-origin:
  - url: https://monit.rs/openapi.yaml
    format: openapi
    version: '3.1'
  x-providerName: monit.rs
  description: 'Operations tagged ingestion across 2 of this provider''s published API definitions: api.monit.rs-openapi.json, monit-rs-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://monit.rs
  description: Production
tags:
- name: Ingestion
  description: Push probe results and retrieve probe details.
paths:
  /api/v1/probes:
    post:
      tags:
      - Ingestion
      summary: Push a probe result
      description: Push a self-reported probe. Minimal body (endpoint_id + is_success) = pass/fail check. Full body (status_code + response_body + ...) enables schema-diff regression detection.
      security:
      - ApiKeyBearer: []
      x-scopes:
      - ingest:probes
      parameters:
      - name: X-Backfill
        in: header
        schema:
          type: string
          enum:
          - 'true'
        description: Set to `true` to allow checked_at in [-24h, -1h]. Backfilled probes bypass alerting.
      - name: Idempotency-Key
        in: header
        schema:
          type: string
          maxLength: 255
        description: Optional. Same key + same body replays cached response for 24h; same key + different body returns 409.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProbeIngestRequest'
      responses:
        '202':
          description: Accepted. Poll GET /probes/{id} for derived fields.
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '403':
          description: Missing `ingest:probes` scope.
        '404':
          description: Endpoint not owned by caller.
        '422':
          description: Validation error (e.g. checked_at out of range).
        '429':
          description: Rate limit exceeded.
      operationId: postApiV1Probes
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/probes/{probe_id}:
    get:
      tags:
      - Ingestion
      summary: Retrieve a pushed probe result + derived fields
      security:
      - ApiKeyBearer: []
      x-scopes:
      - read:endpoints
      parameters:
      - name: probe_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Probe detail incl. regression_id if detected.
        '404':
          description: Not found or not owned.
      operationId: getApiV1ProbesByProbeId
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/heartbeats/{token}:
    post:
      tags:
      - Ingestion
      summary: Heartbeat push
      description: Cron-liveness ping. Token-in-URL (no Bearer auth needed). If no heartbeat received within `interval_seconds * 1.2`, monit.rs opens an incident. Accepts POST, GET, HEAD. Body up to 100kB stored as diagnostic.
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
      - name: state
        in: query
        schema:
          type: string
          enum:
          - ok
          - fail
        description: Alternative to /fail subpath — some cron ecosystems can't set path parts.
      responses:
        '204':
          description: Heartbeat recorded.
        '404':
          description: Token not recognized.
        '413':
          description: Body exceeds 100kB.
      operationId: postApiV1HeartbeatsByToken
      x-operation-id-source: derived
    get:
      tags:
      - Ingestion
      summary: Heartbeat push (GET variant for cron/wget)
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
      - name: state
        in: query
        schema:
          type: string
          enum:
          - ok
          - fail
      responses:
        '204':
          description: Heartbeat recorded.
        '404':
          description: Token not recognized.
      operationId: getApiV1HeartbeatsByToken
      x-operation-id-source: derived
    head:
      tags:
      - Ingestion
      summary: Heartbeat push (HEAD variant for curl -I)
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Heartbeat recorded.
      operationId: headApiV1HeartbeatsByToken
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/heartbeats/{token}/fail:
    post:
      tags:
      - Ingestion
      summary: Heartbeat fail (subpath variant)
      description: Semantically identical to POST /heartbeats/{token}?state=fail. Ships alongside the query-param form because different cron ecosystems ship different conventions.
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Fail heartbeat recorded.
        '404':
          description: Token not recognized.
      operationId: postApiV1HeartbeatsByTokenFail
      x-operation-id-source: derived
    get:
      tags:
      - Ingestion
      summary: Report a failed run for a heartbeat monitor
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      operationId: getApiV1HeartbeatsByTokenFail
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/incidents:
    post:
      tags:
      - Ingestion
      summary: Push a custom incident (PagerDuty Events v2 envelope)
      description: 'Agent-detected incident. Action-based state machine: trigger opens or updates, acknowledge marks, resolve closes. Deduplicated on (user_id, dedup_key) — same key merges into one incident.'
      security:
      - ApiKeyBearer: []
      x-scopes:
      - ingest:incidents
      parameters:
      - name: Idempotency-Key
        in: header
        schema:
          type: string
          maxLength: 255
        description: Optional. Same key + same body replays cached response for 24h; same key + different body returns 409.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncidentIngestRequest'
      responses:
        '202':
          description: Incident created or updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentIngestResponse'
        '401':
          description: Missing/invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '403':
          description: Missing ingest:incidents scope.
        '404':
          description: endpoint_id not owned by caller (on trigger), OR no open incident with dedup_key (on ack/resolve).
        '409':
          description: Idempotency-Key reused with different body.
        '422':
          description: Validation error.
        '429':
          description: Rate limit exceeded.
      operationId: postApiV1Incidents
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/endpoints/{endpoint_id}/probes:
    get:
      tags:
      - Ingestion
      summary: List probe results (test_results) for an endpoint
      security:
      - ApiKeyBearer: []
      - BearerJwt: []
      x-scopes:
      - read:endpoints
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 200
          default: 50
      - name: since
        in: query
        schema:
          type: string
          format: date-time
      - name: until
        in: query
        schema:
          type: string
          format: date-time
      - name: only_failures
        in: query
        schema:
          type: boolean
          default: false
      - $ref: '#/components/parameters/CursorParam'
      - $ref: '#/components/parameters/LimitParam'
      responses:
        '200':
          description: Paginated probe results.
        '403':
          description: Missing read:endpoints scope.
        '404':
          description: Endpoint not owned by caller.
      operationId: getApiV1EndpointsByEndpointIdProbes
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/endpoints/{endpoint_id}/uptime:
    get:
      tags:
      - Ingestion
      summary: Aggregated uptime for an endpoint
      security:
      - ApiKeyBearer: []
      - BearerJwt: []
      x-scopes:
      - read:uptime
      parameters:
      - name: endpoint_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: window
        in: query
        schema:
          type: string
          enum:
          - 24h
          - 7d
          - 30d
          - 90d
          default: 7d
      - name: granularity
        in: query
        schema:
          type: string
          enum:
          - 1h
          - 1d
          default: 1d
      responses:
        '200':
          description: Uptime overall_pct + per-bucket series.
        '404':
          description: Endpoint not found.
      operationId: getApiV1EndpointsByEndpointIdUptime
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
components:
  parameters:
    CursorParam:
      name: cursor
      in: query
      required: false
      schema:
        type: string
      description: 'Opaque cursor from a previous response''s `next_cursor` field or `Link: rel=next` header. Omit for first page.'
    LimitParam:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
      description: Max items per page.
  schemas:
    ApiError:
      type: object
      required:
      - code
      - message
      - docs_url
      - request_id
      properties:
        code:
          type: string
          example: endpoint_not_found
        message:
          type: string
        docs_url:
          type: string
          format: uri
        request_id:
          type: string
          example: req_01HXY...
        param:
          type: string
          description: Only present on 422 validation errors.
    ApiErrorEnvelope:
      type: object
      required:
      - error
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
    IncidentPayload:
      type: object
      required:
      - title
      - severity
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 255
        severity:
          type: string
          enum:
          - critical
          - error
          - warning
          - info
        description:
          type: string
          nullable: true
        source:
          type: string
          nullable: true
    IncidentIngestResponse:
      type: object
      required:
      - incident_id
      - dedup_key
      - status
      properties:
        incident_id:
          type: string
          format: uuid
        dedup_key:
          type: string
        status:
          type: string
          enum:
          - open
          - acknowledged
          - resolved
    IncidentIngestRequest:
      type: object
      required:
      - action
      - dedup_key
      - payload
      properties:
        action:
          type: string
          enum:
          - trigger
          - acknowledge
          - resolve
        dedup_key:
          type: string
          minLength: 1
          maxLength: 255
          description: Merges trigger/ack/resolve events into one incident (PagerDuty pattern).
        endpoint_id:
          type: string
          format: uuid
          nullable: true
          description: Required on trigger; optional on ack/resolve.
        external_ref:
          type: string
          maxLength: 255
          nullable: true
          description: Free-form caller-side reference (e.g. ticket number).
        payload:
          $ref: '#/components/schemas/IncidentPayload'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ProbeIngestRequest:
      type: object
      required:
      - endpoint_id
      - is_success
      properties:
        endpoint_id:
          type: string
          format: uuid
        is_success:
          type: boolean
        status_code:
          type: integer
          minimum: 0
          maximum: 599
          nullable: true
        response_time_ms:
          type: number
          minimum: 0
          nullable: true
        response_body:
          description: 'Any JSON value: object, array, string, number, boolean, or null.'
        response_headers:
          type: object
          nullable: true
        error_message:
          type: string
          nullable: true
        checked_at:
          type: string
          format: date-time
          nullable: true
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: mrs_live_*
      description: monit.rs API key (mrs_live_ prefix). Get one at https://monit.rs/settings?tab=api-keys after signing in.
    BearerJwt:
      type: http
      scheme: bearer
      description: Bearer JWT token for authenticated user sessions.
externalDocs:
  description: Full public site + browsable changelog
  url: https://monit.rs/changelog
x-refined-from:
- api.monit.rs-openapi.json
- monit-rs-openapi.json