Tools
/
Crawler
/
apiKey
Jan. 08, 2021
apiKey
Type:
string
Required
Parameter syntax
apiKey: 'your_api_key'
About this parameter
API key for your targeted application.
Using the Admin API key is not allowed, and it must:
- Have the following rights:
search
,addObject
,deleteObject
,deleteIndex
,settings
,editSettings
,listIndexes
,browse
- Have access to the correct set of indices, according to the
indexPrefix
(e.g. have access tocrawler_*
if the indexPrefix iscrawler_
)
This key will be generated for you by the Admin Console when you create a configuration if you don’t provide one yourself.
Examples
Copy
1
2
3
{
apiKey: '33758f9a4be7766e94bf8800aad345900',
}