Add a blacklist entry for an IP and/or login. Note that netmask and ip parameters are mutually exclusive.
Provide IP and/or login
| expire_secs | integer |
| ip | string |
| login | string |
| netmask | string |
| reason | string |
{- "expire_secs": 3600,
- "ip": "127.0.0.1",
- "netmask": "2001:503:ba3e::/64",
- "reason": "Is there ever a good reason"
}{- "status": "ok"
}Add a whitelist entry for an IP and/or login. Note that netmask and ip parameters are mutually exclusive.
Provide IP and/or login
| expire_secs | integer |
| ip | string |
| login | string |
| netmask | string |
| reason | string |
{- "expire_secs": 3600,
- "ip": "127.0.0.1",
- "netmask": "2001:503:ba3e::/64",
- "reason": "Is there ever a good reason"
}{- "status": "ok"
}Query whether a login should be allowed
Login Tuple for allow command
object (LTAttrs) | |
| device_id | string |
| login required | string |
| protocol | string Enum: "http" "imap" "pop" "smtp" "mobileapi" |
| pwhash required | string |
| remote required | string |
| tls | boolean |
{- "attrs": {
- "foo": "bar"
}, - "login": "joe.bloggs",
- "protocol": "http",
- "pwhash": "cc04",
- "remote": "192.168.1.2",
- "success": true,
- "tls": true
}{- "msg": "string",
- "r_attrs": {
- "two_factor_required": true
}, - "status": 0
}Extensible mechanism allows custom REST endpoints to be defined - this is an example
Arguments to custom REST endpoint
required | object (LTAttrs) |
{- "attrs": {
- "key": "value"
}
}{- "r_attrs": {
- "two_factor_required": true
}, - "success": true
}Delete a blacklist entry for an IP and/or login. Note that netmask and ip parameters are mutually exclusive.
Provide IP and/or login
| ip | string |
| login | string |
| netmask | string |
{- "ip": "127.0.0.1",
- "netmask": "2001:503:ba3e/64"
}{- "status": "ok"
}Delete a whitelist entry for an IP and/or login. Note that netmask and ip parameters are mutually exclusive.
Provide IP and/or login
| ip | string |
| login | string |
| netmask | string |
{- "ip": "127.0.0.1",
- "netmask": "2001:503:ba3e/64"
}{- "status": "ok"
}{- "bl_entries": [
- {
- "ip": [
- {
- "expiration": "2002-Jan-01 10:00:01",
- "login": "joe.bloggs",
- "reason": "Too many invalid login attempts from greylisted countries"
}
], - "iplogin": [
- {
- "expiration": "2002-Jan-01 10:00:01",
- "login": "joe.bloggs",
- "reason": "Too many invalid login attempts from greylisted countries"
}
], - "login": [
- {
- "expiration": "2002-Jan-01 10:00:01",
- "login": "joe.bloggs",
- "reason": "Too many invalid login attempts from greylisted countries"
}
]
}
]
}Get the db stats for an IP and/or login
Provide IP and/or login
| ip | string |
| login | string |
{- "ip": "127.0.0.1"
}{- "bl_expire": "string",
- "bl_reason": "string",
- "blacklisted": true,
- "key_name": "string",
- "stats": {
- "db_name": {
- "countLogins": 239,
- "diffPassword": 10
}
}, - "whitelisted": true,
- "wl_expire": "string",
- "wl_reason": "string"
}{- "bl_entries": [
- {
- "ip": [
- {
- "expiration": "2002-Jan-01 10:00:01",
- "login": "joe.bloggs",
- "reason": "Too many invalid login attempts from greylisted countries"
}
], - "iplogin": [
- {
- "expiration": "2002-Jan-01 10:00:01",
- "login": "joe.bloggs",
- "reason": "Too many invalid login attempts from greylisted countries"
}
], - "login": [
- {
- "expiration": "2002-Jan-01 10:00:01",
- "login": "joe.bloggs",
- "reason": "Too many invalid login attempts from greylisted countries"
}
]
}
]
}Creates a new report about a login (successful or unsuccessful)
Login Tuple for report command
object (LTAttrs) | |
| device_id | string |
| login required | string |
| policy_reject | boolean |
| protocol | string Enum: "http" "imap" "pop3" "smtp" "mobileapi" |
| pwhash required | string |
| remote required | string |
| success required | boolean |
| tls | boolean |
{- "login": "joe.bloggs",
- "pwhash": "cc04",
- "remote": "192.168.1.2",
- "success": true
}{- "status": "ok"
}Reset the stats and any blacklist entry for an IP and/or login
Provide IP and/or login
| ip | string |
| login | string |
{- "ip": "127.0.0.1"
}{- "status": "ok"
}{- "allows": 120321,
- "commandstats": {
- "addBLEntry": 0,
- "addWLEntry": 1,
- "allow": 8,
- "allow_allowed": 4,
- "allow_blacklisted": 0,
- "allow_denied": 0,
- "allow_tarpitted": 0,
- "allow_whitelisted": 4,
- "delBLEntry": 0,
- "delWLEntry": 0,
- "getBL": 0,
- "getDBStats": 0,
- "getWL": 0,
- "ping": 0,
- "report": 0,
- "reset": 0,
- "stats": 3,
- "syncDBs": 0,
- "syncDone": 0
}, - "customstats": {
- "custom1": 0,
- "custom2": 0
}, - "denieds": 20201,
- "perfstats": {
- "WTR_0_1": 0,
- "WTR_100_1000": 0,
- "WTR_10_100": 0,
- "WTR_1_10": 0,
- "WTR_Slow": 0,
- "WTW_0_1": 1,
- "WTW_100_1000": 0,
- "WTW_10_100": 0,
- "WTW_1_10": 0,
- "WTW_Slow": 0
}, - "reports": 28291,
- "sys-msec": 97211221,
- "user-msec": 292910108
}This is a request to synchronize StatsDBs.
The ip and address to sync to
| callback_auth_pw | string |
| callback_url required | string |
| replication_host required | string |
| replication_port required | integer |
{- "callback_auth_pw": "string",
- "callback_url": "string",
- "replication_host": "string",
- "replication_port": 0
}{- "status": "ok"
}