API Reference / API Methods / Query rules / Clear rules

Feb. 26, 2019

Clear Rules

Required API Key: any key with the editSettings ACL

Method signature

$index->clearRules([
  // All the following parameters are optional
  'forwardToReplicas' => boolean
])

index.clear_rules(Boolean forwardToReplicas)

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

index.clear_rules({
    // All the following parameters are optional
    'forwardToReplicas': bool
})

This method is not available in mobile API clients.

Query Rules need to be configured via
the Algolia Dashboard or with one of our backend API clients.

suspend fun Index.clearRules(
    forwardToReplicas: Boolean? = null,
    requestOptions: RequestOptions? = null
): RevisionIndex

This method is not available in mobile API clients.

Query Rules need to be configured via
the Algolia Dashboard or with one of our backend API clients.

index.ClearRules(
  forwardToReplicas: bool
)

index.clearRules(bool forwardToReplicas)

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

clear rules of index "indexName"
clear rules of index "indexName" and forwardToReplicas

See code examples

About this method

Delete all rules in an index.

Examples

Copy

// Delete all rules in the index.
$index->clearRules();

// Delete all rules in the index and all its replicas.
$index->clearRules(['forwardToReplicas' => true]);

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)

// 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);
});

Parameters


            forwardToReplicas

type: boolean

default: false

Optional

Whether to forward the operation to the replica indices.

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

Copy
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}

`updatedAt`	string Date at which the delete rule job has been created.
`taskID`	integer The taskID used with the waitTask method.

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Clear Rules

About this method

Examples

Parameters

Response

JSON format

Did you find this page helpful?

On this page