Weaviate Replication API

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

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /replication/replicate Move or copy a shard replica · Weaviate Initiate A Replica Movement #
Ask an LLM
“How do I move a shard replica from one node to another?”
“Can I copy a shard replica to a target node without removing the original?”
Tell an agent
Move replica of shard {shard} in {collection} from {sourceNode} to {targetNode}.
Copy shard {shard} of {collection} from {sourceNode} to {targetNode} as a {type} operation.
DELETE /replication/replicate Delete all replication operations · Weaviate Delete All Replication Operations #
Ask an LLM
“How do I clear every replication operation across all collections and nodes?”
“Can I wipe all pending shard replication tasks at once?”
Tell an agent destructive · confirm first
Delete all replication operations across the cluster.
Clear every pending shard copy and move task.
POST /replication/replicate/force-delete Force-delete a replication operation · Weaviate Force Delete Replication Operations #
Ask an LLM
“Can I force-delete a replication operation that is stuck in a bad state?”
“Is there a way to force-remove a replication task without checking its state?”
Tell an agent destructive · confirm first
Force-delete replication operation {id}.
Force-remove replication task {id} on shard {shard} in {collection} on node {node}.
GET /replication/replicate/{id} Get a replication operation's status · Weaviate Retrieve A Replication Operation #
Ask an LLM
“What is the current status of a shard replication operation?”
“Can I see the history of a replication task?”
Tell an agent
Show replication operation {id}.
Get details of replication task {id} including its history: {includeHistory}.
DELETE /replication/replicate/{id} Delete a replication operation · Weaviate Delete A Replication Operation #
Ask an LLM
“How do I remove a replication operation that is still active?”
“Will deleting a replication task clean up its resources?”
Tell an agent destructive · confirm first
Delete replication operation {id}.
Remove replication task {id} and clean up its resources.
GET /replication/replicate/list List replication operations · Weaviate List Replication Operations #
Ask an LLM
“Which replication operations are currently registered?”
“Can I list replication tasks for one shard or node?”
Tell an agent
List all replication operations.
List replication tasks for shard {shard} on node {targetNode}.
POST /replication/replicate/{id}/cancel Cancel an active replication operation · Weaviate Cancel A Replication Operation #
Ask an LLM
“How do I stop a shard replication that is in progress?”
“Can I cancel a replication task without deleting it?”
Tell an agent destructive · confirm first
Cancel replication operation {id}.
Stop the active replication task {id}.
GET /replication/sharding-state Get replica locations for a collection · Weaviate Get Sharding State #
Ask an LLM
“Where are the replicas of each shard in a collection located?”
“Can I check the sharding state of one shard?”
Tell an agent
Show the sharding state of {collection}.
Get replica locations for shard {shard} in {collection}.
GET /replication/scale Compute a replication scale plan for a collection · Weaviate Get Replication Scale Plan #
Ask an LLM
“How do I get the plan to add or remove nodes per shard for a collection?”
“What replication factor would I need to scale a collection to?”
Tell an agent
Get the replication scale plan for {collection} to replication factor {replicationFactor}.
Compute a plan to scale collection {collection} to {replicationFactor} replicas.
POST /replication/scale Apply a replication scale plan · Weaviate Apply Replication Scaling Plan #
Ask an LLM
“How do I apply the node addition and removal actions from a replication scale plan?”
“Can I scale a collection's shards by adding and removing nodes from the plan?”
Tell an agent
Apply replication scale plan {planId} to collection {collection}.
Execute plan {planId} on collection {collection} with shard actions {shardScaleActions}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/weaviate:weaviate-replication-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

weaviate-replication-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Weaviate REST Replication API
  description: '# Introduction

    Weaviate is an open source, AI-native vector database that helps developers create intuitive and reliable AI-powered applications.'
  version: 1.38.0-dev
servers:
- url: http://localhost:8080
  description: Local Weaviate instance
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://artifacts.apis.io/weaviate/openapi/weaviate-replication-api-openapi.yml