Get add-on list

Available in VPC

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

Request

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

Method	URI
GET	/vnks/v2/addon-configs (Korea Region)
GET	/vnks/sgn-v2/addon-configs (Singapore Region)
GET	/vnks/jpn-v2/addon-configs (Japan Region)

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`k8sVersion`	String	Required	Kubernetes version `major.minor.patch` format Enter the cluster Kubernetes version excluding the suffix after the `-`. Example: If the cluster version is `1.36.2-nks.1`, enter`1.36.2`
`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/addon-configs?k8sVersion=1.36.2' \
--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:

{
  "totalCount": "integer",
  "page": "integer",
  "size": "integer",
  "addonConfigs": [
    {
      "name": "string",
      "displayName": "string",
      "description": "string",
      "category": "string",
      "versions": [
        "string"
      ]
    }
  ]
}

Response body

The response body includes the following data:

Field	Type	Required	Description
`totalCount`	Integer	-	Total number of add-ons
`page`	Integer	-	Page number to query
`size`	Integer	-	Number of items per page
`addonConfigs[]`	Array	-	Add-on list
`addonConfigs[].name`	String	-	Add-on name
`addonConfigs[].displayName`	String	-	Add-on display name
`addonConfigs[].description`	String	-	Add-on description
`addonConfigs[].category`	String	-	Add-on category `storage` \| `network` \| `security` \| `observability`
`addonConfigs[].versions[]`	Array	-	List of installable versions Exclude versions that are no longer supported (deprecated).

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:

{
    "totalCount": 4,
    "page": 1,
    "size": 10,
    "addonConfigs": [
        {
            "name": "external-dns",
            "displayName": "External DNS (NAVER Cloud)",
            "description": "external-dns with the NAVER Cloud Global DNS webhook provider. Syncs Kubernetes Service/Ingress hostnames to NAVER Cloud Global DNS records via the out-of-tree webhook provider (sidecar).",
            "category": "network",
            "versions": [
                "1.0.0"
            ]
        },
        {
            "name": "nks-csi",
            "displayName": "NKS Block Storage CSI",
            "description": "NKS managed CSI driver for ncloud Block Storage. Provides dynamic volume provisioning, attachment, snapshot, and resize.",
            "category": "storage",
            "versions": [
                "1.0.0"
            ]
        },
        {
            "name": "nks-gateway-adapter",
            "displayName": "NKS Gateway API Adapter",
            "description": "Gateway API adapter for NKS — maps Gateway/HTTPRoute to NAVER Cloud ALB via GatewayClass ncloud-alb.",
            "category": "network",
            "versions": [
                "1.0.0"
            ]
        },
        {
            "name": "nks-nas-csi",
            "displayName": "NKS NAS (NFS) CSI",
            "description": "NKS managed CSI driver for ncloud NAS (NFS) storage. Provides dynamic NFS-backed volume provisioning, resize, and snapshot.",
            "category": "storage",
            "versions": [
                "1.0.0"
            ]
        }
    ]
}

Documentation Index