Reset setting

Reset to default (or clear) settings for system mailer (used to send system emails), postfix relayhost, junk/trash clearing interval and IMAP master password

  • HTTP Method: DELETE
  • URL: https://example.domain.tld/api/v1/settings/<setting>/
  • Require authentication: Yes
  • Permission level required: MasterAdmin

Path parameters

Parameter Type Description Required
setting str system_mailer or postfix_relayhost or junk_trash_clearing_interval or imap_master_password Required

Response parameters

Parameter Type Description
settings dict The settings status object
name str Name of setting
status str Status

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/settings/postfix_relayhost/"
r = requests.delete(url, auth=("admin","long-auth_token-here"))

Example response (JSON)

    'settings' : {
        'name' : 'postfix_relayhost',
        'status' : 'deleting'