Skip to content

Putting data into cache

This API request places the object into Backendless cache and maps it to the specified key. If the timeToLive argument is not set, the object will expire from cache in 2 hours from the time when it is put in cache.

Method:

PUT

URL

https://api.backendless.com/<application-id>/<REST-api-key>/cache/<key>?timeout=<timeToLive>

where:

Argument                Description
<application id> ID of the application which can be obtained from the Manage > App Settings screen of the Backendless Console
<REST-api-key> REST API key of your application. You can get the value from the Manage > App Settings section of the Backendless Console.
<key> key assigned to the object to identify it in cache. The key is used to retrieve the object from cache or to check if the cache still contains the object.
<timeToLive> optional numeric value (in seconds) indicating how long the object must stay in cache before it is expires. When an object expires, Backendless automatically removes it from cache. The default value is 7200 seconds.

Request headers

Content-Type: application/json  
user-token: optional value obtained as a result of the login operation.

where:

Argument                Description
Content-Type Must be set to application/json. This header is mandatory.
user-token Optional header. Contains a value returned by Backendless in a preceding user Login API call. If user-token is set in the request, the currently logged in user will be assigned to the ownerId property of the user object which is being saved.  Additionally, the operation will be executed with the security policy associated currently logged in user. This means all permissions associated with the user and the roles assigned to the user will be enforced by Backendless.

Request body

A primitive JSON value, an array or an object

Example

curl -H Content-Type:application/json -X PUT \  
-d '{"ordername":"birthday present"}' \  
https://api.backendless.com/XXXX-XXXX-XXXX/ZZZZ-ZZZZ-ZZZZ/cache/myorder