API Reference / API Methods / Rules / 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 # A

Delete a specific Rule using its id.

Examples # A

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 # A

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.

requestOptions #
type: key/value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the request.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

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?
PHP v3