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 Operator API

Server operations and metrics

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

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

This API exposes 4 operations across 3 paths. 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.

4 operations 3 paths 0 schemas 3 GET1 PUT

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 Operator 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 4

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

Operator 4

Server operations and metrics

GET
/v1/ns/operator/switches
Get system switches
getSwitches → 200
PUT
/v1/ns/operator/switches
Update system switches
updateSwitches 3 params → 200
GET
/v1/ns/operator/metrics
Get server metrics
getMetrics → 200
GET
/v1/ns/operator/servers
List cluster servers
listServers 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nacos-operator-api-openapi.yml Raw ↑

Other APIs Nacos publishes across the network.

Nacos Auth API
Nacos Configuration API
Nacos Namespace API
Nacos Service Discovery API
Nacos Service Management API