GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node interacts with the GitLab API to retrieve the Pages information of a specific project identified by its ID or URL-encoded path. It is useful for users who want to programmatically access the Pages data of their GitLab projects, such as fetching project web pages hosted on GitLab.

Use Case Examples

  1. A developer wants to automate the retrieval of GitLab Pages URLs for multiple projects to update a dashboard.
  2. A DevOps engineer needs to verify the Pages status of a project as part of a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Collection of path parameters required for the request, specifically the project ID or URL-encoded path.

Output

JSON

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

Dependencies

  • GitLab API authentication credential

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 not skipped, ensure valid GitLab API credentials are configured to avoid authorization errors.
  • Check the baseUrl if connecting to a self-hosted GitLab instance to ensure it is correct.

Links

Discussion