List Build Summaries V2
Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.
Allowed entity token types: title, title_player_account
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
/
ListBuildSummariesV2
List Build Summaries V2
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/ListBuildSummariesV2 \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '{
"PageSize": 10
}'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/ListBuildSummariesV2"
payload = { "PageSize": 10 }
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({PageSize: 10})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/ListBuildSummariesV2', 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/ListBuildSummariesV2",
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([
'PageSize' => 10
]),
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/ListBuildSummariesV2"
payload := strings.NewReader("{\n \"PageSize\": 10\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/ListBuildSummariesV2")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PageSize\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/ListBuildSummariesV2")
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 \"PageSize\": 10\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {
"PageSize": 123,
"BuildSummaries": [
{
"BuildId": "<string>",
"BuildName": "<string>",
"CreationTime": "<string>",
"Metadata": {},
"RegionConfigurations": [
{
"IsAssetReplicationComplete": true,
"MaxServers": 123,
"StandbyServers": 123,
"CurrentServerStats": {
"Active": 123,
"Propping": 123,
"StandingBy": 123,
"Total": 123
},
"DynamicStandbySettings": {
"IsEnabled": true,
"DynamicFloorMultiplierThresholds": [
{
"Multiplier": 123,
"TriggerThresholdPercentage": 123
}
],
"RampDownSeconds": 123
},
"MultiplayerServerCountPerVm": 123,
"Region": "AustraliaEast",
"ScheduledStandbySettings": {
"IsEnabled": true,
"ScheduleList": [
{
"EndTime": "<string>",
"IsDisabled": true,
"IsRecurringWeekly": true,
"StartTime": "<string>",
"TargetStandby": 123,
"Description": "<string>"
}
]
},
"Status": "<string>",
"VmSize": "Standard_A1"
}
]
}
],
"SkipToken": "<string>"
}
}{
"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 a list of summarized details of all multiplayer server builds for a title.
Returns a list of summarized details of all multiplayer server builds for a title.
Last modified on October 1, 2026
Was this page helpful?
⌘I
List Build Summaries V2
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/ListBuildSummariesV2 \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '{
"PageSize": 10
}'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/ListBuildSummariesV2"
payload = { "PageSize": 10 }
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({PageSize: 10})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/ListBuildSummariesV2', 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/ListBuildSummariesV2",
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([
'PageSize' => 10
]),
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/ListBuildSummariesV2"
payload := strings.NewReader("{\n \"PageSize\": 10\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/ListBuildSummariesV2")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PageSize\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/ListBuildSummariesV2")
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 \"PageSize\": 10\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {
"PageSize": 123,
"BuildSummaries": [
{
"BuildId": "<string>",
"BuildName": "<string>",
"CreationTime": "<string>",
"Metadata": {},
"RegionConfigurations": [
{
"IsAssetReplicationComplete": true,
"MaxServers": 123,
"StandbyServers": 123,
"CurrentServerStats": {
"Active": 123,
"Propping": 123,
"StandingBy": 123,
"Total": 123
},
"DynamicStandbySettings": {
"IsEnabled": true,
"DynamicFloorMultiplierThresholds": [
{
"Multiplier": 123,
"TriggerThresholdPercentage": 123
}
],
"RampDownSeconds": 123
},
"MultiplayerServerCountPerVm": 123,
"Region": "AustraliaEast",
"ScheduledStandbySettings": {
"IsEnabled": true,
"ScheduleList": [
{
"EndTime": "<string>",
"IsDisabled": true,
"IsRecurringWeekly": true,
"StartTime": "<string>",
"TargetStandby": 123,
"Description": "<string>"
}
]
},
"Status": "<string>",
"VmSize": "Standard_A1"
}
]
}
],
"SkipToken": "<string>"
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}