# ClustersApi

All URIs are relative to *https://www.gitlab.com/api/v4*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteApiV4AdminClustersClusterId**](#deleteapiv4adminclustersclusterid) | **DELETE** /admin/clusters/{cluster_id} | Delete instance cluster|
|[**getApiV4AdminClusters**](#getapiv4adminclusters) | **GET** /admin/clusters | List instance clusters|
|[**getApiV4AdminClustersClusterId**](#getapiv4adminclustersclusterid) | **GET** /admin/clusters/{cluster_id} | Get a single instance cluster|
|[**postApiV4AdminClustersAdd**](#postapiv4adminclustersadd) | **POST** /admin/clusters/add | Add existing instance cluster|
|[**putApiV4AdminClustersClusterId**](#putapiv4adminclustersclusterid) | **PUT** /admin/clusters/{cluster_id} | Edit instance cluster|

# **deleteApiV4AdminClustersClusterId**
> APIEntitiesCluster deleteApiV4AdminClustersClusterId()

This feature was introduced in GitLab 13.2. Deletes an existing instance cluster. Does not remove existing resources within the connected Kubernetes cluster.

### Example

```typescript
import {
    ClustersApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new ClustersApi(configuration);

let clusterId: number; //The cluster ID (default to undefined)

const { status, data } = await apiInstance.deleteApiV4AdminClustersClusterId(
    clusterId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **clusterId** | [**number**] | The cluster ID | defaults to undefined|


### Return type

**APIEntitiesCluster**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | Delete instance cluster |  -  |
|**403** | Forbidden |  -  |
|**404** | Not found |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getApiV4AdminClusters**
> Array<APIEntitiesCluster> getApiV4AdminClusters()

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

### Example

```typescript
import {
    ClustersApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new ClustersApi(configuration);

const { status, data } = await apiInstance.getApiV4AdminClusters();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**Array<APIEntitiesCluster>**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | List instance clusters |  -  |
|**403** | Forbidden |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getApiV4AdminClustersClusterId**
> APIEntitiesCluster getApiV4AdminClustersClusterId()

This feature was introduced in GitLab 13.2. Returns a single instance cluster.

### Example

```typescript
import {
    ClustersApi,
    Configuration
} from 'berg';

const configuration = new Configuration();
const apiInstance = new ClustersApi(configuration);

let clusterId: number; //The cluster ID (default to undefined)

const { status, data } = await apiInstance.getApiV4AdminClustersClusterId(
    clusterId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **clusterId** | [**number**] | The cluster ID | defaults to undefined|


### Return type

**APIEntitiesCluster**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Get a single instance cluster |  -  |
|**403** | Forbidden |  -  |
|**404** | Not found |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **postApiV4AdminClustersAdd**
> APIEntitiesCluster postApiV4AdminClustersAdd(postApiV4AdminClustersAddRequest)

This feature was introduced in GitLab 13.2. Adds an existing Kubernetes instance cluster.

### Example

```typescript
import {
    ClustersApi,
    Configuration,
    PostApiV4AdminClustersAddRequest
} from 'berg';

const configuration = new Configuration();
const apiInstance = new ClustersApi(configuration);

let postApiV4AdminClustersAddRequest: PostApiV4AdminClustersAddRequest; //

const { status, data } = await apiInstance.postApiV4AdminClustersAdd(
    postApiV4AdminClustersAddRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **postApiV4AdminClustersAddRequest** | **PostApiV4AdminClustersAddRequest**|  | |


### Return type

**APIEntitiesCluster**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Add existing instance cluster |  -  |
|**400** | Validation error |  -  |
|**403** | Forbidden |  -  |
|**404** | Not found |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **putApiV4AdminClustersClusterId**
> APIEntitiesCluster putApiV4AdminClustersClusterId()

This feature was introduced in GitLab 13.2. Updates an existing instance cluster.

### Example

```typescript
import {
    ClustersApi,
    Configuration,
    PutApiV4AdminClustersClusterIdRequest
} from 'berg';

const configuration = new Configuration();
const apiInstance = new ClustersApi(configuration);

let clusterId: number; //The cluster ID (default to undefined)
let putApiV4AdminClustersClusterIdRequest: PutApiV4AdminClustersClusterIdRequest; // (optional)

const { status, data } = await apiInstance.putApiV4AdminClustersClusterId(
    clusterId,
    putApiV4AdminClustersClusterIdRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **putApiV4AdminClustersClusterIdRequest** | **PutApiV4AdminClustersClusterIdRequest**|  | |
| **clusterId** | [**number**] | The cluster ID | defaults to undefined|


### Return type

**APIEntitiesCluster**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Edit instance cluster |  -  |
|**400** | Validation error |  -  |
|**403** | Forbidden |  -  |
|**404** | Not found |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)