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

Remove the custom domain

Takes the live domain off the school. Needs a `domain:write` token.

DELETE
/api/v1/domain

Takes the live domain off the school. Needs a domain:write token.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Response Body

Removed, with the domain as it was.

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 DELETE 'https://aula.sferarc.com/api/v1/domain'
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"}

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.

Verify the custom domain POST

Checks the DNS records now. Checks are spaced out: inside the interval the answer is the domain as it stands. Needs a `domain:write` token.