Skip to main content
GET
/
matchmaker
/
matches
List all active matches for a matchmaker
curl --request GET \
  --url https://backend.computeflow.cloud/matchmaker/matches \
  --header 'api-key: <api-key>'
[
  {
    "match_id": "m1n2o3p4-q5r6-7890-1234-567890ghijkl",
    "matchmaker_id": "c0c17d62-890e-4788-83e0-f16be8db4901",
    "gameBuild": "Build_1.2.3",
    "status": "active",
    "created_at": 1678886500000,
    "backfill": true,
    "maxPlayers": 10,
    "currentPlayers": 8,
    "players": [
      {
        "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": {}
      }
    ],
    "teams": [
      [
        {
          "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": {}
        }
      ]
    ],
    "server": {
      "name": "lobby-xyz-server",
      "instance_id": "srv_abc123",
      "network_ports": [
        {
          "name": "game",
          "internal_port": 7777,
          "external_port": 7777,
          "protocol": "udp",
          "host": "127.0.0.1",
          "tls_enabled": false
        }
      ],
      "status": "running",
      "startup_args": {},
      "service_type": "match_based",
      "compute_size": "small",
      "region": "us-east",
      "version_tag": "<string>",
      "started_at": "2023-03-15T10:00:00Z",
      "stopped_at": {},
      "custom_data": {},
      "ttl": 3600,
      "connect_code": "XYZ123",
      "game_build": "Build_1.2.3"
    }
  }
]

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

Query Parameters

​
matchmaker_name
string
required

Name of the matchmaker

​
matchmaker_id
string
required

Response

A list of active matches

​
match_id
string
required

Unique identifier for the match

Example:

"m1n2o3p4-q5r6-7890-1234-567890ghijkl"

​
matchmaker_id
string
required

Identifier of the matchmaker this match belongs to

Example:

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

​
gameBuild
string
required

Game build version for this match

Example:

"Build_1.2.3"

​
status
enum<string>
required

Current status of the match

Available options:
created,
active,
ended,
failed
Example:

"active"

​
created_at
number
required

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

Example:

1678886500000

​
backfill
boolean
required

Indicates if backfill is enabled for this match

Example:

true

​
maxPlayers
number
required

Maximum number of players allowed in this match

Example:

10

​
currentPlayers
number
required

Current number of players in this match

Example:

8

​
players
object[]
required

List of players in the match

​
teams
object[][]

Team assignments for the players (if applicable)

​
server
object

Server instance information