replication

Force delete replication operations

USE AT OWN RISK! Synchronously force delete operations from the FSM. This will not perform any checks on which state the operation is in so may lead to data corruption or loss. It is recommended to first scale the number of replication engine workers to 0 before calling this endpoint to ensure no operations are in-flight.

post/replication/replicate/force-delete

Request

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

Request body

idstring uuid

The unique identifier (ID) of the replication operation to be forcefully deleted.

collectionstring

The name of the collection to which the shard being replicated belongs.

shardstring

The identifier of the shard involved in the replication operations.

nodestring

The name of the target node where the replication operations are registered.

dryRunboolean

If true, the operation will not actually delete anything but will return the expected outcome of the deletion.

Response

Replication operations force deleted successfully.

deletedstring[]

The unique identifiers (IDs) of the replication operations that were forcefully deleted.

dryRunboolean

Indicates whether the operation was a dry run (true) or an actual deletion (false).

Changes

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