List registered domains

Lists registered domains.

GET /1/domains

List registered domains

cURL

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

200

{
  "itemsPerPage": 20,
  "page": 1,
  "total": 100,
  "items": [
    {
      "appId": "<string>",
      "domain": "wwww.algolia.com",
      "validated": true
    }
  ]
}

Crawlers will only run if the URLs match any of the registered domains.

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

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

page · integer · default: 1

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

Required range: 1 <= x <= 100

appID · string

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

Response

200

application/json

Domains

Pagination information.

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

items · domainResponse · object[]

Show child attributes