Clear Rules | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

index.clearRules({ forwardToReplicas: boolean }, callback)

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]);

1
2
3
4
5
6
7
8
forward_to_replicas = true

# Delete all rules in the index.
index.clear_rules
# Delete all rules in the index and wait the end of indexing.
index.clear_rules!
# Delete all rules in the index and all its replicas.
index.clear_rules(forward_to_replicas)

1
2
3
4
5
6
7
8
9
10
11
12
13
// Delete all rules in the index.
index.clearRules((err, content) => {
  if (err) throw err;

  console.log(content);
});

// Delete all rules in the index and all its replicas.
index.clearRules({forwardToReplicas: true}, (err, content) => {
  if (err) throw err;

  console.log(content);
});

1
2
3
4
# Delete all rules in the index.
index.clear_rules()
# Delete all rules in the index and all its replicas.
index.clear_rules({'forwardToReplicas': True})

1
2
3
4
index.ClearRules(forwardToReplicas: true);

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

1
2
3
4
5
6
boolean forwardToReplicas = true;

index.clearRules(forwardToReplicas);

// Async version
index.clearRulesAsync(forwardToReplicas);

1
2
forwardToReplicas := opt.ForwardToReplicas(true)
res, err := index.ClearRules(forwardToReplicas)

1
2
3
client.execute {
  clear rules of index "index_name" and forwardToReplicas
}

1
index.clearRules(forwardToReplicas = true)

Parameters

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
}