Get available domains

Gets available domains along with their collection status

GET /api/v2/available-domains

Error

A valid request URL is required to generate request examples

200

{
  "data": [
    {
      "type": "<string>",
      "name": "<string>",
      "id": "<string>",
      "collected": true
    }
  ]
}

Authorizations

Authorization · string · header · required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer · integer · default: 0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x >= 0

Query Parameters

sort_by · string

Sortable columns are objectid, name. Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

objectid · string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

name · string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

collected · string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Response

200

application/json

OK

data · object[]

Show child attributes