Bans (Invite Only)
Create a Player Ban
API Documentation
Activity
- In-Game Tracking
- Users
- Sessions
- GETRetrieve Leaderboard
Order Logging
Staff
Workspace
- GETRetrieve a Workspace
- POSTUpdate a Workspace
- GETList Games
- POSTCreate Game
- DELDelete a Game
- GETList Roles
- POSTCreate a Role
- PUTUpdate Role
- DELDelete a Role
- GETList logbook templates
- GETRetrieve Logbook Template
- POSTCreate a Logbook Template
- PATCHUpdate a Logbook Template
- DELDelete a Logbook Template
- GETRetrieve GApps Config
- POSTSet GApps Service Account
- PATCHUpdate GApps Config
- DELDelete GApps Config
- GETGet Trello Config
- GETGet Trello boards
- POSTSet Trello board
- POSTSet Trello format
- DELDisconnect Trello board
- DELDelete Trello Config
- GETRetrieve Schedules
- POSTCreate a Schedule
- POSTUpdate a Schedule
Trello Integration
Bans (Invite Only)
Connections
Bans (Invite Only)
Create a Player Ban
Create a new ban
POST
/
players
/
bans
/
{workspaceId}
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>",
"removed_by": "<string>",
"removed_at": "<string>",
"ban_incremental_id": 123,
"source": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json
Response
200 - application/json
Ban created successfully
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>",
"removed_by": "<string>",
"removed_at": "<string>",
"ban_incremental_id": 123,
"source": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "<string>"
}