GIgitlab
clusters

List all group clusters

Lists all group clusters for a specified group.

get/api/v4/groups/{id}/clusters

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID of the group

Query parameters

pageinteger

Current page number

per_pageinteger

Number of items per page

Response

List all group clusters

idstring required
namestring required
created_atstring required
domainstring required
enabledstring required
managedstring required
provider_typestring required
platform_typestring required
environment_scopestring required
cluster_typestring required
namespace_per_environmentstring required

Example response

[
  {
    "user": {
      "id": 1,
      "username": "admin",
      "public_email": "john@example.com",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://gravatar.com/avatar/1",
      "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
      "custom_attributes": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "web_url": "https://gitlab.example.com/root"
    },
    "management_project": {
      "id": 1,
      "description": "desc",
      "name": "project1",
      "name_with_namespace": "John Doe / project1",
      "path": "project1",
      "path_with_namespace": "namespace1/project1",
      "created_at": "2020-05-07T04:27:17.016Z"
    }
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.