GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows updating GitLab project pages by sending a PATCH request to the GitLab API endpoint `/api/v4/projects/{id}/pages`. It is useful for modifying the pages of a specific project identified by its ID or URL-encoded path. Common scenarios include automating updates to project pages or integrating GitLab page management into workflows.

Use Case Examples

  1. Updating the content or configuration of a GitLab project's pages programmatically.
  2. Automating page updates as part of a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the 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 HTTP method to use for the request, default is GET but PATCH is used for this operation.
Path Parameters Parameters to specify the project ID or URL-encoded path for the request.

Output

JSON

  • id - The ID or URL-encoded path of the project whose pages are being updated.
  • pages - The updated pages data returned from the GitLab API after the PATCH request.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly specified in the path parameters to avoid 404 errors.
  • If authentication is skipped, the request may fail due to lack of permissions; verify credentials if errors occur.
  • Check that the base URL is correct and accessible, especially if using a self-hosted GitLab instance.
  • Verify that the request body schema matches the expected format for updating project pages to prevent validation errors.

Links

Discussion