POST /relays/{domain}/

post

https://{apiHost}/api-v1/relays/{domain}/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

domain

string

required

Body Params

admin

integer

admin_email

string

alias_delivery

boolean

allow_unknown_users

boolean

archive_logging_days

integer

arf_recipients

string

auto_add_recipients

boolean

auto_enable_protection_report

boolean

auto_esr_template_id

integer

batv_enabled

boolean

batv_enforced

boolean

blackhole_all_recipients

boolean

blackhole_arf

boolean

block_hidden_executables

boolean

block_passwd_attachments

boolean

block_spam

boolean

block_tld

string

blocked_extensions

string

blocked_languages

string

blocked_report

boolean

blocked_report_frequency

integer

case_sensitive

boolean

check_link_no_extensions

boolean

date_added

integer

disallowed_release_extensions

string

domain

string

domain_utf8

string

enable_filtering

boolean

enable_ldap_sync

boolean

enable_quarantine

boolean

enforce_header_encoding

boolean

enforce_header_limits

boolean

fake_accept

boolean

from_notification_email

string

ham_cutoff

number

has_catchall

boolean

hidden_bcc_address

string

hidden_bcc_recipients

string

hidden_exe_extensions

string

include_temp_reject_in_report

boolean

language

string

latest_blocked_report

string

ldap_sync_allow_deactivation

boolean

ldap_sync_allow_updates

boolean

ldap_sync_base_dn

string

ldap_sync_bind_dn

string

ldap_sync_filter

string

ldap_sync_host

string

ldap_sync_last_run

string

ldap_sync_password

string

ldap_sync_period

integer

ldap_sync_port

integer

ldap_sync_tls

boolean

ldap_sync_type

string

enum

Allowed:

load_default_allowlist_rules

boolean

load_default_blacklist_rules

boolean

load_default_blocklist_rules

boolean

load_default_recipient_allowlist

boolean

load_default_recipient_blacklist

boolean

load_default_recipient_blocklist

boolean

load_default_recipient_whitelist

boolean

load_default_sender_allowlist

boolean

load_default_sender_blacklist

boolean

load_default_sender_blocklist

boolean

load_default_sender_whitelist

boolean

load_default_whitelist_rules

boolean

local_part_characters

string

local_recipients_list

boolean

log_invalid_recipients

boolean

logging_days

integer

logging_server

string

max_days_to_retry

integer

maximum_date_disparity

integer

maximum_email_size

integer

maximum_hourly_bounces

integer

maximum_line_length

integer

maximum_local_parts

integer

maximum_message_link_size

integer

maximum_mime_boundary

integer

maximum_mime_defects

integer

maximum_mime_parts

integer

may_review

boolean

notate_subject

string

notate_subject_spam

string

ownership

string

pre_data_dnsbl

string

enum

Allowed:

quarantine_days

integer

quarantine_oversized_messages

boolean

quarantine_server

string

region_id

integer

reject_newsletters

boolean

reject_pua

boolean

report_actions

string

report_format

string

enum

Allowed:

report_template

string

reports_with_no_quarantined

boolean

require_tls_incoming_sender

string

require_tls_outgoing_recipient

string

required_languages

string

scanned_linked_extensions

string

spam_cutoff

number

spf_soft_fail

string

subaddressing_separator

string

sync_status

string

sync_with

string

threshold

integer

timezone

string

transferring_to_admin

integer

trust_training

boolean

unsure_days

integer

use_default_ldap_attribute_mapping

boolean

username

string

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

403Invalid or missing credentials