GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation fetches metric definitions from the GitLab API's usage data endpoint. It is useful for retrieving detailed information about available usage metrics, including optionally the file paths associated with those metrics. This can help users analyze and monitor GitLab usage data programmatically.

Use Case Examples

  1. Retrieve all metric definitions from GitLab usage data to understand available metrics for monitoring.
  2. Fetch metric definitions including file paths to get detailed insights into usage data metrics.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Collection of query parameters for the API request, including 'include_paths' to optionally include file paths in the metric definitions.

Output

JSON

  • metric_definitions - Array of metric definitions retrieved from the GitLab API usage data endpoint.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is valid and has sufficient permissions to access usage data metric definitions.
  • Verify the baseUrl is correct and accessible from the network where the node runs.
  • If 'include_paths' query parameter is used, ensure it is a valid boolean string ('true' or 'false').
  • Common error messages may include authentication failures or 404 if the API endpoint path is incorrect; verify credentials and endpoint path.

Links

Discussion