Unaffiliated

Home Documentation & Help
Steamworks Documentation
IGameServersService Interface
Methods to improve the administration of Steam Game Servers.

NOTE: This is a Service interface, methods in this interface should be called with the input_json parameter.

For more info on how to use the Steamworks Web API please see the Web API Overview.

GetAccountList

GET https://api.steampowered.com/IGameServersService/GetAccountList/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.

Gets a list of game server accounts with their logon tokens

CreateAccount

POST https://api.steampowered.com/IGameServersService/CreateAccount/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
appiduint32The app to use the account for
memostringThe memo to set on the new account

Creates a persistent game server account

SetMemo

POST https://api.steampowered.com/IGameServersService/SetMemo/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The SteamID of the game server to set the memo on
memostringThe memo to set on the new account

This method changes the memo associated with the game server account. Memos do not affect the account in any way. The memo shows up in the GetAccountList response and serves only as a reminder of what the account is used for.

ResetLoginToken

POST https://api.steampowered.com/IGameServersService/ResetLoginToken/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The SteamID of the game server to reset the login token of

Generates a new login token for the specified game server

DeleteAccount

POST https://api.steampowered.com/IGameServersService/DeleteAccount/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The SteamID of the game server account to delete

Deletes a persistent game server account

GetAccountPublicInfo

GET https://api.steampowered.com/IGameServersService/GetAccountPublicInfo/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The SteamID of the game server to get info on

Gets public information about a given game server account

QueryLoginToken

GET https://api.steampowered.com/IGameServersService/QueryLoginToken/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
login_tokenstringLogin token to query

Queries the status of the specified token, which must be owned by you

SetBanStatus

POST https://partner.steam-api.com/IGameServersService/SetBanStatus/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64
bannedbool
ban_secondsuint32

performs a GSLT ban/unban of GSLT associated with a GS. If banning, also bans associated users' GSLTs.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

GetServerSteamIDsByIP

GET https://api.steampowered.com/IGameServersService/GetServerSteamIDsByIP/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
server_ipsstring

Gets a list of server SteamIDs given a list of IPs

GetServerIPsBySteamID

GET https://api.steampowered.com/IGameServersService/GetServerIPsBySteamID/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
server_steamidsuint64

Gets a list of server IP addresses given a list of SteamIDs