Retrieving data from cache

This API request retrieves an object from Backendless cache. If object is not present in cache, the method returns null for complex types or default value for primitive values.

Method:

GET

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>

where:

Argument	Description
<key>	identifies the object to retrieve from cache.

Request headers

user-token: optional value obtained as a result of the login operation.

where:

Argument

Description

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

N/A

Example

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

curl -X GET \  
[`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.

Returns a value associated with the requested key.

Consider the following key-value pair stored in cache:

The example below retrieves the value of the key "orderName" stored in cache.

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