GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

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

Use Case Examples

  1. Fetch all Pages domains for a project with ID '12345' to display or manage them in an automation workflow.
  2. Use pagination parameters to retrieve Pages domains in batches when dealing with a large number of domains.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public endpoints or testing.
Authentication Select the authentication method to use, typically 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' representing the ID or URL-encoded path of the GitLab project owned by the authenticated user.

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 Pages domain belongs.
  • certificate - Details about the SSL certificate associated with the domain, if any.
  • verification_code - Verification code for domain ownership verification.
  • created_at - Timestamp when the Pages domain was created.
  • updated_at - Timestamp when the Pages 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.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project Pages domains.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • If pagination parameters are used, ensure they are valid integers to avoid request errors.

Links

Discussion