RunWhen workspace-alerts API

openapi: 3.1.0
info:
  title: papi alert-query-proxy workspace-alerts API
  description: RunWhen Platform API
  version: 2.0.0
tags:
- name: workspace-alerts
paths:
  /api/v3/workspaces/{workspace_short_name}/alerts:
    get:
      tags:
      - workspace-alerts
      summary: List alerts for a workspace
      description: 'List alerts for a workspace with pagination and filtering.


        Combines SLI and SLO alerts from the unified alerts table.

        Matches Django WorkspaceViewSet.get_alerts() response shape.'
      operationId: list_workspace_alerts_api_v3_workspaces__workspace_short_name__alerts_get
      parameters:
      - name: workspace_short_name
        in: path
        required: true
        schema:
          type: string
          title: Workspace Short Name
      - name: created__gte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created  Gte
      - name: created__lte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created  Lte
      - name: modified__gte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Modified  Gte
      - name: modified__lte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Modified  Lte
      - name: slxNames
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Slxnames
      - name: slxNames[]
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Slxnames[]
      - name: slxName
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Slxname
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          default: 100
          title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Workspace Alerts Api V3 Workspaces  Workspace Short Name  Alerts Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
components:
  schemas:
    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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT access token from /api/v3/token/ or Auth0 login