---
title: "Ncloud Kubernetes Service overview"
slug: "compute-vpckubernetesservice"
tags: ["Kubernetes Service", "overview"]
updated: 2026-09-17T10:05:57Z
published: 2026-09-17T10:05:57Z
canonical: "api.ncloud-docs.com/compute-vpckubernetesservice"
---

> ## 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.

# Ncloud Kubernetes Service overview

Available in VPC

Ncloud Kubernetes Service is an open-source platform that automates the containerization, deployment, scaling, and management of applications. Ncloud Kubernetes Service provides APIs for controlling and managing Kubernetes environments in a RESTful form.

## Common Ncloud Kubernetes Service settings

The following describes commonly used request and response formats in Ncloud Kubernetes Service APIs.

### Request

The following describes the common request format.

#### API URL

The request API URL is as follows:

```
https://nks.apigw.ntruss.com
```

#### Request headers

The following describes the request headers.

| Field | Required | Description |
| --- | --- | --- |
| `x-ncp-apigw-timestamp` | Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. - Request is considered invalid if the timestamp differs from the current time by more than 5 minutes. - Unix timestamp format. |
| `x-ncp-iam-access-key` | Required | Access key issued on NAVER Cloud Platform - Issue and check access key: See [Create authentication key](/docs/en/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1). - Issue and check access key for sub account: See [Create sub account](https://guide.ncloud-docs.com/docs/en/subaccount-use#%EC%84%9C%EB%B8%8C-%EA%B3%84%EC%A0%95-%EC%83%9D%EC%84%B1). |
| `x-ncp-apigw-signature-v2` | Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256). - Issue and check secret key: See [Create authentication key](/docs/en/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1). - Create signature: See [Create signature](/docs/en/common-ncpapi#%EC%8B%9C%EA%B7%B8%EB%8B%88%EC%B2%98%EC%83%9D%EC%84%B1). |
| `Content-Type` | Required | Request data format - `application/json` |

### Response

The following describes the common response format.

#### Response status codes

The following describes the response status codes.

| HTTP status code | Code | Message | Description |
| --- | --- | --- | --- |
| 403 | - | ForbiddenException | It is caused by insufficient permissions when making API calls with Sub Account. |
| 409 | - | ConflictException | It is caused by making a modification request while a cluster or pool of nodes is in operation. |

              Note

              

For information about the HTTP status codes common to NAVER Cloud Platform, see [Ncloud API response status codes](/docs/en/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C).

## Ncloud Kubernetes Service API

The following describes the APIs provided by the Ncloud Kubernetes Service service.

| API | Description |
| --- | --- |
| [Get cluster list](/docs/en/nks-getclusterlist) | Get cluster list. |
| [Get cluster](/docs/en/nks-getcluster) | Get cluster information. |
| [Create cluster](/docs/en/nks-createcluster) | Create new cluster. |
| [Upgrade cluster version](/docs/en/nks-upgrade) | Upgrade Kubernetes on a cluster to a new version. |
| [Set cluster audit log](/docs/en/nks-clusterauditlog) | Set whether to collect logs through the Cloud Log Analytics service. |
| [Add cluster subnet](/docs/en/nks-addsubnet) | Add subnet to a cluster. |
| [Set cluster OIDC](/docs/en/nks-patchoidc) | Add OIDC authentication feature to a cluster. |
| [Get cluster OIDC](/docs/en/nks-getoidc) | Get cluster's OIDC configuration information. |
| [Set cluster IP ACL](/docs/en/nks-patchipacl) | Set IP ACL for a cluster. |
| [Get cluster IP ACL](/docs/en/nks-getipacl) | Get IP ACL information configured in a cluster. |
| [Edit cluster LB subnet](/docs/en/nks-lbsubnet) | Set up a new load balancer subnet if the load balancer subnet configured for the cluster has been deleted. |
| [Set cluster termination protection](/docs/en/nks-returnprotection) | Set termination protection status for a cluster. |
| [Set cluster secret encryption](/docs/en/nks-updatesecretencryption) | Set secret encryption for a created cluster. |
| [Set cluster authentication mode](/docs/en/nks-updateauthtype) | Edit cluster authentication mode for a cluster. |
| [Get cluster IAM access list](/docs/en/nks-getaccessentrylist) | Get cluster's IAM access list information. |
| [Get cluster IAM access](/docs/en/nks-getaccessentry) | Get cluster's IAM access information. |
| [Create cluster IAM access](/docs/en/nks-createaccessentry) | Create IAM access for a cluster. |
| [Edit cluster IAM access](/docs/en/nks-updateaccessentry) | Edit cluster's IAM access information. |
| [Delete cluster IAM access](/docs/en/nks-deleteaccessentry) | Delete cluster's IAM access. |
| [Delete cluster](/docs/en/nks-deletecluster) | Delete cluster. |
| [Get WorkerNode](/docs/en/nks-getworkernode) | Get the list of worker nodes created in a cluster. |
| [Delete WorkerNode](/docs/en/nks-deleteworkernode) | Delete worker nodes created in a cluster. |
| [Get NodePool](/docs/en/nks-viewnodepool) | Get the list of node pools set up to create nodes in a cluster. |
| [Create NodePool](/docs/en/nks-createnodepool) | Create a node pool that sets the number of worker nodes in the cluster, their specifications, and more. |
| [Edit NodePool](/docs/en/nks-updatenodepool) | Change the number of pinned nodes in an already created node pool or set whether to use autoscaling. |
| [Edit NodePool subnet](/docs/en/nks-updatenodepoolsubnet) | Edit the assigned subnet band only for NodePools that have been assigned a separate subnet. |
| [Edit NodePool label](/docs/en/nks-updatenodepoollabel) | Edit node pool's label. |
| [Edit NodePool taint](/docs/en/nks-updatenodepooltaint) | Edit node pool's taint. |
| [Upgrade NodePool](/docs/en/nks-upgradenodepool) | Upgrade the version of the node pool registered in a cluster. |
| [Delete NodePool](/docs/en/nks-deletenodepool) | Delete a created node pool and the nodes belonging to it from a cluster. |
| [Get add-on list](/docs/en/nks-getaddonconfiglist) | Get the list of add-ons that can be installed on a cluster. |
| [Get add-on](/docs/en/nks-getaddonconfig) | Get details of an add-on. |
| [Get add-on version](/docs/en/nks-getaddonconfigversion) | Get details of an add-on version. |
| [Get cluster add-on list](/docs/en/nks-getclusteraddonlist) | Get the list of add-ons installed on a cluster. |
| [Get cluster add-on](/docs/en/nks-getclusteraddon) | Get an add-on installed on a cluster. |
| [Install cluster add-on](/docs/en/nks-installaddon) | Install one or more add-ons on a cluster. |
| [Edit cluster add-on](/docs/en/nks-updateaddon) | Edit the version or settings of an add-on installed on a cluster. |
| [Delete cluster add-on](/docs/en/nks-deleteaddon) | Delete an add-on installed on a cluster. |
| [Get kubeconfig](/docs/en/nks-viewkubeconfig) | Get the kubeconfig configuration file for a cluster. |
| [Get supported K8s versions](/docs/en/nks-viewk8sversion) | Check which versions of Kubernetes support cluster creation. |
| [Get server image](/docs/en/nks-viewserverimage) | Get the types of server images available when creating a cluster. |
| [Get server specifications](/docs/en/nks-viewserverspec) | Get server specifications available when creating a cluster or node pool. |

## Ncloud Kubernetes Service related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Ncloud Kubernetes Service APIs.

- Ncloud Kubernetes Service API guides
  - [Create signature](/docs/en/common-ncpapi#%EC%8B%9C%EA%B7%B8%EB%8B%88%EC%B2%98%EC%83%9D%EC%84%B1): How to create a signature to add to the request header
  - [Sub Account User Guides](https://guide.ncloud-docs.com/docs/en/subaccount-overview): How to issue the access key to be added to the request header
  - [Common Ncloud response status codes](/docs/en/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): Information on common response status codes of NAVER Cloud Platform used by the Ncloud Kubernetes Service service
- How to use the Ncloud Kubernetes Service
  - [Ncloud Kubernetes Service user guide](https://guide.ncloud-docs.com/docs/en/k8s-k8soverview): How to use Ncloud Kubernetes Service in the NAVER Cloud Platform console
  - [Ncloud user environment guide](https://guide.ncloud-docs.com/docs/en/environment-environment-1-1): Explore VPC and Classic environments and supported services.
  - [Pricing and features](https://www.ncloud.com/product/containers/NcloudKubernetesService): View pricing details and key capabilities.
  - [Latest announcements](https://www.ncloud.com/intro/news?categoryCode=CNTR&serviceCode=SV_0099): Stay informed about Ncloud Kubernetes Service updates and news.
  - [FAQs](https://www.ncloud.com/support/faq/prod?categoryCode2=CNTR&categoryCode3=SV_0099&page=1): Get answers to common Ncloud Kubernetes Service questions.
  - [Contact Support](https://www.ncloud.com/support/question/general): Get help if you can't find what you need in the API guide.