---
title: "GET /v2/servers"
method: GET
path: "/v2/servers"
---

# GET /v2/servers

`GET /v2/servers`

## Query parameters

- `game_mode` string
- `has_players` union
  - boolean
  - 'true' | 'false'
- `search` string
- `region` string
- `password` union
  - boolean
  - 'true' | 'false'
- `limit` integer
- `cursor` integer

## Response `200`

OK

- object
  - `servers` object[], required
    - `id` string, required
    - `name` string, required
    - `ip` string
    - `port` integer, required
    - `visibility` 'public' | 'unlisted' | 'private' | 'password', required
    - `password_protected` boolean
    - `connect_code` string
    - `gateway_url` string
    - `player_count` integer
    - `max_players` integer, required
    - `map` string
    - `game_mode` string
    - `version` string
    - `players` object[]
      - `name` string, required
      - `hero` string
      - `team` integer
      - `kills` integer
      - `deaths` integer
      - `assists` integer
      - `level` integer
    - `mods` object[]
      - `name` string, required
      - `version` string
    - `required_mods` object[]
      - `id` string, required
      - `provider` 'gamebanana' | 'custom', required
      - `url` string, required
      - `version` string
    - `last_seen` string, required
    - `auth_required` boolean
    - `auth_providers` object[]
      - `type` 'discord' | 'steam' | 'password' | 'custom', required
      - `label` string
      - `metadata` object
    - `auth_public_key` string
    - `auth_prompt_message` string
    - `auth_prompt_url` string
    - `source_relay` string, required
    - `source_region` string
    - `managed_content` boolean
  - `total` integer, required
  - `cursor` integer, nullable, required
  - `relays_queried` integer, required
  - `relays_failed` integer, required
  - `registry_degraded` boolean
  - `registry_snapshot_age_ms` number, nullable

---

[API](https://skmtc.dev/deadlockmods/apis/deadlock-mods-api.md) · [All operations](https://skmtc.dev/deadlockmods/apis/deadlock-mods-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/deadlockmods/deadlock-mods-api/revisions/bd2128436e2f/schema)