monit-rs Regressions API

openapi: 3.2.0
info:
  title: Monit Rs Regressions 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 regressions 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: regressions
  description: Query API regressions and schema diffs.
paths:
  /api/v1/regressions:
    get:
      tags:
      - regressions
      summary: List regressions
      security:
      - ApiKeyBearer: []
      - BearerJwt: []
      x-scopes:
      - read:regressions
      parameters:
      - $ref: '#/components/parameters/CursorParam'
      - $ref: '#/components/parameters/LimitParam'
      responses:
        '200':
          description: List of regressions.
      operationId: getApiV1Regressions
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/regressions/{regression_id}:
    get:
      tags:
      - regressions
      summary: Regression detail
      security:
      - ApiKeyBearer: []
      - BearerJwt: []
      x-scopes:
      - read:regressions
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Regression detail with diff.
        '404':
          description: Not found.
      operationId: getApiV1RegressionsByRegressionId
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/regressions/{regression_id}/acknowledge:
    post:
      tags:
      - regressions
      summary: Acknowledge a detected regression
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegressionAcknowledge'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegressionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '404':
          description: Not found.
      operationId: postApiV1RegressionsByRegressionIdAcknowledge
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/regressions/{regression_id}/analyses:
    get:
      tags:
      - regressions
      summary: AI analyses attached to a regression
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '404':
          description: Not found.
      operationId: getApiV1RegressionsByRegressionIdAnalyses
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/regressions/{regression_id}/archive:
    delete:
      tags:
      - regressions
      summary: Remove a regression's public archive page
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '403':
          description: Not permitted for this account or scope.
        '404':
          description: Not found.
      operationId: deleteApiV1RegressionsByRegressionIdArchive
      x-operation-id-source: derived
    post:
      tags:
      - regressions
      summary: Archive a regression to a permanent public URL
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '403':
          description: Not permitted for this account or scope.
        '404':
          description: Not found.
      operationId: postApiV1RegressionsByRegressionIdArchive
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/regressions/{regression_id}/diff-context:
    get:
      tags:
      - regressions
      summary: Baseline and current response side by side for a regression
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '404':
          description: Not found.
      operationId: getApiV1RegressionsByRegressionIdDiffContext
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/regressions/{regression_id}/markdown:
    get:
      tags:
      - regressions
      summary: Regression rendered as Markdown, for pasting into an issue
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '404':
          description: Not found.
      operationId: getApiV1RegressionsByRegressionIdMarkdown
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/regressions/{regression_id}/promote-baseline:
    post:
      tags:
      - regressions
      summary: Accept a regression's response as the new baseline
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegressionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '404':
          description: Not found.
      operationId: postApiV1RegressionsByRegressionIdPromoteBaseline
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/regressions/{regression_id}/resolve:
    post:
      tags:
      - regressions
      summary: Resolve a regression
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegressionResolve'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegressionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '404':
          description: Not found.
      operationId: postApiV1RegressionsByRegressionIdResolve
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
  /api/v1/regressions/{regression_id}/share:
    delete:
      tags:
      - regressions
      summary: Revoke a regression report's share token
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '404':
          description: Not found.
      operationId: deleteApiV1RegressionsByRegressionIdShare
      x-operation-id-source: derived
    get:
      tags:
      - regressions
      summary: Get the share token for a regression report, if one exists
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '404':
          description: Not found.
      operationId: getApiV1RegressionsByRegressionIdShare
      x-operation-id-source: derived
    post:
      tags:
      - regressions
      summary: Create a share token for a regression report
      security:
      - BearerJwt: []
      parameters:
      - name: regression_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Regression Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '404':
          description: Not found.
      operationId: postApiV1RegressionsByRegressionIdShare
      x-operation-id-source: derived
    servers:
    - url: https://monit.rs
      description: Production
components:
  schemas:
    RegressionAcknowledge:
      properties:
        is_acknowledged:
          type: boolean
          title: Is Acknowledged
          default: true
      type: object
      title: RegressionAcknowledge
    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
    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
    RegressionResolve:
      properties:
        is_resolved:
          type: boolean
          title: Is Resolved
          default: true
      type: object
      title: RegressionResolve
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  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.
  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