GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation verifies a domain for GitLab Pages within a specific project. It is useful for users managing GitLab projects who want to confirm ownership or configuration of a custom domain associated with their project's GitLab Pages. For example, a user can verify that a domain they intend to use for their project's website is correctly set up and recognized by GitLab.

Use Case Examples

  1. Verifying a custom domain for a GitLab Pages site in a project to ensure it is properly configured.
  2. Automating domain verification as part of a CI/CD pipeline for GitLab projects.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated access scenarios.
Authentication Specifies the authentication method to use, 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, default is GET but can be set to PUT for this operation.
Path Parameters Parameters to specify the project ID or URL-encoded path and the domain to verify.

Output

JSON

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

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and domain parameters are correctly specified and URL-encoded if necessary.
  • Verify that the authentication credentials are valid and have sufficient permissions to access the project and perform domain verification.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages may include 401 Unauthorized if authentication fails, 404 Not Found if the project or domain does not exist, or 400 Bad Request if parameters are invalid.

Links

Discussion