GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to retrieve information about admin clusters using the GET method on the /api/v4/admin/clusters endpoint. It is useful for administrators who need to manage or monitor GitLab clusters programmatically, such as fetching cluster details for automation or reporting purposes.

Use Case Examples

  1. An admin wants to automate the retrieval of cluster information to monitor cluster health and status.
  2. A DevOps engineer integrates this node into a workflow to fetch cluster data and trigger alerts based on cluster metrics.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making 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 The HTTP method used for the API request, defaulting to GET.
Parameter Schema Hidden property for the parameter schema of the getApiV4AdminClusters operation.
Request Body Schema Hidden property for the request body schema of the getApiV4AdminClusters operation.
Request Path Hidden property specifying the API endpoint path for the getApiV4AdminClusters operation, defaulting to /api/v4/admin/clusters.

Output

JSON

  • response - The JSON response from the GitLab API containing details about admin clusters.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access admin cluster information.
  • Verify the baseUrl is correct and accessible from the network where the node is running.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated access to the admin clusters endpoint, which is uncommon and may cause authorization errors.

Links

Discussion