Api clients
/
JavaScript
/
V3
/
Methods
Jan. 22, 2021
Delete Rule | JavaScript API Client V3 (Deprecated)
This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.
Required API Key: any key with the
editSettings ACL
Method signature
index.deleteRule( string objectID, { forwardToReplicas: boolean }, callback )
About this method
Delete a specific Rule using its id.
Examples
Copy
Copy
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. |
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
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. |
