GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node interacts with the GitLab API to update a specific Pages domain for a project. It is useful for managing GitLab Pages domains associated with projects, such as updating domain settings or configurations. For example, a user can update the domain settings of a GitLab Pages site hosted under a project by specifying the project ID and domain name.

Use Case Examples

  1. Updating the domain configuration of a GitLab Pages site for a project by providing the project ID and domain name along with the updated domain details in the request body.
  2. Managing project Pages domains programmatically to automate domain updates or changes.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters for the API path, including project ID and domain name.

Output

JSON

  • response - The JSON response from the GitLab API after updating the Pages domain for the specified project.

Dependencies

  • Requires GitLab API key credential for authentication.

Troubleshooting

  • Ensure the project ID and domain name are correctly specified and URL-encoded if necessary.
  • Verify that the GitLab API key has sufficient permissions to update Pages domains for the project.
  • Check the base URL if using a self-hosted GitLab instance instead of gitlab.com.
  • Common errors include authentication failures, invalid project ID or domain, and insufficient permissions. Verify credentials and input parameters to resolve these.

Links

Discussion