Get Remote Login Endpoint
Gets a remote login endpoint to a VM that is hosting a multiplayer server 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 |
| MultiplayerServerTooManyRequests | 1380 |
| MultiplayerServerUnauthorized | 1383 |
| MultiplayerServerUnavailable | 1388 |
| ProductDisabledForTitle | 1609 |
Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
Gets a remote login endpoint to a VM that is hosting a multiplayer server build in a specific region.
Gets a remote login endpoint to a VM that is hosting a multiplayer server build in a specific region.
The guid string build ID of the multiplayer server to get remote login information for.
The region of the multiplayer server to get remote login information for.
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 The virtual machine ID the multiplayer server is located on.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
