v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Domains

Checks the status of the maindomain, any alternate maindomains, and additional domains

Checks the status of the maindomain, any alternate maindomains, and additional domains

get/v1/sites/{id}/maindomain/status

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "maindomain": {
      "hostname": "example.com",
      "validation_errors": [
        "The authority has rate limited these domains. Please wait for the rate limit to expire (17 Oct 25 21:18 UTC) or try another authority."
      ],
      "ssl_rate_limit": {
        "limited": true,
        "certificate_authority": "google",
        "expires_at": "2025-10-25T21:18:00Z"
      },
      "expected_dns_records": [
        {
          "name": "_acme-challenge.thebestreallylongdomainname.com",
          "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
        }
      ],
      "found_dns_records": [
        {
          "name": "_acme-challenge.thebestreallylongdomainname.com",
          "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
        }
      ],
      "records_to_remove": [
        {
          "name": "_acme-challenge.thebestreallylongdomainname.com",
          "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
        }
      ]
    },
    "alternate_maindomain": {
      "hostname": "example.com",
      "validation_errors": [
        "The authority has rate limited these domains. Please wait for the rate limit to expire (17 Oct 25 21:18 UTC) or try another authority."
      ],
      "ssl_rate_limit": {
        "limited": true,
        "certificate_authority": "google",
        "expires_at": "2025-10-25T21:18:00Z"
      },
      "expected_dns_records": [
        {
          "name": "_acme-challenge.thebestreallylongdomainname.com",
          "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
        }
      ],
      "found_dns_records": [
        {
          "name": "_acme-challenge.thebestreallylongdomainname.com",
          "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
        }
      ],
      "records_to_remove": [
        {
          "name": "_acme-challenge.thebestreallylongdomainname.com",
          "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
        }
      ]
    },
    "additional_domains": [
      {
        "hostname": "example.com",
        "validation_errors": [
          "The authority has rate limited these domains. Please wait for the rate limit to expire (17 Oct 25 21:18 UTC) or try another authority."
        ],
        "ssl_rate_limit": {
          "limited": true,
          "certificate_authority": "google",
          "expires_at": "2025-10-25T21:18:00Z"
        },
        "expected_dns_records": [
          {
            "name": "_acme-challenge.thebestreallylongdomainname.com",
            "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
          }
        ],
        "found_dns_records": [
          {
            "name": "_acme-challenge.thebestreallylongdomainname.com",
            "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
          }
        ],
        "records_to_remove": [
          {
            "name": "_acme-challenge.thebestreallylongdomainname.com",
            "value": "m_K7UGMVceMWPcgPn3zpqEtUV7RpFDBUqvl-yZyAUNU"
          }
        ]
      }
    ]
  }
}