API Reference / API Methods / Query rules / Export rules
Feb. 26, 2019

Export rules

Required API Key: any key with the settings ACL
Method signature
$index->browseRules()

About this method

Retrieve an index’s full list of rules using an iterator.

The list contains the rule name, plus the complete details of its conditions and consequences.

The list includes all rules, whether created on the dashboard or pushed by the API.

To export rules, you will need to use an iterator.

Examples

1
2
3
4
5
$iterator = $index->browseRules();

foreach ($iterator as $rule) {
  var_dump($rule);
}

Parameters

indexName
type: string
only needed in go, scala, c#

Index name.

Response

Returns a rule iterator.

Did you find this page helpful?