GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves descendant groups of a specified GitLab group using the GitLab API v4. It is useful for scenarios where you need to explore or manage group hierarchies within GitLab, such as fetching all subgroups under a parent group for reporting, automation, or synchronization purposes.

Use Case Examples

  1. Fetch all descendant groups of a specific GitLab group by providing the group ID.
  2. Filter descendant groups by visibility or ownership to get a refined list of groups.
  3. Paginate through descendant groups to handle large group hierarchies efficiently.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated access.
Authentication Select the authentication method, typically an API key credential for GitLab.
baseUrl Base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Query Parameters Collection of optional query parameters to filter and control the response, such as statistics inclusion, visibility, search terms, pagination, and access level filters.
Path Parameters Path parameters required for the API endpoint, specifically the group ID to identify the parent group.

Output

JSON

  • id - Unique identifier of the descendant group
  • name - Name of the descendant group
  • path - Path of the descendant group
  • visibility - Visibility level of the descendant group (private, internal, public)
  • statistics - Optional project statistics if requested
  • custom_attributes - Custom attributes included if requested
  • other_properties - Additional properties returned by the GitLab API for each descendant group

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the provided group ID in path parameters is valid and accessible by the authenticated user.
  • Check that the authentication credentials are correctly configured and have sufficient permissions to access group data.
  • Verify that optional query parameters are correctly formatted and valid according to GitLab API specifications.
  • If pagination is used, ensure page and per_page parameters are set appropriately to avoid missing data or excessive requests.

Links

Discussion