Aula is in early access. These docs grow as it does.
Skip to Content
Aula
API ReferenceDomain

Add the custom domain

Adds the hostname as pending and checks it once. Publish the records in the answer, then verify. Needs a `domain:write` token and `custom_domain` on the plan.

POST
/api/v1/domain

Adds the hostname as pending and checks it once. Publish the records in the answer, then verify. Needs a domain:write token and custom_domain on the plan.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Request Body

application/json
  1. body
hostname*string

Response Body

Added.

application/json
  1. response
id*string
Formatuuid
hostname*string
status*string
Value in"pending""active""misconfigured""failed""removed"
pointsTo*

Where the hostname points: an A record at an apex, else a CNAME.

ownershipRecord*
verification*array<>
verifiedAt*|
Formatdate-time
Example Request
curl -X POST 'https://aula.sferarc.com/api/v1/domain' \  -H 'Content-Type: application/json' \  -d '{  "hostname": "string"}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "hostname": "string",  "status": "pending",  "pointsTo": {    "type": "A",    "value": "string"  },  "ownershipRecord": {    "type": "TXT",    "name": "string",    "value": "string"  },  "verification": [    {      "type": "string",      "domain": "string",      "value": "string",      "reason": "string"    }  ],  "verifiedAt": "2019-08-24T14:15:22Z"}

Your child's health file, consents and pickup

Where a family keeps a child's health file, answers the school's consent items and lists the adults allowed to collect them.

Read the custom domain GET

The school's live main-site domain with the DNS records to publish. Needs a `site:read` or `domain:write` token.