API Reference / API Methods / Rules / Clear Rules
Required API Key: any key with the editSettings ACL
Method signature
$index->clearRules([
  // All the following parameters are optional
  'forwardToReplicas' => boolean
])

About this method # A

Delete all Rules in an index.

Examples # A

1
2
3
4
5
// Delete all rules in the index.
$index->clearRules();

// Delete all rules in the index and all its replicas.
$index->clearRules(['forwardToReplicas' => true]);

Parameters # A

forwardToReplicas #
type: boolean
default: false
Optional

Whether to forward the operation to the replica indices.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format#

1
2
3
4
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
updatedAt #
string

Date at which the delete Rule job has been created.

taskID #
integer

The taskID used with the waitTask method.

Did you find this page helpful?
PHP v3