v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

Sites

List sites

Get list of all sites and their details for given user, can be filtered by domain.

get/v1/sites

domainstring

search string to match the domain by

Example:rocket

searchstring

Search for a site by its domain, label, or ID

Example:rocket

pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page (default = 10)

sort'created_at' | 'domain' | 'label' | 'disk_usage'

direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

successboolean

whether the request succeeded

errorsstring[]

messagesstring[] nullable

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  }
}