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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Weaviate

Weaviate replication API

The replication API from Weaviate — 7 operation(s) for replication.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 10 operations across 7 paths, and defines 13 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.

10 operations 7 paths 13 schemas 2 DELETE4 GET4 POST

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 replication 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 10

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

replication 10
POST
/replication/replicate
Weaviate Initiate A Replica Movement
replicate body → 200400401403422500501
DELETE
/replication/replicate
Weaviate Delete All Replication Operations
deleteAllReplications → 204400401403422500501
POST
/replication/replicate/force-delete
Weaviate Force Delete Replication Operations
forceDeleteReplications body → 200400401403422500
GET
/replication/replicate/{id}
Weaviate Retrieve A Replication Operation
replicationDetails 2 params → 200401403404422500501
DELETE
/replication/replicate/{id}
Weaviate Delete A Replication Operation
deleteReplication 1 param → 204401403404409422500501
GET
/replication/replicate/list
Weaviate List Replication Operations
listReplication 4 params → 200400401403500501
POST
/replication/replicate/{id}/cancel
Weaviate Cancel A Replication Operation
cancelReplication 1 param → 204401403404409422500501
GET
/replication/sharding-state
Weaviate Get Sharding State
getCollectionShardingState 2 params → 200400401403404500501
GET
/replication/scale
Weaviate Get Replication Scale Plan
getReplicationScalePlan 2 params → 200400401403404500501
POST
/replication/scale
Weaviate Apply Replication Scaling Plan
applyReplicationScalePlan body → 200400401403404500501

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ReplicationReplicateDetailsReplicaResponse (12 properties), ReplicationReplicateForceDeleteRequest (5 properties), ReplicationReplicateReplicaRequest (5 properties), ReplicationScalePlan (3 properties). Each schema is shown below with its type and property counts.

ReplicationReplicateForceDeleteResponse
object
Provides the UUIDs that were successfully force deleted as part of the replication operation. If dryRun is true, this will return the expected outcome without…
2 properties
ReplicationShardingState
object
Details the sharding layout for a specific collection, mapping each shard to its set of replicas across the cluster.
2 properties
ReplicationReplicateReplicaResponse
object
Contains the unique identifier for a successfully initiated asynchronous replica movement operation. This ID can be used to track the progress of the operation.
1 property 1 required
ReplicationShardingStateResponse
object
Provides the detailed sharding state for one or more collections, including the distribution of shards and their replicas across the cluster nodes.
1 property
ReplicationReplicateForceDeleteRequest
object
Specifies the parameters available when force deleting replication operations.
5 properties
ReplicationReplicateReplicaRequest
object
Specifies the parameters required to initiate a shard replica movement operation between two nodes for a given collection and shard. This request defines the s…
5 properties 4 required
ErrorResponse
object
An error response returned by Weaviate endpoints.
1 property
ReplicationReplicateDetailsReplicaStatusError
object
Represents an error encountered during a replication operation, including its timestamp and a human-readable message.
2 properties
ReplicationReplicateDetailsReplicaStatus
object
Represents the current or historical status of a shard replica involved in a replication operation, including its operational state and any associated errors.
3 properties
ReplicationReplicateDetailsReplicaResponse
object
Provides a comprehensive overview of a specific replication operation, detailing its unique ID, the involved collection, shard, source and target nodes, transf…
12 properties 7 required
ReplicationScalePlan
object
Defines a complete plan for scaling replication within a collection. Each shard entry specifies nodes to remove and nodes to add. Added nodes may either be ini…
3 properties 3 required
ReplicationShardReplicas
object
Represents a shard and lists the nodes that currently host its replicas.
2 properties
ReplicationScaleApplyResponse
object
Response for the POST /replication/scale endpoint containing the list of initiated shard copy operation IDs.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weaviate-replication-api-openapi.yml Raw ↑

Other APIs Weaviate publishes across the network.

Weaviate authz API
AE Profile APIs.io
Weaviate backups API
AE Profile APIs.io
Weaviate batch API
AE Profile APIs.io
Weaviate classifications API
AE Profile APIs.io
Weaviate cluster API
AE Profile APIs.io
Weaviate discovery API
AE Profile APIs.io
Weaviate distributedTasks API
AE Profile APIs.io
Weaviate export API
AE Profile APIs.io
Weaviate graphql API
AE Profile APIs.io
Weaviate mcp API
AE Profile APIs.io
Weaviate meta API
AE Profile APIs.io
Weaviate namespaces API
AE Profile APIs.io
#replication
← Back to W APIs
API Details
ID
weaviate:weaviate-replication-api
Server
http://localhost:8080
Docs
https://weaviate.io/developers/weaviate/api/rest
Provider
Weaviate
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network