Skip to main content
This page documents an earlier version of the API client. For the latest version, see Delete a rule.
Required ACL: editSettings To find the objectID for rules, use the searchRules method.

​
Examples

index.DeleteRule("ruleID", forwardToReplicas: true);

// Asynchronous
await index.DeleteRuleAsync("ruleID", forwardToReplicas: true);

​
Parameters

​
objectID
string
required
Unique identifier of a rule object.
​
forwardToReplicas
boolean
Whether to delete the rule also from all replica indices.
​
requestOptions
object
A mapping of request options to send along with the request.

​
Response

​
taskID
integer
The task ID used with the waitTask method.
​
updatedAt
string
Date at which the delete Rule job has been created.

​
Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.
JSON
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
⌘I