---
title: "Get cluster add-on list"
slug: "nks-getclusteraddonlist"
updated: 2026-09-17T10:05:54Z
published: 2026-09-17T10:05:54Z
canonical: "api.ncloud-docs.com/nks-getclusteraddonlist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get cluster add-on list

Available in VPC

Get the list of add-ons installed on a cluster.

## Request

This section describes the request format. The method and URI are as follows:

| Method | URI |
| --- | --- |
| GET | /vnks/v2/clusters/{uuid}/addons (Korea Region) |
| GET | /vnks/sgn-v2/clusters/{uuid}/addons (Singapore Region) |
| GET | /vnks/jpn-v2/clusters/{uuid}/addons (Japan Region) |

### Request headers

For information about the headers common to all Ncloud Kubernetes Service APIs, see [Ncloud Kubernetes Service request headers](/docs/en/compute-vpckubernetesservice#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94).

### Request path parameters

You can use the following path parameters with your request:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `uuid` | String | Required | Cluster UUID - See [Get cluster list](/docs/en/nks-getclusterlist). |

### Request query parameters

You can use the following query parameters with your request:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | String | Optional | Add-on status |
| `page` | Integer | Optional | Page number |
| `size` | Integer | Optional | Number of items per page |

### Request example

The request example is as follows:

```
curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/clusters/****a20e-e0fb-4dc9-af1b-97fd3f8d****/addons' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
```

## Response

This section describes the response format.

### Response syntax

The response syntax is as follows:

```
{
  "addons": [
    {
      "uuid": "string",
      "clusterUuid": "string",
      "addonName": "string",
      "version": "string",
      "configurationValues": "string",
      "displayName": "string",
      "description": "string",
      "category": "string",
      "status": "string",
      "message": "string",
      "k8sVersion": "string",
      "latestVersion": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "totalCount": "integer",
  "page": "integer",
  "size": "integer"
}
```

### Response body

The response body includes the following data:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `addons[]` | Array | - | List of add-ons installed |
| `addons[].uuid` | String | - | UUID of installed add-on |
| `addons[].clusterUuid` | String | - | UUID of the cluster |
| `addons[].addonName` | String | - | Add-on name |
| `addons[].version` | String | - | Installed add-on version |
| `addons[].configurationValues` | String | - | Helm values override values (JSON object string) - `{}` if not set. |
| `addons[].displayName` | String | - | Add-on display name |
| `addons[].description` | String | - | Add-on description |
| `addons[].category` | String | - | Add-on category |
| `addons[].status` | String | - | Add-on status |
| `addons[].message` | String | - | Status detail message - Provided only for failure status - Empty or omitted for other status |
| `addons[].k8sVersion` | String | - | Cluster Kubernetes version |
| `addons[].latestVersion` | String | - | Latest installable version - Provided only when a version higher than the current one exists |
| `addons[].createdAt` | String | - | Installation date and time |
| `addons[].updatedAt` | String | - | Last modification date and time |
| `totalCount` | Integer | - | Total number of add-ons |
| `page` | Integer | - | Page number to query |
| `size` | Integer | - | Number of items per page |

### Response status codes

For information about the HTTP status codes common to all Ncloud Kubernetes Service APIs, see [Ncloud Kubernetes Service response status codes](/docs/en/compute-vpckubernetesservice#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C).

### Response example

The response example is as follows:

```
{
    "addons": [
        {
            "uuid": "****b3f1-2c4d-4a6e-9f80-1a2b3c4d****",
            "clusterUuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****",
            "addonName": "nks-csi",
            "version": "1.0.0",
            "configurationValues": "{}",
            "displayName": "NKS Block Storage CSI",
            "description": "NKS managed CSI driver for ncloud Block Storage. Provides dynamic volume provisioning, attachment, snapshot, and resize.",
            "category": "storage",
            "status": "running",
            "message": "",
            "k8sVersion": "1.36.2-nks.1",
            "latestVersion": "",
            "createdAt": "2025-06-05T10:15:30.000Z",
            "updatedAt": "2025-06-05T10:20:12.000Z"
        }
    ],
    "totalCount": 1,
    "page": 1,
    "size": 50
}
```