List instance clusters

GET /admin/clusters

This feature was introduced in GitLab 13.2. Returns a list of instance clusters.

Responses

200 application/json

List instance clusters
Hide response attributes Show response attributes object
- id string
- name string
- created_at string
- domain string
- enabled string
- managed string
- provider_type string
- platform_type string
- environment_scope string
- cluster_type string
- namespace_per_environment string
- user object
  
  Hide user attributes Show user attributes object
  
  id integer(int32)
  
  username string
  
  name string
  
  state string
  
  avatar_url string
  
  avatar_path string
  
  custom_attributes array[object]
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  key string
  
  value string
  
  web_url string
  
  email string
- platform_kubernetes object
  
  Hide platform_kubernetes attributes Show platform_kubernetes attributes object
  
  api_url string
  
  namespace string
  
  authorization_type string
  
  ca_cert string
- provider_gcp object
  
  Hide provider_gcp attributes Show provider_gcp attributes object
  
  cluster_id string
  
  status_name string
  
  gcp_project_id string
  
  zone string
  
  machine_type string
  
  num_nodes string
  
  endpoint string
- management_project object
  
  Hide management_project attributes Show management_project attributes object
  
  id integer(int32)
  
  description string
  
  name string
  
  name_with_namespace string
  
  path string
  
  path_with_namespace string
  
  created_at string(date-time)
403

Forbidden

GET /admin/clusters

curl \
 --request GET 'https://www.gitlab.com/api/v4/admin/clusters' \
 --header "Private-Token: $API_KEY"

Response examples (200)

[
  {
    "id": "string",
    "name": "string",
    "created_at": "string",
    "domain": "string",
    "enabled": "string",
    "managed": "string",
    "provider_type": "string",
    "platform_type": "string",
    "environment_scope": "string",
    "cluster_type": "string",
    "namespace_per_environment": "string",
    "user": {
      "id": 1,
      "username": "admin",
      "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",
      "email": "string"
    },
    "platform_kubernetes": {
      "api_url": "string",
      "namespace": "string",
      "authorization_type": "string",
      "ca_cert": "string"
    },
    "provider_gcp": {
      "cluster_id": "string",
      "status_name": "string",
      "gcp_project_id": "string",
      "zone": "string",
      "machine_type": "string",
      "num_nodes": "string",
      "endpoint": "string"
    },
    "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:17Z"
    }
  }
]