Multiplayer Server - Get Asset Download Url

Service:

Multiplayer

API Version:

240426

Gets a URL that can be used to download the specified asset. A sample pre-authenticated url - https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05&ss=b&srt=sco&sp=rw&st=startDate&se=endDate&spr=https&sig=sampleSig&api-version=2017-07-29

POST https://titleId.playfabapi.com/MultiplayerServer/GetAssetDownloadUrl

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
FileName	True	string	The asset's file name to get the download URL for.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	GetAssetDownloadUrlResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
GetAssetDownloadUrlRequest	Gets a URL that can be used to download the specified asset.
GetAssetDownloadUrlResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

GetAssetDownloadUrlRequest

Gets a URL that can be used to download the specified asset.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
FileName	string	The asset's file name to get the download URL for.

GetAssetDownloadUrlResponse

Name	Type	Description
AssetDownloadUrl	string	The asset's download URL.
FileName	string	The asset's file name to get the download URL for.

Error Codes

Name	Code
MultiplayerServerBadRequest	1382
MultiplayerServerForbidden	1384
MultiplayerServerInternalServerError	1387
MultiplayerServerNotFound	1385
MultiplayerServerTooManyRequests	1380
MultiplayerServerUnauthorized	1383
MultiplayerServerUnavailable	1388