Skip to main content
PATCH
/
1
/
crawlers
/
{id}
Replace crawler configuration
curl --request PATCH \
  --url https://crawler.algolia.com/api/1/crawlers/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "test-crawler"
}
'
{
  "taskId": "98458796-b7bb-4703-8b1b-785c1080b110"
}
Required ACL: editSettings See also: Update configuration

Authorizations

ā€‹
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

ā€‹
id
string
required

Crawler ID. Universally unique identifier (UUID) of the crawler.

Example:

"e0f6db8a-24f5-4092-83a4-1b2c6cb6d809"

Body

application/json
ā€‹
name
string

Name of the crawler.

Maximum string length: 64
Example:

"test-crawler"

ā€‹
config
object

Crawler configuration.

Response

OK

ā€‹
taskId
string
required

Universally unique identifier (UUID) of the task.

Example:

"98458796-b7bb-4703-8b1b-785c1080b110"

Last modified on February 20, 2026