GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to update (PATCH) the pages of a specific project identified by its ID or URL-encoded path. It is useful for automating project page updates in GitLab, such as modifying project documentation or web pages hosted on GitLab Pages.

Use Case Examples

  1. Updating the content or configuration of GitLab Pages for a project by specifying the project ID and sending the desired changes in the request body.
  2. Automating project page management in CI/CD workflows by patching project pages programmatically.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API 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 but can be set to PATCH for this operation.
Path Parameters Parameters included in the request path, specifically the project ID or URL-encoded path to identify the project whose pages are being patched.

Output

JSON

  • response - The JSON response from the GitLab API after patching the project pages, containing the updated page details or status.

Dependencies

  • Requires GitLab API authentication credentials unless skipping authentication is enabled.

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly specified in the path parameters to avoid 404 errors.
  • Verify that the authentication credentials are valid and have sufficient permissions to patch project pages to prevent authorization errors.
  • Check the request body schema for correctness to avoid validation errors from the GitLab API.

Links

Discussion