GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node operation retrieves the subgroups of a specified GitLab group using the GitLab API. It is useful for scenarios where you need to manage or analyze group hierarchies within GitLab, such as automating group management, auditing subgroup structures, or integrating group data into other workflows.

Use Case Examples

  1. Fetch all subgroups of a specific GitLab group by providing the group ID.
  2. Filter subgroups by visibility or ownership to get a refined list of subgroups.
  3. Paginate through subgroups when dealing with large group hierarchies.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
baseUrl The base URL of the GitLab instance to connect to.
Method HTTP method to use for the request (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters Optional query parameters to filter or modify the request results, such as statistics inclusion, visibility, search terms, pagination, and more.
Path Parameters Path parameters required for the request, specifically the group ID to retrieve subgroups for.

Output

JSON

  • id - Unique identifier of the subgroup.
  • name - Name of the subgroup.
  • path - Path of the subgroup.
  • visibility - Visibility level of the subgroup (private, internal, public).
  • parent_id - ID of the parent group.
  • full_name - Full name of the subgroup.
  • full_path - Full path of the subgroup.
  • created_at - Creation timestamp of the subgroup.
  • updated_at - Last update timestamp of the subgroup.
  • statistics - Project statistics if requested.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the group ID provided in the 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 the base URL is correct and points to the intended GitLab instance.
  • If filtering by query parameters, ensure the values are valid and supported by the GitLab API.
  • Handle pagination properly if the number of subgroups exceeds the per_page limit to avoid incomplete data retrieval.

Links

Discussion