Get Policy
Gets the requested policy.
POST
/
Admin
/
GetPolicy
Get Policy
curl --request POST \
--url https://{titleId}.playfabapi.com/Admin/GetPolicy \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"PolicyName": "ApiPolicy"
}
'import requests
url = "https://{titleId}.playfabapi.com/Admin/GetPolicy"
payload = { "PolicyName": "ApiPolicy" }
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({PolicyName: 'ApiPolicy'})
};
fetch('https://{titleId}.playfabapi.com/Admin/GetPolicy', 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/Admin/GetPolicy",
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([
'PolicyName' => 'ApiPolicy'
]),
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/Admin/GetPolicy"
payload := strings.NewReader("{\n \"PolicyName\": \"ApiPolicy\"\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/Admin/GetPolicy")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PolicyName\": \"ApiPolicy\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Admin/GetPolicy")
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 \"PolicyName\": \"ApiPolicy\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"PolicyName": "ApiPolicy",
"Statements": [
{
"Resource": "pfrn:api--*",
"Action": "*",
"Principal": "*",
"Comment": "The default allow all policy"
},
{
"Resource": "pfrn:api--/Client/ConfirmPurchase",
"Action": "*",
"Principal": "*",
"Comment": "This statement allows only request to ConfirmPurchase"
}
]
}
}{
"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
application/json
Views the requested policy. Today, the only supported policy is 'ApiPolicy'.
Views the requested policy. Today, the only supported policy is 'ApiPolicy'.
The name of the policy to read. Only 'ApiPolicy' is supported. This parameter is optional and defaults to 'ApiPolicy' if omitted.
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
Example:
{
"PolicyName": "ApiPolicy",
"Statements": [
{
"Resource": "pfrn:api--*",
"Action": "*",
"Principal": "*",
"Comment": "The default allow all policy"
},
{
"Resource": "pfrn:api--/Client/ConfirmPurchase",
"Action": "*",
"Principal": "*",
"Comment": "This statement allows only request to ConfirmPurchase"
}
]
}
Last modified on October 1, 2026
Was this page helpful?
⌘I
Get Policy
curl --request POST \
--url https://{titleId}.playfabapi.com/Admin/GetPolicy \
--header 'Content-Type: application/json' \
--header 'X-SecretKey: <api-key>' \
--data '
{
"PolicyName": "ApiPolicy"
}
'import requests
url = "https://{titleId}.playfabapi.com/Admin/GetPolicy"
payload = { "PolicyName": "ApiPolicy" }
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({PolicyName: 'ApiPolicy'})
};
fetch('https://{titleId}.playfabapi.com/Admin/GetPolicy', 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/Admin/GetPolicy",
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([
'PolicyName' => 'ApiPolicy'
]),
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/Admin/GetPolicy"
payload := strings.NewReader("{\n \"PolicyName\": \"ApiPolicy\"\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/Admin/GetPolicy")
.header("X-SecretKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"PolicyName\": \"ApiPolicy\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Admin/GetPolicy")
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 \"PolicyName\": \"ApiPolicy\"\n}"
response = http.request(request)
puts response.read_body{
"code": 200,
"status": "OK",
"data": {
"PolicyName": "ApiPolicy",
"Statements": [
{
"Resource": "pfrn:api--*",
"Action": "*",
"Principal": "*",
"Comment": "The default allow all policy"
},
{
"Resource": "pfrn:api--/Client/ConfirmPurchase",
"Action": "*",
"Principal": "*",
"Comment": "This statement allows only request to ConfirmPurchase"
}
]
}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}