blob: 2d4691df8465a44342b1cb3f0d61720329a89d9d [file] [log] [blame]
{
"documentation": "https://lucene.apache.org/solr/guide/replica-management.html#deletereplica",
"description": "Deletes a replica. If the responding node is up, the core is unloaded, the entry removed from clusterstate.json, and the instanceDir and dataDir removed. If the node is not up, the entry for the replica is removed from clusterstate.json; if the nodes comes up later, the replica is automatically de-registered.",
"methods": [
"DELETE"
],
"url": {
"paths": [
"/collections/{collection}/shards/{shard}/{replica}",
"/c/{collection}/shards/{shard}/{replica}"
],
"params": {
"onlyIfDown": {
"type": "boolean",
"default": "false",
"description": "When set to 'true', no action will be taken if the replica is active."
},
"deleteIndex": {
"type": "boolean",
"default": "true",
"description": "By default Solr will delete the index of the replica that is deleted. Set this to false to prevent the index directory from being deleted."
},
"deleteDataDir": {
"type": "boolean",
"default": "true",
"description": "By default Solr will delete the dataDir of the replica that is deleted. Set this to false to prevent the data directory from being deleted."
},
"deleteInstanceDir": {
"type": "boolean",
"default": "true",
"description": "By default Solr will delete the entire instanceDir of the replica that is deleted. Set this to false to prevent the instance directory from being deleted."
},
"async":{
"type":"string",
"description":"Defines a request ID that can be used to track this action after it's submitted. The action will be processed asynchronously when this is defined."
}
}
}
}