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

Endpoint URL

The xxxx.backendless.app is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.

https://xxxx.backendless.app/api/cache/<key>?timeout=<timeToLive>

where:

Argument	Description
<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

Make sure to replace xxxx in the domain name in the sample request below to the one assigned to your application.

curl -H Content-Type:application/json -X PUT \  
-d '{"ordername":"birthday present"}' \  
[`https://xxxx.backendless.app/api/cache/myorder`](https://xxxx.backendless.app/api/cache/myorder)

Codeless Reference

where:

Argument	Description
key name	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.
data	Value to place into cache, it can be a string, number, or any other valid JSON type.
time to live (in seconds)	Numeric value (in seconds) indicating how long the object must stay in cache before it expires. When an object expires, Backendless automatically removes it from cache. The default value is 7200 seconds.

This operation does not return a value.

The example below adds a new key-value pair into cache that will expire in 300 seconds.

The result of this operation will look as shown below after the Codeless logic runs: