> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Multiplayer Servers

> Lists multiplayer server sessions for a build.

Allowed entity token types: title

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| APINotEnabledForGameClientAccess | 1082 |
| MultiplayerServerBadRequest | 1382 |
| MultiplayerServerForbidden | 1384 |
| MultiplayerServerInternalServerError | 1387 |
| MultiplayerServerNotFound | 1385 |
| MultiplayerServerUnauthorized | 1383 |
| MultiplayerServerUnavailable | 1388 |
| ProductDisabledForTitle | 1609 |




## OpenAPI

````yaml post /MultiplayerServer/ListMultiplayerServers
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Multiplayer API
  description: >-
    API methods for managing multiplayer servers. API methods for managing
    parties. The lobby service helps players group together to play multiplayer
    games. It is often used as a rendezvous point for players to share
    connection information. The TrueSkill service helps titles to estimate a
    player's skill based on their match results. The player skill values from
    this service are commonly used by a matchmaking service to provide players
    with balanced matches.
  termsOfService: https://playfab.com/terms/
  contact:
    url: https://community.playfab.com/index.html
  license:
    name: Apache 2.0
    url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE
servers:
  - url: https://{titleId}.playfabapi.com
    description: PlayFab title endpoint
    variables:
      titleId:
        default: your_title_id
        description: Your PlayFab title ID (hex).
security: []
tags:
  - name: Lobby
    description: ''
  - name: Matchmaking
    description: Matchmaking APIs
  - name: Matchmaking Admin
    description: Matchmaking Admin APIs
  - name: MultiplayerServer
    description: Multiplayer Server APIs
  - name: PubSub
    description: PlayFab PubSub APIs
  - name: TrueSkill
    description: TrueSkill APIs
  - name: TrueSkill Admin
    description: TrueSkill Admin APIs
paths:
  /MultiplayerServer/ListMultiplayerServers:
    post:
      tags:
        - MultiplayerServer
      summary: List Multiplayer Servers
      description: |
        Lists multiplayer server sessions for a build.

        Allowed entity token types: title

        ## Error codes

        This operation may return the following PlayFab errors:

        | Error | Code |
        | --- | --- |
        | APINotEnabledForGameClientAccess | 1082 |
        | MultiplayerServerBadRequest | 1382 |
        | MultiplayerServerForbidden | 1384 |
        | MultiplayerServerInternalServerError | 1387 |
        | MultiplayerServerNotFound | 1385 |
        | MultiplayerServerUnauthorized | 1383 |
        | MultiplayerServerUnavailable | 1388 |
        | ProductDisabledForTitle | 1609 |
      operationId: ListMultiplayerServers
      requestBody:
        $ref: '#/components/requestBodies/ListMultiplayerServersRequest'
      responses:
        '200':
          $ref: '#/components/responses/ListMultiplayerServersResponse'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - EntityToken: []
components:
  requestBodies:
    ListMultiplayerServersRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListMultiplayerServersRequest'
      description: Returns a list of multiplayer servers for a build in a specific region.
  responses:
    ListMultiplayerServersResponse:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
                description: >-
                  The Http status code. If X-ReportErrorAsSuccess header is set
                  to true, this will report the actual http error code.
              status:
                type: string
                description: The Http status code as a string.
              data:
                $ref: '#/components/schemas/ListMultiplayerServersResponse'
            example:
              code: 200
              status: OK
              data:
                MultiplayerServerSummaries:
                  - ServerId: AMultiplayerGameServer
                    SessionId: 02bdef0e-e01e-4b29-8efe-ff9f47a06d8c
                    VmId: VmID1
                    Region: SouthCentralUs
                    State: Active
                    ConnectedPlayers:
                      - PlayerId: '10931352888739351331'
                      - PlayerId: '10271352123739051532'
                    IPV4Address: 10.250.24.54
                    FQDN: vm.azure.cloudapp.net
                    Ports:
                      - Name: PortName
                        Num: 1243
                  - ServerId: SomeOtherMultiplayerGameServer
                    SessionId: 82bdef0e-a21e-3b29-8efe-ff9e57a08c1d
                    VmId: VmID2
                    Region: SouthCentralUs
                    State: Terminated
                    ConnectedPlayers: []
                    IPV4Address: 10.250.24.54
                    FQDN: vm.azure.cloudapp.net
                    Ports:
                      - Name: PortName
                        Num: 1243
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  schemas:
    ListMultiplayerServersRequest:
      description: Returns a list of multiplayer servers for a build in a specific region.
      type: object
      properties:
        BuildId:
          description: The guid string build ID of the multiplayer servers to list.
          type: string
        CustomTags:
          description: >-
            The optional custom tags associated with the request (e.g. build
            number, external trace identifiers, etc.).
          type: object
        PageSize:
          description: The page size for the request.
          type: number
          x-actualtype: int32
        Region:
          allOf:
            - $ref: '#/components/schemas/AzureRegion'
          description: The region the multiplayer servers to list.
        SkipToken:
          description: The skip token for the paged request.
          type: string
      required:
        - BuildId
        - Region
      example:
        BuildId: 21781fa8-096d-4d9c-b699-75433d579285
        Region: SouthCentralUs
    ListMultiplayerServersResponse:
      type: object
      properties:
        MultiplayerServerSummaries:
          description: The list of multiplayer server summary details.
          type: array
          items:
            $ref: '#/components/schemas/MultiplayerServerSummary'
          x-isclass: true
        PageSize:
          description: The page size on the response.
          type: number
          x-actualtype: int32
        SkipToken:
          description: The skip token for the paged response.
          type: string
      required:
        - PageSize
      example:
        MultiplayerServerSummaries:
          - ServerId: AMultiplayerGameServer
            SessionId: 02bdef0e-e01e-4b29-8efe-ff9f47a06d8c
            VmId: VmID1
            Region: SouthCentralUs
            State: Active
            ConnectedPlayers:
              - PlayerId: '10931352888739351331'
              - PlayerId: '10271352123739051532'
            IPV4Address: 10.250.24.54
            FQDN: vm.azure.cloudapp.net
            Ports:
              - Name: PortName
                Num: 1243
          - ServerId: SomeOtherMultiplayerGameServer
            SessionId: 82bdef0e-a21e-3b29-8efe-ff9e57a08c1d
            VmId: VmID2
            Region: SouthCentralUs
            State: Terminated
            ConnectedPlayers: []
            IPV4Address: 10.250.24.54
            FQDN: vm.azure.cloudapp.net
            Ports:
              - Name: PortName
                Num: 1243
    ApiErrorWrapper:
      description: The basic wrapper around every failed API response
      type: object
      properties:
        code:
          description: Numerical HTTP code
          type: integer
        status:
          description: String HTTP code
          type: string
        error:
          description: Playfab error code
          type: string
        errorCode:
          description: Numerical PlayFab error code
          type: integer
        errorMessage:
          description: Description for the PlayFab errorCode
          type: string
        errorDetails:
          description: Detailed description of individual issues with the request object
          type: object
      required:
        - code
        - errorCode
    AzureRegion:
      type: string
      enum:
        - AustraliaEast
        - AustraliaSoutheast
        - BrazilSouth
        - CentralUs
        - EastAsia
        - EastUs
        - EastUs2
        - JapanEast
        - JapanWest
        - NorthCentralUs
        - NorthEurope
        - SouthCentralUs
        - SoutheastAsia
        - WestEurope
        - WestUs
        - SouthAfricaNorth
        - WestCentralUs
        - KoreaCentral
        - FranceCentral
        - WestUs2
        - CentralIndia
        - UaeNorth
        - UkSouth
        - SwedenCentral
        - CanadaCentral
        - MexicoCentral
        - WestUs3
        - CanadaEast
        - UkWest
        - FranceSouth
        - SouthIndia
        - SpainCentral
        - GermanyWestCentral
        - ItalyNorth
        - IndonesiaCentral
        - ChileCentral
        - PolandCentral
        - NewZealandNorth
        - BrazilSoutheast
        - NorwayEast
        - SwitzerlandNorth
        - MalaysiaWest
        - IsraelCentral
        - QatarCentral
        - UaeCentral
        - GermanyNorth
        - AustriaEast
        - BelgiumCentral
        - DenmarkEast
        - SwitzerlandWest
        - SwedenSouth
        - NorwayWest
        - SouthAfricaWest
        - MalaysiaSouth
    MultiplayerServerSummary:
      type: object
      properties:
        ConnectedPlayers:
          description: The connected players in the multiplayer server.
          type: array
          items:
            $ref: '#/components/schemas/ConnectedPlayer'
          x-isclass: true
        LastStateTransitionTime:
          description: >-
            The time (UTC) at which a change in the multiplayer server state was
            observed.
          type: string
        Region:
          allOf:
            - $ref: '#/components/schemas/AzureRegion'
          description: The region the multiplayer server is located in.
        ServerId:
          description: The string server ID of the multiplayer server generated by PlayFab.
          type: string
        SessionId:
          description: >-
            The title generated guid string session ID of the multiplayer
            server.
          type: string
        State:
          description: The state of the multiplayer server.
          type: string
        VmId:
          description: The virtual machine ID that the multiplayer server is located on.
          type: string
    ConnectedPlayer:
      type: object
      properties:
        PlayerId:
          description: The player ID of the player connected to the multiplayer server.
          type: string
  securitySchemes:
    EntityToken:
      type: apiKey
      in: header
      name: X-EntityToken
      description: >-
        This API requires an Entity Session Token, available from the Entity
        GetEntityToken method.

````

## Related topics

- [List Multiplayer Servers](/api-reference/multiplayerserver/list-multiplayer-servers.md)
- [List Archived Multiplayer Servers](/api-reference/multiplayerserver/list-archived-multiplayer-servers.md)
- [List Party Qos Servers](/api-reference/multiplayerserver/list-party-qos-servers.md)
- [List Qos Servers For Title](/api-reference/multiplayerserver/list-qos-servers-for-title.md)
- [PFMultiplayerServerListQosServersForTitleRequest](/services/playfab/api-references/c/pfmultiplayerservertypes/structs/pfmultiplayerserverlistqosserversfortitlerequest.md)
