GitLab Alert management API

openapi: 3.2.0
info:
  title: GitLab REST Alert management API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Alert management
  description: 'Use this API to interact with metric images for alerts.


    Additional endpoints are available with the GraphQL API.'
  x-displayName: Alert management
  externalDocs:
    url: https://docs.gitlab.com/api/alert_management_alerts/
paths:
  /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize:
    post:
      operationId: postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize
      summary: Workhorse authorize metric image file upload
      description: Pre-upload authorization endpoint for metric images attached to alerts. Called by GitLab Workhorse.
      tags:
      - Alert management
      responses:
        '200':
          description: OK
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 17
      - name: alert_iid
        required: true
        description: Internal ID of the alert.
        schema:
          type: integer
        in: path
        example: 23
  /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images:
    post:
      operationId: postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
      summary: Upload a metric image
      description: Uploads a metric image for a specified alert.
      tags:
      - Alert management
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesMetricImage'
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 17
      - name: alert_iid
        required: true
        description: Internal ID of the alert.
        schema:
          type: integer
        in: path
        example: 23
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest'
    get:
      operationId: getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
      summary: List all metric images
      description: Lists all metric images for a specified alert.
      tags:
      - Alert management
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesMetricImage'
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 17
      - name: alert_iid
        required: true
        description: Internal ID of the alert.
        schema:
          type: integer
        in: path
        example: 23
  /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}:
    put:
      operationId: putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
      summary: Update a metric image
      description: Updates a specified metric image for an alert.
      tags:
      - Alert management
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesMetricImage'
        '403':
          description: Forbidden
        '422':
          description: Unprocessable entity
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 17
      - name: alert_iid
        required: true
        description: Internal ID of the alert.
        schema:
          type: integer
        in: path
        example: 23
      - name: metric_image_id
        required: true
        description: ID of the metric image.
        schema:
          type: integer
        in: path
        example: 42
      requestBody:
        required: false
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest'
    delete:
      operationId: deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
      summary: Delete a metric image
      description: Deletes a specified metric image for an alert.
      tags:
      - Alert management
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesMetricImage'
        '403':
          description: Forbidden
        '422':
          description: Unprocessable entity
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 17
      - name: alert_iid
        required: true
        description: Internal ID of the alert.
        schema:
          type: integer
        in: path
        example: 23
      - name: metric_image_id
        required: true
        description: ID of the metric image.
        schema:
          type: integer
        in: path
        example: 42
components:
  schemas:
    APIEntitiesMetricImage:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 23
        created_at:
          type: string
          format: date-time
          example: '2020-11-13T00:06:18.084Z'
        filename:
          type: string
          example: file.png
        file_path:
          type: string
          example: /uploads/-/system/alert_metric_image/file/23/file.png
        url:
          type: string
          example: https://example.com/metric
        url_text:
          type: string
          example: An example metric
    postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesRequest:
      type: object
      properties:
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The image file to be uploaded
        url:
          type:
          - string
          - 'null'
          description: The url to view more metric info
          example: https://example.com/metric
        url_text:
          type:
          - string
          - 'null'
          description: A description of the image or URL
          example: An example metric
      required:
      - file
    putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageIdRequest:
      type: object
      properties:
        url:
          type:
          - string
          - 'null'
          description: The url to view more metric info
          example: https://example.com/metric
        url_text:
          type:
          - string
          - 'null'
          description: A description of the image or URL
          example: An example metric
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header