Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nacos Configuration API

Configuration management operations

Nacos Configuration API is one of 6 APIs that Nacos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.3.0.

Requests are made against 2 base URLs: http://localhost:8848/nacos, http://{nacos_host}:{port}/nacos.

6 operations 4 paths 1 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.3.0
Base URL
http://localhost:8848/nacos
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Nacos Configuration API declares 1 security scheme for authenticating requests. An API key is passed in the query as accessToken (AccessToken). By default, every request must be authenticated.

  • AccessToken — Access token obtained from login endpoint

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Configuration 6

Configuration management operations

GET
/v1/cs/configs
Get configuration
getConfig 3 params → 200404
POST
/v1/cs/configs
Publish configuration
publishConfig body → 200
DELETE
/v1/cs/configs
Delete configuration
deleteConfig 3 params → 200
POST
/v1/cs/configs/listener
Listen for configuration changes
listenConfig body → 200
GET
/v1/cs/history
Get configuration history
getConfigHistory 5 params → 200
GET
/v1/cs/history/previous
Get previous configuration version
getPreviousConfig 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ConfigHistoryItem (12 properties). Each schema is shown below with its type and property counts.

ConfigHistoryItem
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nacos-configuration-api-openapi.yml Raw ↑

Other APIs Nacos publishes across the network.

Nacos Auth API
Nacos Namespace API
Nacos Operator API
Nacos Service Discovery API
Nacos Service Management API