monit-rs Dashboard API

openapi: 3.2.0
info:
  title: Monit Rs Dashboard 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 dashboard 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: Dashboard
paths:
  /api/v1/dashboard:
    get:
      tags:
      - Dashboard
      summary: 'Dashboard summary: endpoint counts, open incidents, recent activity'
      security:
      - BearerJwt: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardResponse'
      operationId: getApiV1Dashboard
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/dashboard/heatmaps:
    get:
      tags:
      - Dashboard
      summary: Per-endpoint uptime heatmap data across the account
      security:
      - BearerJwt: []
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
          maximum: 30
          minimum: 1
          default: 7
          title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      operationId: getApiV1DashboardHeatmaps
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/dashboard/response-times:
    get:
      tags:
      - Dashboard
      summary: Response-time history across the account
      security:
      - BearerJwt: []
      parameters:
      - name: hours
        in: query
        required: false
        schema:
          type: integer
          maximum: 168
          minimum: 1
          default: 24
          title: Hours
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      operationId: getApiV1DashboardResponseTimes
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/dashboard/uptime-history:
    get:
      tags:
      - Dashboard
      summary: Uptime history across the account
      security:
      - BearerJwt: []
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
          maximum: 90
          minimum: 1
          default: 30
          title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      operationId: getApiV1DashboardUptimeHistory
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
components:
  schemas:
    DashboardStats:
      properties:
        total_endpoints:
          type: integer
          title: Total Endpoints
        active_endpoints:
          type: integer
          title: Active Endpoints
        total_regressions:
          type: integer
          title: Total Regressions
        unresolved_regressions:
          type: integer
          title: Unresolved Regressions
        avg_response_time_ms:
          anyOf:
          - type: number
          - type: 'null'
          title: Avg Response Time Ms
        monitoring_coverage_percentage:
          anyOf:
          - type: number
          - type: 'null'
          title: Monitoring Coverage Percentage
        unknown_monitoring_seconds:
          type: number
          title: Unknown Monitoring Seconds
          default: 0
        uptime_percentage:
          anyOf:
          - type: number
          - type: 'null'
          title: Uptime Percentage
      type: object
      required:
      - total_endpoints
      - active_endpoints
      - total_regressions
      - unresolved_regressions
      - avg_response_time_ms
      - uptime_percentage
      title: DashboardStats
    DashboardResponse:
      properties:
        stats:
          $ref: '#/components/schemas/DashboardStats'
        recent_regressions:
          items:
            $ref: '#/components/schemas/RegressionResponse'
          type: array
          title: Recent Regressions
        endpoints_status:
          items:
            $ref: '#/components/schemas/EndpointResponse'
          type: array
          title: Endpoints Status
      type: object
      required:
      - stats
      - recent_regressions
      - endpoints_status
      title: DashboardResponse
    RegressionResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        endpoint_id:
          type: string
          format: uuid
          title: Endpoint Id
        endpoint_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Endpoint Name
          description: Name of the monitored endpoint this regression is about.
        incident_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Incident Id
        incident_regression_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Incident Regression Count
          description: How many regressions the incident this one belongs to groups in total. Null when the regression is not linked to an incident.
        regression_type:
          type: string
          title: Regression Type
        severity:
          type: string
          title: Severity
        diff_summary:
          additionalProperties: true
          type: object
          title: Diff Summary
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        is_acknowledged:
          type: boolean
          title: Is Acknowledged
        is_resolved:
          type: boolean
          title: Is Resolved
        resolved_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Resolved At
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - endpoint_id
      - regression_type
      - severity
      - diff_summary
      - description
      - is_acknowledged
      - is_resolved
      - resolved_at
      - created_at
      title: RegressionResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    EndpointResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        url:
          type: string
          title: Url
        method:
          type: string
          title: Method
        interval_seconds:
          type: integer
          title: Interval Seconds
        is_active:
          type: boolean
          title: Is Active
        config_version:
          type: integer
          title: Config Version
          default: 1
        monitoring_mode:
          type: string
          title: Monitoring Mode
          default: http
        heartbeat_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Heartbeat Url
        response_capture:
          type: string
          title: Response Capture
          default: redacted
        last_status:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Status
        last_checked_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Checked At
        created_at:
          type: string
          format: date-time
          title: Created At
        body_assertions:
          type: array
          maxItems: 20
          items:
            type: object
            required:
            - path
            - op
            properties:
              path:
                type: string
                maxLength: 256
              op:
                type: string
                enum:
                - contains
                - empty
                - equals
                - exists
                - gt
                - gte
                - lt
                - lte
                - not_contains
                - not_empty
                - not_equals
                - not_exists
              value:
                description: 'Required unless op is one of: empty, exists, not_empty, not_exists.'
          description: Assertions checked against the JSON response body on each probe. A failing assertion marks the endpoint DOWN.
      type: object
      required:
      - id
      - name
      - url
      - method
      - interval_seconds
      - is_active
      - last_status
      - last_checked_at
      - created_at
      title: EndpointResponse
  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