Revoke All Bans For User
Revoke all active bans for a user.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| UserisNotValid | 1030 |
curl --request POST \
--url https://{titleId}.playfabapi.com/Server/RevokeAllBansForUser \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"PlayFabId": "1679AF5CD04BD838"
}
'import requests
url = "https://{titleId}.playfabapi.com/Server/RevokeAllBansForUser"
payload = { "PlayFabId": "1679AF5CD04BD838" }
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({PlayFabId: '1679AF5CD04BD838'})
};
fetch('https://{titleId}.playfabapi.com/Server/RevokeAllBansForUser', 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/RevokeAllBansForUser",
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([
'PlayFabId' => '1679AF5CD04BD838'
]),
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/RevokeAllBansForUser"
payload := strings.NewReader("{\n \"PlayFabId\": \"1679AF5CD04BD838\"\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/RevokeAllBansForUser")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PlayFabId\": \"1679AF5CD04BD838\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Server/RevokeAllBansForUser")
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 \"PlayFabId\": \"1679AF5CD04BD838\"\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 non-expired bans for a user to Inactive. Expired bans with an Active state will be ignored, however. Returns information about applied updates only.
Setting the active state of all non-expired bans for a user to Inactive. Expired bans with an Active state will be ignored, however. Returns information about applied updates only.
Unique PlayFab assigned ID of the user on whom the operation will be performed.
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/RevokeAllBansForUser \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"PlayFabId": "1679AF5CD04BD838"
}
'import requests
url = "https://{titleId}.playfabapi.com/Server/RevokeAllBansForUser"
payload = { "PlayFabId": "1679AF5CD04BD838" }
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({PlayFabId: '1679AF5CD04BD838'})
};
fetch('https://{titleId}.playfabapi.com/Server/RevokeAllBansForUser', 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/RevokeAllBansForUser",
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([
'PlayFabId' => '1679AF5CD04BD838'
]),
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/RevokeAllBansForUser"
payload := strings.NewReader("{\n \"PlayFabId\": \"1679AF5CD04BD838\"\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/RevokeAllBansForUser")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PlayFabId\": \"1679AF5CD04BD838\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Server/RevokeAllBansForUser")
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 \"PlayFabId\": \"1679AF5CD04BD838\"\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": {}
}