Skip to main content
POST
/
matchmaker
/
tickets
Create a new matchmaking ticket
curl --request POST \
  --url https://backend.computeflow.cloud/matchmaker/tickets \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "matchmaker_name": "default_matchmaker",
  "player_id": "player123",
  "matchmaker_id": "c0c17d62-890e-4788-83e0-f16be8db4901",
  "regions": [
    "us-east",
    "us-west"
  ],
  "elo": 1000,
  "preferred_modes": [
    "capture_the_flag",
    "deathmatch"
  ],
  "gameBuild": "Build_1.2.3"
}
'
{
  "ticket_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "player_id": "player_123",
  "matchmaker_id": "c0c17d62-890e-4788-83e0-f16be8db4901",
  "status": "In Queue",
  "created_at": 1678886400000,
  "elo": 1250,
  "gameBuild": "Build_1.2.3",
  "regions": [
    "NA-East",
    "EU-West"
  ],
  "match": {}
}

Authorizations

​
api-key
string
header
required

Headers

​
api-key
string
required

API key for authentication

​
client-auth-token
string

Optional client authentication token for player validation

Body

application/json
​
matchmaker_name
string
required

Name of the matchmaker configuration

Example:

"default_matchmaker"

​
player_id
string

The player's unique identifier. If not provided, an anonymous ID will be generated.

Example:

"player123"

​
matchmaker_id
string

Legacy: Identifier of the matchmaker configuration

Example:

"c0c17d62-890e-4788-83e0-f16be8db4901"

​
regions
enum<string>[]

Geographic regions for matchmaking. Defaults to ['us-east'] if not provided or empty.

Available options:
us-east,
us-west,
eu-north,
eu-west,
ap-south,
sea,
ea,
ap-north,
ap-southeast,
south-africa,
south-america-brazil,
south-america-chile
Example:
["us-east", "us-west"]
​
elo
number

Player's skill rating

Example:

1000

​
preferred_modes
string[]

Preferred game modes

Example:
["capture_the_flag", "deathmatch"]
​
gameBuild
string

Game build version

Example:

"Build_1.2.3"

Response

Ticket created successfully

​
ticket_id
string<uuid>
required

Unique identifier for the ticket

Example:

"a1b2c3d4-e5f6-7890-1234-567890abcdef"

​
player_id
string
required

Unique identifier for the player

Example:

"player_123"

​
matchmaker_id
string
required

Identifier of the matchmaker this ticket belongs to

Example:

"c0c17d62-890e-4788-83e0-f16be8db4901"

​
status
enum<string>
required

Current status of the ticket

Available options:
In Queue,
matched,
cancelled,
expired,
deleted,
abandoned
Example:

"In Queue"

​
created_at
integer<int64>
required

Timestamp of when the ticket was created (Unix epoch milliseconds)

Example:

1678886400000

​
elo
number

Player's skill rating

Example:

1250

​
gameBuild
string

Game build version associated with the ticket

Example:

"Build_1.2.3"

​
regions
string[]

Player's selected regions

Example:
["NA-East", "EU-West"]
​
match
object

Details of the match if the ticket status is 'matched'.