GitLab API

GitlabTool
Join our community

Actions1000

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 Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, 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.
Path Parameters The path parameters for the API request, specifically the project ID or URL-encoded path.

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 Skip Authentication is enabled.

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided in the path parameters; otherwise, the API request will fail.
  • If authentication is required and not provided or invalid, the node will throw an authentication error.
  • Verify the baseUrl is correct and accessible; incorrect URLs will cause connection errors.

Links

Discussion