Skip to main content
GET
/
attack-protection
/
suspicious-ip-throttling
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.attackProtection.suspiciousIpThrottling.get();
}
main();
{
  "enabled": true,
  "shields": [
    "block"
  ],
  "allowlist": [
    "127.0.0.1"
  ],
  "stage": {
    "pre-login": {
      "max_attempts": 100,
      "rate": 864000
    },
    "pre-user-registration": {
      "max_attempts": 50,
      "rate": 1728000
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Suspicious IP throttling configuration successfully retrieved.

​
enabled
boolean

Whether or not suspicious IP throttling attack protections are active.

​
shields
enum<string>[]

Action to take when a suspicious IP throttling threshold is violated. Possible values: block, admin_notification.

Available options:
block,
admin_notification
​
allowlist
(string<ipv4> | string<cidr> | string<ipv6> | string<ipv6_cidr>)[]

List of trusted IP addresses that will not have attack protection enforced against them.

​
stage
object

Holds per-stage configuration options (max_attempts and rate).