Get add-on

Available in VPC

Get details of an add-on.

Request

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

Method	URI
GET	/vnks/v2/addon-configs/{addonName} (Korea Region)
GET	/vnks/sgn-v2/addon-configs/{addonName} (Singapore Region)
GET	/vnks/jpn-v2/addon-configs/{addonName} (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
`addonName`	String	Required	Add-on name See Get add-on list.

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`

Request example

The request example is as follows:

curl --location --request GET 'https://nks.apigw.ntruss.com/vnks/v2/addon-configs/nks-csi?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:

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "category": "string",
  "versions": [
    "string"
  ]
}

Response body

The response body includes the following data:

Field	Type	Required	Description
`name`	String	-	Add-on name
`displayName`	String	-	Add-on display name
`description`	String	-	Add-on description
`category`	String	-	Add-on category
`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:

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

Documentation Index