Domains

List all domains

Changed on
get/domains

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/domains
  • Auth: HTTP bearer

Query parameters

pageinteger nullable

Page number (1-indexed)

page_sizeinteger nullable

Number of items per page (max 100)

searchstring nullable

Search domains by name (substring match)

sort_by'created_at' | 'domain' | 'status' | 'expiration'

Allowlisted sort columns for the paginated domain collection.

Sort column (defaults to created_at)

sort_order'asc' | 'desc'

Sort direction (defaults to desc). Unknown expiration dates always sort last.

Response

Domains retrieved successfully

pageinteger required
page_sizeinteger required
totalinteger required

Changes

  • 4b228ebed583Revision changes
    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_order

  • 1dc3e6788214Revision changes
    • warning

      deleted the query request parameter sort_by

    • warning

      deleted the query request parameter sort_order