Skip to content
RallyHere Docs

Get Config For Single Setting Type All Versions

GET
/settings/v1/setting_type/{setting_type_id}/v

Get a configuration and all versions for a given setting type ID.

Required Permissions:

  • For any player (including themselves) any of: setting-config:read, setting:*:*

Authorizations

Parameters

Path Parameters

setting_type_id
required
string

Responses

200

Successful Response

object
key
additional properties
object
allow_update

Are players allowed to set/update keys to this version of the setting type? Does not affect getting or deleting existing settings.

boolean
default: true
key_regex

Regex that is used to verify keys at assignment time

string
default: ^.+$
value_jsonschema
required

jsonschema that is used to verify values at assignment time

object
custom_data

Custom data that was provided when the setting type was created

object
key
additional properties
string

403

Error Codes:

  • auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token
  • auth_invalid_version - Invalid Authorization - version
  • auth_malformed_access - Invalid Authorization - malformed access token
  • auth_not_jwt - Invalid Authorization
  • auth_token_expired - Token is expired
  • auth_token_format - Invalid Authorization - {}
  • auth_token_invalid_claim - Token contained invalid claim value: {}
  • auth_token_invalid_type - Invalid Authorization - Invalid Token Type
  • auth_token_sig_invalid - Token Signature is invalid
  • auth_token_unknown - Failed to parse token
  • insufficient_permissions - Insufficient Permissions
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Error Codes:

  • setting_type_id_not_found - The setting type ID was not found
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string