GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to retrieve information about Pages domains associated with a specific project. It is useful for users who want to manage or view the Pages domains configured for their GitLab projects, such as developers or DevOps engineers managing project deployments.

Use Case Examples

  1. Retrieve the list of Pages domains for a project to verify domain configurations.
  2. Paginate through Pages domains if there are many, by specifying page number and items per page.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters to control pagination of the results, including page number and items per page.
Path Parameters Path parameters required by the API endpoint, specifically the project ID or URL-encoded path.

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.
  • created_at - Timestamp when the Pages domain was created.
  • updated_at - Timestamp when the Pages domain was last updated.
  • verification_code - Code used to verify domain ownership.
  • verified - Boolean indicating if the domain is verified.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided in the path parameters to avoid 404 errors.
  • Check that the API authentication token is valid and has sufficient permissions to access project Pages domains.
  • If pagination parameters are used, verify that page and per_page values are integers and within allowed ranges to avoid request errors.

Links

Discussion