Version 2.4.8 · latest

CC filters cc-filters

How matched requests are handled: rate limiting or a challenge (JS, slider, captcha and so on).

Pick an endpoint to see its example call on the right.

ProtectionAuthentication: User (some parameters admin only)5 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/cc-filtersList CC filters

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
sortstring Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data
namestring Filter by name substring.
ownerstring platform = platform objects only; tenant = tenant objects only.
Values ["platform","tenant"]
POST/api/v2/cc-filtersCreate CC filter

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
count_keystring Who to count by (rate/challenge): ip = client IP (default, existing behavior); ja4 = TLS fingerprint only, regardless of IP — real visitors sharing the fingerprint are counted together, so it is allowed with the log action only (a rule item with ban/deny is rejected with 422); to punish use ip_ja4 = same IP and same fingerprint combined. Plaintext requests have no fingerprint, so ja4/ip_ja4 fall back to IP. Not used by url_auth (must be ip).
Values ["ip","ja4","ip_ja4"]
desstring Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object).
kindstring Challenge type (required for challenge): js/redirect/slide/captcha/click/delay_jump/rotate/cookie; not used for rate.
maxRequiredinteger Requests allowed within the window.
modestring Required for url_auth: signing scheme. a = ?<sign_arg>=md5(key+path+timestamp)&<time_arg>=timestamp; b = ?<sign_arg>=timestamp-random-uid-md5(path-timestamp-random-uid-key).
Values ["a","b"]
nameRequiredstring Name
per_uri_maxinteger rate: per-URI limit; 0 = unlimited.
sign_argstring Required for url_auth: name of the signature query parameter (letters, digits, underscore, hyphen).
sign_use_maxinteger url_auth: how many times the same signature may be used; 0 = unlimited.
time_argstring Required for url_auth with mode=a: name of the timestamp query parameter; not used with mode=b.
ttl_sinteger Required for url_auth (1 to 2592000): maximum difference in seconds between the signed timestamp and the current time.
typeRequiredstring rate = request rate; challenge = challenge (the type is given by kind); url_auth = URL signature check (the signing key is the site's config.url_auth_salt).
Values ["rate","challenge","url_auth"]
window_sRequiredinteger Counting window in seconds.
GET/api/v2/cc-filters/{id}Get CC filter

Authentication: User (some parameters admin only)

PUT/api/v2/cc-filters/{id}Update CC filter

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
count_keystring Who to count by (rate/challenge): ip = client IP (default, existing behavior); ja4 = TLS fingerprint only, regardless of IP — real visitors sharing the fingerprint are counted together, so it is allowed with the log action only (a rule item with ban/deny is rejected with 422); to punish use ip_ja4 = same IP and same fingerprint combined. Plaintext requests have no fingerprint, so ja4/ip_ja4 fall back to IP. Not used by url_auth (must be ip).
Values ["ip","ja4","ip_ja4"]
desstring Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object).
kindstring Challenge type (required for challenge): js/redirect/slide/captcha/click/delay_jump/rotate/cookie; not used for rate.
maxRequiredinteger Requests allowed within the window.
modestring Required for url_auth: signing scheme. a = ?<sign_arg>=md5(key+path+timestamp)&<time_arg>=timestamp; b = ?<sign_arg>=timestamp-random-uid-md5(path-timestamp-random-uid-key).
Values ["a","b"]
nameRequiredstring Name
per_uri_maxinteger rate: per-URI limit; 0 = unlimited.
sign_argstring Required for url_auth: name of the signature query parameter (letters, digits, underscore, hyphen).
sign_use_maxinteger url_auth: how many times the same signature may be used; 0 = unlimited.
time_argstring Required for url_auth with mode=a: name of the timestamp query parameter; not used with mode=b.
ttl_sinteger Required for url_auth (1 to 2592000): maximum difference in seconds between the signed timestamp and the current time.
typeRequiredstring rate = request rate; challenge = challenge (the type is given by kind); url_auth = URL signature check (the signing key is the site's config.url_auth_salt).
Values ["rate","challenge","url_auth"]
window_sRequiredinteger Counting window in seconds.
DELETE/api/v2/cc-filters/{id}Delete CC filter

Authentication: User (some parameters admin only)

CC filters object

FieldTypeDescription
builtinboolean Built-in object; cannot be deleted.
read-only
count_keystring Who to count by (rate/challenge): ip = client IP (default, existing behavior); ja4 = TLS fingerprint only, regardless of IP — real visitors sharing the fingerprint are counted together, so it is allowed with the log action only (a rule item with ban/deny is rejected with 422); to punish use ip_ja4 = same IP and same fingerprint combined. Plaintext requests have no fingerprint, so ja4/ip_ja4 fall back to IP. Not used by url_auth (must be ip).
Values ["ip","ja4","ip_ja4"]
created_atstring Created at
read-only
desstring Remark; empty if omitted (omitting it on update also clears it, since the update replaces the whole object).
idinteger Record ID
read-only
kindstring Challenge type (required for challenge): js/redirect/slide/captcha/click/delay_jump/rotate/cookie; not used for rate.
maxinteger Requests allowed within the window.
modestring Required for url_auth: signing scheme. a = ?<sign_arg>=md5(key+path+timestamp)&<time_arg>=timestamp; b = ?<sign_arg>=timestamp-random-uid-md5(path-timestamp-random-uid-key).
Values ["a","b"]
namestring Name
per_uri_maxinteger rate: per-URI limit; 0 = unlimited.
sign_argstring Required for url_auth: name of the signature query parameter (letters, digits, underscore, hyphen).
sign_use_maxinteger url_auth: how many times the same signature may be used; 0 = unlimited.
tenant_idinteger Owning tenant; null = platform object (built-in or created by an admin, read-only for tenants).
read-only
time_argstring Required for url_auth with mode=a: name of the timestamp query parameter; not used with mode=b.
ttl_sinteger Required for url_auth (1 to 2592000): maximum difference in seconds between the signed timestamp and the current time.
typestring rate = request rate; challenge = challenge (the type is given by kind); url_auth = URL signature check (the signing key is the site's config.url_auth_salt).
Values ["rate","challenge","url_auth"]
updated_atstring Updated at
read-only
window_sinteger Counting window in seconds.

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command