API Reference (hyper cloud)
Cache API
Cache Value with Key
8min
This command creates a cached key, value pair in the named cache. You can also specify the time to live property on this request which will specify how long you wish the document to be in the cache.
-
- appname - the name of your hyper cloud application.
- servicename - the name of your hyper cloud service within the application.
- key - string
- value requirements
- must begin with lowercase letter (a-z)
- must be lowercase letters (a-z)
- digits (0-9)
- any of these characters _ $ + -
- value - object
- ttl - string - optional - instructs cache on how long the key/pair should remain in the cache
- _s - for seconds, eg 20s = 20 seconds
- _m - for minutes eg 40m = 40 minutes
- _h - for hours eg 8h = 8 hours
- _d - for days eg 10d = 10 days
Request Payload Limit
When creating or updating the cache, the document size limit is 10MB.
Don't forget!
Be sure to set your HYPER environment variable with the value of your hyper app's connection string.
Status Code | Description | Example Response |
201 | Success | {"ok": true} |
500 | Error | {"ok": false, "msg": "..."} |
409 | Key Conflict | {"ok": false, "msg": "the key already exists"} |
Need Help?
You can always reach out to our support team for any additional assistance on slack.
Updated 03 Mar 2023

Did this page help you?