Skip to main content
GET
/
1
/
crawlers
/
{id}
Retrieve crawler details
curl --request GET \
  --url https://crawler.algolia.com/api/1/crawlers/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "name": "test-crawler",
  "createdAt": "2023-07-04T12:49:15Z",
  "updatedAt": "2023-07-04T12:49:15Z",
  "running": true,
  "reindexing": true,
  "blocked": true,
  "lastReindexStartAt": "2024-04-07T09:16:04Z",
  "lastReindexEndedAt": "<string>",
  "blockingError": "Error: Failed to fetch external data for source 'testCSV': 404\n",
  "blockingTaskId": "<string>"
}
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.

Path Parameters

​
id
string
required

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

Example:

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

Query Parameters

​
withConfig
boolean

Whether the response should include the crawler's configuration.

Response

OK

  • Without configuration
  • With configuration
​
name
string
required

Name of the crawler.

Maximum string length: 64
Example:

"test-crawler"

​
createdAt
string
required

Date and time when the object was created, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"

​
updatedAt
string
required

Date and time when the object was updated, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"

​
running
boolean
required

Whether this crawler is active.

​
reindexing
boolean
required

Whether this crawler is completely reindexing your content.

​
blocked
boolean
required

Whether this crawler is currently blocked.

If true, you can unblock it from the Crawler page in the Algolia dashboard or by cancelling the blocking task.

​
lastReindexStartAt
string | null
required

Date and time when the last crawl started, in RFC 3339 format.

Example:

"2024-04-07T09:16:04Z"

​
lastReindexEndedAt
string | null
required

Date and time when the last crawl finished, in RFC 3339 format.

​
blockingError
string

Reason why the crawler is blocked.

Example:

"Error: Failed to fetch external data for source 'testCSV': 404\n"

​
blockingTaskId
string

ID of the task that's blocking the crawler.