GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node interacts with the GitLab API to retrieve system hooks via the API v4 endpoint. It is useful for automating workflows that require monitoring or managing GitLab system hooks, such as fetching hook configurations or statuses programmatically. For example, it can be used to list all system hooks with pagination support to handle large sets of hooks.

Use Case Examples

  1. Fetch the first page of system hooks with default pagination.
  2. Customize the number of hooks retrieved per page by setting the 'per_page' query parameter.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method HTTP method used for the API request, default is GET.
Query Parameters Collection of query parameters to customize the API request, including pagination options like 'page' and 'per_page'.

Output

JSON

  • hooks - Array of system hooks retrieved from the GitLab API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access system hooks.
  • Verify the baseUrl is correct and accessible from the network where the node runs.
  • Check that the query parameters 'page' and 'per_page' are valid integers to avoid API errors.

Links

Discussion