GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows updating a specific domain for GitLab Pages within a project. It is useful for managing custom domains associated with GitLab Pages, such as modifying domain settings or configurations for a project you own or have access to. For example, you can update the domain settings of your project's GitLab Pages to point to a new domain or change SSL configurations.

Use Case Examples

  1. Updating the domain settings of a GitLab Pages domain for a project to enable HTTPS.
  2. Changing the domain configuration for a project to use a different custom domain.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication The authentication method used for the request, 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 PUT for this operation.
Path Parameters Parameters required in the request path to identify the project and domain to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the domain.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and domain are correctly specified and URL-encoded if necessary.
  • Verify that the authentication credentials are valid and have sufficient permissions to update project domains.
  • Check the base URL if using a self-hosted GitLab instance instead of gitlab.com.
  • Common errors include 401 Unauthorized (authentication issues), 404 Not Found (invalid project ID or domain), and 400 Bad Request (invalid request body).

Links

Discussion