Domains
Manage custom domains
Manage custom domains
List domains
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/domains"{
"data": [
{
"id": "string",
"domain": "string",
"status": "pending",
"verifiedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}Add a custom domain
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://app.thefaq.app/api/v1/string/domains" \ -H "Content-Type: application/json" \ -d '{ "domain": "faq.example.com" }'{
"data": {
"domain": {
"id": "string",
"domain": "string",
"status": "string"
},
"verification": {
"type": "string",
"domain": "string",
"value": "string"
}
}
}Get domain detail
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Domain ID
Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/domains/string"{
"data": {
"id": "string",
"domain": "string",
"status": "string",
"verifiedAt": "2019-08-24T14:15:22Z"
}
}Remove a domain
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Response Body
application/json
curl -X DELETE "https://app.thefaq.app/api/v1/string/domains/string"{
"data": {
"id": "string",
"deleted": true
}
}Verify domain DNS
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Response Body
application/json
curl -X POST "https://app.thefaq.app/api/v1/string/domains/string/verify"{
"data": {
"verified": true,
"status": "string"
}
}Check domain health
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/domains/string/health"{
"data": {
"domain": "string",
"healthy": true,
"checks": {
"dns": true,
"ssl": true,
"reachable": true
}
}
}