v1.DomainService
Get domain details and DNS status.
Get domain details and DNS status.
POST
/
v1.DomainService
/
GetDomain
Get domain details and DNS status.
const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({id: '<string>'})
};
fetch('https://api.simpleemailapi.dev/v1.DomainService/GetDomain', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://api.simpleemailapi.dev/v1.DomainService/GetDomain \
--header 'Authorization: Bearer <token>' \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>"
}
'import requests
url = "https://api.simpleemailapi.dev/v1.DomainService/GetDomain"
payload = { "id": "<string>" }
headers = {
"Connect-Protocol-Version": "<connect-protocol-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.simpleemailapi.dev/v1.DomainService/GetDomain"
payload := strings.NewReader("{\n \"id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"domain": {
"id": "<string>",
"domain": "<string>",
"region": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"summary": {
"message": "<string>",
"nextAction": "<string>",
"recordsPending": 123,
"recordsConfigured": 123,
"canSend": true,
"canReceive": true
},
"records": {
"dkimRecords": [
{
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
}
],
"spfRecord": {
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
},
"dmarcRecord": {
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
},
"mxRecords": [
{
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
}
],
"mailFromRecords": [
{
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
}
]
}
}
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Authorizations
API key authentication. Get your API key from the SimpleEmailAPI dashboard and include it in the Authorization header as: Bearer sea_live_xxxxx
Headers
Define the version of the Connect protocol
Available options:
1 Define the timeout, in ms
Body
application/json
Response
Success
A sending domain.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get domain details and DNS status.
const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({id: '<string>'})
};
fetch('https://api.simpleemailapi.dev/v1.DomainService/GetDomain', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://api.simpleemailapi.dev/v1.DomainService/GetDomain \
--header 'Authorization: Bearer <token>' \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>"
}
'import requests
url = "https://api.simpleemailapi.dev/v1.DomainService/GetDomain"
payload = { "id": "<string>" }
headers = {
"Connect-Protocol-Version": "<connect-protocol-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.simpleemailapi.dev/v1.DomainService/GetDomain"
payload := strings.NewReader("{\n \"id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"domain": {
"id": "<string>",
"domain": "<string>",
"region": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"summary": {
"message": "<string>",
"nextAction": "<string>",
"recordsPending": 123,
"recordsConfigured": 123,
"canSend": true,
"canReceive": true
},
"records": {
"dkimRecords": [
{
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
}
],
"spfRecord": {
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
},
"dmarcRecord": {
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
},
"mxRecords": [
{
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
}
],
"mailFromRecords": [
{
"type": "<string>",
"name": "<string>",
"value": "<string>",
"priority": 123,
"nameShort": "<string>",
"discoveredValue": "<string>",
"instructions": "<string>"
}
]
}
}
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}