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
])

About this method

Delete a specific rule using its id.

Examples

1
2
3
4
5
// 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]);

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. Thus, if you want to forward your rule to replicas you will need to specify that.

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

1
2
3
4
{
  "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.

Did you find this page helpful?