Email domains / Get dns setup
Get DNS records used to configure email domain
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/email_domains/get_dns_setup/{domain}
Method: GET
Authorisation: Minimum role: ADMIN
Request Arguments
| Name | Type | Source |
|---|---|---|
| domain | String |
Request body example
Response object
Response status: 200 (OK)
Response type: DTO_dns_setup[]
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_dns_setup
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| type | ENUM dns_record_type | Type | |
| status | ENUM dns_setup_status | Status | |
| host_value | String | Host value | |
| data | String | Data |
ENUM dns_record_type
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | TXT | TXT |
| 2 | CNAME | CNAME |
ENUM dns_setup_status
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | PENDING | Waiting client to setup DNS records (or verification of it) |
| 2 | INSTALLING | Client DNS record setup completed, and verification done |
| 3 | COMPLETED | Install completed |
