GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves the pages domains associated with a specific project in GitLab using the GitLab API v4. It is useful for users who want to list or manage the domains linked to their project's GitLab Pages. For example, a developer or DevOps engineer can use this node to fetch all custom domains configured for a project's GitLab Pages to verify or audit domain settings.

Use Case Examples

  1. Fetch all pages domains for a project with ID '12345' to display them in a dashboard.
  2. Retrieve pages domains with pagination to handle large sets of domains efficiently.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public endpoints or testing.
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 GET.
Query Parameters Optional query parameters for pagination, including 'page' (current page number) and 'per_page' (number of items per page).
Path Parameters Path parameter 'id' specifying the ID or URL-encoded path of the project owned by the authenticated user.

Output

JSON

  • id - The unique identifier of the pages domain.
  • domain - The domain name associated with the project's GitLab Pages.
  • project_id - The ID of the project to which the domain belongs.
  • certificate - SSL certificate details for the domain, if available.
  • 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 key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user to avoid authorization errors.
  • Verify that the base URL is correct and reachable, especially if using a self-hosted GitLab instance.
  • If pagination parameters are used, ensure they are valid integers to prevent request errors.
  • Authentication errors may occur if the API key is missing, invalid, or lacks necessary permissions.

Links

Discussion