GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node interacts with the GitLab API to retrieve user count statistics from the endpoint `/api/v4/user_counts`. It supports making HTTP requests with customizable methods and base URL, primarily used to fetch user-related metrics from a GitLab instance. This is useful for administrators or developers who want to programmatically access user count data for monitoring or reporting purposes.

Use Case Examples

  1. Fetching the total number of users in a GitLab instance for analytics.
  2. Automating user count retrieval to integrate with a dashboard or alerting system.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for 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.
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, not user-configurable.
Request Body Schema Hidden property for the request body schema of the API request, not user-configurable.
Request Path The API endpoint path for retrieving user counts, fixed to `/api/v4/user_counts`.

Output

JSON

  • user_counts - The JSON object containing user count statistics returned from the GitLab API.

Dependencies

  • GitLab API key credential

Troubleshooting

  • If authentication fails, ensure the GitLab API key credential is correctly configured and has sufficient permissions.
  • If the base URL is incorrect or the GitLab instance is unreachable, the request will fail; verify the URL and network connectivity.
  • HTTP method must be appropriate for the endpoint; typically, GET is used for retrieving user counts.
  • Errors related to request schema or path are unlikely since these are fixed or hidden, but malformed requests could cause API errors.

Links

Discussion