Tools / Crawler / APIs / Configuration

Crawler: InitialIndexSettings

Type: object
Parameter syntax
initialIndexSettings: {
   yourIndexName: {
     yourIndexSettings...
   }
}

About this parameter

Crawler index settings.

Provide index names as keys in the key-value pairings. The values are objects that specify Algolia index settings such as searchableAttributes attributesForFaceting.

These index settings are only applied during the first crawl of an index. After this, these settings won’t be re-applied. This prevents you from overriding changes you made, for example, in the Algolia dashboard.

Examples

1
2
3
4
5
6
7
8
9
10
{
  initialIndexSettings: {
    myIndexName: {
      searchableAttributes: ['title'],
    },
    mySecondIndexName: {
      searchableAttributes: ['title'],
    }
  }
}

Parameters

settings

A list of indexName to index setting pairings.

settings ➔ setting

setting

indexName to index settings key-value pairs.

Did you find this page helpful?