GitLab API

GitlabTool
Join our community

Actions1000

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. For example, you can fetch all subgroups of a project group to display in a dashboard or to synchronize group data with another system.

Use Case Examples

  1. Fetch all subgroups of a 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 to handle large group hierarchies.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, hidden unless skipping authentication is false.
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).
Query Parameters Optional query parameters to filter and control the response, such as statistics inclusion, visibility, search terms, ownership, ordering, pagination, and custom attributes.
Path Parameters Path parameters including the group ID to specify which group's subgroups to retrieve.

Output

JSON

  • id - The unique identifier of the subgroup.
  • name - The name of the subgroup.
  • path - The path of the subgroup.
  • visibility - The visibility level of the subgroup (private, internal, public).
  • parent_id - The ID of the parent group.
  • description - Description of the subgroup.
  • created_at - Timestamp when the subgroup was created.
  • updated_at - Timestamp when the subgroup was last updated.
  • statistics - Statistics about the subgroup's projects, if requested.

Dependencies

  • GitLab API authentication

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 optional query parameters are correctly formatted and valid according to the GitLab API specification.
  • If pagination is used, ensure page and per_page parameters are set appropriately to avoid missing data or excessive requests.

Links

Discussion