PlayFab

PlayFab Admin API

APIs for managing title configurations, uploaded Game Server code executables, and user data

Media & content#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

APIs for managing title configurations, uploaded Game Server code executables, and user data

Endpoints 123

Account Management

  • POSTBanUsers/Admin/BanUsersBans users by PlayFab ID with optional IP address for the provided game.
  • POSTCreateIPBan/Admin/CreateIPBanBans an IP address or CIDR range for a title.
  • POSTDeleteMasterPlayerAccount/Admin/DeleteMasterPlayerAccountRemoves a master player account entirely from all titles and deletes all associated data
  • POSTDeleteMasterPlayerEventData/Admin/DeleteMasterPlayerEventDataDeletes PlayStream and telemetry event data associated with the master player account from PlayFab storage
  • POSTDeleteMembershipSubscription/Admin/DeleteMembershipSubscriptionDeletes a player's subscription
  • POSTDeletePlayer/Admin/DeletePlayerRemoves a user's player account from a title and deletes all associated data
  • POSTDeleteTitle/Admin/DeleteTitlePermanently deletes a title and all associated configuration
  • POSTExportMasterPlayerData/Admin/ExportMasterPlayerDataExports all associated data of a master player account
  • POSTGetIPBansForIP/Admin/GetIPBansForIPGets all IP bans that apply to a specific IP address.
  • POSTGetIPBansForTitle/Admin/GetIPBansForTitleGets all IP bans for a title.
  • POSTGetPlayedTitleList/Admin/GetPlayedTitleListGet the list of titles that the player has played
  • POSTGetPlayerIdFromAuthToken/Admin/GetPlayerIdFromAuthTokenGets a player's ID from an auth token.
  • POSTGetPlayerProfile/Admin/GetPlayerProfileRetrieves the player's profile
  • POSTGetUserAccountInfo/Admin/GetUserAccountInfoRetrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
  • POSTGetUserBans/Admin/GetUserBansGets all bans for a user.
  • POSTResetPassword/Admin/ResetPasswordReset a player's password for a given title.
  • POSTRevokeAllBansForUser/Admin/RevokeAllBansForUserRevoke all active bans for a user.
  • POSTRevokeBans/Admin/RevokeBansRevoke all active bans specified with BanId.
  • POSTRevokeIPBan/Admin/RevokeIPBanRevokes an active IP ban.
  • POSTSendAccountRecoveryEmail/Admin/SendAccountRecoveryEmailForces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery…
  • POSTSetMembershipOverride/Admin/SetMembershipOverrideSets the override expiration for a membership subscription
  • POSTUpdateBans/Admin/UpdateBansUpdates information of a list of existing bans specified with Ban Ids.
  • POSTUpdateIPBan/Admin/UpdateIPBanUpdates an existing IP ban.
  • POSTUpdateUserTitleDisplayName/Admin/UpdateUserTitleDisplayNameUpdates the title specific display name for a user

Authentication

  • POSTCreateOpenIdConnection/Admin/CreateOpenIdConnectionRegisters a relationship between a title and an Open ID Connect provider.
  • POSTCreatePlayerSharedSecret/Admin/CreatePlayerSharedSecretCreates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after this API returns.
  • POSTDeleteOpenIdConnection/Admin/DeleteOpenIdConnectionRemoves a relationship between a title and an OpenID Connect provider.
  • POSTDeletePlayerSharedSecret/Admin/DeletePlayerSharedSecretDeletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API returns.
  • POSTGetPlayerSharedSecrets/Admin/GetPlayerSharedSecretsReturns all Player Shared Secret Keys including disabled and expired.
  • POSTGetPolicy/Admin/GetPolicyGets the requested policy.
  • POSTListOpenIdConnection/Admin/ListOpenIdConnectionRetrieves a list of all Open ID Connect providers registered to a title.
  • POSTSetPlayerSecret/Admin/SetPlayerSecretSets or resets the player's secret. Player secrets are used to sign API requests.
  • POSTUpdateOpenIdConnection/Admin/UpdateOpenIdConnectionModifies data and credentials for an existing relationship between a title and an Open ID Connect provider
  • POSTUpdatePlayerSharedSecret/Admin/UpdatePlayerSharedSecretUpdates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available after this API returns.
  • POSTUpdatePolicy/Admin/UpdatePolicyChanges a policy for a title
  • POSTValidateApiPolicy/Admin/ValidateApiPolicyValidates the result of a policy update without persisting it.

Characters

  • POSTResetCharacterStatistics/Admin/ResetCharacterStatisticsCompletely removes all statistics for the specified character, for the current game

Content

  • POSTDeleteContent/Admin/DeleteContentDelete a content file from the title. When deleting a file that does not exist, it returns success.
  • POSTGetContentList/Admin/GetContentListList all contents of the title and get statistics such as size
  • POSTGetContentUploadUrl/Admin/GetContentUploadUrlRetrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content. Also, please be aware that the…

Player Data Management

  • POSTCreatePlayerStatisticDefinition/Admin/CreatePlayerStatisticDefinitionAdds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method.
  • POSTDeletePlayerCustomProperties/Admin/DeletePlayerCustomPropertiesDeletes title-specific custom properties for a player
  • POSTGetDataReport/Admin/GetDataReportRetrieves a download URL for the requested report
  • POSTGetPlayerCustomProperty/Admin/GetPlayerCustomPropertyRetrieves a title-specific custom property value for a player.
  • POSTGetPlayerStatisticDefinitions/Admin/GetPlayerStatisticDefinitionsRetrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval.
  • POSTGetPlayerStatisticVersions/Admin/GetPlayerStatisticVersionsRetrieves the information on the available versions of the specified statistic.
  • POSTGetUserData/Admin/GetUserDataRetrieves the title-specific custom data for the user which is readable and writable by the client
  • POSTGetUserInternalData/Admin/GetUserInternalDataRetrieves the title-specific custom data for the user which cannot be accessed by the client
  • POSTGetUserPublisherData/Admin/GetUserPublisherDataRetrieves the publisher-specific custom data for the user which is readable and writable by the client
  • POSTGetUserPublisherInternalData/Admin/GetUserPublisherInternalDataRetrieves the publisher-specific custom data for the user which cannot be accessed by the client
  • POSTGetUserPublisherReadOnlyData/Admin/GetUserPublisherReadOnlyDataRetrieves the publisher-specific custom data for the user which can only be read by the client
  • POSTGetUserReadOnlyData/Admin/GetUserReadOnlyDataRetrieves the title-specific custom data for the user which can only be read by the client
  • POSTIncrementPlayerStatisticVersion/Admin/IncrementPlayerStatisticVersionResets the indicated statistic, removing all player entries for it and backing up the old values.
  • POSTListPlayerCustomProperties/Admin/ListPlayerCustomPropertiesRetrieves title-specific custom property values for a player.
  • POSTRefundPurchase/Admin/RefundPurchase_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Attempts to process an…
  • POSTResetUserStatistics/Admin/ResetUserStatisticsCompletely removes all statistics for the specified user, for the current game
  • POSTResolvePurchaseDispute/Admin/ResolvePurchaseDispute_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Attempts to resolve a…
  • POSTUpdatePlayerCustomProperties/Admin/UpdatePlayerCustomPropertiesUpdates the title-specific custom property values for a player
  • POSTUpdatePlayerStatisticDefinition/Admin/UpdatePlayerStatisticDefinitionUpdates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.
  • POSTUpdateUserData/Admin/UpdateUserDataUpdates the title-specific custom data for the user which is readable and writable by the client
  • POSTUpdateUserInternalData/Admin/UpdateUserInternalDataUpdates the title-specific custom data for the user which cannot be accessed by the client
  • POSTUpdateUserPublisherData/Admin/UpdateUserPublisherDataUpdates the publisher-specific custom data for the user which is readable and writable by the client
  • POSTUpdateUserPublisherInternalData/Admin/UpdateUserPublisherInternalDataUpdates the publisher-specific custom data for the user which cannot be accessed by the client
  • POSTUpdateUserPublisherReadOnlyData/Admin/UpdateUserPublisherReadOnlyDataUpdates the publisher-specific custom data for the user which can only be read by the client
  • POSTUpdateUserReadOnlyData/Admin/UpdateUserReadOnlyDataUpdates the title-specific custom data for the user which can only be read by the client

Player Item Management

  • POSTAddUserVirtualCurrency/Admin/AddUserVirtualCurrency_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the specified…
  • POSTCheckLimitedEditionItemAvailability/Admin/CheckLimitedEditionItemAvailability_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Checks the global count for…
  • POSTGetUserInventory/Admin/GetUserInventory_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified…
  • POSTGrantItemsToUsers/Admin/GrantItemsToUsers_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to…
  • POSTIncrementLimitedEditionItemAvailability/Admin/IncrementLimitedEditionItemAvailability_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increases the global count…
  • POSTRevokeInventoryItem/Admin/RevokeInventoryItem_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access to an item…
  • POSTRevokeInventoryItems/Admin/RevokeInventoryItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access for up to 25…
  • POSTSubtractUserVirtualCurrency/Admin/SubtractUserVirtualCurrency_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the specified…

PlayStream

  • POSTAddPlayerTag/Admin/AddPlayerTagAdds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
  • POSTExportPlayersInSegment/Admin/ExportPlayersInSegmentStarts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which match the segment definition at the time…
  • POSTGetAllSegments/Admin/GetAllSegmentsRetrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as ExportPlayersInSegment which requires a…
  • POSTGetPlayerSegments/Admin/GetPlayerSegmentsList all segments that a player currently belongs to at this moment in time.
  • POSTGetPlayerTags/Admin/GetPlayerTagsGet all tags with a given Namespace (optional) from a player profile.
  • POSTGetSegmentExport/Admin/GetSegmentExportRetrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and complete, this API returns the…
  • POSTGetSegmentPlayerCount/Admin/GetSegmentPlayerCountReturns the total number of players in a given segment.
  • POSTRemovePlayerTag/Admin/RemovePlayerTagRemove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.

ScheduledTask

  • POSTAbortTaskInstance/Admin/AbortTaskInstanceAbort an ongoing task instance.
  • POSTCreateActionsOnPlayersInSegmentTask/Admin/CreateActionsOnPlayersInSegmentTaskCreate an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.
  • POSTCreateCloudScriptTask/Admin/CreateCloudScriptTaskCreate a CloudScript task, which can run a CloudScript on a schedule.
  • POSTCreateInsightsScheduledScalingTask/Admin/CreateInsightsScheduledScalingTaskCreate a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule
  • POSTDeleteTask/Admin/DeleteTaskDelete a task.
  • POSTGetActionsOnPlayersInSegmentTaskInstance/Admin/GetActionsOnPlayersInSegmentTaskInstanceGet information about a ActionsOnPlayersInSegment task instance.
  • POSTGetCloudScriptTaskInstance/Admin/GetCloudScriptTaskInstanceGet detail information about a CloudScript task instance.
  • POSTGetTaskInstances/Admin/GetTaskInstancesQuery for task instances by task, status, or time range.
  • POSTGetTasks/Admin/GetTasksGet definition information on a specified task or all tasks within a title.
  • POSTRunTask/Admin/RunTaskRun a task immediately regardless of its schedule.
  • POSTUpdateTask/Admin/UpdateTaskUpdate an existing task.

Segments

  • POSTCreateSegment/Admin/CreateSegmentCreates a new player segment by defining the conditions on player properties. Also, create actions to target the player segments for a title.
  • POSTDeleteSegment/Admin/DeleteSegmentDeletes an existing player segment and its associated action(s) for a title.
  • POSTGetSegments/Admin/GetSegmentsGet detail information of a segment and its associated definition(s) and action(s) for a title.
  • POSTUpdateSegment/Admin/UpdateSegmentUpdates an existing player segment and its associated definition(s) and action(s) for a title.

Server-Side Cloud Script

  • POSTGetCloudScriptRevision/Admin/GetCloudScriptRevisionGets the contents and information of a specific Cloud Script revision.
  • POSTGetCloudScriptVersions/Admin/GetCloudScriptVersionsLists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed.
  • POSTSetPublishedRevision/Admin/SetPublishedRevisionSets the currently published revision of a title Cloud Script
  • POSTUpdateCloudScript/Admin/UpdateCloudScriptCreates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be submitted in the revision.

Shared Group Data

  • POSTSetPublisherData/Admin/SetPublisherDataUpdates the key-value store of custom publisher settings

Title-Wide Data Management

  • POSTAddLocalizedNews/Admin/AddLocalizedNewsUpdate news item to include localized version
  • POSTAddNews/Admin/AddNewsAdds a new news item to the title's news feed
  • POSTAddVirtualCurrencyTypes/Admin/AddVirtualCurrencyTypes_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds one or more virtual…
  • POSTDeleteStore/Admin/DeleteStore_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Deletes an existing virtual…
  • POSTDeleteTitleDataOverride/Admin/DeleteTitleDataOverrideDeletes a specified set of title data overrides.
  • POSTGetCatalogItems/Admin/GetCatalogItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified…
  • POSTGetPublisherData/Admin/GetPublisherDataRetrieves the key-value store of custom publisher settings
  • POSTGetRandomResultTables/Admin/GetRandomResultTables_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the random drop…
  • POSTGetStoreItems/Admin/GetStoreItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items…
  • POSTGetTitleData/Admin/GetTitleDataRetrieves the key-value store of custom title settings which can be read by the client
  • POSTGetTitleInternalData/Admin/GetTitleInternalDataRetrieves the key-value store of custom title settings which cannot be read by the client
  • POSTListVirtualCurrencyTypes/Admin/ListVirtualCurrencyTypes_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retuns the list of all…
  • POSTRemoveVirtualCurrencyTypes/Admin/RemoveVirtualCurrencyTypes_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Removes one or more virtual…
  • POSTSetCatalogItems/Admin/SetCatalogItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Creates the catalog…
  • POSTSetStoreItems/Admin/SetStoreItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Sets all the items in one…
  • POSTSetTitleData/Admin/SetTitleDataCreates and updates the key-value store of custom title settings which can be read by the client. For example, a developer could choose to store values which…
  • POSTSetTitleDataAndOverrides/Admin/SetTitleDataAndOverridesSet and delete key-value pairs in a title data override instance.
  • POSTSetTitleInternalData/Admin/SetTitleInternalDataUpdates the key-value store of custom title settings which cannot be read by the client. These values can be used to tweak settings used by game servers and…
  • POSTSetupPushNotification/Admin/SetupPushNotificationSets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at:…
  • POSTUpdateCatalogItems/Admin/UpdateCatalogItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the catalog…
  • POSTUpdateRandomResultTables/Admin/UpdateRandomResultTables_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the random drop…
  • POSTUpdateStoreItems/Admin/UpdateStoreItems_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates an existing virtual…

API details

Base URL
https://titleId.playfabapi.com
Authentication
An API key in the None header
An API key in the X-Authorization header
An API key in the X-SecretKey header
An API key in the X-EntityToken header
Operations
123 operations on 123 pathsPOST 123
Main resources
Player Data Management 25Account Management 24Title-Wide Data Management 22Authentication 12ScheduledTask 11PlayStream 8Player Item Management 8Segments 4Server-Side Cloud Script 4Content 3
Response formats
application/json
Description format
Swagger 2.0, API version 260922

How to test the PlayFab Admin API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the PlayFab Admin API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the None header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “BanUsers” (POST /Admin/BanUsers), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the PlayFab Admin API?

APIs for managing title configurations, uploaded Game Server code executables, and user data It is listed under Media & content and has 123 endpoints.

Who publishes the PlayFab Admin API?

It is listed from PlayFab's public API description (an OpenAPI document), not published by PlayFab on Swastik Codes. Anyone who controls playfab.com can claim the profile by adding a DNS TXT record.

What is the base URL of the PlayFab Admin API?

Requests go to https://titleId.playfabapi.com. Endpoint paths are added to this base URL.

How do I authenticate with the PlayFab Admin API?

It accepts 4 methods: an API key in the None header; an API key in the X-Authorization header; an API key in the X-SecretKey header; an API key in the X-EntityToken header.

How many endpoints does the PlayFab Admin API have?

123 operations on 123 paths (123 POST). The largest groups are Player Data Management, Account Management, Title-Wide Data Management, Authentication.

Is forking the PlayFab Admin API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.