Cache Value with Key

8min

POST /{appname}/cache/{servicename}
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.
Parameters
Path Parameters
﻿
appname - the name of your hyper cloud application.
servicename - the name of your hyper cloud service within the application. 
Request Body
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.
JSON
{
    "key": "string",
    "value": {},
    "ttl": "string"
}
{
    "key": "string",
    "value": {},
    "ttl": "string"
}
﻿
Examples
Don't forget!
Be sure to set your HYPER environment variable with the value of your hyper app's connection string.
Node.js
Curl
export JWT=mytokenvalue

curl -X POST  https://cloud.hyper.io/app-blue-diablo-wind/cache/default \                             ─╯
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer ${JWT}' \
-d '{"key": "movie-1-1983", "value": {"id": "movie-1", "title": "Ghostbusters"}}'

#> {"ok": true}
export JWT=mytokenvalue

curl -X POST  https://cloud.hyper.io/app-blue-diablo-wind/cache/default \                             ─╯
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer ${JWT}' \
-d '{"key": "movie-1-1983", "value": {"id": "movie-1", "title": "Ghostbusters"}}'

#> {"ok": true}
﻿
Responses
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?

Query Cache Store

Get Cache Value by Key

Docs powered by Archbee

TABLE OF CONTENTS

POST /{appname}/cache/{servicename}

Parameters

Path Parameters

Request Body

Request Payload Limit

Status Code	Description	Example Response
201	Success	{"ok": true}
500	Error	{"ok": false, "msg": "..."}
409	Key Conflict	{"ok": false, "msg": "the key already exists"}