GitLab API

GitlabTool

Actions905

Overview

This node operation retrieves resource groups associated with a specific project in GitLab using the GitLab API v4. It is useful for users who want to programmatically access and manage resource groups within their GitLab projects, such as for automation or integration purposes. For example, a DevOps engineer might use this node to fetch resource groups for monitoring or reporting.

Use Case Examples

  1. Fetch resource groups for a project with ID '12345' to display or process them in an automation workflow.
  2. Paginate through resource groups by specifying page and per_page query parameters to handle large sets of data.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Query Parameters Optional query parameters for pagination such as page number and items per page.
Path Parameters Path parameters including the project ID or URL-encoded path to identify the project.

Output

JSON

  • resourceGroups - Array of resource groups associated with the specified project
  • pagination
    • page - Current page number of the results
    • per_page - Number of items per page in the results
    • total - Total number of resource groups available

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project resource groups.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • If pagination parameters are used, ensure they are valid integers to avoid API errors.

Links

Discussion