Catalog - Create Upload Urls
Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info around uploading content can be found here: https://video2.skills-academy.com/en-us/gaming/playfab/features/pricing/meters/catalog-meters
POST https://titleId.playfabapi.com/Catalog/CreateUploadUrlsRequest 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 | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Files |
Description of the files to be uploaded by the client. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Create |
Upload URLs point to Azure Blobs; clients must follow the Microsoft Azure Storage Blob Service REST API pattern for uploading content. The response contains upload URLs and IDs for each file. The IDs and URLs returned must be added to the item metadata and committed using the CreateDraftItem or UpdateDraftItem Item APIs. |
|
Create |
|
|
Upload |
|
|
Upload |
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 |
CreateUploadUrlsRequest
Upload URLs point to Azure Blobs; clients must follow the Microsoft Azure Storage Blob Service REST API pattern for uploading content. The response contains upload URLs and IDs for each file. The IDs and URLs returned must be added to the item metadata and committed using the CreateDraftItem or UpdateDraftItem Item APIs.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Files |
Description of the files to be uploaded by the client. |
CreateUploadUrlsResponse
| Name | Type | Description |
|---|---|---|
| UploadUrls |
List of URLs metadata for the files to be uploaded by the client. |
UploadInfo
| Name | Type | Description |
|---|---|---|
| FileName |
string |
Name of the file to be uploaded. |
UploadUrlMetadata
| Name | Type | Description |
|---|---|---|
| FileName |
string |
Name of the file for which this upload URL was requested. |
| Id |
string |
Unique ID for the binary content to be uploaded to the target URL. |
| Url |
string |
URL for the binary content to be uploaded to. |