Update Build Regions
Updates a multiplayer server build’s regions.
Allowed entity token types: title
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| APINotEnabledForGameClientAccess | 1082 |
| MultiplayerServerBadRequest | 1382 |
| MultiplayerServerConflict | 1386 |
| MultiplayerServerForbidden | 1384 |
| MultiplayerServerInternalServerError | 1387 |
| MultiplayerServerNotFound | 1385 |
| MultiplayerServerTitleQuotaCoresExceeded | 1445 |
| MultiplayerServerUnauthorized | 1383 |
| MultiplayerServerUnavailable | 1388 |
| ProductDisabledForTitle | 1609 |
POST
/
MultiplayerServer
/
UpdateBuildRegions
Update Build Regions
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildRegions \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
"BuildRegions": [
{
"Region": "EastUs",
"MaxServers": 10,
"StandbyServers": 5
},
{
"Region": "WestUs",
"MaxServers": 12,
"StandbyServers": 8
},
{
"Region": "NorthEurope",
"MaxServers": 7,
"StandbyServers": 3
}
]
}
'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildRegions"
payload = {
"BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
"BuildRegions": [
{
"Region": "EastUs",
"MaxServers": 10,
"StandbyServers": 5
},
{
"Region": "WestUs",
"MaxServers": 12,
"StandbyServers": 8
},
{
"Region": "NorthEurope",
"MaxServers": 7,
"StandbyServers": 3
}
]
}
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: '21781fa8-096d-4d9c-b699-75433d579285',
BuildRegions: [
{Region: 'EastUs', MaxServers: 10, StandbyServers: 5},
{Region: 'WestUs', MaxServers: 12, StandbyServers: 8},
{Region: 'NorthEurope', MaxServers: 7, StandbyServers: 3}
]
})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildRegions', 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/UpdateBuildRegions",
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' => '21781fa8-096d-4d9c-b699-75433d579285',
'BuildRegions' => [
[
'Region' => 'EastUs',
'MaxServers' => 10,
'StandbyServers' => 5
],
[
'Region' => 'WestUs',
'MaxServers' => 12,
'StandbyServers' => 8
],
[
'Region' => 'NorthEurope',
'MaxServers' => 7,
'StandbyServers' => 3
]
]
]),
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/UpdateBuildRegions"
payload := strings.NewReader("{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"BuildRegions\": [\n {\n \"Region\": \"EastUs\",\n \"MaxServers\": 10,\n \"StandbyServers\": 5\n },\n {\n \"Region\": \"WestUs\",\n \"MaxServers\": 12,\n \"StandbyServers\": 8\n },\n {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n ]\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/UpdateBuildRegions")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"BuildRegions\": [\n {\n \"Region\": \"EastUs\",\n \"MaxServers\": 10,\n \"StandbyServers\": 5\n },\n {\n \"Region\": \"WestUs\",\n \"MaxServers\": 12,\n \"StandbyServers\": 8\n },\n {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildRegions")
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\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"BuildRegions\": [\n {\n \"Region\": \"EastUs\",\n \"MaxServers\": 10,\n \"StandbyServers\": 5\n },\n {\n \"Region\": \"WestUs\",\n \"MaxServers\": 12,\n \"StandbyServers\": 8\n },\n {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {}
}{
"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
Updates a multiplayer server build's regions.
Updates a multiplayer server build's regions.
The guid string ID of the build we want to update regions for.
The updated region configuration that should be applied to the specified build.
Show child attributes
Show child attributes
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Last modified on October 1, 2026
Was this page helpful?
⌘I
Update Build Regions
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildRegions \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
"BuildRegions": [
{
"Region": "EastUs",
"MaxServers": 10,
"StandbyServers": 5
},
{
"Region": "WestUs",
"MaxServers": 12,
"StandbyServers": 8
},
{
"Region": "NorthEurope",
"MaxServers": 7,
"StandbyServers": 3
}
]
}
'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildRegions"
payload = {
"BuildId": "21781fa8-096d-4d9c-b699-75433d579285",
"BuildRegions": [
{
"Region": "EastUs",
"MaxServers": 10,
"StandbyServers": 5
},
{
"Region": "WestUs",
"MaxServers": 12,
"StandbyServers": 8
},
{
"Region": "NorthEurope",
"MaxServers": 7,
"StandbyServers": 3
}
]
}
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: '21781fa8-096d-4d9c-b699-75433d579285',
BuildRegions: [
{Region: 'EastUs', MaxServers: 10, StandbyServers: 5},
{Region: 'WestUs', MaxServers: 12, StandbyServers: 8},
{Region: 'NorthEurope', MaxServers: 7, StandbyServers: 3}
]
})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildRegions', 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/UpdateBuildRegions",
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' => '21781fa8-096d-4d9c-b699-75433d579285',
'BuildRegions' => [
[
'Region' => 'EastUs',
'MaxServers' => 10,
'StandbyServers' => 5
],
[
'Region' => 'WestUs',
'MaxServers' => 12,
'StandbyServers' => 8
],
[
'Region' => 'NorthEurope',
'MaxServers' => 7,
'StandbyServers' => 3
]
]
]),
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/UpdateBuildRegions"
payload := strings.NewReader("{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"BuildRegions\": [\n {\n \"Region\": \"EastUs\",\n \"MaxServers\": 10,\n \"StandbyServers\": 5\n },\n {\n \"Region\": \"WestUs\",\n \"MaxServers\": 12,\n \"StandbyServers\": 8\n },\n {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n ]\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/UpdateBuildRegions")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"BuildRegions\": [\n {\n \"Region\": \"EastUs\",\n \"MaxServers\": 10,\n \"StandbyServers\": 5\n },\n {\n \"Region\": \"WestUs\",\n \"MaxServers\": 12,\n \"StandbyServers\": 8\n },\n {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildRegions")
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\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"BuildRegions\": [\n {\n \"Region\": \"EastUs\",\n \"MaxServers\": 10,\n \"StandbyServers\": 5\n },\n {\n \"Region\": \"WestUs\",\n \"MaxServers\": 12,\n \"StandbyServers\": 8\n },\n {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}