Get Config For All Setting Types

GET 
/settings/v1/setting_type

Get all setting types and their configuration.

Required Permissions:

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

Request

Header Parameters

if-match any

Precondition check if the resource's current ETag matches the provided values. * can be used to match any existing value.

See https://www.rfc-editor.org/rfc/rfc9110#name-if-match for more information

if-none-match any

Precondition check if the resource's current ETag does NOT match the provided values. * can be used to match existing value, causing the request to fail.

See https://www.rfc-editor.org/rfc/rfc9110#name-if-none-match for more information

if-modified-since any

Precondition check if the resource's Last-Modified date is newer than the provided date. Ignored if the If-None-Match header is provided. Only valid for GET/HEAD endpoints.

See https://www.rfc-editor.org/rfc/rfc9110#name-if-modified-since for more information

if-unmodified-since any

Precondition check if the resource's Last-Modified date is older than the provided date. Ignored if the If-Match header is provided.

See https://www.rfc-editor.org/rfc/rfc9110#name-if-unmodified-since for more information

Responses

200

Successful Response

Response Headers

• ETag

  string

  The ETag for the resource. Used for caching and preconditions.

• Last-Modified

  string

  The Last-Modified date for the resource. Used for caching and preconditions.

application/json

Schema

Schema

property name*

SettingType

versions

object

required

Map of setting type version ids to the version

property name*

SettingTypeVersion

allow_update Allow Update (boolean)

Default value: true

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

key_regex Key Regex (string)

Default value: ^.+$

Regex that is used to verify keys at assignment time

value_jsonschema objectrequired

jsonschema that is used to verify values at assignment time

custom_data

object

Custom data that was provided when the setting type was created

property name* string

Example (from schema)

{}

304

The resource has not been modified from the provided preconditions.

Response Headers

• ETag

  string

  The ETag for the resource. Used for caching and preconditions.

• Last-Modified

  string

  The Last-Modified date for the resource. Used for caching and preconditions.

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

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

412

The resource does not meet the provided preconditions.

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

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

Loading...