Skip to main content
This page documents an earlier version of the API client. For the latest version, see Create or update rules.
Required ACL: editSettings Each rule is created or updated, depending on whether a rule with the same objectID already exists.

​
Examples

List<Rule> rules;
index.SaveRules(rules, forwardToReplicas: true, clearExistingRules: false);

// Asynchronous
await index.SaveRulesAsync(rules, forwardToReplicas: true, clearExistingRules: false);

​
Parameters

​
rules
rule[]
required
See the rule parameter of the saveRule method.
​
clearExistingRules
boolean
default:false
Whether to delete all existing rules before adding new ones.
​
forwardToReplicas
boolean
default:false
Whether to forward the changes to the 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 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