Alert Management alerts API

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

The Alert Management alerts API is limited to metric images. For more API endpoints, see the GraphQL API.

Upload metric image

POST /projects/:id/alert_management_alerts/:alert_iid/metric_images
AttributeTypeRequiredDescription
idinteger/stringyesThe ID or URL-encoded path of the project.
alert_iidintegeryesThe internal ID of a project’s alert.

Example request:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --form 'file=@/path/to/file.png' \
  --form 'url=http://example.com' \
  --form 'url_text=Example website' \
  --url "https://gitlab.example.com/api/v4/projects/5/alert_management_alerts/93/metric_images"

Example response:

{
  "id":17,
  "created_at":"2020-11-12T20:07:58.156Z",
  "filename":"sample_2054",
  "file_path":"/uploads/-/system/alert_metric_image/file/17/sample_2054.png",
  "url":"https://example.com/metric",
  "url_text":"An example metric"
}

List metric images

GET /projects/:id/alert_management_alerts/:alert_iid/metric_images
AttributeTypeRequiredDescription
idinteger/stringyesThe ID or URL-encoded path of the project.
alert_iidintegeryesThe internal ID of a project’s alert.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/alert_management_alerts/93/metric_images"

Example response:

[
  {
    "id":17,
    "created_at":"2020-11-12T20:07:58.156Z",
    "filename":"sample_2054",
    "file_path":"/uploads/-/system/alert_metric_image/file/17/sample_2054.png",
    "url":"https://example.com/metric",
    "url_text":"An example metric"
  },
  {
    "id":18,
    "created_at":"2020-11-12T20:14:26.441Z",
    "filename":"sample_2054",
    "file_path":"/uploads/-/system/alert_metric_image/file/18/sample_2054.png",
    "url":"https://example.com/metric",
    "url_text":"An example metric"
  }
]

Update metric image

PUT /projects/:id/alert_management_alerts/:alert_iid/metric_images/:image_id
AttributeTypeRequiredDescription
idinteger/stringyesThe ID or URL-encoded path of the project.
alert_iidintegeryesThe internal ID of a project’s alert.
image_idintegeryesThe ID of the image.
urlstringnoThe URL to view more metrics information.
url_textstringnoA description of the image or URL.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --request PUT  --form 'url=http://example.com' \
  --form 'url_text=Example website' \
  --url "https://gitlab.example.com/api/v4/projects/5/alert_management_alerts/93/metric_images/1"

Example response:

{
  "id":23,
  "created_at":"2020-11-13T00:06:18.084Z",
  "filename":"file.png",
  "file_path":"/uploads/-/system/alert_metric_image/file/23/file.png",
  "url":"https://example.com/metric",
  "url_text":"An example metric"
}

Delete metric image

DELETE /projects/:id/alert_management_alerts/:alert_iid/metric_images/:image_id
AttributeTypeRequiredDescription
idinteger/stringyesThe ID or URL-encoded path of the project.
alert_iidintegeryesThe internal ID of a project’s alert.
image_idintegeryesThe ID of the image.

Example request:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url  "https://gitlab.example.com/api/v4/projects/5/alert_management_alerts/93/metric_images/1"

Can return the following status codes:

  • 204 No Content: if the image was deleted successfully.
  • 422 Unprocessable: if the image could not be deleted.