Get Sandbox Game Config

GET /v1/sandbox/:sandbox_identifier/game-config

Get sandbox game config, requires sandbox:config:view or sandbox:config:edit permissions

Request

Path Parameters

sandbox_identifier anyrequired

Sandbox identifier

Responses

Successful Response

application/json

Schema
Example (from schema)

Schema

last_modified_account_id uuid

Account ID of the user who last modified the resource

last_modified_timestamp date-time

Timestamp of when the resource was last modified

created_timestamp date-time

Timestamp of when the resource was created

social

object

Social options

friend_limit Friend Limit (integer)

Possible values: <= 1000

Default value: 100

Maximum allowed friends per player

block_limit Block Limit (integer)

Possible values: <= 1000

Default value: 100

Maximum allowed outgoing blocks per player

basic

object

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable basic logins

anon

object

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable anonymous login

epic

object

Epic Online Services options

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Epic logins

client_id Client Id (string)required

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

product_id Product Id (string)required

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

sandbox_id Sandbox Id (string)required

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

scopes string[]

Default value: basic_profile,friends_list,presence

Epic Online Services scopes to request

steam

object

Steam options

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Steam

wallet_refunds_trigger_ban Wallet Refunds Trigger Ban (boolean)

Default value: true

Whether or not to ban players who refund their wallet purchases

enforce_vac_bans Enforce Vac Bans (boolean)

Default value: true

Whether or not to enforce VAC bans

enforce_publisher_bans Enforce Publisher Bans (boolean)

Default value: true

Whether or not to enforce publisher bans

appid App IDs (integer)required

Possible values: >= 1

Steam app ID for the game

playstation

object

Playstation options

enable_login Enable Playstation Login (boolean)

Default value: true

Whether or not to enable Playstation logins

environment PlayStation Environment (string)

Possible values: [sp-int, prod-qa, np]

Default value: sp-int

Currently active Playstation environment to use

ps4_use_entitlements_v1_api Use PS4 Entitlements V1 API (boolean)

Whether or not to use the old entitlements API for PS4

ps5_use_entitlements_v1_api Use PS5 Entitlements V1 API (boolean)

Whether or not to use the old entitlements API for PS5

ps4_use_auth_v1_api Use PS4 Auth V1 API (boolean)

Whether or not to use the old auth API for PS4

ps5_use_auth_v1_api Use PS5 Auth V1 API (boolean)

Whether or not to use the old auth API for PS5

psn_web_client_id PSN Web Client ID (string)required

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

commerce_partner_name Commerce Partner Name (string)

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

title_ids string[]

Default value: ``

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.

ps4_client_id PS4 Client ID (string)required

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

ps5_client_id PS5 Client ID (string)required

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

ps4_v1_portal_token_details_enable Enable PS4 V1 Portal Token Details (boolean)

Whether or not to enable the PS4 V1 portal token details

ps4_v3_portal_token_details_enable Enable PS4 V3 Portal Token Details (boolean)

Whether or not to enable the PS4 V3 portal token details

ps5_v3_portal_token_details_enable Enable PS5 V3 Portal Token Details (boolean)

Whether or not to enable the PS5 V3 portal token details

eu_service_labels integer[]

Default value: ``

EU Service Labels

na_service_labels integer[]

Default value: ``

NA Service Labels

nintendo

object

environments

object

required

Nintendo environments

dd1

object

required

Config Values for DD1

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Nintendo logins

client_id Client Id (string)required

Nintendo client ID. Client tokens are validated against this ID

auth_key Auth Key (string)required

Nintendo auth key

dp1

object

required

Config Values for DP1

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Nintendo logins

client_id Client Id (string)required

Nintendo client ID. Client tokens are validated against this ID

auth_key Auth Key (string)required

Nintendo auth key

sd1

object

required

Config Values for SD1

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Nintendo logins

client_id Client Id (string)required

Nintendo client ID. Client tokens are validated against this ID

auth_key Auth Key (string)required

Nintendo auth key

sp1

object

required

Config Values for SP1

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Nintendo logins

client_id Client Id (string)required

Nintendo client ID. Client tokens are validated against this ID

auth_key Auth Key (string)required

Nintendo auth key

jd1

object

required

Config Values for JD1

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Nintendo logins

client_id Client Id (string)required

Nintendo client ID. Client tokens are validated against this ID

auth_key Auth Key (string)required

Nintendo auth key

lp1

object

required

Config Values for LP1

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Nintendo logins

client_id Client Id (string)required

Nintendo client ID. Client tokens are validated against this ID

auth_key Auth Key (string)required

Nintendo auth key

active_envs string[]

Default value: ``

List of active/enabled nintendo environments for this sandbox

app_id App Id (string)required

Nintendo app ID. Client tokens are validated against this ID

twitch

object

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Twitch logins

client_id Client Id (string)required

Twitch client ID. Client tokens are validated against this ID

game_id Game Id (string)required

Twitch game ID.

amazon

object

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Amazon logins

client_id Client Id (string)required

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

scopes string[]

Default value: profile:user_id,games::prime

Amazon OAuth scopes to request

google

object

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Google logins

client_id Client Id (string)required

Google client ID. Client tokens are validated against this ID

apple

object

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Apple logins

web_client_id Web Client Id (string)required

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

web_auth_key_id Web Auth Key Id (string)required

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

xbox

object

enable_login Enable Login (boolean)

Default value: true

Whether or not to enable Xbox logins

web_client_id Web Client Id (string)required

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

vivox

object

enable Enable (boolean)

Default value: true

Whether or not to enable Vivox logins

server Server (string)required

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

key_issuer Key Issuer (string)required

Vivox key issuer

key_time Key Time (integer)

Possible values: >= 60

Default value: 60

Number of seconds that vivox tokens last before expiration

legacy

object

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

allowed_game_versions Allowed Game Versions (string)

Default value: *.*.*.*

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

eac_enabled Eac Enabled (boolean)

Whether or not to enforce EAC checks for new client connections

eac_check_ban_status_at_login Eac Check Ban Status At Login (boolean)

Whether or not to check EAC ban status at login

eac_submit_player_reports Eac Submit Player Reports (boolean)

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

experiments

object[]

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

Array [

name Name (string)required

Name of the feature

enabled Enabled (boolean)required

Whether or not the feature is enabled

]

game_bits Legacy Game Bit (string)[]

Possible 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]

Default value: USE_LOCAL_HOME_MAP,CHAT_NOTIFY_CHANGES,CLAN_CAN_CHANGE_SITEID,GLOBAL_SERVER_DB,USE_SPECTATOR,GB_ALLOW_LIVE_SPECTATE

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

max_party_size Max Party Size (integer)

Possible values: >= 1

Default value: 10

Maximum number of players allowed in a party

max_party_info_count Max Party Info Count (integer)

Default value: 0

Maximum number of party info entries allowed per party

default_map_game_id Default Map Game Id (integer)

Possible values: >= 1

Default value: 1

Default map game ID to return to when leaving a match

game_id Game Id (integer)

Game ID to use for the game

inventory_custom_data_item_legacy_type_field Inventory Custom Data Item Legacy Type Field (string)

Default value: item_legacy_type

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

inventory_custom_data_item_legacy_subtype_field Inventory Custom Data Item Legacy Subtype Field (string)

Default value: item_legacy_subtype

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

inventory_custom_data_vendor_legacy_type_field Inventory Custom Data Vendor Legacy Type Field (string)

Default value: vendor_legacy_type

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

default_role_id Default Role Id (string)

Possible values: non-empty

Default role ID for players without a role

inventory_always_owned_items

object[]

List of items that are always owned by players

Array [

item_id uuidrequired

Item ID for the always owned item

legacy_item_id Legacy Item Id (integer)

Default value: 0

Legacy item ID for the always owned item

]

inventory_session_loot string[]

Possible values: non-empty

Default value: ``

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

inventory_session_loot_v2

object[]

List of inventory session loot associated with this config

Array [

loot_id uuidrequired

Loot ID for the reward tied to the player session

]

allow_client_to_update_inventory Allow Client To Update Inventory (boolean)

Whether or not to allow the client source to update inventory

email_reward_loot string[]

Possible values: non-empty

Default value: ``

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

email_reward_loot_v2

object[]

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

Array [

loot_id uuidrequired

Loot ID granted to players when they have an email

]

coupon_enable Coupon Enable (boolean)

Default value: true

Are coupons allowed to be used for purchasing Loot?

coupon_vendor_id Coupon Vendor Id (string)

Vendor ID that lists all enabled coupons

legacy_id_generation

object

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.

vendor UuidGenerationType (string)

Possible values: [uuid4, sequential, uuid5]

Default value: sequential

How to generate Vendor IDs

loot UuidGenerationType (string)

Possible values: [uuid4, sequential, uuid5]

Default value: sequential

How to generate Loot IDs

item UuidGenerationType (string)

Possible values: [uuid4, sequential, uuid5]

Default value: sequential

How to generate Item IDs

inventory_bucket_use_rule_set UuidGenerationType (string)

Possible values: [uuid4, sequential, uuid5]

Default value: sequential

How to generate Inventory Bucket Use Rule Set IDs

xp UuidGenerationType (string)

Possible values: [uuid4, sequential, uuid5]

Default value: sequential

How to generate Xp IDs

role UuidGenerationType (string)

Possible values: [uuid4, sequential, uuid5]

Default value: sequential

How to generate Role IDs

enable_legacy_setting_types Enable Legacy Setting Types (boolean)

Whether or not to enable legacy setting types

{
  "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
  "created_timestamp": "2024-07-29T15:51:28.071Z",
  "social": {
    "friend_limit": 100,
    "block_limit": 100
  },
  "basic": {
    "enable_login": true
  },
  "anon": {
    "enable_login": true
  },
  "epic": {
    "enable_login": true,
    "client_id": "string",
    "product_id": "string",
    "sandbox_id": "string",
    "scopes": [
      "string"
    ]
  },
  "steam": {
    "enable_login": true,
    "wallet_refunds_trigger_ban": true,
    "enforce_vac_bans": true,
    "enforce_publisher_bans": true,
    "appid": 0
  },
  "playstation": {
    "enable_login": true,
    "environment": "sp-int",
    "ps4_use_entitlements_v1_api": false,
    "ps5_use_entitlements_v1_api": false,
    "ps4_use_auth_v1_api": false,
    "ps5_use_auth_v1_api": false,
    "psn_web_client_id": "string",
    "commerce_partner_name": "string",
    "title_ids": [
      "string"
    ],
    "ps4_client_id": "string",
    "ps5_client_id": "string",
    "ps4_v1_portal_token_details_enable": false,
    "ps4_v3_portal_token_details_enable": false,
    "ps5_v3_portal_token_details_enable": false,
    "eu_service_labels": [
      0
    ],
    "na_service_labels": [
      0
    ]
  },
  "nintendo": {
    "environments": {
      "dd1": {
        "enable_login": true,
        "client_id": "string",
        "auth_key": "string"
      },
      "dp1": {
        "enable_login": true,
        "client_id": "string",
        "auth_key": "string"
      },
      "sd1": {
        "enable_login": true,
        "client_id": "string",
        "auth_key": "string"
      },
      "sp1": {
        "enable_login": true,
        "client_id": "string",
        "auth_key": "string"
      },
      "jd1": {
        "enable_login": true,
        "client_id": "string",
        "auth_key": "string"
      },
      "lp1": {
        "enable_login": true,
        "client_id": "string",
        "auth_key": "string"
      }
    },
    "active_envs": [
      "string"
    ],
    "app_id": "string"
  },
  "twitch": {
    "enable_login": true,
    "client_id": "string",
    "game_id": "string"
  },
  "amazon": {
    "enable_login": true,
    "client_id": "string",
    "scopes": [
      "string"
    ]
  },
  "google": {
    "enable_login": true,
    "client_id": "string"
  },
  "apple": {
    "enable_login": true,
    "web_client_id": "string",
    "web_auth_key_id": "string"
  },
  "xbox": {
    "enable_login": true,
    "web_client_id": "string"
  },
  "vivox": {
    "enable": true,
    "server": "string",
    "key_issuer": "string",
    "key_time": 60
  },
  "legacy": {
    "allowed_game_versions": "*.*.*.*",
    "eac_enabled": false,
    "eac_check_ban_status_at_login": false,
    "eac_submit_player_reports": false,
    "experiments": [
      {
        "name": "string",
        "enabled": true
      }
    ],
    "game_bits": [
      "DISABLE_FTP"
    ],
    "max_party_size": 10,
    "max_party_info_count": 0,
    "default_map_game_id": 1,
    "game_id": 0,
    "inventory_custom_data_item_legacy_type_field": "item_legacy_type",
    "inventory_custom_data_item_legacy_subtype_field": "item_legacy_subtype",
    "inventory_custom_data_vendor_legacy_type_field": "vendor_legacy_type"
  },
  "default_role_id": "string",
  "inventory_always_owned_items": [
    {
      "item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "legacy_item_id": 0
    }
  ],
  "inventory_session_loot": [
    "string"
  ],
  "inventory_session_loot_v2": [
    {
      "loot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "allow_client_to_update_inventory": false,
  "email_reward_loot": [
    "string"
  ],
  "email_reward_loot_v2": [
    {
      "loot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "coupon_enable": true,
  "coupon_vendor_id": "string",
  "legacy_id_generation": {
    "vendor": "sequential",
    "loot": "sequential",
    "item": "sequential",
    "inventory_bucket_use_rule_set": "sequential",
    "xp": "sequential",
    "role": "sequential"
  },
  "enable_legacy_setting_types": false
}

Validation Error

application/json

Schema
Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1
MOD2

string

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Sandbox Game Config

/v1/sandbox/:sandbox_identifier/game-config

Request​

Path Parameters

Responses​

Request

Responses