GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation verifies a custom domain for GitLab Pages within a specific project. It is useful for developers or DevOps engineers managing GitLab Pages who need to confirm ownership and proper configuration of a domain associated with their project. For example, after setting up a custom domain for a GitLab Pages site, this operation can be used to trigger the verification process to ensure the domain is correctly linked and authorized.

Use Case Examples

  1. Verifying a custom domain 'example.com' for a GitLab Pages site in project with ID '12345'.
  2. Automating domain verification as part of a CI/CD pipeline to ensure the domain is valid before deployment.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request, useful for public or unauthenticated endpoints.
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 PUT for this operation.
Path Parameters Parameters required in the URL path to identify the project and domain to verify.

Output

JSON

  • status - The HTTP status or result of the domain verification request.
  • data - Response data from the GitLab API regarding the domain verification status.

Dependencies

  • Requires GitLab API key credential for authentication unless skipping authentication is enabled.

Troubleshooting

  • Ensure the project ID and domain parameters are correctly specified and URL-encoded if necessary.
  • Authentication errors may occur if the API key is missing, invalid, or lacks sufficient permissions.
  • Verify that the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • HTTP method must be PUT for this verification operation; using other methods may result in errors.

Links

Discussion