This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

Required API Key: any key with the editSettings ACL

Method signature
index.ClearRules(opt.ForwardToReplicas(bool forwardToReplicas))

About this method # A

Delete all Rules in an index.

Examples # A

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

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. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format#

1
2
3
4
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
Field Description
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?
Go API clients v3