Data Stores
Access Data Stores (built-in key-value store).
Last updated
Access Data Stores (built-in key-value store).
Last updated
GET
https://api.appmixer.com/stores
Get all key-value stores.
curl "https://api.appmixer.com/stores" -H "Authorization: Bearer [ACCESS_TOKEN]"
GET
https://api.appmixer.com/stores/:id
Get name of a store.
curl "https://api.appmixer.com/stores/5c6fc9932ff3ff000747ead4" -H "Authorization: Bearer [ACCESS_TOKEN]"
Name | Type | Description |
---|---|---|
GET
https://api.appmixer.com/store/count
Get number of records in a store.
curl "https://api.appmixer.com/store/count?storeId=5c6fc9932ff3ff000747ead4" -H "Authorization: Bearer [ACCESS_TOKEN]"
GET
https://api.appmixer.com/store
Get records. Supports search and pagination.
curl "https://api.appmixer.com/store?storeId=5b213e0ef90a6200113abfd4&offset=0&limit=30&sort=updatedAt:-1" -H "Authorization: Bearer [ACCESS_TOKEN]"
POST
https://api.appmixer.com/stores
Create a new key-value store. Returns the newly created Store ID.
curl -XPOST "https://api.appmixer.com/stores" -H "Authorization: Bearer [ACCESS_TOKEN]" -H "Content-Type: application/json" -d '{ "name": "My Store" }'
DELETE
https://api.appmixer.com/stores/:id
Delete a store and all the records in the store.
curl -XDELETE "https://api.appmixer.com/stores/5c7f9bfe51dbaf0007f08db0" -H "Authorization: Bearer [ACCESS_TOKEN]"
PUT
https://api.appmixer.com/stores/:id
Rename an existing store.
curl -XPUT "https://api.appmixer.com/stores/5c7f9bfe51dbaf0007f08db0" -H "Authorization: Bearer [ACCESS_TOKEN]" -H "Content-Type: application/json" -d '{ "name": "My New Name" }'
POST
https://api.appmixer.com/store/:id/:key
Create a new value in the store under a key.
curl -XPOST "https://api.appmixer.com/store/5c7f9bfe51dbaf0007f08db0/mykey" -H "Authorization: Bearer [ACCESS_TOKEN]" -H "Content-Type: text/plain" -d "my value"
PATCH
https://api.appmixer.com/store/:id/:key
Use this endpoint to rename a key or update the value against the key. Updates are passed in the body payload.
curl --location --request PATCH 'https://api.appmixer.com/store/623632fb3eb18366c82aa9fd/existingKey'
--header 'Authorization: Bearer [ACCESS TOKEN]'
--header 'Content-Type: application/json'
--data-raw '{ "key": "newKey", "value": "newValue" }'
DELETE
https://api.appmixer.com/store
Delete one or multiple items from a store.
curl -XDELETE "https://api.appmixer.com/store" -H "Authorization: Bearer [ACCESS_TOKEN]" -H "Content-Type: application/json" -d '[{ key: "mykey", storeId: "5c7f9bfe51dbaf0007f08db0" }, { "key": "mykey2", "storeId": "5c7f9bfe51dbaf0007f08db0" }]'
GET
https://api.appmixer.com/store/download/:storeId
The endpoint downloads the entire store either as a CSV or JSON file.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
id
string
Store ID.
storeId
string
Store ID.
storeId
string
Store ID.
sort
string
Store record parameter to sort by. Followed by ":" and the sort order -1 (descending) or 1 (ascending).
offset
number
Index of the first record returned.
limit
number
Maximum number of records returned.
name
string
Name of the store.
id
string
Store ID.
id
string
Store ID.
name
string
New name of the store.
key
string
Key under which the posted value will be stored.
id
string
Store ID.
string
Value to store under the key.
id*
String
Store ID
key*
String
Key under which the updates are required
key
String
New key
value
String
New Value
items
array
Array of items to delete. Each item is an object of the form { key, storeId }.
format
String
Default value 'json'. The other option is 'csv'.