GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation interacts with the GitLab API to retrieve a list of Pages domains using the 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 managing and viewing GitLab Pages domains programmatically, such as in automation workflows for DevOps or project management.

Use Case Examples

  1. Retrieve the first page of GitLab Pages domains with default pagination.
  2. Fetch a specific page of domains by setting the `page` and `per_page` query parameters to control the number of results returned.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request. If true, no authentication is used.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET. Options include GET, POST, PUT, DELETE, HEAD, PATCH.
Query Parameters Collection of query parameters to customize the API request, specifically for pagination in this operation.

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.

Dependencies

  • GitLab API key credential for authentication unless Skip Authentication is enabled.

Troubleshooting

  • If authentication fails, verify that the GitLab API key credential is correctly configured and has the necessary permissions.
  • Ensure the baseUrl is correct and accessible; otherwise, the API request will fail.
  • Pagination parameters must be integers; invalid values may cause errors or unexpected results.
  • If the API endpoint changes or is deprecated, update the node configuration accordingly.

Links

Discussion