Get cluster add-on

Available in VPC

Get an add-on 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/{addonRef} (Korea Region)
GET	/vnks/sgn-v2/clusters/{uuid}/addons/{addonRef} (Singapore Region)
GET	/vnks/jpn-v2/clusters/{uuid}/addons/{addonRef} (Japan Region)

Request headers

For information about the headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service request headers.

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.
`addonRef`	String	Required	Add-on name or UUID of installed add-on See Get cluster add-on list.

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/nks-csi' \
--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:

{
  "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"
}

Response body

The response body includes the following data:

Field	Type	Required	Description
`uuid`	String	-	UUID of installed add-on
`clusterUuid`	String	-	UUID of the cluster
`addonName`	String	-	Add-on name
`version`	String	-	Installed add-on version
`configurationValues`	String	-	Helm values override values (JSON object string) `{}` if not set.
`displayName`	String	-	Add-on display name
`description`	String	-	Add-on description
`category`	String	-	Add-on category
`status`	String	-	Add-on status
`message`	String	-	Status detail message Provided only for failure status Empty or omitted for other status
`k8sVersion`	String	-	Cluster Kubernetes version
`latestVersion`	String	-	Latest installable version Provided only when a version higher than the current one exists
`createdAt`	String	-	Installation date and time
`updatedAt`	String	-	Last modification date and time

Response status codes

For information about the HTTP status codes common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service response status codes.

Response example

The response example is as follows:

{
    "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"
}

Documentation Index