GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the Pages information for a specific project in GitLab using the GitLab API v4. It is useful for users who want to programmatically access the Pages details of their GitLab projects, such as for automation, monitoring, or integration purposes. For example, a user can fetch the Pages URL or status of a project to display on a dashboard or trigger further workflows based on the Pages availability.

Use Case Examples

  1. Fetch Pages details of a project by providing the project ID to monitor the project's GitLab Pages status.
  2. Automate retrieval of project Pages URLs to update documentation or internal tools.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using 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 which the API requests are sent, 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 owned by the authenticated user.

Output

JSON

  • id - The ID or URL-encoded path of the project whose Pages information is retrieved.
  • pages - The Pages information of the specified project returned by the GitLab API.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • If authentication is skipped, the API request may fail due to lack of permissions.
  • Verify the baseUrl is correct for the GitLab instance being accessed.
  • Common error messages include 401 Unauthorized (check API key or authentication), 404 Not Found (check project ID), and 403 Forbidden (check user permissions).

Links

Discussion