Tools / Crawler / APIs / Configuration
Type: string
Parameter syntax
apiKey: 'your_api_key'

About this parameter

API key for your targeted application.

If you don’t provide an API key yourself, one will be generated by the Crawler Admin interface when you create a configuration.

The API key must have:

  • The following permissions: search, addObject, deleteObject, deleteIndex, settings, editSettings, listIndexes, browse
  • Access to the correct set of indices, based on indexPrefix. For example, if the prefix is crawler_, the API key must have access to crawler_*)

You may not use your Admin API key.


  apiKey: '33758f9a4be7766e94bf8800aad345900',
Did you find this page helpful?