Mabl Alert API

openapi: 3.2.0
info:
  title: mabl Alert API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Alert
paths:
  /alerts/configurations:
    get:
      tags:
      - Alert
      summary: Query AlertConfigurations
      description: Used to query AlertConfigurations
      operationId: queryAlertConfigurations
      parameters:
      - name: parent_namespace
        in: query
        description: Namespace of the parent for which to query AlertConfigurations
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/AlertConfigurationParentNamespace'
      - name: parent_id
        in: query
        description: ID of the parent for which to query AlertConfigurations
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: enabled
        in: query
        description: Enabled status for which to query AlertConfigurations
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: offset
        in: query
        description: Offset to use for pagination
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Limit to use for pagination
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Results of the query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfigurationsQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Alert
    post:
      tags:
      - Alert
      summary: Create AlertConfiguration
      description: Create an AlertConfiguration
      operationId: createAlertConfiguration
      requestBody:
        description: The AlertConfiguration to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfiguration'
        required: true
      responses:
        '201':
          description: The AlertConfiguration that was created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::Alert
  /alerts/configurations/default:
    get:
      tags:
      - Alert
      summary: Fetch default AlertConfiguration
      description: Used to fetch the default AlertConfiguration
      operationId: getDefaultAlertConfiguration
      parameters:
      - name: parent_namespace
        in: query
        description: Namespace of the parent for which to fetch the default AlertConfiguration
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/AlertConfigurationParentNamespace'
      - name: parent_id
        in: query
        description: Target parent query
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: The default AlertConfiguration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: Default AlertConfiguration not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Alert
    post:
      tags:
      - Alert
      summary: Create default AlertConfiguration
      description: Create the default AlertConfiguration
      operationId: createDefaultAlertConfiguration
      parameters:
      - name: parent_namespace
        in: query
        description: Namespace of the parent for which to create the AlertConfigurations
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/AlertConfigurationParentNamespace'
      - name: parent_id
        in: query
        description: ID of the parent for which to create the AlertConfigurations
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: The AlertConfiguration that was created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Create::Alert
  /alerts/configurations/defaults:
    get:
      tags:
      - Alert
      summary: Fetch all default AlertConfigurations
      description: Used to fetch every system-created AlertConfiguration for a parent, ordered by ascending usage threshold. An Account carries one configuration per credit usage threshold.
      operationId: getDefaultAlertConfigurations
      parameters:
      - name: parent_namespace
        in: query
        description: Namespace of the parent for which to fetch the default AlertConfigurations
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/AlertConfigurationParentNamespace'
      - name: parent_id
        in: query
        description: Target parent query
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: The default AlertConfigurations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfigurationsQueryResult'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Alert
  /alerts/configurations/{alert_configuration_id}:
    get:
      tags:
      - Alert
      summary: Fetch an AlertConfiguration by ID
      operationId: getAlertConfiguration
      parameters:
      - name: alert_configuration_id
        in: path
        description: The ID of the AlertConfiguration
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: The AlertConfiguration entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: AlertConfiguration not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::Alert
    delete:
      tags:
      - Alert
      summary: Remove AlertConfiguration
      description: Remove an AlertConfiguration
      operationId: removeAlertConfiguration
      parameters:
      - name: alert_configuration_id
        in: path
        description: The ID of the AlertConfiguration
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: The operation was successful
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: AlertConfiguration not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Delete::Alert
    patch:
      tags:
      - Alert
      summary: Patch AlertConfiguration
      description: Patch an AlertConfiguration. Only name, description, and active are mutable. To change a configuration, you must replace it.
      operationId: patchAlertConfiguration
      parameters:
      - name: alert_configuration_id
        in: path
        description: The ID of the AlertConfiguration
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The AlertConfiguration to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfiguration'
        required: true
      responses:
        '200':
          description: The AlertConfiguration that was updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        '404':
          description: AlertConfiguration not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseGeneric'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::Alert
  /alerts/configurations/{alert_configuration_id}/trigger:
    post:
      tags:
      - Alert
      summary: Trigger an AlertConfiguration by ID
      operationId: triggerAlertConfiguration
      parameters:
      - name: alert_configuration_id
        in: path
        description: The ID of the AlertConfiguration
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: window_start
        in: query
        description: The window start time of the current notification configuration window
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: window_end
        in: query
        description: The window end time of the current notification configuration window
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: The operation was successful
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::Alert
  /alerts/notifications/{alert_notification_id}/processed:
    put:
      tags:
      - Alert
      summary: Acknowledge processing of an AlertNotification
      operationId: acknowledgeAlertNotificationProcessed
      parameters:
      - name: alert_notification_id
        in: path
        description: The ID of the AlertNotification
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The AlertConfiguration to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertNotificationProcessedAcknowledgementRequest'
        required: true
      responses:
        '204':
          description: The operation was successful
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Edit::Alert
components:
  responses:
    ErrorResponse401:
      description: User not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse400:
      description: Invalid or missing parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse403:
      description: User not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse:
      description: Unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
  schemas:
    AlertNotificationProcessedAcknowledgementRequest:
      type: object
      properties:
        processed_time:
          type: integer
          description: Time at which this AlertNotification was processed
          format: int64
        processed_confirmation_id:
          type: string
          description: Confirmation ID from processing the notification, if one exists
    GuardrailApprovalKind:
      type: string
      description: Who decides a guardrail approval. SELF is decided by the person the agent acts for; WORKSPACE, for an agent acting for an API key, by a workspace owner or editor.
      enum:
      - SELF
      - WORKSPACE
    GuardrailRefusal:
      type: object
      properties:
        id:
          type: string
          description: The id of the guardrail policy that decided the refusal.
        reason:
          type: string
          description: Why the policy refuses the request, written for the person the agent acts for.
        decision_id:
          type: string
          description: The id of this decision in the guardrail decision log.
        action:
          type: string
          description: The action the request was evaluated as, written Verb::Resource (for example Delete::Test), as declared by the operation's x-mabl-action extension.
        policy_source:
          type: string
          description: 'Who set the deciding policy: workspace for a rule the workspace''s owners wrote, account for a rule set for the workspace''s account, mabl_agent_type for the agent type''s ceiling, and mabl_default for mabl''s own defaults.'
        approval:
          description: The approval for this request; present when error_code is approval_required and the approval could be recorded. Without it the request cannot be approved.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalRef'
      description: The guardrail policy that refused an agent request.
    AlertConfiguration:
      type: object
      properties:
        id:
          type: string
          description: ID of the AlertConfiguration
        parent_namespace:
          $ref: '#/components/schemas/AlertConfigurationParentNamespace'
        parent_id:
          type: string
          description: ID of the parent to which this AlertConfiguration belongs
        name:
          type: string
          description: Name of the AlertConfiguration
        description:
          type: string
          description: Description of the AlertConfiguration
        trigger_type:
          type: string
          description: Discriminator for the type of trigger for this AlertConfiguration
          enum:
          - usage
          - time_based
        trigger:
          type: object
          additionalProperties: true
          description: Configuration of the trigger for this AlertConfiguration. Type depends on trigger_type (AlertConfigurationUsageTrigger for usage, AlertConfigurationTimeBasedTrigger for time_based)
        targets:
          type: array
          description: Configuration of the targets for this AlertConfiguration
          items:
            $ref: '#/components/schemas/AlertTarget'
        enabled:
          type: boolean
          description: Whether or not this configuration is enabled
        created_time:
          type: integer
          description: Time at which the AlertConfiguration was created
          format: int64
          readOnly: true
        created_by_id:
          type: string
          description: The ID of the user who created this AlertConfiguration
        last_updated_time:
          type: integer
          description: Time at which the AlertConfiguration was last updated
          format: int64
          readOnly: true
        last_updated_by_id:
          type: string
          description: The ID of the user who last updated this AlertConfiguration
      x-implements-interface:
      - HasId
      - HasCreatedActivity
      - HasUpdatedActivity
    GuardrailApprovalState:
      type: string
      description: Where a guardrail approval stands. PENDING awaits a decision and expires undecided after 24 hours; APPROVED lets the agent repeat the request, as often as it does, for 20 minutes; DENIED refuses the same request for 20 minutes after the decision, after which asking again opens a new approval; CANCELLED means a person withdrew it while pending or revoked it while approved. EXPIRED and CANCELLED are final.
      enum:
      - PENDING
      - APPROVED
      - DENIED
      - EXPIRED
      - CANCELLED
    AlertConfigurationsQueryResult:
      type: object
      properties:
        alert_configurations:
          type: array
          description: All AlertConfigurations that matched the query
          readOnly: true
          items:
            $ref: '#/components/schemas/AlertConfiguration'
    AlertTarget:
      type: object
      properties:
        medium:
          type: string
          description: Medium of the target
          enum:
          - email
        target:
          type: string
          description: The target
      description: An alert target for use with AlertConfiguration and AlertNotification
    GuardrailApprovalRef:
      type: object
      properties:
        id:
          type: string
          description: The approval's id.
        state:
          description: Where the approval stands.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalState'
        kind:
          description: Who decides the approval.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalKind'
        request_expires_time:
          type: integer
          description: When the approval expires if nobody decides it, in epoch milliseconds.
          format: int64
        url:
          type: string
          description: The mabl app page where a person reviews the approval.
      description: 'An approval a guardrail policy asks for. While it is PENDING, stop: give the person the url, tell them the request is waiting for approval, and do not repeat the request or poll in a loop. Once a person tells you it is APPROVED, repeat the identical request with the header X-Mabl-Approval set to id. DENIED means a person said no, so do not work around it.'
    AlertConfigurationParentNamespace:
      type: string
      description: Namespace of the parent to which this AlertConfiguration belongs
      enum:
      - accounts
      - api_keys
      - workspaces
    ErrorResponseGeneric:
      type: object
      properties:
        id:
          type: string
          x-mabl-scope: public
        code:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          x-mabl-scope: public
        message:
          type: string
          x-mabl-scope: public
        error_code:
          type: string
          description: Machine-readable reason for the error, present only when the API names one. Values are guardrail_blocked (a guardrail policy refused an agent request), approval_required (a guardrail policy requires a person to approve the request first).
        guardrail:
          description: The guardrail policy that refused the request; present only when error_code is guardrail_blocked or approval_required.
          allOf:
          - $ref: '#/components/schemas/GuardrailRefusal'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header