Skip to main content
POST
Validate Api Policy

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json

Validates the proposed policy change and returns the resulting merged policy, validation errors, warnings, and a diff summary showing what would change. Use this to validate the impact of a policy update before calling UpdatePolicy. No changes are saved.

Validates the proposed policy change and returns the resulting merged policy, validation errors, warnings, and a diff summary showing what would change. Use this to validate the impact of a policy update before calling UpdatePolicy. No changes are saved.

OverwritePolicy
boolean
required

Whether the validation should simulate overwriting or appending to the existing policy.

PolicyVersion
number
required

Version of the policy to validate against. Must be the latest (as returned by GetPolicy).

Statements
object[]
required

The statements to validate.

PolicyName
string

The name of the policy to validate. Only 'ApiPolicy' is supported. This parameter is optional and defaults to 'ApiPolicy' if omitted.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026