Skip to main content
Required ACL: settings The list contains the name and details of conditions and consequences for all rules for the selected index. To export rules, you will need to use an iterator.

Examples

var rulesIterator = index.BrowseRules();

foreach (var rule in rulesIterator)
{
    Console.WriteLine(rule);
}
it, err := index.BrowseRules()
if err != nil {
	panic(err)
}

for {
	rule, err := it.Next()
	if err != nil {
		if err == io.EOF {
			break
		}
	}

	fmt.Printf("%#v\n", *rule)
}
List<Rule> rules = new ArrayList();
RulesIterable sourceRules = index.browseRules();
sourceRules.forEach(rules::add);
index
  .browseRules({
    batch: (batch) => console.log(batch),
  })
  .then(() => {
    // done
  });
index.browseRules().forEach {
    println(it)
}
$iterator = $index->browseRules();

foreach ($iterator as $rule) {
  var_dump($rule);
}
for rule in index.browse_rules():
    print(rule)
rules = index.browse_rules
val helper = AlgoliaSyncHelper(client)
helper.exportRules("myIndex").map(println)
index.browseRules { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Parameters

indexName
string
Index name. Only required in the Scala API client.
requestOptions
object
A mapping of request options to send along with the query.

Response

This method returns an iterator.
Last modified on March 11, 2026