Skip to main content
POST
/
players
/
bans
/
{workspaceId}
cURL
curl --request POST \
  --url https://api.hyra.io/players/bans/{workspaceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "player": "<string>",
  "reason": "<string>",
  "source": "<string>",
  "actor": "<string>"
}
'
{
  "actor": "<string>",
  "victim": "<string>",
  "workspace": "<string>",
  "reason": "<string>",
  "ban_incremental_id": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "removed_by": "<string>",
  "removed_at": "<string>",
  "source": "<string>",
  "_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyra.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspaceId
string
required

Body

application/json
​
player
string
required
​
reason
string
required
​
source
string
required
​
actor
string

Response

200 - application/json

Ban created successfully

Ban created successfully

​
actor
string
required
​
victim
string
required
​
workspace
string
required
​
reason
string
required
​
ban_incremental_id
number
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
removed_by
string
​
removed_at
string
​
source
string
​
_id
string