Sign in

v1

latestOpenAPI 3.0.02026-07-2451442464.5 KB
Relay

PUT /relays/{domain}/

put/relays/{domain}/

Path parameters

domainstring required

Request body

admininteger
admin_emailstring
alias_deliveryboolean
allow_unknown_usersboolean
archive_logging_daysinteger
arf_recipientsstring
auto_add_recipientsboolean
auto_enable_protection_reportboolean
auto_esr_template_idinteger
batv_enabledboolean
batv_enforcedboolean
blackhole_all_recipientsboolean
blackhole_arfboolean
block_hidden_executablesboolean
block_passwd_attachmentsboolean
block_spamboolean
block_tldstring
blocked_extensionsstring
blocked_languagesstring
blocked_reportboolean
blocked_report_frequencyinteger
case_sensitiveboolean
check_link_no_extensionsboolean
date_addedinteger
disallowed_release_extensionsstring
domainstring
domain_utf8string
emailstring
enable_filteringboolean
enable_ldap_syncboolean
enable_quarantineboolean
enforce_header_encodingboolean
enforce_header_limitsboolean
fake_acceptboolean
from_notification_emailstring
ham_cutoffnumber
has_catchallboolean
hidden_bcc_addressstring
hidden_bcc_recipientsstring
hidden_exe_extensionsstring
idinteger
include_temp_reject_in_reportboolean
languagestring
latest_blocked_reportstring
ldap_sync_allow_deactivationboolean
ldap_sync_allow_updatesboolean
ldap_sync_base_dnstring
ldap_sync_bind_dnstring
ldap_sync_filterstring
ldap_sync_hoststring
ldap_sync_last_runstring
ldap_sync_passwordstring
ldap_sync_periodinteger
ldap_sync_portinteger
ldap_sync_tlsboolean
ldap_sync_type'OpenLDAP' | 'AD'
load_default_allowlist_rulesboolean
load_default_blacklist_rulesboolean
load_default_blocklist_rulesboolean
load_default_recipient_allowlistboolean
load_default_recipient_blacklistboolean
load_default_recipient_blocklistboolean
load_default_recipient_whitelistboolean
load_default_sender_allowlistboolean
load_default_sender_blacklistboolean
load_default_sender_blocklistboolean
load_default_sender_whitelistboolean
load_default_whitelist_rulesboolean
local_part_charactersstring
local_recipients_listboolean
log_invalid_recipientsboolean
logging_daysinteger
logging_serverstring
max_days_to_retryinteger
maximum_date_disparityinteger
maximum_email_sizeinteger
maximum_hourly_bouncesinteger
maximum_line_lengthinteger
maximum_local_partsinteger
maximum_message_link_sizeinteger
maximum_mime_boundaryinteger
maximum_mime_defectsinteger
maximum_mime_partsinteger
may_reviewboolean
notate_subjectstring
notate_subject_spamstring
ownershipstring
pre_data_dnsbl'temporary' | 'permanent' | 'disabled'
quarantine_daysinteger
quarantine_oversized_messagesboolean
quarantine_serverstring
region_idinteger
reject_newslettersboolean
reject_puaboolean
report_actionsstring
report_format'pdf' | 'html'
report_templatestring
reports_with_no_quarantinedboolean
require_tls_incoming_senderstring
require_tls_outgoing_recipientstring
required_languagesstring
scanned_linked_extensionsstring
spam_cutoffnumber
spf_soft_failstring
subaddressing_separatorstring
sync_statusstring
sync_withstring
thresholdinteger
timezonestring
transferring_to_admininteger
trust_trainingboolean
unsure_daysinteger
use_default_ldap_attribute_mappingboolean
usernamestring

Response

Success

messagestring
num_resultsinteger
statusinteger