Replace crawler configuration

Replaces the crawler configuration with a new one.

PATCH /1/crawlers/{id}

Replace crawler configuration

cURL

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"
}
'

200

{
  "taskId": "98458796-b7bb-4703-8b1b-785c1080b110"
}

If you only want to change the crawler’s name, you can use this operation. For other configuration changes, use the “Update configuration” endpoint instead instead, because changes made here aren’t versioned.

When replacing the configuration, you must provide the full configuration, including any settings you want to keep.

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

config · object

Crawler configuration.

Show child attributes

name · string

Name of the crawler.

Maximum string length: 64

Example:

"test-crawler"

Response

200

application/json

OK

taskId · string · required

Universally unique identifier (UUID) of the task.

Example:

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