Revoke Bans
Revoke all active bans specified with BanId.
curl --request POST \
--url https://{titleId}.playfabapi.com/Server/RevokeBans \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"BanIds": [
"E0B5FF89542D413C",
"EF43FF89542G1546"
]
}
'import requests
url = "https://{titleId}.playfabapi.com/Server/RevokeBans"
payload = { "BanIds": ["E0B5FF89542D413C", "EF43FF89542G1546"] }
headers = {
"X-SecretKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({BanIds: ['E0B5FF89542D413C', 'EF43FF89542G1546']})
};
fetch('https://{titleId}.playfabapi.com/Server/RevokeBans', 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/Server/RevokeBans",
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([
'BanIds' => [
'E0B5FF89542D413C',
'EF43FF89542G1546'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SecretKey: <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/Server/RevokeBans"
payload := strings.NewReader("{\n \"BanIds\": [\n \"E0B5FF89542D413C\",\n \"EF43FF89542G1546\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SecretKey", "<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/Server/RevokeBans")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BanIds\": [\n \"E0B5FF89542D413C\",\n \"EF43FF89542G1546\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Server/RevokeBans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BanIds\": [\n \"E0B5FF89542D413C\",\n \"EF43FF89542G1546\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"BanData": [
{
"PlayFabId": "1679AF5CD04BD838",
"BanId": "E0B5FF89542D413C",
"IPAddress": "192.111.11.1",
"Created": "2016-08-13T05:04:03",
"Reason": "You cheated!"
},
{
"PlayFabId": "2329AF5CD04BF513",
"BanId": "EF43FF89542G1546",
"Created": "2016-05-13T05:04:03",
"Expires": "2016-09-13T05:04:03",
"Reason": "You used speed hack!"
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
Setting the active state of all bans requested to Inactive regardless of whether that ban has already expired. BanIds that do not exist will be skipped. Returns information about applied updates only.
Setting the active state of all bans requested to Inactive regardless of whether that ban has already expired. BanIds that do not exist will be skipped. Returns information about applied updates only.
Ids of the bans to be revoked. Maximum 100.
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
{
"BanData": [
{
"PlayFabId": "1679AF5CD04BD838",
"BanId": "E0B5FF89542D413C",
"IPAddress": "192.111.11.1",
"Created": "2016-08-13T05:04:03",
"Reason": "You cheated!"
},
{
"PlayFabId": "2329AF5CD04BF513",
"BanId": "EF43FF89542G1546",
"Created": "2016-05-13T05:04:03",
"Expires": "2016-09-13T05:04:03",
"Reason": "You used speed hack!"
}
]
}
Was this page helpful?
curl --request POST \
--url https://{titleId}.playfabapi.com/Server/RevokeBans \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"BanIds": [
"E0B5FF89542D413C",
"EF43FF89542G1546"
]
}
'import requests
url = "https://{titleId}.playfabapi.com/Server/RevokeBans"
payload = { "BanIds": ["E0B5FF89542D413C", "EF43FF89542G1546"] }
headers = {
"X-SecretKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({BanIds: ['E0B5FF89542D413C', 'EF43FF89542G1546']})
};
fetch('https://{titleId}.playfabapi.com/Server/RevokeBans', 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/Server/RevokeBans",
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([
'BanIds' => [
'E0B5FF89542D413C',
'EF43FF89542G1546'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-SecretKey: <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/Server/RevokeBans"
payload := strings.NewReader("{\n \"BanIds\": [\n \"E0B5FF89542D413C\",\n \"EF43FF89542G1546\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-SecretKey", "<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/Server/RevokeBans")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BanIds\": [\n \"E0B5FF89542D413C\",\n \"EF43FF89542G1546\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Server/RevokeBans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BanIds\": [\n \"E0B5FF89542D413C\",\n \"EF43FF89542G1546\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"BanData": [
{
"PlayFabId": "1679AF5CD04BD838",
"BanId": "E0B5FF89542D413C",
"IPAddress": "192.111.11.1",
"Created": "2016-08-13T05:04:03",
"Reason": "You cheated!"
},
{
"PlayFabId": "2329AF5CD04BF513",
"BanId": "EF43FF89542G1546",
"Created": "2016-05-13T05:04:03",
"Expires": "2016-09-13T05:04:03",
"Reason": "You used speed hack!"
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}