Saltar al contenido principal
POST
Get Remote Login Endpoint

Autorizaciones

X-EntityToken
string
header
requerido

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Cuerpo

application/json

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.

BuildId
string
requerido

The guid string build ID of the multiplayer server to get remote login information for.

Region
enum<string>
requerido

The region of the multiplayer server to get remote login information for.

Opciones disponibles:
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
VmId
string
requerido

The virtual machine ID the multiplayer server is located on.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Respuesta

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Ejemplo:
Última modificación el 6 de octubre de 2026