GitLab API

GitlabTool

Actions1095

Clusters → getApiV4ProjectsIdClustersClusterId

AI-generated

Summary

Retrieve detailed information about a specific cluster within a GitLab project by providing the project ID or URL-encoded path and the cluster ID.

Inputs

  • id (required) — The ID or URL-encoded path of the GitLab project containing the cluster.
  • cluster_id (required) — The ID of the cluster to retrieve information for.
  • baseUrl — Optional custom base URL of the GitLab instance; defaults to https://gitlab.com.
  • skipAuthentication — Optionally skip authentication; defaults to false.

Output shape

a single JSON object representing the details of the specified cluster within the project.

The operation performs a GET request to the GitLab API endpoint /api/v4/projects/{id}/clusters/{cluster_id}. Authentication is required unless explicitly skipped. The output structure corresponds to the cluster resource as defined by GitLab's API.

Examples

Example 1: Get cluster details for project 123 and cluster 456

Set 'id' to '123' and 'cluster_id' to '456', method defaults to GET, use default baseUrl and provide GitLab API credentials.

Links

Discussion