GitLab API

GitlabTool
Join our community

Actions905

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 configured for GitLab Pages within a particular project. For example, a user can fetch domain details to verify domain settings or status for a project hosted on GitLab Pages.

Use Case Examples

  1. Get details of a Pages domain 'example.com' for project with ID '12345'.
  2. Fetch domain information for a project to automate domain management or monitoring.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used for the request, typically an API key credential for GitLab.
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 to specify the project ID and the domain name for the Pages domain to retrieve.

Output

JSON

  • id - The unique identifier 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 associated with the domain, if any.
  • auto_ssl_enabled - Indicates if automatic SSL is enabled for the domain.
  • verification_code - Verification code for domain ownership.
  • created_at - Timestamp when the domain was created.
  • updated_at - Timestamp when the domain was last updated.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID and domain parameters are correctly provided and URL-encoded if necessary.
  • Authentication errors may occur if the API key or token is invalid or missing; verify credentials.
  • The domain must exist for the specified project; otherwise, a 404 Not Found error will be returned.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.

Links

Discussion