GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation performs an HTTP request to the GitLab API endpoint `/api/v4/admin/clusters` to retrieve information about admin clusters. It supports various HTTP methods such as GET, POST, PUT, DELETE, HEAD, and PATCH, with GET being the default. The node is useful for administrators who need to manage or query cluster information within GitLab's admin API.

Use Case Examples

  1. An admin wants to list all clusters managed in their GitLab instance by sending a GET request to `/api/v4/admin/clusters`.
  2. An admin might use a POST request to create or update cluster information if supported by the API.

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. Defaults to https://gitlab.com.
Method The HTTP method to use for the API request. Options include GET, POST, PUT, DELETE, HEAD, and PATCH. Defaults to GET.
Parameter Schema Hidden property for the parameter schema of the request, specific to the operation.
Request Body Schema Hidden property for the request body schema, specific to the operation.
Request Path The API endpoint path for the request, fixed to `/api/v4/admin/clusters` for this operation.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication unless Skip Authentication is true

Troubleshooting

  • If authentication fails, verify that the GitLab API key credential is correctly configured and has sufficient permissions.
  • Ensure the baseUrl is correct and accessible from the network where the node runs.
  • If the API endpoint returns an error, check the HTTP method and request parameters for correctness.

Links

Discussion