Create Title Multiplayer Servers Quota Change
Creates a request to change a title’s multiplayer server quotas.
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 |
| MultiplayerServerUnauthorized | 1383 |
| ProductDisabledForTitle | 1609 |
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"ContactEmail": "john@mygamestudio.com",
"StartDate": "2020-01-23T00:00:00",
"ChangeDescription": "Season 3 Launch",
"Notes": "Based on the last launch, we expect 1 trillion active users.",
"Changes": [
{
"VmFamily": "Dasv4",
"Region": "EastUs",
"NewCoreLimit": 55000
},
{
"VmFamily": "Dasv4",
"Region": "NorthCentralUs",
"NewCoreLimit": 65000
}
]
}
'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange"
payload = {
"ContactEmail": "john@mygamestudio.com",
"StartDate": "2020-01-23T00:00:00",
"ChangeDescription": "Season 3 Launch",
"Notes": "Based on the last launch, we expect 1 trillion active users.",
"Changes": [
{
"VmFamily": "Dasv4",
"Region": "EastUs",
"NewCoreLimit": 55000
},
{
"VmFamily": "Dasv4",
"Region": "NorthCentralUs",
"NewCoreLimit": 65000
}
]
}
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({
ContactEmail: 'john@mygamestudio.com',
StartDate: '2020-01-23T00:00:00',
ChangeDescription: 'Season 3 Launch',
Notes: 'Based on the last launch, we expect 1 trillion active users.',
Changes: [
{VmFamily: 'Dasv4', Region: 'EastUs', NewCoreLimit: 55000},
{VmFamily: 'Dasv4', Region: 'NorthCentralUs', NewCoreLimit: 65000}
]
})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange', 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/CreateTitleMultiplayerServersQuotaChange",
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([
'ContactEmail' => 'john@mygamestudio.com',
'StartDate' => '2020-01-23T00:00:00',
'ChangeDescription' => 'Season 3 Launch',
'Notes' => 'Based on the last launch, we expect 1 trillion active users.',
'Changes' => [
[
'VmFamily' => 'Dasv4',
'Region' => 'EastUs',
'NewCoreLimit' => 55000
],
[
'VmFamily' => 'Dasv4',
'Region' => 'NorthCentralUs',
'NewCoreLimit' => 65000
]
]
]),
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/CreateTitleMultiplayerServersQuotaChange"
payload := strings.NewReader("{\n \"ContactEmail\": \"john@mygamestudio.com\",\n \"StartDate\": \"2020-01-23T00:00:00\",\n \"ChangeDescription\": \"Season 3 Launch\",\n \"Notes\": \"Based on the last launch, we expect 1 trillion active users.\",\n \"Changes\": [\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"EastUs\",\n \"NewCoreLimit\": 55000\n },\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"NorthCentralUs\",\n \"NewCoreLimit\": 65000\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/CreateTitleMultiplayerServersQuotaChange")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ContactEmail\": \"john@mygamestudio.com\",\n \"StartDate\": \"2020-01-23T00:00:00\",\n \"ChangeDescription\": \"Season 3 Launch\",\n \"Notes\": \"Based on the last launch, we expect 1 trillion active users.\",\n \"Changes\": [\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"EastUs\",\n \"NewCoreLimit\": 55000\n },\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"NorthCentralUs\",\n \"NewCoreLimit\": 65000\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange")
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 \"ContactEmail\": \"john@mygamestudio.com\",\n \"StartDate\": \"2020-01-23T00:00:00\",\n \"ChangeDescription\": \"Season 3 Launch\",\n \"Notes\": \"Based on the last launch, we expect 1 trillion active users.\",\n \"Changes\": [\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"EastUs\",\n \"NewCoreLimit\": 55000\n },\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"NorthCentralUs\",\n \"NewCoreLimit\": 65000\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"RequestId": "1234",
"WasApproved": 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
Creates a request to change a title's multiplayer server quotas.
Creates a request to change a title's multiplayer server quotas.
Changes to make to the titles cores quota.
Show child attributes
Show child attributes
A brief description of the requested changes.
Email to be contacted by our team about this request. Only required when a request is not approved.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Additional information about this request that our team can use to better understand the requirements.
When these changes would need to be in effect. Only required when a request is not approved.
Was this page helpful?
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"ContactEmail": "john@mygamestudio.com",
"StartDate": "2020-01-23T00:00:00",
"ChangeDescription": "Season 3 Launch",
"Notes": "Based on the last launch, we expect 1 trillion active users.",
"Changes": [
{
"VmFamily": "Dasv4",
"Region": "EastUs",
"NewCoreLimit": 55000
},
{
"VmFamily": "Dasv4",
"Region": "NorthCentralUs",
"NewCoreLimit": 65000
}
]
}
'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange"
payload = {
"ContactEmail": "john@mygamestudio.com",
"StartDate": "2020-01-23T00:00:00",
"ChangeDescription": "Season 3 Launch",
"Notes": "Based on the last launch, we expect 1 trillion active users.",
"Changes": [
{
"VmFamily": "Dasv4",
"Region": "EastUs",
"NewCoreLimit": 55000
},
{
"VmFamily": "Dasv4",
"Region": "NorthCentralUs",
"NewCoreLimit": 65000
}
]
}
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({
ContactEmail: 'john@mygamestudio.com',
StartDate: '2020-01-23T00:00:00',
ChangeDescription: 'Season 3 Launch',
Notes: 'Based on the last launch, we expect 1 trillion active users.',
Changes: [
{VmFamily: 'Dasv4', Region: 'EastUs', NewCoreLimit: 55000},
{VmFamily: 'Dasv4', Region: 'NorthCentralUs', NewCoreLimit: 65000}
]
})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange', 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/CreateTitleMultiplayerServersQuotaChange",
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([
'ContactEmail' => 'john@mygamestudio.com',
'StartDate' => '2020-01-23T00:00:00',
'ChangeDescription' => 'Season 3 Launch',
'Notes' => 'Based on the last launch, we expect 1 trillion active users.',
'Changes' => [
[
'VmFamily' => 'Dasv4',
'Region' => 'EastUs',
'NewCoreLimit' => 55000
],
[
'VmFamily' => 'Dasv4',
'Region' => 'NorthCentralUs',
'NewCoreLimit' => 65000
]
]
]),
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/CreateTitleMultiplayerServersQuotaChange"
payload := strings.NewReader("{\n \"ContactEmail\": \"john@mygamestudio.com\",\n \"StartDate\": \"2020-01-23T00:00:00\",\n \"ChangeDescription\": \"Season 3 Launch\",\n \"Notes\": \"Based on the last launch, we expect 1 trillion active users.\",\n \"Changes\": [\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"EastUs\",\n \"NewCoreLimit\": 55000\n },\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"NorthCentralUs\",\n \"NewCoreLimit\": 65000\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/CreateTitleMultiplayerServersQuotaChange")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ContactEmail\": \"john@mygamestudio.com\",\n \"StartDate\": \"2020-01-23T00:00:00\",\n \"ChangeDescription\": \"Season 3 Launch\",\n \"Notes\": \"Based on the last launch, we expect 1 trillion active users.\",\n \"Changes\": [\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"EastUs\",\n \"NewCoreLimit\": 55000\n },\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"NorthCentralUs\",\n \"NewCoreLimit\": 65000\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange")
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 \"ContactEmail\": \"john@mygamestudio.com\",\n \"StartDate\": \"2020-01-23T00:00:00\",\n \"ChangeDescription\": \"Season 3 Launch\",\n \"Notes\": \"Based on the last launch, we expect 1 trillion active users.\",\n \"Changes\": [\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"EastUs\",\n \"NewCoreLimit\": 55000\n },\n {\n \"VmFamily\": \"Dasv4\",\n \"Region\": \"NorthCentralUs\",\n \"NewCoreLimit\": 65000\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"RequestId": "1234",
"WasApproved": true
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}