Clear Rules

Required API Key: any key with the editSettings ACL

Method signature

$index->clearRules([
  // All the following parameters are optional
  'forwardToReplicas' => boolean
])

index.clear_rules(Hash opts = {
  Boolean forwardToReplicas: false
})

index.clearRules({ forwardToReplicas: boolean })

index.clear_rules({
    // All the following parameters are optional
    'forwardToReplicas': bool
})

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

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

index.ClearRules(
  forwardToReplicas: bool
)

index.clearRules(bool forwardToReplicas)

index.ClearRules(opt.ForwardToReplicas(bool forwardToReplicas))

clear rules of index "indexName"
clear rules of index "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 all Rules in an index.

Examples

Read the Algolia CLI documentation for more information.

Copy

1
2
3
4
5
// Delete all rules in the index.
$index->clearRules();

// Delete all rules in the index and all its replicas.
$index->clearRules(['forwardToReplicas' => true]);

1
2
3
4
5
6
7
8
# Delete all rules in the index.
index.clear_rules

# Delete all rules in the index and wait the end of indexing.
index.clear_rules!

# Delete all rules in the index and all its replicas.
index.clear_rules({ forwardToReplicas: true })

1
2
3
4
5
6
7
8
9
// Delete all rules in the index.
index.clearRules().then(() => {
  // done
});

// Delete all rules in the index and all its replicas.
index.clearRules({ forwardToReplicas: true }).then(() => {
  // done
});

1
2
3
4
5
6
7
8
9
10
11
12
13
// Delete all rules in the index.
index.clearRules { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

// Delete all rules in the index and all its replicas.
index.clearRules(forwardToReplicas: true) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Parameters

Parameter	Description
`forwardToReplicas`	type: boolean default: false Optional Whether to forward the operation to the replica indices.

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.