GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves details of a specific resource group within a GitLab project using the GitLab API v4. It is useful for users who want to access information about resource groups associated with their projects, such as for project management or automation workflows. For example, a user can fetch resource group details by specifying the project ID and the resource group key.

Use Case Examples

  1. Fetch resource group details for a project to automate project resource management.
  2. Retrieve resource group information to integrate with other project tracking tools.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines required path parameters 'id' (project ID or URL-encoded path) and 'key' (resource group key) for the API call.
Request Body Schema Schema for the request body, not used in this GET operation.
Request Path API endpoint path template for the request.
Path Parameters Collection of path parameters including 'id' (project ID) and 'key' (resource group key) to specify the resource group to retrieve.

Output

JSON

  • id - The ID of the resource group.
  • name - The name of the resource group.
  • key - The key identifier of the resource group.
  • project_id - The ID of the project the resource group belongs to.
  • created_at - Timestamp when the resource group was created.
  • updated_at - Timestamp when the resource group was last updated.
  • other_properties - Additional properties returned by the GitLab API for the resource group.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and resource group key are correctly specified and URL-encoded if necessary.
  • Authentication errors may occur if the GitLab API key is missing or invalid; verify credentials.
  • Check the base URL if using a self-hosted GitLab instance instead of gitlab.com.
  • API rate limits or permissions may restrict access to the resource group data.

Links

Discussion