CRCON API
There is an API for CRCON available at http://(your VPS IP):8010/api/
You'll find a list of endpoints and related documentation at http://(your VPS IP):8010/api/get_api_documentation
You can generate an API token through the Admin interface at Login to the Admin interface at http://(your VPS IP):8010/admin
Note
You don't have to create a user, you can use the admin account. However, if you wish to control an API key's permissions, you need to create a user and apply those permissions to the user and then generate an API key for the user.
Create new User with permissions you wish for the API key to have.
- Login to the Admin interface at
http://(your VPS IP):8010/admin - Click '+Add' next to users
- Enter Username and Password and Click
Save and continue editing
- The password can be random and forgotten, SteamID not required.
- Ensure that the account has the
Activecheckbox checked.
- Provide Permission to User via Permissions
- You can give specific permissions to each user via the Permissions Section or Groups.
- Login to the Admin interface at
http://(your VPS IP):8010/admin - Click
+Addnext toDjango API Keys
[!IMPORTANT]
The next step the API key will be provided, make sure you copy this down and save it. You will not see it again.
- Fill out API Details and click
Save
- Select the User for the API Key.
- Add Notes (great for tracking API keys)
You can access them through the various endpoints available at http://(your VPS IP):8010/api/ most of which require authentication.
You must generate an API token through the CRCON Admin interface.
curl https://(your VPS IP):8010/api/get_map_rotation -H "Authorization: Bearer <django-api-token>"
curl -X POST https://(your VPS IP):8010/api/get_historical_logs -H "Authorization: Bearer <django-api-token>" -d '{"log_type":"KILL", "limit":9999}'
curl -X POST https://(your VPS IP):8010/api/get_gamestate -H "Authorization: Bearer <django-api-token>"
import requests
headers = {
"Authorization": "bearer 12345678-your-api-token-123456789",
"Connection": "keep-alive",
"Content-Type": "application/json"
}
data_request={
"player": "ThisGuy",
"steam_id_64": "765611981123456952",
"message": "test"
}
foo = requests.post("http://(your VPS IP):8010/api/do_message_player", data=json.dumps(data_request), headers=headers)
From emathey on Discord
I believe it is currently coded to only accept POST requests because historically that's what it's accepted, on an unreleased branch it accepts both
The following is the output of the /get_api_documentation
{
"result": [
{
"endpoint": "add_admin",
"arguments": {
"player_id": {
"default": null,
"annotation": null
},
"role": {
"default": null,
"annotation": null
},
"description": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "add_blacklist_record",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
},
"blacklist_id": {
"default": null,
"annotation": "<class 'int'>"
},
"reason": {
"default": null,
"annotation": "<class 'str'>"
},
"expires_at": {
"default": "None",
"annotation": "datetime.datetime | None"
},
"admin_name": {
"default": "",
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'rcon.types.BlacklistType'>",
"doc_string": "Adds a new record to a blacklist.\n\nBlacklists are collections of ban-like records stored by CRCON\nto provide greater flexibility and scalability.\n\nArgs:\n player_id: steam_id_64 or windows store ID to blacklist\n blacklist_id: The ID of the blacklist to use\n reason: The reason the player was blacklisted for\n expires_at: When the blacklist should expire, if ever\n admin_name: The person/tool that is blacklisting the player",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "add_map_to_rotation",
"arguments": {
"map_name": {
"default": null,
"annotation": "<class 'str'>"
},
"after_map_name": {
"default": "None",
"annotation": "str | None"
},
"after_map_name_number": {
"default": "None",
"annotation": "int | None"
}
},
"return_type": "<class 'str'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "add_map_to_votemap_whitelist",
"arguments": {
"map_name": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "add_maps_to_rotation",
"arguments": {
"map_names": {
"default": null,
"annotation": "list[str]"
}
},
"return_type": "list[tuple[str, str]]",
"doc_string": "Add the given maps to the rotation, returns the game server response for each map",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "add_maps_to_votemap_whitelist",
"arguments": {
"map_names": {
"default": null,
"annotation": "typing.Iterable[str]"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "add_vip",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
},
"description": {
"default": null,
"annotation": "<class 'str'>"
},
"expiration": {
"default": "None",
"annotation": "str | None"
}
},
"return_type": "<class 'str'>",
"doc_string": "Adds VIP status on the game server and adds or updates their PlayerVIP record.",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "ban_profanities",
"arguments": {
"profanities": {
"default": null,
"annotation": "list[str]"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "clear_cache",
"arguments": {},
"return_type": "<class 'bool'>",
"doc_string": "Clear every key in this servers Redis cache and return number of deleted keys\n\nMany things in CRCON are cached in Redis to avoid excessively polling\nthe game server, this clears the entire cache which is sometimes necessary\nto force a refresh",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "create_blacklist",
"arguments": {
"name": {
"default": null,
"annotation": "<class 'str'>"
},
"sync": {
"default": "BlacklistSyncMethod.KICK_ONLY",
"annotation": "<enum 'BlacklistSyncMethod'>"
},
"servers": {
"default": "None",
"annotation": "typing.Optional[typing.Sequence[int]]"
}
},
"return_type": null,
"doc_string": "Creates a new, empty blacklist.\n\nBlacklists are collections of ban-like records stored by CRCON\nto provide greater flexibility and scalability.\n\nArgs:\n name:\n Name for the list\n sync:\n Method to use for synchronizing an active record with the\n game server. See `BlacklistSyncMethod` for more details.\n servers:\n A sequence of server numbers which this blacklist will\n apply to. `None` means all servers.",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "delete_blacklist",
"arguments": {
"blacklist_id": {
"default": null,
"annotation": "<class 'int'>"
}
},
"return_type": null,
"doc_string": "Removes a blacklist alongside all of its records.\n\nBlacklists are collections of ban-like records stored by CRCON\nto provide greater flexibility and scalability.\n\nArgs:\n blacklist_id: The ID of the blacklist",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "delete_blacklist_record",
"arguments": {
"record_id": {
"default": null,
"annotation": "<class 'int'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": "Removes a blacklist record.\n\nBlacklists are collections of ban-like records stored by CRCON\nto provide greater flexibility and scalability.\n\nArgs:\n record_id: The ID of the record",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "describe_admin_pings_discord_webhooks_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_audit_discord_webhooks_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_auto_broadcasts_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_auto_mod_level_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_auto_mod_no_leader_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_auto_mod_seeding_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_auto_mod_solo_tank_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_camera_discord_webhooks_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_camera_notification_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_chat_commands_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_chat_discord_webhooks_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_expired_vip_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_kills_discord_webhooks_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_log_line_webhook_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_log_stream_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_name_kick_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_rcon_connection_settings_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_rcon_server_settings_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_real_vip_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_scorebot_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_server_name_change_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_standard_broadcast_messages",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_standard_punishments_messages",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_standard_welcome_messages",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_steam_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_tk_ban_on_connect_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_vac_game_bans_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_votekick_autotoggle_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_votemap_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "describe_watchlist_discord_webhooks_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "do_service",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "download_vips",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "edit_blacklist",
"arguments": {
"blacklist_id": {
"default": null,
"annotation": "<class 'int'>"
},
"name": {
"default": "MISSING",
"annotation": "<class 'str'>"
},
"sync_method": {
"default": "MISSING",
"annotation": "<enum 'BlacklistSyncMethod'>"
},
"servers": {
"default": "MISSING",
"annotation": "typing.Optional[typing.Sequence[int]]"
}
},
"return_type": null,
"doc_string": "Edits a blacklist.\n\nBlacklists are collections of ban-like records stored by CRCON\nto provide greater flexibility and scalability.\n\nArgs:\n blacklist_id: The ID of the blacklist\n name: What to name the blacklist\n sync: Method to use for synchronizing records with the game\n servers: List of server numbers this blacklist applies to. `None` means all.",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "edit_blacklist_record",
"arguments": {
"record_id": {
"default": null,
"annotation": "<class 'int'>"
},
"blacklist_id": {
"default": "MISSING",
"annotation": "<class 'int'>"
},
"reason": {
"default": "MISSING",
"annotation": "<class 'str'>"
},
"expires_at": {
"default": "MISSING",
"annotation": "datetime.datetime | None"
}
},
"return_type": "<class 'bool'>",
"doc_string": "Edits a blacklist record.\n\nBlacklists are collections of ban-like records stored by CRCON\nto provide greater flexibility and scalability.\n\nThe blacklisted player ID cannot be edited. You instead need to\ndelete this record and create a new one.\n\nArgs:\n record_id: The ID of the record\n blacklist_id: The ID of the blacklist this record should be part of\n reason: The reason the player was blacklisted for\n expires_at: When the blacklist should expire, if ever",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "flag_player",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
},
"flag": {
"default": null,
"annotation": "<class 'str'>"
},
"player_name": {
"default": "None",
"annotation": "str | None"
},
"comment": {
"default": "None",
"annotation": "str | None"
}
},
"return_type": "<class 'rcon.types.PlayerFlagType'>",
"doc_string": "Adds a new flag to the specified player_id\n\nFlags are used to label users and some tools use the flags to whitelist\nusers. They are traditionally an emoji (the frontend uses an emoji picker)\nbut there is no length restriction in the database.\n\nArgs:\n player_id: steam_id_64 or windows store ID\n player_name: The players name which will be added as an alias\n flag:\n comment:",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "get_admin_groups",
"arguments": {},
"return_type": "list[str]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_admin_ids",
"arguments": {},
"return_type": "list[rcon.types.AdminType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_admin_pings_discord_webhooks_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.webhooks.AdminPingWebhooksUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_all_discord_webhooks_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_all_standard_message_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_audit_discord_webhooks_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.webhooks.AuditWebhooksUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_audit_logs",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_audit_logs_autocomplete",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_auto_broadcasts_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.auto_broadcast.AutoBroadcastUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_auto_mod_level_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.auto_mod_level.AutoModLevelUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_auto_mod_no_leader_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.auto_mod_no_leader.AutoModNoLeaderUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_auto_mod_seeding_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.auto_mod_seeding.AutoModSeedingUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_auto_mod_solo_tank_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.auto_mod_solo_tank.AutoModNoSoloTankUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_auto_settings",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_autobalance_enabled",
"arguments": {},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_autobalance_threshold",
"arguments": {},
"return_type": "<class 'int'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_ban",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "list[rcon.types.GameServerBanType]",
"doc_string": "get all bans from player_id\n@param player_id: steam_id_64 or windows store ID of a user\n@return: a array of bans",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_bans",
"arguments": {},
"return_type": "list[rcon.types.GameServerBanType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_blacklist",
"arguments": {
"blacklist_id": {
"default": null,
"annotation": "<class 'int'>"
}
},
"return_type": "<class 'rcon.types.BlacklistWithRecordsType'>",
"doc_string": "Get a blacklist and its respective records.\n\nBlacklists are collections of ban-like records stored by CRCON\nto provide greater flexibility and scalability.\n\nArgs:\n blacklist_id: The ID of the blacklist",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_blacklist_records",
"arguments": {
"player_id": {
"default": "None",
"annotation": "<class 'str'>"
},
"reason": {
"default": "None",
"annotation": "<class 'str'>"
},
"blacklist_id": {
"default": "None",
"annotation": "<class 'int'>"
},
"exclude_expired": {
"default": "False",
"annotation": "<class 'bool'>"
},
"page_size": {
"default": "50",
"annotation": "<class 'int'>"
},
"page": {
"default": "1",
"annotation": "<class 'int'>"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_blacklists",
"arguments": {},
"return_type": "list[rcon.types.BlacklistType]",
"doc_string": "Get all blacklists.\n\nBlacklists are collections of ban-like records stored by CRCON\nto provide greater flexibility and scalability.",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_broadcast_message",
"arguments": {},
"return_type": "str | bytes | None",
"doc_string": "Returns the current broadcast message if the cache is set\n\nThere is no RCON command to get the current broadcast message so it can only\nbe retrieved if it was set by CRCON and the cache has not expired",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_camera_discord_webhooks_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.webhooks.CameraWebhooksUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_camera_notification_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.camera_notification.CameraNotificationUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_chat_commands_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_chat_discord_webhooks_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.webhooks.ChatWebhooksUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_connection_info",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_current_map_sequence",
"arguments": {},
"return_type": "list[str]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_date_scoreboard",
"arguments": {
"start": {
"default": null,
"annotation": "<class 'int'>"
},
"end": {
"default": null,
"annotation": "<class 'int'>"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_detailed_player_info",
"arguments": {
"player_name": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'rcon.types.GetDetailedPlayer'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_detailed_players",
"arguments": {},
"return_type": "<class 'rcon.types.GetDetailedPlayers'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_expired_vip_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.expired_vips.ExpiredVipsUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_gamestate",
"arguments": {},
"return_type": "<class 'rcon.types.GameState'>",
"doc_string": "Returns player counts, team scores, remaining match time and current/next map\n\nPlayers: Allied: 0 - Axis: 1\nScore: Allied: 2 - Axis: 2\nRemaining Time: 0:11:51\nMap: foy_warfare\nNext Map: stmariedumont_warfare",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_historical_logs",
"arguments": {
"player_name": {
"default": "None",
"annotation": "str | None"
},
"player_id": {
"default": "None",
"annotation": "str | None"
},
"action": {
"default": "None",
"annotation": "str | None"
},
"limit": {
"default": "1000",
"annotation": "<class 'int'>"
},
"from_": {
"default": "None",
"annotation": "datetime.datetime | None"
},
"till": {
"default": "None",
"annotation": "datetime.datetime | None"
},
"time_sort": {
"default": "desc",
"annotation": "typing.Literal['desc', 'asc']"
},
"exact_player_match": {
"default": "False",
"annotation": "<class 'bool'>"
},
"exact_action": {
"default": "True",
"annotation": "<class 'bool'>"
},
"server_filter": {
"default": "None",
"annotation": "str | None"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET",
"POST"
]
},
{
"endpoint": "get_historical_logs_csv",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET",
"POST"
]
},
{
"endpoint": "get_idle_autokick_time",
"arguments": {},
"return_type": "<class 'int'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_ingame_mods",
"arguments": {},
"return_type": "list[rcon.types.AdminUserType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_kills_discord_webhooks_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_live_game_stats",
"arguments": {},
"return_type": null,
"doc_string": "Return stats for the currently playing match",
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_live_scoreboard",
"arguments": {},
"return_type": null,
"doc_string": "Return stats for all currently connected players (stats are reset on disconnect, not match start)",
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_log_line_webhook_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.log_line_webhooks.LogLineWebhookUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_log_stream_config",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_logs",
"arguments": {
"since_min_ago": {
"default": null,
"annotation": "str | int"
},
"filter_": {
"default": "",
"annotation": "<class 'str'>"
},
"by": {
"default": "",
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'str'>",
"doc_string": "Returns raw text logs from the game server with no parsing performed\n\nYou most likely want to use a different method/endpoint to get parsed logs.",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_map",
"arguments": {},
"return_type": "<class 'rcon.maps.Layer'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_map_history",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_map_rotation",
"arguments": {},
"return_type": "list[rcon.maps.Layer]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_map_scoreboard",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_map_shuffle_enabled",
"arguments": {},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_maps",
"arguments": {},
"return_type": "list[rcon.maps.Layer]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_max_ping_autokick",
"arguments": {},
"return_type": "<class 'int'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_name",
"arguments": {},
"return_type": "<class 'str'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_name_kick_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.name_kicks.NameKickUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_next_map",
"arguments": {},
"return_type": "<class 'rcon.maps.Layer'>",
"doc_string": "Return the next map in the rotation as determined by the gameserver through the gamestate command",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_objective_row",
"arguments": {
"row": {
"default": null,
"annotation": "<class 'int'>"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_objective_rows",
"arguments": {},
"return_type": "typing.List[typing.List[str]]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_online_mods",
"arguments": {},
"return_type": "list[rcon.types.AdminUserType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_own_user_permissions",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_perma_bans",
"arguments": {},
"return_type": "list[rcon.types.GameServerBanType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_player_comments",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "list[rcon.types.PlayerCommentType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_player_info",
"arguments": {
"player_name": {
"default": null,
"annotation": "<class 'str'>"
},
"can_fail": {
"default": "False",
"annotation": null
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_player_messages",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_player_profile",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
},
"num_sessions": {
"default": "10",
"annotation": "<class 'int'>"
}
},
"return_type": "rcon.types.PlayerProfileTypeEnriched | None",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_playerids",
"arguments": {
"as_dict": {
"default": "False",
"annotation": null
}
},
"return_type": "dict[str, str] | list[tuple[str, str]]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_players",
"arguments": {},
"return_type": "list[rcon.types.GetPlayersType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_players_history",
"arguments": {
"page": {
"default": "1",
"annotation": "<class 'int'>"
},
"page_size": {
"default": "500",
"annotation": "<class 'int'>"
},
"last_seen_from": {
"default": "None",
"annotation": "datetime.datetime | None"
},
"last_seen_till": {
"default": "None",
"annotation": "datetime.datetime | None"
},
"player_id": {
"default": "None",
"annotation": "str | None"
},
"player_name": {
"default": "None",
"annotation": "str | None"
},
"blacklisted": {
"default": "None",
"annotation": "bool | None"
},
"is_watched": {
"default": "None",
"annotation": "bool | None"
},
"exact_name_match": {
"default": "False",
"annotation": "<class 'bool'>"
},
"ignore_accent": {
"default": "True",
"annotation": "<class 'bool'>"
},
"flags": {
"default": "None",
"annotation": "str | list[str] | None"
},
"country": {
"default": "None",
"annotation": "str | None"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET",
"POST"
]
},
{
"endpoint": "get_previous_map",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_profanities",
"arguments": {},
"return_type": "list[str]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_public_info",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_queue_length",
"arguments": {},
"return_type": "<class 'int'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_rcon_connection_settings_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.rcon_connection_settings.RconConnectionSettingsUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_rcon_server_settings_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.rcon_server_settings.RconServerSettingsUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_real_vip_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.real_vip.RealVipUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_recent_logs",
"arguments": {
"filter_player": {
"default": "[]",
"annotation": "list[str] | str"
},
"filter_action": {
"default": "[]",
"annotation": "list[str]"
},
"inclusive_filter": {
"default": "True",
"annotation": "<class 'bool'>"
},
"start": {
"default": "0",
"annotation": "<class 'int'>"
},
"end": {
"default": "10000",
"annotation": "<class 'int'>"
},
"exact_player_match": {
"default": "True",
"annotation": "<class 'bool'>"
},
"exact_action": {
"default": "False",
"annotation": "<class 'bool'>"
}
},
"return_type": "<class 'rcon.types.ParsedLogsType'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET",
"POST"
]
},
{
"endpoint": "get_round_time_remaining",
"arguments": {},
"return_type": "<class 'float'>",
"doc_string": "Returns the amount of time left in the round as seconds",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_scoreboard_maps",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_scorebot_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.scorebot.ScorebotUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_server_list",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_server_name_change_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.gtx_server_name.GtxServerNameChangeUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_server_settings",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_services",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_slots",
"arguments": {},
"return_type": "<class 'rcon.types.SlotsType'>",
"doc_string": "Return the current number of connected players and max players allowed",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_standard_broadcast_messages",
"arguments": {},
"return_type": "<class 'rcon.user_config.standard_messages.StandardBroadcastMessagesUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_standard_punishments_messages",
"arguments": {},
"return_type": "<class 'rcon.user_config.standard_messages.StandardPunishmentMessagesUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_standard_welcome_messages",
"arguments": {},
"return_type": "<class 'rcon.user_config.standard_messages.StandardWelcomeMessagesUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_status",
"arguments": {},
"return_type": "<class 'rcon.types.StatusType'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_steam_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.steam.SteamUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_structured_logs",
"arguments": {
"since_min_ago": {
"default": null,
"annotation": "<class 'int'>"
},
"filter_action": {
"default": "None",
"annotation": "str | None"
},
"filter_player": {
"default": "None",
"annotation": "str | None"
}
},
"return_type": "<class 'rcon.types.ParsedLogsType'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_team_objective_scores",
"arguments": {},
"return_type": "tuple[int, int]",
"doc_string": "Returns the number of objectives held by the allied/axis team respectively",
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_team_switch_cooldown",
"arguments": {},
"return_type": "<class 'int'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_team_view",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_temp_bans",
"arguments": {},
"return_type": "list[rcon.types.GameServerBanType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_tk_ban_on_connect_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.ban_tk_on_connect.BanTeamKillOnConnectUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_vac_game_bans_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.vac_game_bans.VacGameBansUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_version",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_vip_ids",
"arguments": {},
"return_type": "list[rcon.types.VipIdType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_vip_slots_num",
"arguments": {},
"return_type": "<class 'int'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_vips_count",
"arguments": {},
"return_type": "<class 'int'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_votekick_autotoggle_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.auto_kick.AutoVoteKickUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_votekick_enabled",
"arguments": {},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_votekick_thresholds",
"arguments": {},
"return_type": "list[tuple[int, int]]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_votemap_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.vote_map.VoteMapUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_votemap_status",
"arguments": {},
"return_type": "list[rcon.types.VoteMapStatusType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_votemap_whitelist",
"arguments": {},
"return_type": "list[str]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_watchlist_discord_webhooks_config",
"arguments": {},
"return_type": "<class 'rcon.user_config.webhooks.WatchlistWebhooksUserConfig'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "get_welcome_message",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "is_logged_in",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "kick",
"arguments": {
"player_name": {
"default": null,
"annotation": null
},
"reason": {
"default": null,
"annotation": null
},
"by": {
"default": null,
"annotation": null
},
"player_id": {
"default": "None",
"annotation": "str | None"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "login",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "logout",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET",
"POST"
]
},
{
"endpoint": "message_player",
"arguments": {
"player_name": {
"default": "None",
"annotation": null
},
"player_id": {
"default": "None",
"annotation": null
},
"message": {
"default": "",
"annotation": "<class 'str'>"
},
"by": {
"default": "",
"annotation": "<class 'str'>"
},
"save_message": {
"default": "False",
"annotation": "<class 'bool'>"
}
},
"return_type": "<class 'str'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "perma_ban",
"arguments": {
"player_name": {
"default": "None",
"annotation": null
},
"player_id": {
"default": "None",
"annotation": null
},
"reason": {
"default": "",
"annotation": null
},
"by": {
"default": "",
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "post_player_comment",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
},
"comment": {
"default": null,
"annotation": "<class 'str'>"
},
"by": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "punish",
"arguments": {
"player_name": {
"default": null,
"annotation": "<class 'str'>"
},
"reason": {
"default": null,
"annotation": "<class 'str'>"
},
"by": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "reconnect_gameserver",
"arguments": {},
"return_type": null,
"doc_string": "Restart gunicorn workers which reconnects Rcon endpoint instances",
"auto_settings_capable": false,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "remove_admin",
"arguments": {
"player_id": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "remove_all_vips",
"arguments": {},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "remove_map_from_rotation",
"arguments": {
"map_name": {
"default": null,
"annotation": "<class 'str'>"
},
"map_number": {
"default": "None",
"annotation": "int | None"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "remove_map_from_votemap_whitelist",
"arguments": {
"map_name": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "remove_maps_from_rotation",
"arguments": {
"map_names": {
"default": null,
"annotation": "list[str]"
}
},
"return_type": "typing.Literal['SUCCESS']",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "remove_maps_from_votemap_whitelist",
"arguments": {
"map_names": {
"default": null,
"annotation": "typing.Iterable[str]"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "remove_perma_ban",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": "Remove a perma ban by ban log. Note that a player ID is a valid ban log.",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "remove_temp_ban",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": "Remove a temp ban by player ID or game server ban log",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "remove_vip",
"arguments": {
"player_id": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": "Removes VIP status on the game server and removes their PlayerVIP record.",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "reset_map_votemap_whitelist",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "reset_votekick_thresholds",
"arguments": {},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "reset_votemap_state",
"arguments": {},
"return_type": "list[rcon.types.VoteMapStatusType]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "run_raw_command",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET",
"POST"
]
},
{
"endpoint": "set_admin_pings_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_audit_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_auto_broadcasts_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_auto_mod_level_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_auto_mod_no_leader_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_auto_mod_seeding_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"user_config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_auto_mod_solo_tank_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_auto_settings",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_autobalance_enabled",
"arguments": {
"value": {
"default": null,
"annotation": "<class 'bool'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_autobalance_threshold",
"arguments": {
"max_diff": {
"default": null,
"annotation": "<class 'int'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_broadcast",
"arguments": {
"message": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'str'>",
"doc_string": "Set the in game broadcast message and return the previous message if set",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_camera_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_camera_notification_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_chat_commands_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_chat_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_expired_vip_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_game_layout",
"arguments": {
"objectives": {
"default": null,
"annotation": "typing.Sequence[str | int | None]"
},
"random_constraints": {
"default": "0",
"annotation": "<flag 'GameLayoutRandomConstraints'>"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_idle_autokick_time",
"arguments": {
"minutes": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_kills_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_log_line_webhook_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_log_stream_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_map",
"arguments": {
"map_name": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "None",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_map_shuffle_enabled",
"arguments": {
"enabled": {
"default": null,
"annotation": "<class 'bool'>"
}
},
"return_type": "None",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_maprotation",
"arguments": {
"map_names": {
"default": null,
"annotation": "list[str]"
}
},
"return_type": "list[rcon.maps.Layer]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_max_ping_autokick",
"arguments": {
"max_ms": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_name_kick_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_profanities",
"arguments": {
"profanities": {
"default": null,
"annotation": "list[str]"
}
},
"return_type": "list[str]",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_queue_length",
"arguments": {
"value": {
"default": null,
"annotation": "<class 'int'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_rcon_connection_settings_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_rcon_server_settings_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_real_vip_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_scorebot_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_server_name",
"arguments": {
"name": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_server_name_change_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_standard_broadcast_messages",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_standard_punishments_messages",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_standard_welcome_messages",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_steam_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_team_switch_cooldown",
"arguments": {
"minutes": {
"default": null,
"annotation": "<class 'int'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_tk_ban_on_connect_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_vac_game_bans_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_vip_slots_num",
"arguments": {
"value": {
"default": null,
"annotation": "<class 'int'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_votekick_autotoggle_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_votekick_enabled",
"arguments": {
"value": {
"default": null,
"annotation": "<class 'bool'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_votekick_thresholds",
"arguments": {
"threshold_pairs": {
"default": null,
"annotation": "list[tuple[int, int]]"
}
},
"return_type": "str | bool",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_votemap_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_votemap_whitelist",
"arguments": {
"map_names": {
"default": null,
"annotation": "typing.Iterable[str]"
}
},
"return_type": null,
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_watchlist_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "set_welcome_message",
"arguments": {
"message": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'str'>",
"doc_string": "Set the in game welcome (rules) message and return the previous message if set",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "switch_player_now",
"arguments": {
"player_name": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "switch_player_on_death",
"arguments": {
"player_name": {
"default": null,
"annotation": null
},
"by": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "temp_ban",
"arguments": {
"player_name": {
"default": "None",
"annotation": "str | None"
},
"player_id": {
"default": "None",
"annotation": "str | None"
},
"duration_hours": {
"default": "2",
"annotation": "<class 'int'>"
},
"reason": {
"default": "",
"annotation": "<class 'str'>"
},
"by": {
"default": "",
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "unban",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": "Remove all temporary and permanent bans from the player_id.\n\nThis does not remove any blacklists, meaning the player may be immediately banned\nagain. To remove any bans or blacklists, use `unblacklist_player` instead.\n\nArgs:\n player_id: steam_id_64 or windows store ID",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "unban_profanities",
"arguments": {
"profanities": {
"default": null,
"annotation": "list[str]"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "unblacklist_player",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": "Expires all blacklists of a player and unbans them from all servers.\n\nArgs:\n player_id: steam_id_64 or windows store ID",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "unflag_player",
"arguments": {
"flag_id": {
"default": "None",
"annotation": "int | None"
},
"player_id": {
"default": "None",
"annotation": "str | None"
},
"flag": {
"default": "None",
"annotation": "str | None"
}
},
"return_type": "<class 'rcon.types.PlayerFlagType'>",
"doc_string": "Flags can be removed either by flag_id (database key) or by passing a player ID and flag\n\nArgs:\n flag_id: The database primary key of the flag record to delete\n player_id: steam_id_64 or windows store ID\n flag: The flag to remove from `player_id` if present",
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "unwatch_player",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "upload_vips",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "upload_vips_result",
"arguments": {},
"return_type": null,
"doc_string": null,
"auto_settings_capable": false,
"allowed_http_methods": [
"GET"
]
},
{
"endpoint": "validate_admin_pings_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_audit_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_auto_broadcasts_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_auto_mod_level_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_auto_mod_no_leader_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_auto_mod_seeding_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_auto_mod_solo_tank_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_camera_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_camera_notification_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_chat_commands_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_chat_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_expired_vip_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_kills_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_log_line_webhook_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_log_stream_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_name_kick_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_rcon_connection_settings_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_rcon_server_settings_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_real_vip_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_scorebot_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_server_name_change_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_standard_broadcast_messages",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_standard_punishments_messages",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_standard_welcome_messages",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_steam_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_tk_ban_on_connect_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_vac_game_bans_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_votekick_autotoggle_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_votemap_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "validate_watchlist_discord_webhooks_config",
"arguments": {
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"config": {
"default": "None",
"annotation": "dict[str, typing.Any] | rcon.user_config.utils.BaseUserConfig | None"
},
"reset_to_default": {
"default": "False",
"annotation": "<class 'bool'>"
},
"kwargs": {
"default": null,
"annotation": null
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
},
{
"endpoint": "watch_player",
"arguments": {
"player_id": {
"default": null,
"annotation": "<class 'str'>"
},
"reason": {
"default": null,
"annotation": "<class 'str'>"
},
"by": {
"default": null,
"annotation": "<class 'str'>"
},
"player_name": {
"default": "None",
"annotation": "str | None"
}
},
"return_type": "<class 'bool'>",
"doc_string": null,
"auto_settings_capable": true,
"allowed_http_methods": [
"POST"
]
}
],
"command": "get_api_documentation",
"arguments": null,
"failed": false,
"error": null,
"forwards_results": null,
"version": "v10.3.0"
}