API Reference / API Methods / Query rules / Delete rule

Feb. 26, 2019

Delete Rule

Required API Key: any key with the editSettings ACL

Method signature

$index->deleteRule(string objectID, [
  // All the following parameters are optional
  'forwardToReplicas' => boolean
])

index.delete_rule(String objectID, Boolean forwardToReplicas)

index.deleteRule(
  string objectID,
  {
    forwardToReplicas: boolean
  },
  callback
)

index.delete_rule(str objectID, {
    // 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.deleteRule(
    objectID: ObjectID,
    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.DeleteRule(
  String objectID,

  // All the following parameters are optional
  forwardToReplicas: bool
)

index.deleteRule(String objectID, bool forwardToReplicas)

index.DeleteRule(string objectID, opt.ForwardToReplicas(bool forwardToReplicas))

delete rule objectID from "indexName" and forwardToReplicas

See code examples

About this method

Delete a specific rule using its id.

Examples

Copy

// Delete a rule from the index.
$index->deleteRule('a-rule-id');

// Delete a rule from the index and all its replicas.
$index->deleteRule('a-rule-id', ['forwardToReplicas' => true]);

forward_to_replicas = true

# Delete a rule from the index.
index.delete_rule('a-rule-id')
# Delete a rule from the index and wait the end of indexing.
index.delete_rule!('a-rule-id')
# Delete a rule from the index and all its replicas.
index.delete_rule('a-rule-id', forward_to_replicas)

// Delete a rule from the index.
index.deleteRule('a-rule-id', (err, content) => {
  if (err) throw err;

  console.log(content);
});

// Delete a rule from the index and all its replicas.
index.deleteRule('a-rule-id', {forwardToReplicas: true}, (err, content) => {
  if (err) throw err;

  console.log(content);
});

# Delete a rule from the index.
index.delete_rule('a-rule-id')

# Delete a rule from the index and all its replicas.
index.delete_rule('a-rule-id', {'forwardToReplicas': True})

boolean forwardToReplicas = false;

index.deleteRule("a-unique-identifier", forwardToReplicas);

// Async version
index.deleteRuleAsync("a-unique-identifier", forwardToReplicas);

Parameters

`objectID`	type: string Required The ID of the rule to delete
`forwardToReplicas`	type: boolean default: Optional By default, this method applies only to the specified index. By making this true, the method will also send the rule to all replicas.

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

Delete Rule

About this method

Examples

Parameters

Response

JSON format

Did you find this page helpful?

On this page