Return service configuration settings

This function returns a service's configuration settings.

SecurityBasicAuth

Request

query Parameters

service

required

string

The service's name.

dovecot — The Dovecot service.

Note:

For a fresh install, the data returned for the Dovecot service will only contain the list of protocols. It will not be until the mailserver configuration is saved that the return data for Dovecot will look like what is shown in the example.

Value: "dovecot"

Example: service=dovecot

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object A list of the configuration key's settings.
	object

get/get_service_config

Request samples

whmapi1 --output=jsonpretty \
  get_service_config \
  service='dovecot'

Response samples

application/json

{"data": {"auth_cache_negative_ttl": 3600,
"auth_cache_size": "1M",
"auth_cache_ttl": 3600,
"auth_policy_hash_nonce": 91057590,
"compress_messages": 0,
"config_vsz_limit": 2048,
"disable_plaintext_auth": "no",
"expire_trash": 0,
"expire_spam": 0,
"hulk_auth_passwd": "FAMONex4Bn9Hv1BO",
"include_trash_in_quota": 0,
"incoming_reached_quota": "bounce",
"ipv6": "on",
"lmtp_process_limit": 500,
"lmtp_process_min_avail": 0,
"lmtp_user_concurrency_limit": 4,
"login_max_processes_count": 50,
"login_process_per_connection": "no",
"login_process_size": 128,
"login_processes_count": 2,
"mail_process_size": 512,
"mdbox_rotate_interval": 0,
"mdbox_rotate_size": "10M",
"protocol_imap": {"mail_max_userip_connections": 20,
"map_idle_notify_interval": 24
},
"protocol_pop3": {"mail_max_userip_connections": 3
},
"protocols": "imap pop3",
"ssl_cipher_list": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384",
"ssl_min_protocol": "TLSv1.2"
},
"metadata": {"command": "get_service_config",
"reason": "OK",
"result": 1,
"version": 1
}
}