GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves the share locations of a specific project in GitLab using the GitLab API v4. It is useful for scenarios where you need to find out which groups a project is shared with, optionally filtering the results by a search string. For example, it can be used to manage project sharing settings or audit access permissions.

Use Case Examples

  1. Retrieve all share locations for a project with a given project ID.
  2. Search for groups matching a specific search term that the project is shared with.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for 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, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET.
Query Parameters Optional query parameters for the request, including 'search' to filter groups by name.
Path Parameters Path parameters for the request, including 'id' which is the project ID to retrieve share locations for.

Output

JSON

  • id - The ID of the project.
  • share_locations - List of groups the project is shared with, optionally filtered by search criteria.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID ('id') path parameter is provided and valid, as it is required.
  • If authentication is enabled, verify that the GitLab API key credential is correctly configured and has sufficient permissions.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • If the search query parameter is used, ensure it is a valid string to avoid unexpected results.

Links

Discussion