Sign in
Websites

List websites

Changed on

Lists all websites owned by the current user.

Returns paginated list of website configurations with status, domain, and target information. Supports filtering by status and other criteria.

See also:.*

get/api/websites

Request

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

Query parameters

_endinteger

Ending index of the items to return (exclusive). Defaults to 10.

_orderstring

Comma-separated list of sort orders ('asc' or 'desc') corresponding to _sort fields. Defaults to 'asc'.

_sortstring

Comma-separated list of fields to sort by. Available fields: target_type, status

_startinteger

Starting index of the items to return (0-based). Defaults to 0.

domain_containsstring

Filter by domain contains

domain_endswithstring

Filter by domain endswith

domain_eqstring

Filter by domain eq

domain_nestring

Filter by domain ne

domain_startswithstring

Filter by domain startswith

filters[domain][contains]string

Filter by domain contains

filters[domain][endswith]string

Filter by domain endswith

filters[domain][eq]string

Filter by domain eq

filters[domain][ne]string

Filter by domain ne

filters[domain][startswith]string

Filter by domain startswith

filters[status][contains]string

Filter by status contains

filters[status][endswith]string

Filter by status endswith

filters[status][eq]string

Filter by status eq

filters[status][ne]string

Filter by status ne

filters[status][startswith]string

Filter by status startswith

filters[target_type][contains]string

Filter by target_type contains

filters[target_type][endswith]string

Filter by target_type endswith

filters[target_type][eq]string

Filter by target_type eq

filters[target_type][ne]string

Filter by target_type ne

filters[target_type][startswith]string

Filter by target_type startswith

status_containsstring

Filter by status contains

status_endswithstring

Filter by status endswith

status_eqstring

Filter by status eq

status_nestring

Filter by status ne

status_startswithstring

Filter by status startswith

target_type_containsstring

Filter by target_type contains

target_type_endswithstring

Filter by target_type endswith

target_type_eqstring

Filter by target_type eq

target_type_nestring

Filter by target_type ne

target_type_startswithstring

Filter by target_type startswith

Response

List of websites

totalinteger required

Changes

  • 06e0fa4f446eRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      added the new failed enum value to the /// response property for the response status

    • warning

      added the new issuing enum value to the /// response property for the response status

    • warning

      added the new pending enum value to the /// response property for the response status

    • warning

      added the new ready enum value to the /// response property for the response status

    • info

      added the new optional query request parameter _end

    • info

      added the new optional query request parameter _order

    • info

      added the new optional query request parameter _sort

    • info

      added the new optional query request parameter _start

    • info

      added the new optional query request parameter domain_contains

    • info

      added the new optional query request parameter domain_endswith

    • info

      added the new optional query request parameter domain_eq

    • info

      added the new optional query request parameter domain_ne

    • info

      added the new optional query request parameter domain_startswith

    • info

      added the new optional query request parameter filters[domain][contains]

    • info

      added the new optional query request parameter filters[domain][endswith]

    • info

      added the new optional query request parameter filters[domain][eq]

    • info

      added the new optional query request parameter filters[domain][ne]

    • info

      added the new optional query request parameter filters[domain][startswith]

    • info

      added the new optional query request parameter filters[status][contains]

    • info

      added the new optional query request parameter filters[status][endswith]

    • info

      added the new optional query request parameter filters[status][eq]

    • info

      added the new optional query request parameter filters[status][ne]

    • info

      added the new optional query request parameter filters[status][startswith]

    • info

      added the new optional query request parameter filters[target_type][contains]

    • info

      added the new optional query request parameter filters[target_type][endswith]

    • info

      added the new optional query request parameter filters[target_type][eq]

    • info

      added the new optional query request parameter filters[target_type][ne]

    • info

      added the new optional query request parameter filters[target_type][startswith]

    • info

      added the new optional query request parameter status_contains

    • info

      added the new optional query request parameter status_endswith

    • info

      added the new optional query request parameter status_eq

    • info

      added the new optional query request parameter status_ne

    • info

      added the new optional query request parameter status_startswith

    • info

      added the new optional query request parameter target_type_contains

    • info

      added the new optional query request parameter target_type_endswith

    • info

      added the new optional query request parameter target_type_eq

    • info

      added the new optional query request parameter target_type_ne

    • info

      added the new optional query request parameter target_type_startswith

    • info

      added the non-success response with the status

    • info

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

  • b97dd0465ab3Revision changes
    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status