Download Manual Download

Navigation Mobile menu

Get Cloud Saves

Overview

Use this end point to return paginated cloud saves in a players account.

Request URL

All parameters in the request must be sent as a POST HTTP request. Make all requests to the following URL:

https://cloudsave.construct.net/getcloudsaves.json

Authenticating The Request

This end point can be called by signed in players, or with secret key authentication.

Session Key Authentication

sessionKey string Required: The session key of the player you're making the request against.

Secret Key Authentication

secret string Required: Your games secret API key.
playerID guid Required: The player ID you wish to make this request against.

Request Parameters

gameID guid Required: The ID of the game you are making this request against. You can find the ID of your game in your Construct Game Services (CGS) account.
name string: Filter cloud saves by their name. Matches cloud save blobs with this whole word in the name property. Partial matches are not supported (EG: est will not match my test blob but test will match the blob).
key string: Filter cloud saves by their key. For example, passing my.blob will match my.blob.test and testing.my.blob.
orderBy string: The order you want cloud save blobs returned. Must be one of NameAZ, NameZA, KeyAZ, KeyZA, Newest or Oldest. If not specified default value is Newest.
perPage int32: How many cloud save blobs you wish to return on each page of results. Cannot be less than 1 or more than 100. Default value is 10.
page int32: The page of results you are requesting. The first page is always 1. If this value is not specified the first page will be returned.
culture string Optional: Optionally specify a supported culture code for rendering various properties. If not specified, the culture code from your games default language will be used.

Success Response

Successful responses always return a HTTP 200 status code.

{
  "success": true,
  "pagination": { ... },
  "blobs": [
    { ... },
    { ... }
  ],
  "formattingCulture": "en-us",
  "responseLanguage": {
    "iso": "EN",
    "englishName": "English"
  }
}

Response Properties

success bool: If the request was successfull or not.
pagination Pagination: Pagination object to assist with browsing through other pages of cloud save blobs.
blobs Array<Blob>: The cloud save blobs returned on this page of results.
formattingCulture string: If some return values are culture specific, this property indicates what culture the values have been rendered as.
responseLanguage Language: The language of translatable elements in the response. If this is different to the requested language, then it is likely your plan has run out of translation credits.

Failure Response

Unsuccessful responses always return HTTP 4xx status codes.

{
  "success": false,
  "errorMessage": "Your request failed due to...",
  "helpURL": "https://www.construct.net/en/game-services/manuals/game-services/cloud-save/api-end-points/cloud-saves/get-cloud-saves",
  "shouldRetry": false
}

Response Properties

success bool: If the request was successfull or not.
errorMessage string: An error message with more detailed information on why the request failed.
helpURL url (string): A link to documentation which should provide help with the error.
shouldRetry bool: Should the client wait a short period of time and retry the request. Usually this is false, but returns true if the request failed due to rate limiting.