GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the share locations of a specific project from the GitLab API (v4). It is useful for scenarios where you need to find groups that a project is shared with, optionally filtered by a search string. For example, it can be used to automate project access management or audit shared groups for a project.

Use Case Examples

  1. Get all share locations for a project by its ID.
  2. Search for groups matching a specific string that the project is shared with.

Properties

Name Meaning
Skip Authentication If true, the node will skip authentication when making the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Parameter Schema Defines the parameters for the operation, including the project ID (path parameter) and an optional search string (query parameter).
Request Path The API endpoint path for the operation, with a placeholder for the project ID.
Query Parameters Optional query parameters for the request, including 'search' to filter groups by name.
Path Parameters Path parameters for the request, specifically the 'id' of the project to retrieve share locations for.

Output

JSON

  • id - The ID of the project for which share locations are retrieved.
  • share_locations - An array of groups or locations with which the project is shared, optionally filtered by the search query.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in the GitLab instance.
  • If authentication is enabled, verify that the API key credential is correctly configured and has sufficient permissions to access project share locations.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If the search query returns no results, try broadening or removing the search string to confirm data availability.

Links

Discussion