API Reference / API Methods / Rules / Export Rules

Export Rules

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

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

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.

requestOptions
type: key/value mapping
default: No request options
Optional

A mapping of request options to send along with the query.

Response

Returns a Rule iterator.

Did you find this page helpful?