GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation verifies a custom domain for GitLab Pages within a specific project. It is useful for users managing GitLab Pages who want to confirm ownership and proper configuration of a domain associated with their project. For example, a user can verify that their custom domain is correctly set up to serve their project's GitLab Pages site.

Use Case Examples

  1. Verifying a custom domain 'example.com' for a project with ID '12345' to ensure the domain is properly linked and verified for GitLab Pages.
  2. Automating domain verification as part of a CI/CD pipeline to confirm domain setup after deployment.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication used, here it is GitLab API authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but PUT is used for this operation.
Path Parameters Parameters required in the URL path for the request, specifically the project ID and the domain to verify.

Output

JSON

  • status - The status of the domain verification request
  • message - Additional message or details about the verification result

Dependencies

  • Requires GitLab API credentials for authentication.

Troubleshooting

  • Ensure the project ID and domain are correctly specified and URL-encoded if necessary.
  • Authentication errors may occur if the GitLab API credentials are missing or invalid.
  • Verify that the base URL is correct for the GitLab instance being used.

Links

Discussion