minimusdocs
Help center

Connections

Block an address

POST/streams/blocked-ips/

manage Delete and money: deletes, credits, servers or panel settings. Scopes

Blocks an address, a block (203.0.113.0/24) or a range (a-b), for duration or until expires_at. Refused when it covers your own address or a server of the panel, or when a wider block holds it already. When that very entry is blocked already the answer is 409 with it: send replace: true to change it. Connections from inside it are ended.

Body

  • addressstringrequired
  • reasonstring
  • durationstring

    Default: "forever"

  • expires_atstring (date-time)can be null
  • replaceboolean

    Default: false

Response

200 The existing block was changed (replace).

  • blocksobject[]required
    • idintegerrequiredread-only
    • networkstringrequiredread-only

      One address (203.0.113.7/32), a block of them in CIDR form (198.51.100.0/24, 2001:db8::/48) or a range (198.51.100.10-198.51.100.20), as the panel normalised it.

    • addressstringrequiredread-only

      How the panel shows it: a lone address without its /32 or /128, a range with a dash.

    • reasonstringrequiredread-only

      Optional note shown in the admin / panel (e.g. "abusive restreamer").

    • expires_atstring (date-time)requiredread-onlycan be null

      Empty: blocked until removed. Past this moment the block no longer applies.

    • triggerstringrequiredread-only

      Empty: blocked by hand. Otherwise what the panel saw from this address (Settings → Security → Attack protection).

      • signin - Failed sign-ins
      • guess - Wrong passwords
      • flood - Too many requests
    • timesintegerrequiredread-only

      How many times in a row it was blocked automatically. Each time it comes back within a day of its last block, the block lasts twice as long.

    • endedbooleanrequiredread-only
    • lifted_atstring (date-time)requiredread-onlycan be null

      An automatic block someone removed before its end: when. It stays listed a week, and the address is not blocked again for a short while.

    • lifted_by_usernamestringrequiredread-only
    • created_by_usernamestringrequiredread-only
    • created_atstring (date-time)requiredread-only
  • sessions_endedintegerrequired

    Connections ended from inside it.

201 Blocked.

  • blocksobject[]required
    • idintegerrequiredread-only
    • networkstringrequiredread-only

      One address (203.0.113.7/32), a block of them in CIDR form (198.51.100.0/24, 2001:db8::/48) or a range (198.51.100.10-198.51.100.20), as the panel normalised it.

    • addressstringrequiredread-only

      How the panel shows it: a lone address without its /32 or /128, a range with a dash.

    • reasonstringrequiredread-only

      Optional note shown in the admin / panel (e.g. "abusive restreamer").

    • expires_atstring (date-time)requiredread-onlycan be null

      Empty: blocked until removed. Past this moment the block no longer applies.

    • triggerstringrequiredread-only

      Empty: blocked by hand. Otherwise what the panel saw from this address (Settings → Security → Attack protection).

      • signin - Failed sign-ins
      • guess - Wrong passwords
      • flood - Too many requests
    • timesintegerrequiredread-only

      How many times in a row it was blocked automatically. Each time it comes back within a day of its last block, the block lasts twice as long.

    • endedbooleanrequiredread-only
    • lifted_atstring (date-time)requiredread-onlycan be null

      An automatic block someone removed before its end: when. It stays listed a week, and the address is not blocked again for a short while.

    • lifted_by_usernamestringrequiredread-only
    • created_by_usernamestringrequiredread-only
    • created_atstring (date-time)requiredread-only
  • sessions_endedintegerrequired

    Connections ended from inside it.

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 409
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means