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 Service Discovery API

Service instance registration and discovery

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

Tagged areas include Service Discovery. 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 DELETE1 GET1 POST3 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 Service Discovery 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, 1 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Service Discovery 6

Service instance registration and discovery

POST
/v1/ns/instance
Register an instance
registerInstance body → 200
DELETE
/v1/ns/instance
Deregister an instance
deregisterInstance 7 params → 200
PUT
/v1/ns/instance
Update instance
updateInstance body → 200
GET
/v1/ns/instance/list
List instances
listInstances 5 params → 200
PUT
/v1/ns/instance/beat
Send instance heartbeat
sendBeat 5 params → 200
PUT
/v1/ns/health/instance
Update instance health status
updateInstanceHealth 7 params → 200

Schemas 1

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

Instance
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nacos-service-discovery-api-openapi.yml Raw ↑

Other APIs Nacos publishes across the network.

Nacos Auth API
Nacos Configuration API
Nacos Namespace API
Nacos Operator API
Nacos Service Management API