GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation allows users to upload metric images related to alert management in a GitLab project. It is useful for adding visual metric data to alerts, which can help in monitoring and analyzing alert conditions more effectively. For example, users can upload graphs or charts as images to provide additional context to an alert, or link to external URLs with more metric information.

Use Case Examples

  1. Uploading a performance graph image to an alert to visualize CPU usage trends.
  2. Adding a URL link with a description to an alert for detailed metric analysis on an external dashboard.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters required for the operation, including project ID, alert IID, and form data for the image file and optional URL and description.
Path Parameters Collection of path parameters including project ID and alert IID required to identify the alert for uploading metric images.

Output

JSON

  • id - The ID of the uploaded metric image.
  • url - The URL where the uploaded image can be accessed.
  • url_text - Description or text associated with the URL or image.
  • alert_iid - The internal ID of the alert to which the metric image is attached.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and alert IID are correct and exist in the GitLab instance.
  • Verify that the image file is properly attached and meets the API requirements for file uploads.
  • Check that the authentication credentials are valid and have sufficient permissions to upload metric images.
  • Common error messages may include authentication failures, invalid project or alert IDs, or file upload errors. Resolving these typically involves verifying credentials, parameters, and file format/size.

Links

Discussion