GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node operation retrieves information about a specific Pages domain for a project in GitLab using the GitLab API v4. It is useful for users who want to get details about a domain associated with a project's GitLab Pages, such as verifying domain settings or status.

Use Case Examples

  1. A developer wants to check the configuration of a custom domain used for their project's GitLab Pages.
  2. A DevOps engineer needs to automate the retrieval of domain details for multiple projects to monitor their GitLab Pages domains.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using 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, default is GET.
Path Parameters Parameters used in the request path to specify the project and domain.

Output

JSON

  • id - The ID of the Pages domain.
  • domain - The domain name of the Pages domain.
  • project_id - The ID of the project to which the domain belongs.
  • certificate - Details about the SSL certificate for the domain, if any.
  • auto_ssl_enabled - Indicates if automatic SSL is enabled for the domain.
  • verification_code - Verification code for domain ownership.
  • verification_status - Status of the domain verification.
  • created_at - Timestamp when the domain was created.
  • updated_at - Timestamp when the domain was last updated.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID and domain parameters are correctly set and URL-encoded if necessary.
  • Authentication errors may occur if the API token is missing or invalid; verify credentials are correctly configured.
  • If the domain does not exist or is not associated with the project, the API will return an error; verify the domain name and project ID.

Links

Discussion