GitLab CI/CD

GitLab CI/CD alert_management API

Operations about alert_managements

GitHub OpenAPI

Operations 5

POST /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize #
POST /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images #
GET /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images #
PUT /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id} #
DELETE /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id} #

Documentation

📖
Documentation
https://docs.gitlab.com/api/
📖
APIReference
https://docs.gitlab.com/api/api_resources/
📖
Authentication
https://docs.gitlab.com/api/rest/authentication/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gitlab-ci/refs/heads/main/openapi/gitlab-ci-alert-management-api-openapi.yml

Other Resources

🔗
OpenAPISource
https://docs.gitlab.com/api/openapi/openapi_v2.yaml
🔗
InteractiveDocs
https://docs.gitlab.com/api/openapi/openapi_interactive/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitlab-ci-alert-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitlab-ci-alert-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitLab access_requests Alert Management API
  version: v4
  description: Operations related to access requests
servers:
- url: https://gitlab.com
tags:
- name: alert_management
  description: Operations about alert_managements
paths:
  /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/authorize:
    post:
      description: Workhorse authorize metric image file upload
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        example: 17
        schema:
          type: string
      - in: path
        name: alert_iid
        description: The IID of the Alert
        required: true
        example: 23
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Workhorse authorize metric image file upload
        '403':
          description: Forbidden
      tags:
      - alert_management
      operationId: postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesAuthorize
  /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images:
    post:
      description: Upload a metric image for an alert
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        example: 17
        schema:
          type: string
      - in: path
        name: alert_iid
        description: The IID of the Alert
        required: true
        example: 23
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Upload a metric image for an alert
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_MetricImage'
        '403':
          description: Forbidden
      tags:
      - alert_management
      operationId: postApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: The image file to be uploaded
                  format: binary
                url:
                  type: string
                  description: The url to view more metric info
                url_text:
                  type: string
                  description: A description of the image or URL
              required:
              - file
    get:
      description: Metric Images for alert
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        example: 17
        schema:
          type: string
      - in: path
        name: alert_iid
        description: The IID of the Alert
        required: true
        example: 23
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Metric Images for alert
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/API_Entities_MetricImage'
        '404':
          description: Not found
      tags:
      - alert_management
      operationId: getApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImages
  /api/v4/projects/{id}/alert_management_alerts/{alert_iid}/metric_images/{metric_image_id}:
    put:
      description: Update a metric image for an alert
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        example: 17
        schema:
          type: string
      - in: path
        name: alert_iid
        description: The IID of the Alert
        required: true
        example: 23
        schema:
          type: integer
          format: int32
      - in: path
        name: metric_image_id
        description: The ID of metric image
        required: true
        example: 42
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Update a metric image for an alert
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_MetricImage'
        '403':
          description: Forbidden
        '422':
          description: Unprocessable entity
      tags:
      - alert_management
      operationId: putApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: The url to view more metric info
                url_text:
                  type: string
                  description: A description of the image or URL
    delete:
      description: Remove a metric image for an alert
      parameters:
      - in: path
        name: id
        description: The ID or URL-encoded path of the project
        required: true
        example: 17
        schema:
          type: string
      - in: path
        name: alert_iid
        description: The IID of the Alert
        required: true
        example: 23
        schema:
          type: integer
          format: int32
      - in: path
        name: metric_image_id
        description: The ID of metric image
        required: true
        example: 42
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: Remove a metric image for an alert
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_MetricImage'
        '403':
          description: Forbidden
        '422':
          description: Unprocessable entity
      tags:
      - alert_management
      operationId: deleteApiV4ProjectsIdAlertManagementAlertsAlertIidMetricImagesMetricImageId
components:
  schemas:
    API_Entities_MetricImage:
      type: object
      properties:
        id:
          type: integer
          format: int32
          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
      required:
      - id
      - created_at
      - filename
      - file_path
      - url
      - url_text
      description: API_Entities_MetricImage model
  securitySchemes:
    access_token_header:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header
    access_token_query:
      type: apiKey
      name: private_token
      in: query