RallyHere Docs

Authorizations

RallyHereHTTPBearer

Path Parameters

sandbox_identifier

required

Any of:

string
string

string format: uuid

Sandbox identifier

200

Successful Response

General config about a sandbox that doesn’t have a more appropriate breakdown

object

last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid

last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time

created_timestamp

Timestamp of when the resource was created

string format: date-time

social

Social options

object

friend_limit

Maximum allowed friends per player

integer

default: 100 <= 1000

block_limit

Maximum allowed outgoing blocks per player

integer

default: 100 <= 1000

basic

object

enable_login

Whether or not to enable basic logins

boolean

default: true

anon

object

enable_login

Whether or not to enable anonymous login

boolean

default: true

epic

Epic Online Services options

object

enable_login

Whether or not to enable Epic logins

boolean

default: true

client_id

required

Epic Online Services client ID. Client tokens are validated against this ID

string

product_id

required

Epic Online Services product ID. Client tokens are validated against this ID

string

sandbox_id

required

Epic Online Services sandbox ID. Client tokens are validated against this ID

string

scopes

Epic Online Services scopes to request

Array<string>

default: presence,friends_list,basic_profile unique items

steam

Steam options

object

enable_login

Whether or not to enable Steam

boolean

default: true

wallet_refunds_trigger_ban

Whether or not to ban players who refund their wallet purchases

boolean

default: true

enforce_vac_bans

Whether or not to enforce VAC bans

boolean

default: true

enforce_publisher_bans

Whether or not to enforce publisher bans

boolean

default: true

appid

required

Steam app ID for the game

integer

>= 1

playstation

Playstation options

object

enable_login

Whether or not to enable Playstation logins

boolean

default: true

environment

Currently active Playstation environment to use

string

Allowed values: sp-int prod-qa np

ps4_use_entitlements_v1_api

Whether or not to use the old entitlements API for PS4

boolean

ps5_use_entitlements_v1_api

Whether or not to use the old entitlements API for PS5

boolean

ps4_use_auth_v1_api

Whether or not to use the old auth API for PS4

boolean

ps5_use_auth_v1_api

Whether or not to use the old auth API for PS5

boolean

psn_web_client_id

required

Playstation client ID configured as a “Back Office Server” on DevNet. This is used for OAuth2.0 and the PSN Commerce API

string

commerce_partner_name

Playstation partner name for the PSN Commerce API. This will be provided by Sony during the onboarding process.

string

""

title_ids

Playstation Title IDs that will be running against this environment. These are used for the PSN Commerce API to query transaction data about users for refunds/chargebacks.

Array<string>

default: unique items

ps4_client_id

required

Playstation PS4 client ID. Client tokens are validated against this ID

string

ps5_client_id

required

Playstation PS5 client ID. Client tokens are validated against this ID

string

ps4_v1_portal_token_details_enable

Whether or not to enable the PS4 V1 portal token details

boolean

ps4_v3_portal_token_details_enable

Whether or not to enable the PS4 V3 portal token details

boolean

ps5_v3_portal_token_details_enable

Whether or not to enable the PS5 V3 portal token details

boolean

eu_service_labels

EU Service Labels

Array<integer>

default: unique items

na_service_labels

NA Service Labels

Array<integer>

default: unique items

nintendo

object

environments

required

Nintendo environments

object

dd1

required

Config Values for DD1

object

enable_login

Whether or not to enable Nintendo logins

boolean

default: true

client_id

required

Nintendo client ID. Client tokens are validated against this ID

string

auth_key

required

Nintendo auth key

string

dp1

required

Config Values for DP1

object

enable_login

Whether or not to enable Nintendo logins

boolean

default: true

client_id

required

Nintendo client ID. Client tokens are validated against this ID

string

auth_key

required

Nintendo auth key

string

sd1

required

Config Values for SD1

object

enable_login

Whether or not to enable Nintendo logins

boolean

default: true

client_id

required

Nintendo client ID. Client tokens are validated against this ID

string

auth_key

required

Nintendo auth key

string

sp1

required

Config Values for SP1

object

enable_login

Whether or not to enable Nintendo logins

boolean

default: true

client_id

required

Nintendo client ID. Client tokens are validated against this ID

string

auth_key

required

Nintendo auth key

string

jd1

required

Config Values for JD1

object

enable_login

Whether or not to enable Nintendo logins

boolean

default: true

client_id

required

Nintendo client ID. Client tokens are validated against this ID

string

auth_key

required

Nintendo auth key

string

lp1

required

Config Values for LP1

object

enable_login

Whether or not to enable Nintendo logins

boolean

default: true

client_id

required

Nintendo client ID. Client tokens are validated against this ID

string

auth_key

required

Nintendo auth key

string

active_envs

List of active/enabled nintendo environments for this sandbox

Array<string>

default:

app_id

required

Nintendo app ID. Client tokens are validated against this ID

string

twitch

object

enable_login

Whether or not to enable Twitch logins

boolean

default: true

client_id

required

Twitch client ID. Client tokens are validated against this ID

string

game_id

required

Twitch game ID.

string

amazon

object

enable_login

Whether or not to enable Amazon logins

boolean

default: true

client_id

required

Epic Online Services client ID. Client tokens are validated against this ID

string

scopes

Amazon OAuth scopes to request

Array<string>

default: profile:user_id,games::prime unique items

google

object

enable_login

Whether or not to enable Google logins

boolean

default: true

client_id

required

Google client ID. Client tokens are validated against this ID

string

apple

object

enable_login

Whether or not to enable Apple logins

boolean

default: true

web_client_id

required

Apple web client ID. Client tokens are validated against this ID

string

web_auth_key_id

required

Apple web auth key ID. Client tokens are validated against this ID

string

xbox

object

enable_login

Whether or not to enable Xbox logins

boolean

default: true

web_client_id

required

Xbox Online Services client ID. Client tokens are validated against this ID

string

vivox

object

enable

Whether or not to enable Vivox logins

boolean

default: true

server

required

Vivox server URL (e.g. game_name.vivox.com)

string

key_issuer

required

Vivox key issuer

string

key_time

Number of seconds that vivox tokens last before expiration

integer

default: 60 >= 60

legacy

Options used by legacy systems.  These are not used by the new APIs.

object

allowed_game_versions

Version check used by connection managers for new client/instance connections

string

default: *.*.*.*

eac_enabled

Whether or not to enforce EAC checks for new client connections

boolean

eac_check_ban_status_at_login

Whether or not to check EAC ban status at login

boolean

eac_submit_player_reports

Whether or not to submit player reports to EAC when handling normal player reports

boolean

experiments

List of experiments and if they are enabled. Use K/Vs instead

Array<object>

default:

object

name

required

Name of the feature

string

enabled

required

Whether or not the feature is enabled

boolean

game_bits

List of game bits to enable. Use K/Vs instead

Array<string>

default: USE_LOCAL_HOME_MAP,CHAT_NOTIFY_CHANGES,CLAN_CAN_CHANGE_SITEID,GLOBAL_SERVER_DB,USE_SPECTATOR,GB_ALLOW_LIVE_SPECTATE

Allowed values: DISABLE_FTP SERVICE_MODE DISABLE_PRIVATE_PROFILE NO_STORE NO_DYNAMIC_STAT_FLAGS USE_LOCAL_HOME_MAP DEMO_MODE ALWAYS_DELAY_LOGOFF PING_CHECK USE_MAP_CACHING NO_STANDALONE_PLAY CHAT_NOTIFY_CHANGES GAME_DOES_LOCAL_TEAMS MATCH_DOES_LOCAL_TEAMS CLAN_CAN_CHANGE_SITEID USE_NO_AI_DISCONNECT USE_ALT_UI USE_VA_DEBUG USE_SIMULATOR DENY_ALL_CLIENT_AUTHS USE_ALT_QUEUE_UI NO_LANDING_PANEL NO_FORCED_BASIC_TUTORIAL RECOMMEND_TRAINING_ONLY ENABLE_UPCOMING_FEATURES GUARD_PORTAL_PURCHASES USE_SPECTATOR GB_ALLOW_LIVE_SPECTATE GB_ENABLE_PALADINS_NEW_ML GB_USE_REAL_MONEY_BREAKPOINT FRIEND_REFERRAL_UI NO_WISDOM_TAB NO_PLAYER_QUESTS NO_DAILY_REWARDS DISABLE_ACTIVITY_FEED USE_NEW_ITEM_VENDOR GLOBAL_SERVER_DB

max_party_size

Maximum number of players allowed in a party

integer

default: 10 >= 1

max_party_info_count

Maximum number of party info entries allowed per party

integer

default_map_game_id

Default map game ID to return to when leaving a match

integer

default: 1 >= 1

game_id

Game ID to use for the game

integer

inventory_custom_data_item_legacy_type_field

Field name of the property in custom data that maps legacy item type to the fields in Inventory APIs.

string

default: item_legacy_type

inventory_custom_data_item_legacy_subtype_field

Field name of the property in custom data that maps legacy item subtype to the fields in Inventory APIs

string

default: item_legacy_subtype

inventory_custom_data_vendor_legacy_type_field

Field name of the property in custom data that maps legacy vendortype to the fields in Inventory APIs.

string

default: vendor_legacy_type

default_role_id

Default role ID for players without a role

string

>= 1 characters

inventory_always_owned_items

List of items that are always owned by players

Array<object>

default:

object

item_id

required

Item ID for the always owned item

string format: uuid

legacy_item_id

Legacy item ID for the always owned item

integer

inventory_session_loot

(Deprecated) List of loot IDs to grant to players when they start a new inventory session

Array<string>

default:

inventory_session_loot_v2

List of inventory session loot associated with this config

Array<object>

default:

object

loot_id

required

Loot ID for the reward tied to the player session

string format: uuid

allow_client_to_update_inventory

Whether or not to allow the client source to update inventory

boolean

email_reward_loot

(Deprecated) List of loot IDs to grant to players when they have an email

Array<string>

default:

email_reward_loot_v2

List of loot IDs to grant to players when they have an email

Array<object>

default:

object

loot_id

required

Loot ID granted to players when they have an email

string format: uuid

coupon_enable

Are coupons allowed to be used for purchasing Loot?

boolean

default: true

coupon_vendor_id

Vendor ID that lists all enabled coupons

string

legacy_id_generation

Options used to effect how IDs are generated to help bridge the gap between the legacy int based IDs and the new UUID based IDs.
These options will not be supported in the future and it is recommended to stop using anything but UUID4 as soon as possible.

object

vendor

How to generate Vendor IDs

string