Api clients / Ruby / V1 / Methods

Clear Rules | Ruby API Client V1 (Deprecated)

Deprecated content
This documentation is for a deprecated version of Ruby API client . Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of Ruby API client for up-to-date information.
Required API Key: any key with the editSettings ACL
Method signature
index.clear_rules(Boolean forwardToReplicas)

About this method

Delete all Rules in an index.

Examples

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

forwardToReplicas
type: boolean
default: false
Optional

Whether to forward the operation to the replica indices.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

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?