Clear rules

Delete all rules from an index.

This page documents an earlier version of the API client. For the latest version, see Delete all rules.

Required ACL: editSettings

Examples

C#

index.ClearRules(forwardToReplicas: true);

// Asynchronous
index.ClearRulesAsync(forwardToReplicas: true);

Parameters

forwardToReplicas · boolean · default: false

Whether to forward the operation to the replica indices.

Response

taskID · integer

The task ID used with the waitTask method.

updatedAt · string

Date at which the job has been created.

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}