GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation interacts with the GitLab API to retrieve the pages access information for a specific project identified by its ID or URL-encoded path. It is useful for scenarios where you need to programmatically check or manage the access settings of GitLab Pages for a project, such as in automation workflows for DevOps or project management.

Use Case Examples

  1. Retrieve the pages access details of a GitLab project by providing its project ID.
  2. Automate the monitoring of GitLab Pages access permissions for multiple projects in an organization.

Properties

Name Meaning
Skip Authentication Option to 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, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Path Parameters The path parameters for the API request, specifically the project ID or URL-encoded path required to identify the project.

Output

JSON

  • id - The ID or URL-encoded path of the project used in the request path parameter.
  • pages_access - The access information of the GitLab Pages for the specified project, returned by the API.

Dependencies

  • GitLab API key credential for authentication unless skipping authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided in the path parameters to avoid 404 errors.
  • If authentication is enabled, verify that the GitLab API key credential is valid and has sufficient permissions to access project pages information.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the API endpoint is reachable.

Links

Discussion