GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the pages access information for a specific project in GitLab using the GitLab API v4. It is useful for scenarios where you need to check or manage the access permissions of GitLab Pages for a project, such as verifying who can view or modify the project's pages.

Use Case Examples

  1. A DevOps engineer wants to automate the process of auditing GitLab Pages access permissions across multiple projects.
  2. A project manager needs to fetch the current access settings for a project to ensure compliance with company policies.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Path Parameters Parameters included in the API request path, specifically the project ID or URL-encoded path to identify the project.

Output

JSON

  • pages_access - The access information for the project's GitLab Pages, including permissions and roles.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Verify that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Check that the authentication credentials are valid and have sufficient permissions to access project pages access information.
  • Common error messages may include 404 Not Found if the project does not exist or 403 Forbidden if the user lacks permissions. Verify project existence and user permissions to resolve these errors.

Links

Discussion