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, Hash opts = {
  Boolean forwardToReplicas: false
})

index.deleteRule(string objectID, {
  // All the following parameters are optional
  forwardToReplicas: boolean,
  // any other requestOptions
})

index.delete_rule(str objectID, {
    // All the following parameters are optional
    'forwardToReplicas': bool
})

index.deleteRule(
  withID objectID: ObjectID,
  forwardToReplicas: Bool? = nil,
  requestOptions: RequestOptions? = nil,
  completion: Result<WaitableWrapper<IndexRevision>> -> Void
)

suspend fun Index.deleteRule(
    objectID: ObjectID,
    forwardToReplicas: Boolean? = null,
    requestOptions: RequestOptions? = null
): RevisionIndex

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

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

Delete a rule by its objectID.

To find the objectID for rules, use the searchRules method.

objectID isn’t a reference to an Algolia record: it’s the unique identifier for a Rules object.

Examples

Read the Algolia CLI documentation for more information.

Copy

1
$index->deleteRule('ruleID', ['forwardToReplicas' => true]);

1
2
3
4
5
6
index.deleteRule(withID: "ruleID",
                 forwardToReplicas: true) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Parameters

Parameter	Description
`objectID`	type: string Required Unique identifier of a Rule object.
`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

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

Copy

          {
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}

        

Field	Description
`updatedAt`	string Date at which the delete Rule job has been created.
`taskID`	integer The taskID used with the waitTask method.