Sign in

v1

latestOpenAPI 3.0.32026-07-17226134463.9 KB
domains

V2 viewset.

patch/api/v2/domains/{id}/

Path parameters

idinteger required

A unique integer value identifying this domain.

Request body

pkinteger
namestring

The domain name

quotastring

Quota shared between mailboxes. Can be expressed in KB, MB (default) or GB. A value of 0 means no quota.

default_mailbox_quotastring

Default quota in MB applied to mailboxes. A value of 0 means no quota.

enabledboolean

Check to activate this domain

typestring
enable_dkimboolean

If you activate this feature, a DKIM key will be generated for this domain.

dkim_key_selectorstring
dkim_public_keystring
dkim_private_key_pathstring
mailbox_countinteger
mbalias_countinteger
domainalias_countinteger
dns_global_statusstring

Return global DNS status.

message_limitinteger nullable

Number of messages this domain can send per day

creationstring date-time
last_modificationstring date-time
allocated_quota_in_percentstring
enable_dns_checksboolean

Check to enable DNS checks for this domain

opened_alarms_countinteger

Number of alarms currently opened for this domain.

sent_messagesstring
sent_messages_in_percentinteger nullable

Return number of sent messages as a percentage.

last_dns_check_executionstring date-time nullable

Response

pkinteger required
namestring required

The domain name

quotastring

Quota shared between mailboxes. Can be expressed in KB, MB (default) or GB. A value of 0 means no quota.

default_mailbox_quotastring

Default quota in MB applied to mailboxes. A value of 0 means no quota.

enabledboolean

Check to activate this domain

typestring
enable_dkimboolean

If you activate this feature, a DKIM key will be generated for this domain.

dkim_key_selectorstring
dkim_public_keystring required
dkim_private_key_pathstring
mailbox_countinteger required
mbalias_countinteger required
domainalias_countinteger required
dns_global_statusstring required

Return global DNS status.

message_limitinteger nullable

Number of messages this domain can send per day

creationstring date-time required
last_modificationstring date-time required
allocated_quota_in_percentstring required
enable_dns_checksboolean required

Check to enable DNS checks for this domain

opened_alarms_countinteger required

Number of alarms currently opened for this domain.

sent_messagesstring required
sent_messages_in_percentinteger nullable required

Return number of sent messages as a percentage.

last_dns_check_executionstring date-time nullable