GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves domain information related to GitLab Pages by making an API call to the GitLab API endpoint `/api/v4/pages/domains`. It supports pagination through query parameters, allowing users to specify the page number and the number of items per page. This operation is useful for users who want to programmatically access and manage GitLab Pages domains, for example, to list all domains associated with their GitLab instance.

Use Case Examples

  1. A user wants to list all GitLab Pages domains for their projects and uses this node to fetch the domains with pagination support.
  2. An automation workflow that monitors GitLab Pages domains and triggers alerts or updates based on the retrieved domain data.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request. If true, the request is made without authentication.
Authentication Specifies the authentication method to use for the API request, defaulting to GitLab API key authentication. This property is hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the API request. Defaults to GET and supports GET, POST, PUT, DELETE, HEAD, PATCH.
Query Parameters Collection of query parameters to customize the API request, specifically for pagination: 'page' to specify the current page number and 'per_page' to specify the number of items per page.

Output

JSON

  • domains - List of GitLab Pages domains retrieved from the API
  • pagination
    • page - Current page number of the results
    • per_page - Number of items per page in the results
    • total - Total number of items available
    • total_pages - Total number of pages available

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • If authentication is skipped but the API requires it, the request will fail with an authentication error. Ensure the correct authentication method is used.
  • Incorrect baseUrl can lead to connection errors or 404 responses. Verify the GitLab instance URL is correct.
  • Invalid query parameters (e.g., non-integer page or per_page) may cause API errors. Use valid integer values for pagination parameters.

Links

Discussion