GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves information about GitLab admin clusters via the GitLab API. It is useful for administrators who need to manage or monitor clusters within their GitLab instance. For example, it can be used to fetch details about all clusters configured in the GitLab admin area for auditing or management purposes.

Use Case Examples

  1. Fetch all admin clusters from a self-hosted GitLab instance by specifying the base URL and using the GET method.
  2. Retrieve cluster information from the default GitLab.com instance without authentication by enabling the skip authentication option.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication when making the request.
Authentication Specifies the authentication method to use for the API request, hidden if skipping authentication is enabled.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Parameter Schema Hidden property for the parameter schema of the operation, not user-editable.
Request Body Schema Hidden property for the request body schema of the operation, not user-editable.
Request Path The API endpoint path for retrieving admin clusters, fixed to '/api/v4/admin/clusters'.

Output

JSON

  • response - The JSON response from the GitLab API containing the list of admin clusters and their details.

Dependencies

  • GitLab API authentication (optional if skipping authentication)

Troubleshooting

  • If authentication is required but skipped, the API request may fail with an unauthorized error. Ensure the correct authentication method is used or enable authentication.
  • Incorrect baseUrl may lead to connection errors or 404 responses. Verify the GitLab instance URL is correct.
  • Using an unsupported HTTP method for this operation may result in errors. The GET method is typically used for retrieving cluster information.

Links

Discussion