Skip to main content
POST
Create IP Ban

Authorizations

X-SecretKey
string
header
required

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

Body

application/json

Request to create an IP ban for a title.

Request to create an IP ban for a title.

IPAddress
string
required

The IP address to be banned.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Expires
string

The UTC date and time when the IP ban expires. Leave this blank for a permanent ban. Must be later than the current time and no more than 100 years in the future.

Reason
string

The reason for the IP ban. Maximum 140 characters.

Response

Result of creating an IP ban.

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

Result of creating an IP ban.

Example:
Last modified on October 1, 2026