replication

Initiate a replica movement

Begins an asynchronous operation to move or copy a specific shard replica from its current node to a designated target node. The operation involves copying data, synchronizing, and potentially decommissioning the source replica.

post/replication/replicate

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/replication/replicate
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Request body

sourceNodestring required

The name of the Weaviate node currently hosting the shard replica that needs to be moved or copied.

targetNodestring required

The name of the Weaviate node where the new shard replica will be created as part of the movement or copy operation.

collectionstring required

The name of the collection to which the target shard belongs.

shardstring required

The name of the shard whose replica is to be moved or copied.

type'COPY' | 'MOVE'

Specifies the type of replication operation to perform. COPY creates a new replica on the target node while keeping the source replica. MOVE creates a new replica on the target node and then removes the source replica upon successful completion. Defaults to COPY if omitted.

Response

Replication operation registered successfully. ID of the operation is returned.

idstring uuid required

The unique identifier (ID) assigned to the registered replication operation.

Changes

No recorded changes to this operation across all 1 revision of this API.