{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Returns the rule database digest. This is used internally for cluster synchronization.",
"method" : "GET",
"name" : "ruledb_digest",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get common rule properties.",
"method" : "GET",
"name" : "config",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set rule properties.",
"method" : "PUT",
"name" : "update_config",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete group from 'from' list.",
"method" : "DELETE",
"name" : "delete_from_group",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get 'from' group list.",
"method" : "GET",
"name" : "from",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add group to 'from' list.",
"method" : "POST",
"name" : "add_from_group",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete group from 'to' list.",
"method" : "DELETE",
"name" : "delete_to_group",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get 'to' group list.",
"method" : "GET",
"name" : "to",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add group to 'to' list.",
"method" : "POST",
"name" : "add_to_group",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete group from 'when' list.",
"method" : "DELETE",
"name" : "delete_when_group",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get 'when' group list.",
"method" : "GET",
"name" : "when",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add group to 'when' list.",
"method" : "POST",
"name" : "add_when_group",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete group from 'what' list.",
"method" : "DELETE",
"name" : "delete_what_group",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get 'what' group list.",
"method" : "GET",
"name" : "what",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add group to 'what' list.",
"method" : "POST",
"name" : "add_what_group",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete group from 'action' list.",
"method" : "DELETE",
"name" : "delete_action_group",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get 'action' group list.",
"method" : "GET",
"name" : "action",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add group to 'action' list.",
"method" : "POST",
"name" : "add_action_group",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete rule.",
"method" : "DELETE",
"name" : "delete_rule",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get list of rules.",
"method" : "GET",
"name" : "list_rules",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new rule.",
"method" : "POST",
"name" : "create_rule",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete 'actions' object.",
"method" : "DELETE",
"name" : "delete_action",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List 'actions' objects.",
"method" : "GET",
"name" : "list_actions",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'BCC' object settings.",
"method" : "GET",
"name" : "read_bcc",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'BCC' object.",
"method" : "PUT",
"name" : "update_bcc",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create 'BCC' object.",
"method" : "POST",
"name" : "bcc",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Header Attribute' object settings.",
"method" : "GET",
"name" : "read_field",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Header Attribute' object.",
"method" : "PUT",
"name" : "update_field",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create 'Header Attribute' object.",
"method" : "POST",
"name" : "field",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Notification' object settings.",
"method" : "GET",
"name" : "read_notification",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Notification' object.",
"method" : "PUT",
"name" : "update_notification",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create 'Notification' object.",
"method" : "POST",
"name" : "notification",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Disclaimer' object settings.",
"method" : "GET",
"name" : "read_disclaimer",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Disclaimer' object.",
"method" : "PUT",
"name" : "update_disclaimer",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create 'Disclaimer' object.",
"method" : "POST",
"name" : "disclaimer",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Remove attachments' object settings.",
"method" : "GET",
"name" : "read_removeattachments",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Remove attachments' object.",
"method" : "PUT",
"name" : "update_removeattachments",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create 'Remove attachments' object.",
"method" : "POST",
"name" : "removeattachments",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get 'what' group properties",
"method" : "GET",
"name" : "get_config",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Modify 'what' group properties",
"method" : "PUT",
"name" : "set_config",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove an object from the 'what' group.",
"method" : "DELETE",
"name" : "delete_object",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List 'what' group objects.",
"method" : "GET",
"name" : "objects",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'ContentType Filter' object settings.",
"method" : "GET",
"name" : "read_contenttype",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'ContentType Filter' object.",
"method" : "PUT",
"name" : "update_contenttype",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'ContentType Filter' object.",
"method" : "POST",
"name" : "contenttype",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Match Field' object settings.",
"method" : "GET",
"name" : "read_matchfield",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Match Field' object.",
"method" : "PUT",
"name" : "update_matchfield",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Match Field' object.",
"method" : "POST",
"name" : "matchfield",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Spam Filter' object settings.",
"method" : "GET",
"name" : "read_spamfilter",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Spam Filter' object.",
"method" : "PUT",
"name" : "update_spamfilter",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Spam Filter' object.",
"method" : "POST",
"name" : "spamfilter",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Archive Filter' object settings.",
"method" : "GET",
"name" : "read_archivefilter",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Archive Filter' object.",
"method" : "PUT",
"name" : "update_archivefilter",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Archive Filter' object.",
"method" : "POST",
"name" : "archivefilter",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Match Filename' object settings.",
"method" : "GET",
"name" : "read_filenamefilter",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Match Filename' object.",
"method" : "PUT",
"name" : "update_filenamefilter",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Match Filename' object.",
"method" : "POST",
"name" : "filenamefilter",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Virus Filter' object settings.",
"method" : "GET",
"name" : "read_virusfilter",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Virus Filter' object.",
"method" : "PUT",
"name" : "update_virusfilter",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Virus Filter' object.",
"method" : "POST",
"name" : "virusfilter",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a 'what' group.",
"method" : "DELETE",
"name" : "delete_{$oclass}_group",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get list of 'what' groups.",
"method" : "GET",
"name" : "list_what_groups",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a new 'what' group.",
"method" : "POST",
"name" : "create_what_group",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get 'when' group properties",
"method" : "GET",
"name" : "get_config",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Modify 'when' group properties",
"method" : "PUT",
"name" : "set_config",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove an object from the 'when' group.",
"method" : "DELETE",
"name" : "delete_object",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List 'when' group objects.",
"method" : "GET",
"name" : "objects",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'TimeFrame' object settings.",
"method" : "GET",
"name" : "read_timeframe",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'TimeFrame' object.",
"method" : "PUT",
"name" : "update_timeframe",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'TimeFrame' object.",
"method" : "POST",
"name" : "timeframe",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a 'when' group.",
"method" : "DELETE",
"name" : "delete_{$oclass}_group",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get list of 'when' groups.",
"method" : "GET",
"name" : "list_when_groups",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a new 'when' group.",
"method" : "POST",
"name" : "create_when_group",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get 'who' group properties",
"method" : "GET",
"name" : "get_config",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Modify 'who' group properties",
"method" : "PUT",
"name" : "set_config",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove an object from the 'who' group.",
"method" : "DELETE",
"name" : "delete_object",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List 'who' group objects.",
"method" : "GET",
"name" : "objects",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Mail address' object settings.",
"method" : "GET",
"name" : "read_email",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Mail address' object.",
"method" : "PUT",
"name" : "update_email",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Mail address' object.",
"method" : "POST",
"name" : "email",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Domain' object settings.",
"method" : "GET",
"name" : "read_domain",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Domain' object.",
"method" : "PUT",
"name" : "update_domain",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Domain' object.",
"method" : "POST",
"name" : "domain",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Regular Expression' object settings.",
"method" : "GET",
"name" : "read_regex",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Regular Expression' object.",
"method" : "PUT",
"name" : "update_regex",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Regular Expression' object.",
"method" : "POST",
"name" : "regex",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'IP Address' object settings.",
"method" : "GET",
"name" : "read_ip",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'IP Address' object.",
"method" : "PUT",
"name" : "update_ip",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'IP Address' object.",
"method" : "POST",
"name" : "ip",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'IP Network' object settings.",
"method" : "GET",
"name" : "read_network",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'IP Network' object.",
"method" : "PUT",
"name" : "update_network",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'IP Network' object.",
"method" : "POST",
"name" : "network",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'LDAP Group' object settings.",
"method" : "GET",
"name" : "read_ldap",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'LDAP Group' object.",
"method" : "PUT",
"name" : "update_ldap",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'LDAP Group' object.",
"method" : "POST",
"name" : "ldap",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'LDAP User' object settings.",
"method" : "GET",
"name" : "read_ldapuser",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'LDAP User' object.",
"method" : "PUT",
"name" : "update_ldapuser",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'LDAP User' object.",
"method" : "POST",
"name" : "ldapuser",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a 'who' group.",
"method" : "DELETE",
"name" : "delete_{$oclass}_group",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get list of 'who' groups.",
"method" : "GET",
"name" : "list_who_groups",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a new 'who' group.",
"method" : "POST",
"name" : "create_who_group",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Reset PMG rule database back to factory defaults.",
"method" : "POST",
"name" : "reset_ruledb",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove an object from the SMTP whitelist.",
"method" : "DELETE",
"name" : "delete_object",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get list of all SMTP whitelist entries.",
"method" : "GET",
"name" : "objects",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Mail address' object settings.",
"method" : "GET",
"name" : "read_email",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Mail address' object.",
"method" : "PUT",
"name" : "update_email",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Mail address' object.",
"method" : "POST",
"name" : "email",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Mail address' object settings.",
"method" : "GET",
"name" : "read_receiver",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Mail address' object.",
"method" : "PUT",
"name" : "update_receiver",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Mail address' object.",
"method" : "POST",
"name" : "receiver",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Domain' object settings.",
"method" : "GET",
"name" : "read_domain",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Domain' object.",
"method" : "PUT",
"name" : "update_domain",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Domain' object.",
"method" : "POST",
"name" : "domain",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Domain' object settings.",
"method" : "GET",
"name" : "read_receiver_domain",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Domain' object.",
"method" : "PUT",
"name" : "update_receiver_domain",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Domain' object.",
"method" : "POST",
"name" : "receiver_domain",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Regular Expression' object settings.",
"method" : "GET",
"name" : "read_regex",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Regular Expression' object.",
"method" : "PUT",
"name" : "update_regex",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Regular Expression' object.",
"method" : "POST",
"name" : "regex",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'Regular Expression' object settings.",
"method" : "GET",
"name" : "read_receiver_regex",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'Regular Expression' object.",
"method" : "PUT",
"name" : "update_receiver_regex",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'Regular Expression' object.",
"method" : "POST",
"name" : "receiver_regex",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'IP Address' object settings.",
"method" : "GET",
"name" : "read_ip",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'IP Address' object.",
"method" : "PUT",
"name" : "update_ip",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'IP Address' object.",
"method" : "POST",
"name" : "ip",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read 'IP Network' object settings.",
"method" : "GET",
"name" : "read_network",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update 'IP Network' object.",
"method" : "PUT",
"name" : "update_network",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Add 'IP Network' object.",
"method" : "POST",
"name" : "network",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get LDAP profile configuration.",
"method" : "GET",
"name" : "read_config",
"returns" : {}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update LDAP profile settings.",
"method" : "PUT",
"name" : "update_config",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Synchronice LDAP users to local database.",
"method" : "POST",
"name" : "sync_profile",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get all email addresses for the specified user.",
"method" : "GET",
"name" : "address_list",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List LDAP users.",
"method" : "GET",
"name" : "profile_list_users",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List LDAP group members.",
"method" : "GET",
"name" : "profile_list_group_members",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List LDAP groups.",
"method" : "GET",
"name" : "profile_list_groups",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete an LDAP profile",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index",
"method" : "GET",
"name" : "profile_index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List configured LDAP profiles.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add LDAP profile.",
"method" : "POST",
"name" : "create",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a relay domain",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read Domain data (comment).",
"method" : "GET",
"name" : "read",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update relay domain data (comment).",
"method" : "PUT",
"name" : "write",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List relay domains.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add relay domain.",
"method" : "POST",
"name" : "create",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a fetchmail configuration entry.",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read fetchmail user configuration.",
"method" : "GET",
"name" : "read",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update fetchmail user configuration.",
"method" : "PUT",
"name" : "write",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List fetchmail users.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create fetchmail user configuration.",
"method" : "POST",
"name" : "create",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a transport map entry",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read transport map entry.",
"method" : "GET",
"name" : "read",
"port" : {
"type" : "integer"
},
+ "protocol" : {
+ "type" : "string"
+ },
"use_mx" : {
"type" : "boolean"
}
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update transport map entry.",
"method" : "PUT",
"name" : "write",
"typetext" : "<string>"
},
"port" : {
- "description" : "SMTP port.",
+ "description" : "Transport port.",
"maximum" : 65535,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (1 - 65535)"
},
+ "protocol" : {
+ "default" : "smtp",
+ "description" : "Transport protocol.",
+ "enum" : [
+ "smtp",
+ "lmtp"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"use_mx" : {
- "description" : "Enable MX lookups.",
+ "description" : "Enable MX lookups (SMTP).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List transport map entries.",
"method" : "GET",
"name" : "index",
"port" : {
"type" : "integer"
},
+ "protocol" : {
+ "type" : "string"
+ },
"use_mx" : {
"type" : "boolean"
}
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add transport map entry.",
"method" : "POST",
"name" : "create",
},
"port" : {
"default" : 25,
- "description" : "SMTP port.",
+ "description" : "Transport port.",
"maximum" : 65535,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (1 - 65535)"
},
+ "protocol" : {
+ "default" : "smtp",
+ "description" : "Transport protocol.",
+ "enum" : [
+ "smtp",
+ "lmtp"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"use_mx" : {
"default" : 1,
- "description" : "Enable MX lookups.",
+ "description" : "Enable MX lookups (SMTP).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a truster network",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read trusted network data (comment).",
"method" : "GET",
"name" : "read",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update trusted data (comment).",
"method" : "PUT",
"name" : "write",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List of trusted networks from where SMTP clients are allowed to relay mail through Proxmox Mail Gateway.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add a trusted network.",
"method" : "POST",
"name" : "create",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Cluster node index.",
"method" : "GET",
"name" : "nodes",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add an node to the cluster config.",
"method" : "POST",
"name" : "add_node",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Cluster node status.",
"method" : "GET",
"name" : "status",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create initial cluster config with current node as master.",
"method" : "POST",
"name" : "create",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Join local node to an existing cluster.",
"method" : "POST",
"name" : "join",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Mime Types List",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a tls_policy entry",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read tls_policy entry.",
"method" : "GET",
"name" : "read",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update tls_policy entry.",
"method" : "PUT",
"name" : "write",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List tls_policy entries.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add tls_policy entry.",
"method" : "POST",
"name" : "create",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a DKIM-sign domain",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read Domain data (comment).",
"method" : "GET",
"name" : "read",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update DKIM-sign domain data (comment).",
"method" : "PUT",
"name" : "write",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List DKIM-sign domains.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add DKIM-sign domain.",
"method" : "POST",
"name" : "create",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get the public key for the configured selector, prepared as DKIM TXT record",
"method" : "GET",
"name" : "get_selector_info",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Generate a new private key for selector. All future mail will be signed with the new key!",
"method" : "POST",
"name" : "set_selector",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "force" : {
+ "description" : "Overwrite existing key",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"keysize" : {
"description" : "Number of bits for the RSA-Key",
"minimum" : 1024,
"leaf" : 1,
"path" : "/config/dkim/selector",
"text" : "selector"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get a list of all existing selectors",
+ "method" : "GET",
+ "name" : "get_selector_list",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "selector" : {
+ "format" : "dns-name",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{selector}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/config/dkim/selectors",
+ "text" : "selectors"
}
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Edit custom SpamAssassin score",
"method" : "DELETE",
"name" : "delete_score",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get custom SpamAssassin score",
"method" : "GET",
"name" : "get_score",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Edit custom SpamAssassin score",
"method" : "PUT",
"name" : "edit_score",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Revert custom score changes.",
"method" : "DELETE",
"name" : "revert_score_changes",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "List custom scores.",
"method" : "GET",
"name" : "list_scores",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create custom SpamAssassin score",
"method" : "POST",
"name" : "create_score",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Apply custom score changes.",
"method" : "PUT",
"name" : "apply_score_changes",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read admin configuration properties.",
"method" : "GET",
"name" : "read_admin_section",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update admin configuration properties.",
"method" : "PUT",
"name" : "update_admin_section",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read clamav configuration properties.",
"method" : "GET",
"name" : "read_clamav_section",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update clamav configuration properties.",
"method" : "PUT",
"name" : "update_clamav_section",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read mail configuration properties.",
"method" : "GET",
"name" : "read_mail_section",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update mail configuration properties.",
"method" : "PUT",
"name" : "update_mail_section",
},
"relaynomx" : {
"default" : 0,
- "description" : "Disable MX lookups for default relay.",
+ "description" : "Disable MX lookups for default relay (SMTP only, ignored for LMTP).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"relayport" : {
"default" : 25,
- "description" : "SMTP port number for relay host.",
+ "description" : "SMTP/LMTP port number for relay host.",
"maximum" : 65535,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (1 - 65535)"
},
+ "relayprotocol" : {
+ "default" : "smtp",
+ "description" : "Transport protocol for relay host.",
+ "enum" : [
+ "smtp",
+ "lmtp"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"smarthost" : {
"description" : "When set, all outgoing mails are deliverd to the specified smarthost.",
"format" : "address",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read spam configuration properties.",
"method" : "GET",
"name" : "read_spam_section",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update spam configuration properties.",
"method" : "PUT",
"name" : "update_spam_section",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read spamquar configuration properties.",
"method" : "GET",
"name" : "read_spamquar_section",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update spamquar configuration properties.",
"method" : "PUT",
"name" : "update_spamquar_section",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read virusquar configuration properties.",
"method" : "GET",
"name" : "read_virusquar_section",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update virusquar configuration properties.",
"method" : "PUT",
"name" : "update_virusquar_section",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Test Regex",
"method" : "POST",
"name" : "regextest",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Print Postfix queue domain and age distribution.",
"method" : "GET",
"name" : "qshape",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete one message with the named queue ID.",
"method" : "DELETE",
"name" : "delete_queued_mail",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get the contents of a queued mail.",
"method" : "GET",
"name" : "read_queued_mail",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Schedule immediate delivery of deferred mail with the specified queue ID.",
"method" : "POST",
"name" : "flush_queued_mail",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete all mails in the queue.",
"method" : "DELETE",
"name" : "delete_queue",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "List the mail queue for a specific domain.",
"method" : "GET",
"name" : "mailq",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete all mails in all posfix queues.",
"method" : "DELETE",
"name" : "delete_all_queues",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "queue_index",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Flush the queue: attempt to deliver all queued mail.",
"method" : "POST",
"name" : "flush_queues",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Discards the address verification cache.",
"method" : "POST",
"name" : "discard_verify_cache",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "ClamAV virus database status.",
"method" : "GET",
"name" : "database_status",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Update ClamAV virus databases.",
"method" : "POST",
"name" : "update_database",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "SpamAssassin rules status.",
"method" : "GET",
"name" : "rules_status",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Update SpamAssassin rules.",
"method" : "POST",
"name" : "update_rules",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete network device configuration",
"method" : "DELETE",
"name" : "delete_network",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read network device configuration",
"method" : "GET",
"name" : "network_config",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update network device configuration",
"method" : "PUT",
"name" : "update_network",
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "bond-primary" : {
+ "description" : "Specify the primary interface for active-backup bond.",
+ "format" : "pve-iface",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"bond_mode" : {
"description" : "Bonding mode.",
"enum" : [
"type" : "string",
"typetext" : "<string>"
},
+ "mtu" : {
+ "description" : "MTU.",
+ "maximum" : 65520,
+ "minimum" : 1280,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1280 - 65520)"
+ },
"netmask" : {
"description" : "Network mask.",
"format" : "ipv4mask",
"unknown"
],
"type" : "string"
+ },
+ "vlan-id" : {
+ "description" : "vlan-id for a custom named vlan interface (ifupdown2 only).",
+ "maximum" : 4094,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 4094)"
+ },
+ "vlan-raw-device" : {
+ "description" : "Specify the raw interface for the vlan interface.",
+ "format" : "pve-iface",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Revert network configuration changes.",
"method" : "DELETE",
"name" : "revert_network_changes",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "List available networks",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create network device configuration",
"method" : "POST",
"name" : "create_network",
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "bond-primary" : {
+ "description" : "Specify the primary interface for active-backup bond.",
+ "format" : "pve-iface",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"bond_mode" : {
"description" : "Bonding mode.",
"enum" : [
"type" : "string",
"typetext" : "<string>"
},
+ "mtu" : {
+ "description" : "MTU.",
+ "maximum" : 65520,
+ "minimum" : 1280,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1280 - 65520)"
+ },
"netmask" : {
"description" : "Network mask.",
"format" : "ipv4mask",
"unknown"
],
"type" : "string"
+ },
+ "vlan-id" : {
+ "description" : "vlan-id for a custom named vlan interface (ifupdown2 only).",
+ "maximum" : 4094,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 4094)"
+ },
+ "vlan-raw-device" : {
+ "description" : "Specify the raw interface for the vlan interface.",
+ "format" : "pve-iface",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read task log.",
"method" : "GET",
"name" : "read_task_log",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read task status.",
"method" : "GET",
"name" : "read_task_status",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Stop a task.",
"method" : "DELETE",
"name" : "stop_task",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "",
"method" : "GET",
"name" : "upid_index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read task list for one node (finished tasks).",
"method" : "GET",
"name" : "node_tasks",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read service properties",
"method" : "GET",
"name" : "service_state",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Start service.",
"method" : "POST",
"name" : "service_start",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Stop service.",
"method" : "POST",
"name" : "service_stop",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Restart service.",
"method" : "POST",
"name" : "service_restart",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Reload service.",
"method" : "POST",
"name" : "service_reload",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index",
"method" : "GET",
"name" : "srvcmdidx",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Service list.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read subscription info.",
"method" : "GET",
"name" : "get",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Update subscription info.",
"method" : "POST",
"name" : "update",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set subscription key.",
"method" : "PUT",
"name" : "set",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List available updates.",
"method" : "GET",
"name" : "list_updates",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "This is used to resynchronize the package index files from their sources (apt-get update).",
"method" : "POST",
"name" : "update_database",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get package changelogs.",
"method" : "GET",
"name" : "changelog",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get package information for important Proxmox packages.",
"method" : "GET",
"name" : "versions",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index for apt (Advanced Package Tool).",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get the detailed syslog entries for a specific mail ID.",
"method" : "GET",
"name" : "maillog",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read mail list.",
"method" : "GET",
"name" : "list_mails",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a backup file.",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Download a backup file.",
"download" : 1,
"method" : "GET",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Restore the system configuration.",
"method" : "POST",
"name" : "restore",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List all stored backups (files named proxmox-backup_{DATE}.tgz).",
"method" : "GET",
"name" : "list",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Backup the system configuration.",
"method" : "POST",
"name" : "backup",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Gather various system information about a node",
"method" : "GET",
"name" : "report",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read node RRD statistics",
"method" : "GET",
"name" : "rrddata",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read system log",
"method" : "GET",
"name" : "syslog",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read Journal",
"method" : "GET",
"name" : "journal",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Creates a Terminal proxy.",
"method" : "POST",
"name" : "termproxy",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Opens a weksocket for VNC traffic.",
"method" : "GET",
"name" : "vncwebsocket",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read DNS settings.",
"method" : "GET",
"name" : "dns",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Write DNS settings.",
"method" : "PUT",
"name" : "update_dns",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read server time and time zone settings.",
"method" : "GET",
"name" : "time",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set time zone.",
"method" : "PUT",
"name" : "set_timezone",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read server status. This is used by the cluster manager to test the node health.",
"method" : "GET",
"name" : "status",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Reboot or shutdown a node.",
"method" : "POST",
"name" : "node_cmd",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Node index.",
"method" : "GET",
"name" : "index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Cluster node index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a user.",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read User data.",
"method" : "GET",
"name" : "read",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update user data.",
"method" : "PUT",
"name" : "write",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List users.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new user",
"method" : "POST",
"name" : "create",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Dummy. Useful for formaters which want to priovde a login page.",
"method" : "GET",
"name" : "get_ticket",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create or verify authentication ticket.",
"method" : "POST",
"name" : "create_ticket",
{
"info" : {
"PUT" : {
+ "allowtoken" : 1,
"description" : "Change user password.",
"method" : "PUT",
"name" : "change_passsword",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete user whitelist entries.",
"method" : "DELETE",
"name" : "whitelist_delete",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Show user whitelist.",
"method" : "GET",
"name" : "whitelist",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add user whitelist entries.",
"method" : "POST",
"name" : "whitelist_add",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete user blacklist entries.",
"method" : "DELETE",
"name" : "blacklist_delete",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Show user blacklist.",
"method" : "GET",
"name" : "blacklist",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add user blacklist entries.",
"method" : "POST",
"name" : "blacklist_add",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get a list of receivers of spam in the given timespan (Default the last 24 hours).",
"method" : "GET",
"name" : "spamusers",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Spam Quarantine Status",
"method" : "GET",
"name" : "spamstatus",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get a list of users with whitelist/blacklist setttings.",
"method" : "GET",
"name" : "quarusers",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get a list of quarantined spam mails in the given timeframe (default the last 24 hours) for the given user.",
"method" : "GET",
"name" : "spam",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get a list of quarantined virus mails in the given timeframe (default the last 24 hours).",
"method" : "GET",
"name" : "virus",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get a list of quarantined attachment mails in the given timeframe (default the last 24 hours).",
"method" : "GET",
"name" : "attachment",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Virus Quarantine Status",
"method" : "GET",
"name" : "virusstatus",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get email data. There is a special formatter called 'htmlmail' to get sanitized html view of the mail content (use the '/api2/htmlmail/quarantine/content' url).",
"method" : "GET",
"name" : "content",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute quarantine actions.",
"method" : "POST",
"name" : "action",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Attachments for E-Mail in Quarantine.",
"method" : "GET",
"name" : "listattachments",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Download E-Mail or Attachment from Quarantine.",
"download" : 1,
"method" : "GET",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Detailed Contact Statistics.",
"method" : "GET",
"name" : "contactdetails",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Contact Address Statistics.",
"method" : "GET",
"name" : "contact",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Detailed Sender Statistics.",
"method" : "GET",
"name" : "senderdetails",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Sender Address Statistics.",
"method" : "GET",
"name" : "sender",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Detailed Receiver Statistics.",
"method" : "GET",
"name" : "receiverdetails",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Receiver Address Statistics.",
"method" : "GET",
"name" : "receiver",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Mail Domains Statistics.",
"method" : "GET",
"name" : "domains",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "General Mail Statistics.",
"method" : "GET",
"name" : "mail",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Mail Count Statistics.",
"method" : "GET",
"name" : "recent",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Top recent Mail Receivers (including spam)",
"method" : "GET",
"name" : "recentreceivers",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Mail Count Statistics.",
"method" : "GET",
"name" : "mailcount",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Statistics about detected Viruses.",
"method" : "GET",
"name" : "virus",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get the count of spam mails grouped by spam score. Count for score 10 includes mails with spam score > 10.",
"method" : "GET",
"name" : "spamscores",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get the count of spam mails grouped by spam score. Count for score 10 includes mails with spam score > 10.",
"method" : "GET",
"name" : "maildistribution",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Early SMTP reject count statistic (RBL, PREGREET rejects with postscreen)",
"method" : "GET",
"name" : "rejectcount",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "API version details.",
"method" : "GET",
"name" : "version",
projects / pmg-docs.git / commitdiff