Client API: Mail: Domains
The 6 Client API operations for domains.
Part of Mail.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/client/mail/{service_id}/domains |
List domains |
| POST | /api/v1/client/mail/{service_id}/domains |
Add domain |
| DELETE | /api/v1/client/mail/{service_id}/domains/{domain_id} |
Remove domain |
| PATCH | /api/v1/client/mail/{service_id}/domains/{domain_id}/dmarc |
Set DMARC |
| GET | /api/v1/client/mail/{service_id}/domains/{domain_id}/records |
Domain records |
| POST | /api/v1/client/mail/{service_id}/domains/{domain_id}/verify |
Verify domain |
List domains
Section titled List domainsGET /api/v1/client/mail/{service_id}/domains
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
service_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Add domain
Section titled Add domainPOST /api/v1/client/mail/{service_id}/domains
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
service_id |
path | integer | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
domain |
string | yes |
primary |
boolean | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Remove domain
Section titled Remove domainDELETE /api/v1/client/mail/{service_id}/domains/{domain_id}
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
domain_id |
path | integer | yes |
service_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Set DMARC
Section titled Set DMARCPATCH /api/v1/client/mail/{service_id}/domains/{domain_id}/dmarc
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
domain_id |
path | integer | yes |
service_id |
path | integer | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
stage |
string or null | no |
pinned |
boolean or null | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Domain records
Section titled Domain recordsGET /api/v1/client/mail/{service_id}/domains/{domain_id}/records
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
domain_id |
path | integer | yes |
service_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Verify domain
Section titled Verify domainPOST /api/v1/client/mail/{service_id}/domains/{domain_id}/verify
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
domain_id |
path | integer | yes |
service_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |