v1

latestOpenAPI 3.0.02026-07-2451442464.5 KB
Relay

POST /relays/{domain}{property_field}

post/relays/{domain}{property_field}

Path parameters

domainstring required
property_field'ldap_sync_type' | 'transferring_to_admin' | 'auto_esr_template_id' | 'include_temp_reject_in_report' | 'maximum_message_link_size' | 'maximum_date_disparity' | 'enable_filtering' | 'periodic_reports_submission' | 'outgoing' | 'allowlist_rules' | 'spf_soft_fail' | 'require_tls_outgoing_recipient' | 'allowlisted_outgoing_recipients' | 'may_review' | 'unsure_days' | 'maximum_line_length' | 'incoming_ipv6_interfaces' | 'logging_days' | 'blocklist_rules' | 'ldap_sync_period' | 'quarantine_oversized_messages' | 'whitelisted_outgoing_senders' | 'block_hidden_executables' | 'blacklisted_senders' | 'notations' | 'routes' | 'whitelisted_outgoing_recipients' | 'enforce_header_encoding' | 'load_default_recipient_blacklist' | 'timezone' | 'ldap_sync_bind_dn' | 'trust_training' | 'max_days_to_retry' | 'reports_with_no_quarantined' | 'exclusions' | 'username' | 'load_default_sender_allowlist' | 'use_default_ldap_attribute_mapping' | 'block_tld' | 'required_languages' | 'notate_subject_spam' | 'email_aliases' | 'load_default_sender_whitelist' | 'allowlisted_senders' | 'fake_accept' | 'disallowed_release_extensions' | 'auto_enable_protection_report' | 'whitelisted_recipients' | 'spam_cutoff' | 'allowlisted_outgoing_senders' | 'blocked_extensions' | 'pre_data_dnsbl' | 'logging_server' | 'disabled_checks' | 'ldap_sync_allow_updates' | 'enable_quarantine' | 'blocklisted_recipients' | 'subaddressing_separator' | 'blocked_report_frequency' | 'sync_with' | 'blocklisted_senders' | 'load_default_recipient_blocklist' | 'load_default_sender_blacklist' | 'ownership' | 'load_default_allowlist_rules' | 'auto_add_recipients' | 'enable_ldap_sync' | 'case_sensitive' | 'latest_blocked_report' | 'admin' | 'hidden_exe_extensions' | 'id' | 'report_template' | 'ldap_sync_port' | 'block_spam' | 'secure_email_access' | 'load_default_whitelist_rules' | 'outgoing_ipv6_interfaces' | 'maximum_local_parts' | 'region_id' | 'blocklisted_outgoing_senders' | 'archive_exports' | 'enforce_header_limits' | 'load_default_blacklist_rules' | 'email' | 'load_default_recipient_allowlist' | 'ldap_sync_last_run' | 'quarantine_server' | 'blocked_languages' | 'load_default_blocklist_rules' | 'maximum_hourly_bounces' | 'secure_email_policies' | 'load_default_recipient_whitelist' | 'threshold' | 'admin_email' | 'maximum_mime_parts' | 'custom_actions_incoming' | 'blackhole_all_recipients' | 'quarantine_days' | 'whitelisted_senders' | 'outgoing_ipv4_interfaces' | 'valid_helo_chars' | 'blacklist_rules' | 'batv_secret' | 'local_part_characters' | 'remote_syslog_configuration' | 'language' | 'batv_enforced' | 'batv_enabled' | 'maximum_mime_defects' | 'aliases' | 'scanned_linked_extensions' | 'whitelist_rules' | 'quarantine_password' | 'options' | 'date_added' | 'local_recipients_list' | 'periodic_reports_delivery' | 'splunk_configuration' | 'allow_unknown_users' | 'notification_address' | 'allowlisted_recipients' | 'require_tls_incoming_sender' | 'auto_esr' | 'check_link_no_extensions' | 'blacklisted_outgoing_senders' | 'blackhole_arf' | 'block_passwd_attachments' | 'maximum_mime_boundary' | 'outgoing_delivery_details' | 'report_actions' | 'incoming_ipv4_interfaces' | 'log_invalid_recipients' | 'from_notification_email' | 'ldap_sync_allow_deactivation' | 'ldap_sync_password' | 'protection_reports' | 'ldap_sync_tls' | 'recipients' | 'report_format' | 'reject_newsletters' | 'hidden_bcc_address' | 'ham_cutoff' | 'blacklisted_recipients' | 'archive_logging_days' | 'blocked_report' | 'incoming_delivery_details' | 'ldap_sync_base_dn' | 'load_default_sender_blocklist' | 'arf_recipients' | 'ldap_sync_host' | 'has_catchall' | 'on_demand_indexes' | 'domain_utf8' | 'reject_pua' | 'hidden_bcc_recipients' | 'alias_delivery' | 'ldap_sync_filter' | 'maximum_email_size' | 'domain' | 'sync_status' | 'notate_subject' required

Response

Success

messagestring
num_resultsinteger
statusinteger