Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Domains

List additional domains (aliases) for the site

Get additional domains for given site

get/v1/sites/{id}/domains

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

searchstring

Search for a domain by its name

Example:reallyawesomewebsite.co.uk
pageinteger

Page of results to include

per_pageinteger

How many results to include in each page

sort'domain' | 'domain_type' | 'hostname_status' | 'ssl_status' | 'validation_method'
Example:ssl_status

property to sort the results by

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

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

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": {
    "additional_domains": [
      {
        "id": 1,
        "base_domain": "domain.tld",
        "custom_ssl": {
          "id": "1634ccc1-14a2-46b6-b886-95bdcc2efdab",
          "site_id": 12345,
          "serial_number": "398afaa14450d29e7a0905519a3e94cd0",
          "fingerprint": "1661186b8e38e79f434e4549a2d53f84716cfff7c45d334bbc67c9d41d1e3be6",
          "issuer": "LetsEncrypt",
          "uploaded_on": "2026-01-07 18:31:22",
          "issued_on": "2026-01-05 20:49:35",
          "expires_on": "2026-03-06 20:49:35",
          "domains": [
            "custom-ssl.com",
            "www.custom-ssl.com",
            "subdomain.custom-ssl.com"
          ]
        },
        "certificate_authority": "google",
        "display_domain": "sub.domain.tld",
        "domain": "sub.domain.tld",
        "domain_id": 1,
        "dns_provider": "namecheap",
        "sub_domain": "sub",
        "validation_records": [
          {
            "name": "_acme-challenge.thebestreallylongdomainname.com",
            "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
          }
        ]
      }
    ]
  }
}