Partners

Get a domain

Domain status and records. With verify=true live DNS is checked now; otherwise the stored state is returned. Requires partner:read.

get/customers/{id}/domains/{domain}

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

Query parameters

verifyboolean

Check live DNS before answering

Response

Domain status

successboolean

Example response

{
  "success": true,
  "data": {
    "domain": "smiledental.example",
    "brandName": "Smile Dental",
    "dnsRecords": [
      {
        "type": "MX",
        "name": "smiledental.example",
        "value": "10 mx.faivelo.com"
      }
    ],
    "storage": {
      "usedBytes": 3221225472,
      "limitBytes": 53687091200,
      "availableBytes": 50465865728
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.