Skip to main content
POST
Create ban

Authorizations

Authorization
string
header
required

A workspace API key from Settings › Developer.

Query Parameters

workspace_id
string
required

The workspace: the 24-character ID in its Ankra address, or its UUID.

Body

application/json
player_username
string
required

Who is banned.

ban_reason
string
required

The reason they see.

source
string
required

Where the ban came from, e.g. the game name.

player_roblox_id
integer

The player's Roblox user ID.

private_reason
string

A reason only staff see.

ban_type
string
default:permanent

permanent or temporary.

duration_seconds
integer

How long a temporary ban lasts.

banned_by_username
string

Who banned them.

executor_roblox_user_id
integer

Roblox user ID of whoever did this in game. Recorded as the actor when they are linked to someone in the workspace.

Response

Created.

id
string<uuid>
ban_number
integer
player_username
string
player_roblox_id
integer | null
banned_by_username
string | null
ban_reason
string
source
string
ban_type
string
Example:

"permanent"

duration_seconds
integer | null
is_active
boolean
created_at
string<date-time>