GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node interacts with the GitLab API to retrieve pages information for a specific project identified by its ID or URL-encoded path. It is useful for scenarios where users need to programmatically access GitLab project pages data, such as automating project documentation retrieval or managing project web pages.

Use Case Examples

  1. Fetching GitLab project pages for a given project ID to display or process the pages data in an automation workflow.
  2. Automating the retrieval of project pages to integrate with other systems or dashboards.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, defaulting to GET.
Path Parameters Parameters to be included in the request path, specifically the project ID or URL-encoded path.

Output

JSON

  • pages - The pages information retrieved from the GitLab project specified by the ID.

Dependencies

  • GitLab API key credential

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 the project pages.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct and accessible.

Links

Discussion