Update Build Alias
Creates a multiplayer server build alias.
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 |
| MultiplayerServerUnauthorized | 1383 |
| MultiplayerServerUnavailable | 1388 |
| ProductDisabledForTitle | 1609 |
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildAlias \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"AliasName": "AliasName",
"BuildSelectionCriteria": [
{
"BuildWeightDistribution": {
"53781fa8-006d-4e9c-b733-57433d579285": 1
}
}
],
"AliasId": "21781fa8-096d-4d9c-b699-75433d579285"
}
'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildAlias"
payload = {
"AliasName": "AliasName",
"BuildSelectionCriteria": [{ "BuildWeightDistribution": { "53781fa8-006d-4e9c-b733-57433d579285": 1 } }],
"AliasId": "21781fa8-096d-4d9c-b699-75433d579285"
}
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({
AliasName: 'AliasName',
BuildSelectionCriteria: [{BuildWeightDistribution: {'53781fa8-006d-4e9c-b733-57433d579285': 1}}],
AliasId: '21781fa8-096d-4d9c-b699-75433d579285'
})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildAlias', 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/UpdateBuildAlias",
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([
'AliasName' => 'AliasName',
'BuildSelectionCriteria' => [
[
'BuildWeightDistribution' => [
'53781fa8-006d-4e9c-b733-57433d579285' => 1
]
]
],
'AliasId' => '21781fa8-096d-4d9c-b699-75433d579285'
]),
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/UpdateBuildAlias"
payload := strings.NewReader("{\n \"AliasName\": \"AliasName\",\n \"BuildSelectionCriteria\": [\n {\n \"BuildWeightDistribution\": {\n \"53781fa8-006d-4e9c-b733-57433d579285\": 1\n }\n }\n ],\n \"AliasId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\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/UpdateBuildAlias")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"AliasName\": \"AliasName\",\n \"BuildSelectionCriteria\": [\n {\n \"BuildWeightDistribution\": {\n \"53781fa8-006d-4e9c-b733-57433d579285\": 1\n }\n }\n ],\n \"AliasId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildAlias")
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 \"AliasName\": \"AliasName\",\n \"BuildSelectionCriteria\": [\n {\n \"BuildWeightDistribution\": {\n \"53781fa8-006d-4e9c-b733-57433d579285\": 1\n }\n }\n ],\n \"AliasId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"AliasId": "21781fa8-096d-4d9c-b699-75433d579285",
"AliasName": "AliasName",
"BuildSelectionCriteria": [
{
"BuildWeightDistribution": {
"53781fa8-006d-4e9c-b733-57433d579285": 1
}
}
]
}
}{
"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 multiplayer server build alias and returns the created alias.
Creates a multiplayer server build alias and returns the created alias.
The guid string alias Id of the alias to be updated.
The alias name.
Array of build selection criteria.
Show child attributes
Show child attributes
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
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
{ "AliasId": "21781fa8-096d-4d9c-b699-75433d579285", "AliasName": "AliasName", "BuildSelectionCriteria": [ { "BuildWeightDistribution": { "53781fa8-006d-4e9c-b733-57433d579285": 1 } } ] }
Was this page helpful?
curl --request POST \
--url https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildAlias \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"AliasName": "AliasName",
"BuildSelectionCriteria": [
{
"BuildWeightDistribution": {
"53781fa8-006d-4e9c-b733-57433d579285": 1
}
}
],
"AliasId": "21781fa8-096d-4d9c-b699-75433d579285"
}
'import requests
url = "https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildAlias"
payload = {
"AliasName": "AliasName",
"BuildSelectionCriteria": [{ "BuildWeightDistribution": { "53781fa8-006d-4e9c-b733-57433d579285": 1 } }],
"AliasId": "21781fa8-096d-4d9c-b699-75433d579285"
}
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({
AliasName: 'AliasName',
BuildSelectionCriteria: [{BuildWeightDistribution: {'53781fa8-006d-4e9c-b733-57433d579285': 1}}],
AliasId: '21781fa8-096d-4d9c-b699-75433d579285'
})
};
fetch('https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildAlias', 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/UpdateBuildAlias",
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([
'AliasName' => 'AliasName',
'BuildSelectionCriteria' => [
[
'BuildWeightDistribution' => [
'53781fa8-006d-4e9c-b733-57433d579285' => 1
]
]
],
'AliasId' => '21781fa8-096d-4d9c-b699-75433d579285'
]),
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/UpdateBuildAlias"
payload := strings.NewReader("{\n \"AliasName\": \"AliasName\",\n \"BuildSelectionCriteria\": [\n {\n \"BuildWeightDistribution\": {\n \"53781fa8-006d-4e9c-b733-57433d579285\": 1\n }\n }\n ],\n \"AliasId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\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/UpdateBuildAlias")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"AliasName\": \"AliasName\",\n \"BuildSelectionCriteria\": [\n {\n \"BuildWeightDistribution\": {\n \"53781fa8-006d-4e9c-b733-57433d579285\": 1\n }\n }\n ],\n \"AliasId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/MultiplayerServer/UpdateBuildAlias")
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 \"AliasName\": \"AliasName\",\n \"BuildSelectionCriteria\": [\n {\n \"BuildWeightDistribution\": {\n \"53781fa8-006d-4e9c-b733-57433d579285\": 1\n }\n }\n ],\n \"AliasId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"AliasId": "21781fa8-096d-4d9c-b699-75433d579285",
"AliasName": "AliasName",
"BuildSelectionCriteria": [
{
"BuildWeightDistribution": {
"53781fa8-006d-4e9c-b733-57433d579285": 1
}
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}