List crawlers

Lists all your crawlers.

GET /1/crawlers

List crawlers

cURL

curl --request GET \
  --url https://crawler.algolia.com/api/1/crawlers \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "items": [
    {
      "id": "e0f6db8a-24f5-4092-83a4-1b2c6cb6d809",
      "name": "test-crawler"
    }
  ],
  "itemsPerPage": 20,
  "page": 1,
  "total": 100
}

Required ACL: settings

Authorizations

Authorization · string · header · required

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

Query Parameters

appID · string

Algolia application ID for filtering the API response. Algolia application ID where the crawler creates and updates indices.

itemsPerPage · integer · default: 20

Number of items per page to retrieve. Number of items per page of the paginated API response.

Required range: 1 <= x <= 100

name · string

Name of the crawler for filtering the API response. Name of the crawler.

Maximum string length: 64

Example:

"test-crawler"

page · integer · default: 1

Page to retrieve. Current page of the paginated API response.

Required range: 1 <= x <= 100

Response

200

application/json

OK

Pagination information.

items · crawlerResponse · object[]

Crawlers.

Show child attributes

itemsPerPage · integer · default: 20

Number of items per page of the paginated API response.

Required range: 1 <= x <= 100

page · integer · default: 1

Current page of the paginated API response.

Required range: 1 <= x <= 100

total · integer

Total number of retrievable items.

Example:

100