Skip to content
PeekSeekPeekSeek Docs

Gameserver Match

GET
/server/v1/matches/{matchId}
curl --request GET \
  --url https://example.com/server/v1/matches/1

A match’s state. relayTo is the server code to send its players to, and stays null until there is a server to send them to.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
matchId
required
Matchid
integer

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MatchState

GET /matches/{matchId}. relayTo is the server code to send this match’s players to, and stays null until there is a server to send them to.

object
id
required
Id
integer
region
required
Region
string
status
required
Status
string
relayTo
required
Any of:
string
Examplegenerated
{
  "id": 1,
  "region": "example",
  "status": "example",
  "relayTo": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}