GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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, enabling users to modify domain settings programmatically. For example, a user can update the domain configuration of their project's GitLab Pages to reflect changes in DNS or SSL settings.

Use Case Examples

  1. Updating the domain settings of a GitLab Pages site for a project to change SSL certificates or domain verification.
  2. Automating domain management for multiple projects' GitLab Pages in a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to GET but supporting PUT for this operation.
Path Parameters Parameters for the request path, including the project ID or URL-encoded path and the domain to update.

Output

JSON

  • id - The unique identifier of the domain resource.
  • domain - The domain name associated with the GitLab Pages.
  • project_id - The ID of the project to which the domain belongs.
  • certificate - SSL certificate details for the domain.
  • verification_code - Code used to verify domain ownership.
  • created_at - Timestamp when the domain was created.
  • updated_at - Timestamp when the domain was last updated.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID and domain parameters are correctly URL-encoded and valid to avoid 404 errors.
  • Authentication errors may occur if the API token is missing or invalid; verify credentials are correctly set.
  • HTTP method must be PUT for this operation; using other methods may result in errors.
  • Check that the request body schema matches the expected structure for updating the domain to prevent validation errors.

Links

Discussion