Get Build
Gets 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 |
POST
/
MultiplayerServer
/
GetBuild
Get Build
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"BuildId": "53781fa8-006d-4e9c-b733-57433d579285"
}
'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild"
payload = { "BuildId": "53781fa8-006d-4e9c-b733-57433d579285" }
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({BuildId: '53781fa8-006d-4e9c-b733-57433d579285'})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'BuildId' => '53781fa8-006d-4e9c-b733-57433d579285'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild"
payload := strings.NewReader("{\n \"BuildId\": \"53781fa8-006d-4e9c-b733-57433d579285\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BuildId\": \"53781fa8-006d-4e9c-b733-57433d579285\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BuildId\": \"53781fa8-006d-4e9c-b733-57433d579285\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
"BuildName": "GameBuildName",
"BuildStatus": "Deployed",
"CreationTime": "2014-04-07T09:04:28",
"Metadata": {
"MetadataKey": "MetadataValue"
},
"VmSize": "Standard_D2_v2",
"Ports": [
{
"Name": "PortName",
"Num": 1243
}
],
"RegionConfigurations": [
{
"Region": "EastUs",
"Status": "Initializing",
"MaxServers": 10,
"StandbyServers": 5,
"CurrentServerStats": {
"Propping": 5,
"Total": 5
}
},
{
"Region": "WestUs",
"Status": "Succeeded",
"MaxServers": 12,
"StandbyServers": 8,
"CurrentServerStats": {
"Active": 1,
"StandingBy": 7,
"Propping": 1,
"Total": 9
}
},
{
"Region": "NorthEurope",
"Status": "Unhealthy",
"MaxServers": 7,
"StandbyServers": 3,
"CurrentServerStats": {
"Propping": 3,
"Total": 3
}
}
],
"GameAssetReferences": [
{
"FileName": "gameserver.zip",
"MountPath": "C:\\Asset\\"
}
],
"GameCertificateReferences": [
{
"Name": "CertName",
"GsdkAlias": "CertGsdkAlias"
}
],
"StartMultiplayerServerCommand": "C:\\Assets\\gameserver.exe -startserver",
"MultiplayerServerCountPerVm": 1,
"InstrumentationConfiguration": {
"ProcessesToMonitor": [
"GameServerProcessName"
],
"IsEnabled": true
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
application/json
Returns the details about a multiplayer server build.
Response
The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.
The Http status code as a string.
Show child attributes
Show child attributes
Example:
{
"BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
"BuildName": "GameBuildName",
"BuildStatus": "Deployed",
"CreationTime": "2014-04-07T09:04:28",
"Metadata": { "MetadataKey": "MetadataValue" },
"VmSize": "Standard_D2_v2",
"Ports": [{ "Name": "PortName", "Num": 1243 }],
"RegionConfigurations": [
{
"Region": "EastUs",
"Status": "Initializing",
"MaxServers": 10,
"StandbyServers": 5,
"CurrentServerStats": { "Propping": 5, "Total": 5 }
},
{
"Region": "WestUs",
"Status": "Succeeded",
"MaxServers": 12,
"StandbyServers": 8,
"CurrentServerStats": {
"Active": 1,
"StandingBy": 7,
"Propping": 1,
"Total": 9
}
},
{
"Region": "NorthEurope",
"Status": "Unhealthy",
"MaxServers": 7,
"StandbyServers": 3,
"CurrentServerStats": { "Propping": 3, "Total": 3 }
}
],
"GameAssetReferences": [
{
"FileName": "gameserver.zip",
"MountPath": "C:\\Asset\\"
}
],
"GameCertificateReferences": [
{
"Name": "CertName",
"GsdkAlias": "CertGsdkAlias"
}
],
"StartMultiplayerServerCommand": "C:\\Assets\\gameserver.exe -startserver",
"MultiplayerServerCountPerVm": 1,
"InstrumentationConfiguration": {
"ProcessesToMonitor": ["GameServerProcessName"],
"IsEnabled": true
}
}
Last modified on October 1, 2026
Was this page helpful?
⌘I
Get Build
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"BuildId": "53781fa8-006d-4e9c-b733-57433d579285"
}
'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild"
payload = { "BuildId": "53781fa8-006d-4e9c-b733-57433d579285" }
headers = {
"X-EntityToken": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({BuildId: '53781fa8-006d-4e9c-b733-57433d579285'})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'BuildId' => '53781fa8-006d-4e9c-b733-57433d579285'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-EntityToken: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild"
payload := strings.NewReader("{\n \"BuildId\": \"53781fa8-006d-4e9c-b733-57433d579285\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-EntityToken", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BuildId\": \"53781fa8-006d-4e9c-b733-57433d579285\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/GetBuild")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BuildId\": \"53781fa8-006d-4e9c-b733-57433d579285\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
"BuildName": "GameBuildName",
"BuildStatus": "Deployed",
"CreationTime": "2014-04-07T09:04:28",
"Metadata": {
"MetadataKey": "MetadataValue"
},
"VmSize": "Standard_D2_v2",
"Ports": [
{
"Name": "PortName",
"Num": 1243
}
],
"RegionConfigurations": [
{
"Region": "EastUs",
"Status": "Initializing",
"MaxServers": 10,
"StandbyServers": 5,
"CurrentServerStats": {
"Propping": 5,
"Total": 5
}
},
{
"Region": "WestUs",
"Status": "Succeeded",
"MaxServers": 12,
"StandbyServers": 8,
"CurrentServerStats": {
"Active": 1,
"StandingBy": 7,
"Propping": 1,
"Total": 9
}
},
{
"Region": "NorthEurope",
"Status": "Unhealthy",
"MaxServers": 7,
"StandbyServers": 3,
"CurrentServerStats": {
"Propping": 3,
"Total": 3
}
}
],
"GameAssetReferences": [
{
"FileName": "gameserver.zip",
"MountPath": "C:\\Asset\\"
}
],
"GameCertificateReferences": [
{
"Name": "CertName",
"GsdkAlias": "CertGsdkAlias"
}
],
"StartMultiplayerServerCommand": "C:\\Assets\\gameserver.exe -startserver",
"MultiplayerServerCountPerVm": 1,
"InstrumentationConfiguration": {
"ProcessesToMonitor": [
"GameServerProcessName"
],
"IsEnabled": true
}
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}