SteamEx v0.2.0-alpha SteamEx.IGameServersService View Source

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.

Link to this section Summary

Functions

Creates a persistent game server account

Deletes a persistent game server account

Gets a list of game server accounts with their logon tokens

Gets public information about a given game server account

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

Gets a list of game servers (new master query server)

Gets a list of server SteamIDs given a list of IPs

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

Generates a new login token for the specified game server

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

Link to this section Functions

Link to this function create_account(access_key, params \\ %{}, headers \\ %{}) View Source

Creates a persistent game server account

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
appiduint32The app to use the account for
memostringThe memo to set on the new account

See other: https://partner.steamgames.com/doc/webapi/IGameServersService#CreateAccount

Link to this function delete_account(access_key, params \\ %{}, headers \\ %{}) View Source

Deletes a persistent game server account

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The SteamID of the game server account to delete

See other: https://partner.steamgames.com/doc/webapi/IGameServersService#DeleteAccount

Link to this function get_account_list(access_key, params, headers \\ %{}) View Source

Gets a list of game server accounts with their logon tokens

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.

See other: https://partner.steamgames.com/doc/webapi/IGameServersService#GetAccountList

Link to this function get_account_public_info(access_key, params \\ %{}, headers \\ %{}) View Source

Gets public information about a given game server account

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The SteamID of the game server to get info on

See other: https://partner.steamgames.com/doc/webapi/IGameServersService#GetAccountPublicInfo

Link to this function get_server_ips_by_steam_id(access_key, params \\ %{}, headers \\ %{}) View Source

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

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
server_steamidsstring

See other: https://partner.steamgames.com/doc/webapi/IGameServersService#GetServerIPsBySteamID

Link to this function get_server_list(access_key, params \\ %{}, headers \\ %{}) View Source

Gets a list of game servers (new master query server)

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.

See other: https://developer.valvesoftware.com/wiki/Talk:Master_Server_Query_Protocol

Link to this function get_server_steam_ids_by_ip(access_key, params \\ %{}, headers \\ %{}) View Source

Gets a list of server SteamIDs given a list of IPs

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
server_ipsstring

See other: https://partner.steamgames.com/doc/webapi/IGameServersService#GetServerSteamIDsByIP

Link to this function query_login_token(access_key, params \\ %{}, headers \\ %{}) View Source

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

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
login_tokenstringLogin token to query

See other: https://partner.steamgames.com/doc/webapi/IGameServersService#QueryLoginToken

Link to this function reset_login_token(access_key \\ %{}, params, headers \\ %{}) View Source

Generates a new login token for the specified game server

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The SteamID of the game server to reset the login token of

See other: https://partner.steamgames.com/doc/webapi/IGameServersService#ResetLoginToken

Link to this function set_memo(access_key, params \\ %{}, headers \\ %{}) View Source

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.

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

See other: https://partner.steamgames.com/doc/webapi/IGameServersService#SetMemo