crawler

Retrieve crawler details

Changed on

Retrieves details about the specified crawler, optionally with its configuration.

get/1/crawlers/{id}

Request

  • Base URL
    https://crawler.algolia.com/api
  • URL
    https://crawler.algolia.com/api/1/crawlers/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

Universally unique identifier (UUID) of the crawler.

Example:e0f6db8a-24f5-4092-83a4-1b2c6cb6d809

Crawler ID.

Query parameters

withConfigboolean

Whether the response should include the crawler's configuration.

Response

OK

OR

Example response

{
  "name": "test-crawler",
  "createdAt": "2023-07-04T12:49:15Z",
  "updatedAt": "2023-07-04T12:49:15Z",
  "blockingError": "Error: Failed to fetch external data for source 'testCSV': 404\n",
  "lastReindexStartAt": "2024-04-07T09:16:04Z"
}

Changes

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status