{
"where am i?": "you are at store.zapier.com",
"-----------": "-----------------------------------------------",
"what is it?": [
"store.zapier.com is a simple storage REST API that you",
"might use to stash a bit of state. we use it to power",
"`StoreClient` in our Code steps of Zapier - you can read",
"more docs at https://zapier.com/help/code-python/ or at",
"https://zapier.com/help/code/."
],
"---------------": "-------------------------------------------",
"what can it do?": [
"only one endpoint - GET & POST to read and write, PATCH to update",
"store any value that is JSON serializable",
"BYOS (bring your own secrets) for authentication"
],
"--------------------": "--------------------------------------",
"what are the limits?": [
"we reserve to right to throttle anyone (but will avoid it)",
"inactive values are pruned after ~3 months or so",
"each secret can be up to 32 characters in length",
"each secret can store up to 500 values",
"each key can be up to 32 characters in length",
"each value must be under 2500 bytes",
"if you go past your limits or do something bad, expect a 403"
],
"-----------------": "-----------------------------------------",
"how does it work?": {
"always provide either `?secret=12345` or `X-Secret: 12345`": "",
"GET /api/secret": [
"will return a random secret for you to use if you need one."
],
"GET /api/records": [
"will return a full object of all values stored by default.",
"you can also specify only the keys you want via the",
"querystring like`?key=color&key=age`."
],
"POST /api/records": [
"provide a body with a json object with keys/values you want",
"to store like `{\"color\": \"blue\", \"age\": 29}`."
],
"DELETE /api/records": [
"completely clear all the records in this account"
],
"PATCH /api/records": [
"A data with a particular schema needs to be received.",
"The schema specifies which action to do and with what parameters.",
"For example {\"action\": \"increment_by\", \"data\": {\"key\": \"\", \"amount\": 1}} to increment the value specified by \"key\"."
]
}
}