API

Learn how to authenticate and call KakaoCloud APIs, then find API specifications by the endpoint that receives the request.

API specification format

The API specifications follow the OpenAPI Specification (OAS). Each endpoint documents its request and response structure and call details.

Get started with the API

Getting Started

Getting started

Learn how to issue an API authentication token, construct requests, and review responses.

API Index

API Index

Find the API you need by endpoint and resource.

Release Notes

Changelogs

Review major API additions, changes, and deprecations.

API Index

Expand an endpoint in the sidebar to browse its API specifications alphabetically. Specifications generated in the same directory remain separate when requests use different hosts.

bcs

BCS

Manage instances and keypairs, and attach volumes, network interfaces, and public IPs to instances.

image

Image

View, update, delete, and share images across projects.

volume

Volume

Manage volumes and snapshots, and create images from volumes.

vpc · network

VPC & Network

Manage VPCs, subnets, routes, network interfaces, public IPs, and security groups.

load-balancer

Load Balancer

Manage load balancers, listeners, target groups, and health checks.

tgw

Transit Gateway

Manage Transit Gateways, attachments, sharing, and route tables.

kubernetes-engine

Kubernetes Engine

Manage clusters and node pools, scaling, and version upgrades.

mysql

MySQL

Operate instance groups and backups, and manage parameter groups.

file-storage

File Storage

Manage Basic and Infinite file systems, backups, and shared volumes.

key-management-service

KMS

Manage key lifecycles and access permissions, and perform encryption and signing operations.

secrets-manager-service

Secrets Manager

Manage secret and version lifecycles, access permissions, and encryption keys.

resource-explorer-service

Resource Explorer

View project resources and tags.