Skip to main content
This page documents an earlier version of the API client. For the latest version, see Retrieve index settings.
Required ACL: settings For an overview over the available settings, see Index settings.
The response only includes values for settings that aren’t null.

​
Examples

​
Retrieve settings for an index

IndexSettings settings = index.GetSettings();

// Asynchronous
IndexSettings settings = await index.GetSettingsAsync();

​
Parameters

​
requestOptions
object
A mapping of request options to send along with the request.

​
Response

​
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. This response example contains a non-exhaustive list of index settings that can be returned.
JSON
{
  "minWordSizefor1Typo": 4,
  "minWordSizefor2Typos": 8,
  "hitsPerPage": 20,
  "maxValuesPerFacet": 100,
  "searchableAttributes": [
    "title",
    "description",
    "author_name"
  ],
  "numericAttributesToIndex": null,
  "attributesToRetrieve": null,
  "unretrievableAttributes": null,
  "optionalWords": null,
  "attributesForFaceting": null,
  "attributesToSnippet": null,
  "attributesToHighlight": null,
  "paginationLimitedTo": 1000,
  "attributeForDistinct": null,
  "exactOnSingleWordQuery": "attribute",
  "ranking": [
    "typo",
    "geo",
    "words",
    "filters",
    "proximity",
    "attribute",
    "exact",
    "custom"
  ],
  "customRanking": null,
  "separatorsToIndex": "",
  "removeWordsIfNoResults": "none",
  "queryType": "prefixLast",
  "highlightPreTag": "<em>",
  "highlightPostTag": "<\/em>",
  "alternativesAsExact": [
    "ignorePlurals",
    "singleWordSynonym"
  ]
}
⌘I