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

Weaviate nodes API

The nodes API from Weaviate — 2 operation(s) for nodes.

Weaviate nodes API is one of 22 APIs that Weaviate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include nodes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.38.0-dev.

Requests are made against a single base URL, http://localhost:8080.

2 operations 2 paths 7 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.38.0-dev
Server
http://localhost:8080
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Weaviate nodes API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key authentication
  • BearerAuth — OIDC/JWT bearer authentication

Paths & Operations 2

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

nodes 2
GET
/nodes
Weaviate Get Node Status
nodes.get 1 param → 200401403404422500
GET
/nodes/{className}
Weaviate Get Node Status By Collection
nodes.get.class 3 params → 200401403404422500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are NodeShardStatus (10 properties), NodeStatus (8 properties), AsyncReplicationStatus (3 properties), BatchStats (2 properties). Each schema is shown below with its type and property counts.

NodesStatusResponse
object
The status of all of the Weaviate nodes
1 property
NodeStats
object
The summary of Weaviate's statistics.
2 properties
NodeStatus
object
The definition of a backup node status response body
8 properties
BatchStats
object
The summary of a nodes batch queue congestion status.
2 properties
NodeShardStatus
object
The definition of a node shard status response body
10 properties
ErrorResponse
object
An error response returned by Weaviate endpoints.
1 property
AsyncReplicationStatus
object
The status of the async replication.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weaviate-nodes-api-openapi.yml Raw ↑

Other APIs Weaviate publishes across the network.

Weaviate authz API
Weaviate backups API
Weaviate batch API
Weaviate classifications API
Weaviate cluster API
Weaviate discovery API
Weaviate distributedTasks API
Weaviate export API
Weaviate graphql API
Weaviate mcp API
Weaviate meta API
Weaviate namespaces API