GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to retrieve usage data queries via the API endpoint `/api/v4/usage_data/queries`. It supports making HTTP requests with configurable methods and base URLs, primarily designed to fetch usage statistics or query data from GitLab's API v4. This is useful for automation workflows that need to analyze or report on GitLab usage metrics.

Use Case Examples

  1. Automate retrieval of GitLab usage data queries for reporting purposes.
  2. Integrate GitLab usage statistics into a dashboard or monitoring system.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Parameter Schema Hidden property for the parameter schema of the API request, specific to the operation getApiV4UsageDataQueries.
Request Body Schema Hidden property for the request body schema of the API request, specific to the operation getApiV4UsageDataQueries.
Request Path The API endpoint path for the request, fixed to /api/v4/usage_data/queries for this operation.

Output

JSON

  • response - The JSON response from the GitLab API containing usage data queries.

Dependencies

  • Requires GitLab API key credential for authentication unless skipping authentication.

Troubleshooting

  • If authentication fails, verify the GitLab API key credential is correctly configured and has sufficient permissions.
  • Ensure the baseUrl is correct and accessible from the network where the node runs.
  • Check that the HTTP method matches the API endpoint requirements; typically GET is used for retrieving usage data queries.
  • If the API endpoint changes or is deprecated, update the request path accordingly.

Links

Discussion