Skip to main content
POST
Update 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 update an existing IP ban.

Request to update an existing IP ban.

IPAddress
string
required

The IP address of the ban to be updated.

Active
boolean

The updated active state for the IP ban. Null for no change.

CustomTags
object

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

Expires
string

The updated expiration date for the IP ban. Null for no change.

Permanent
boolean

Whether to make this IP ban permanent. Set to true to make this IP ban permanent. This will not modify Active state.

Reason
string

The updated reason for the IP ban. Maximum 140 characters. Null for no change.

Response

Result of updating 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 updating an IP ban.

Example:
Last modified on October 1, 2026