> ## 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.

# Quickstart for multiplayer servers (MpsAllocator Sample)

> Quickstart for the MpsAllocator .NET sample that calls PlayFab Multiplayer APIs to list builds, view VMs, and allocate game servers on demand.

# MpsAllocator sample

> [!NOTE]
>
> MpsAllocatorSample can be found [here](https://github.com/PlayFab/MpsSamples/tree/master/MpsAllocatorSample) along with the rest of the MPS samples.

This sample is a simple .NET Core application that allows you to easily call some frequently used MPS APIs, like the ones that list VMs/servers and allocate game servers (RequestMultiplayerServer). To easily and quickly request a multiplayer server from Game Manager, select the button located at the top of our servers page that can help you do that. To learn more check out our [Servers overview](/services/playfab/multiplayer/servers/build-server-overview.md). In order to use it, you need to have installed .NET Core 3.1 (download [here](https://dotnet.microsoft.com/download)). You can then use either `dotnet build` command to build an executable for your platform or just run `dotnet run` to run the application.

> [!NOTE]
>
> You can find more information about

`dotnet build` command [here](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build)

In order to authenticate with PlayFab APIs, the app needs your PlayFab TitleID and a developer secret key. To create a secret key for your title, visit the Settings/Secret-Keys page on the PlayFab developer portal here: [https://developer.playfab.com/en-US/r/t/\<Your\_TitleID\>/settings/secret-keys](https://developer.playfab.com/en-US/r/t/\<Your_TitleID\>/settings/secret-keys). You can provide these keys via environment variables `PF_TITLEID` and `PF_SECRET`, or as command line arguments.

> [!NOTE]
>
> The app uses the PlayFab SDK via the corresponding [Nuget package](https://www.nuget.org/packages/PlayFabAllSDK/)

Once you run the application, you can choose which API to call. Each API will ask you to provide necessary parameters. Here's the list of the available options:

* [RequestMultiplayerServer](https://learn.microsoft.com/en-us/rest/api/playfab/multiplayer/multiplayer-server/request-multiplayer-server): This option will allocate a game server and return its details (IP, FQDN, Port). Successful invocation of this API call will result in a game server's transition from "StandingBy" state to "Active" (more [here](/services/playfab/multiplayer/servers/allocating-game-servers-and-configuring-vs-debugging-tools.md))
* [ListBuildSummaries](https://learn.microsoft.com/en-us/rest/api/playfab/multiplayer/multiplayer-server/list-build-summaries-v2): This option will return summaries about your title's Builds
* [GetBuild](https://learn.microsoft.com/en-us/rest/api/playfab/multiplayer/multiplayer-server/get-build): This option will return details about the specified Build
* [ListMultiplayerServers](https://learn.microsoft.com/en-us/rest/api/playfab/multiplayer/multiplayer-server/list-multiplayer-servers): This option will return summaries about game servers in a specified Build
* [ListVirtualMachineSummaries](https://learn.microsoft.com/en-us/rest/api/playfab/multiplayer/multiplayer-server/list-virtual-machine-summaries): This option will return summaries about virtual machines in a specified Build
* [GetMultiplayerServerDetails](https://learn.microsoft.com/en-us/rest/api/playfab/multiplayer/multiplayer-server/get-multiplayer-server-details): This option will return details about a specified game server

## See also

* [Create your first server](/services/playfab/multiplayer/servers/create-your-first-server.md)
* [Resources and samples](/services/playfab/multiplayer/servers/server-samples-resources.md)
* [PlayFab Multiplayer Server SDKs](/services/playfab/multiplayer/servers/server-sdks/overview.md)
* [API Reference](xref:titleid.playfabapi.com.multiplayer.multiplayerserver)


## Related topics

- [Wrapper sample](/services/playfab/multiplayer/servers/wrapper-sample.md)
- [Multiplayer Servers samples and resources](/services/playfab/multiplayer/servers/server-samples-resources.md)
- [Deploy builds using Game Manager](/services/playfab/multiplayer/servers/deploy-using-game-manager.md)
- [Connect to Cloud-Hosted Unreal Server](/services/playfab/multiplayer/servers/server-sdks/unreal-gsdk/connect-to-mps-hosted-build.md)
- [Lifecycle of a multiplayer server](/services/playfab/multiplayer/servers/multiplayer-game-server-lifecycle.md)