GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves projects within a specified GitLab group using the GitLab API v4. It allows users to filter and sort projects based on various criteria such as archived status, visibility, search terms, ownership, and feature enablement. This operation is useful for managing and analyzing projects grouped under a specific GitLab group, enabling automation workflows that require project data extraction or monitoring within groups.

Use Case Examples

  1. Retrieve all projects in a GitLab group to generate a report on project activity.
  2. Filter projects by visibility and ownership to manage access control within a group.
  3. Search for projects matching specific criteria within a group for auditing or migration purposes.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request, useful for public data access or testing.
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 requests are sent, defaulting to https://gitlab.com.
Method HTTP method used for the API request, defaulting to GET.
Query Parameters Collection of optional query parameters to filter and sort the projects list, including archived status, visibility, search terms, ordering, pagination, and feature flags.
Path Parameters Path parameter specifying the group ID to identify which group's projects to retrieve.

Output

JSON

  • id - Unique identifier of the project.
  • name - Name of the project.
  • path - Path of the project within GitLab.
  • visibility - Visibility level of the project (private, internal, public).
  • archived - Indicates if the project is archived.
  • owner - Owner information of the project.
  • created_at - Timestamp when the project was created.
  • last_activity_at - Timestamp of the last activity in the project.
  • star_count - Number of stars the project has received.
  • issues_enabled - Indicates if issues feature is enabled for the project.
  • merge_requests_enabled - Indicates if merge requests feature is enabled for the project.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID path parameter is correctly set; missing or incorrect ID will cause request failures.
  • Verify that the authentication credentials are valid and have sufficient permissions to access the group's projects.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • If filtering by query parameters, ensure values conform to expected types and enums to avoid API errors.

Links

Discussion