v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

Site Users

List all the site for user.

For a given user, list all sites user has access to.

get/v1/sites/users

Query parameters

domainstring

search string to match the domain by

Example:rocket

searchstring

search string to match either tha domain or label by

Example:best site

pageinteger

Page of results to include (default = 1)

per_pageinteger

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

statusstring[]

One or more statuses to filter by

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

Sort results by the following property

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

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

Response

successboolean

whether the request succeeded

errorsstring[]

messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "id": 8880000888,
      "domain": "some.domain.tld",
      "display_domain": "some.domain.tld",
      "rocket_url": "abcd.onrocket.com",
      "location": "NL - Amsterdam",
      "ftp_ip_address": "123.456.789.012",
      "sftp_username": "siteuser",
      "disk_usage": 100000000,
      "created_at": "2024-01-01T02:00:00Z",
      "staging": {
        "staging_id": 1234567890
      },
      "label": "some.domain.tld",
      "metadata": "{\"some\": \"metadata\"}"
    }
  ]
}