GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the share locations of a specific project in GitLab using the GitLab API. 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 permissions or audit sharing settings in a GitLab instance.

Use Case Examples

  1. Retrieve all share locations for a project with a given project ID.
  2. Search for share locations matching a specific group name within a project.

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 to send the API request to.
Method The HTTP method to use for the API request, defaulting to GET.
Query Parameters Optional query parameters for the API request, including 'search' to filter groups by name.
Path Parameters Path parameters for the API request, including the required 'id' of the project.

Output

JSON

  • id - The ID of the project whose share locations are retrieved.
  • share_locations - List of groups the project is shared with, optionally filtered by the search query.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the authentication credentials are correctly configured unless 'Skip Authentication' is enabled.
  • Check the base URL 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 filter.

Links

Discussion