GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates a specific metric image associated with an alert in a GitLab project. It is useful for managing alert-related metric images by modifying their URL or description. For example, it can be used to update the URL that provides more metric information or to change the description text of the metric image.

Use Case Examples

  1. Updating the URL of a metric image to point to a new dashboard.
  2. Changing the description text of a metric image to better explain the metric.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET but can be set to PUT for this operation.
Path Parameters Parameters required in the URL path to identify the project, alert, and metric image to update.
url The URL to view more metric information (optional).
url_text A description of the image or URL (optional).

Output

JSON

  • id - The ID of the updated metric image.
  • url - The updated URL of the metric image.
  • url_text - The updated description text of the metric image.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID, alert IID, and metric image ID are correct to avoid 404 errors.
  • Check authentication credentials if receiving authorization errors.
  • Verify that the URL and description fields are correctly formatted if the update fails.

Links

Discussion