Skip to content

Create Pex Player

POST
/match/v1/pex/client

Create PEX Client

Required Permissions:

  • For any pex client any of: match:*, match:pex:client:write

Authorizations

Request Body required

object
frame_time
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
delta_time
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
tick_count
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
delayed_tick_count
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
memory_ws
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
memory_vb
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
cpu_process
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
ping
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
in_packets
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
out_packets
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
total_packets
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
in_packet_loss
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
out_packet_loss
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
total_packet_loss
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
in_packet_loss_pct
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
out_packet_loss_pct
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
total_packet_loss_pct
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
total_disconnects
Any of:
object
count
Any of:
number
match_duration
Any of:
object
count
Any of:
number
game_thread_time
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
render_thread_time
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
gpu_time
Any of:
object
min
Any of:
number
max
Any of:
number
avg
Any of:
number
stddev
Any of:
number
match_id
required

Match ID

string
region_id
Any of:
string
server_id
Any of:
string
allocation_id
Any of:
string
datacenter_provider
Any of:
string
datacenter_location
Any of:
string
address_ip
Any of:
string
map_name
Any of:
string
game_mode
Any of:
string
matchmaking_profile_id
Any of:
string
expected_team_size
Any of:
integer
expected_player_count
Any of:
integer
host_player_uuid
Any of:
string format: uuid
owning_player_uuid
Any of:
string format: uuid
version
Any of:
string
player_uuid
required

Player UUID

string format: uuid
device_info
Any of:
string

Responses

204

Successful Response

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

422

Validation Error

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