Ban a player in every studio game

Optional: applies one ban to every studio game whose group key happens to have universe.user-restriction:write (Open Cloud user restrictions). The platform never asks for that permission; a game whose group key lacks it is skipped and says so. The ban is recorded for the studio’s owners, who can undo it in the panel. The answer says, for each studio game, whether the ban was applied, failed or skipped, and why. A key may make 20 an hour, beyond its per-minute limit (429 after that).

POSTstudio.blockoutgames.com/developer/v1/game/bans

Authorizations

  • Authorizationstringheaderrequired

    Bearer bk_live_…. The game’s API key, from the game’s Developer tab in the studio panel. One key per game.

Body

application/json

  • userIdintegerrequired

  • displayReasonstringrequired

  • privateReasonstringrequired

  • durationSecondsinteger

  • excludeAltAccountsbooleandefault: false

  • bannedByinteger

  • idempotencyKeystring

Response

Recorded, with where it was applied.

  • idstringrequired

  • userIdintegerrequired

  • displayReasonstringrequired

  • privateReasonstringrequired

  • durationSecondsinteger | nullrequired

    Null: until an owner undoes it.

  • excludeAltAccountsbooleanrequired

  • fromUniverseintegerrequired

  • bannedByinteger | nullrequired

  • createdAtstringrequired

    An ISO 8601 date and time, UTC.

  • revokedAtstring | nullrequired

    An ISO 8601 date and time, UTC.

  • targetsobject[]required

    Show child attributes
    • universeIdintegerrequired

    • namestringrequired

    • statestringrequired

      One ofappliedfailedskipped

    • detailstring | nullrequired