minimusdocs
Help center

Connections

List blocked addresses

GET/streams/blocked-ips/

read Read: looks, changes nothing. Scopes

Addresses blocked for everything: the panel and every streaming server. Panel operators only. Blocks that ran out are left out unless include_ended.

Query parameters

  • include_endedboolean

    Also the automatic blocks that ran out, kept a week.

  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    A search term.

  • sourcestring

    Only the blocks the panel placed by itself, or the ones made by hand.

    One of: "auto" "manual"

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]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

Errors

  • 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.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means