Detailed API documentation
The Swagger API documentation is is always up-to-date and lets you try out any query with your user session or an API - key.
Integration guide
Listing available datastores
Listing available datastores is done by querying the descriptor endpoint:
| No Format |
|---|
curl -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/descriptor |
The endpoint will return metadata about available datastores:
| No Format |
|---|
{
"data": [
{
"name": "myStore",
"description": "Description of store",
"dataType": "MAP",
"behaviourType": "CENTRAL",
"lastUpdatedTimestamp": 1501662018874,
"lastUpdatedByUser": {...},
"lifeTime": 259200000,
"deleted": false,
"globalData": false,
"expireData": true
}
],... |
| Tip |
|---|
Only datastores with behaviourType: CENTRAL can be queried and/or updated via the API. |
| Tip |
|---|
DataStores Datastores with globalData: true cannot be queried or updated per customer. For these datastores data only exists for customer 0 (global). |
| Note |
|---|
Before interacting with a datastore it must be defined in Argus by creating a new descriptor. This is an administrative operation and only users with special permissions are allowed to manage datastore descriptors. |
Querying a datastore
To query a datastore for entries use the store endpoint:
| No Format |
|---|
curl -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/store/myStore |
By default, this will query the store for all keys and across all customers the current user has access to. The default result limit is 25.
To query for only a specific customer , use the customerID parameter:
| No Format |
|---|
curl -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/store/myStore?customerID=1 |
Fetching a datastore entry
To fetch a specific key from a datastore use the key on the store endpoint. Note that unless otherwise specified, this will fetch the value for the key belonging to the current user's customer.
| No Format |
|---|
# fetch entry for "myKey" from "myStore" for the customer of the active user
curl -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/store/myStore/myKey
# fetch entry for "myKey" from "myStore" for customer 1
curl -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/store/myStore/myKey?customerID=1 |
Advanced search
Advanced search has access to all possible filtering parameters for datastores , and follow follows the general advanced search structure as described in the the General integration guide.
Searching for specific keys
| No Format |
|---|
# search for all values on keys "key1" or "key2" across all available customers
curl -XPOST -H "Argus-API-Key: my/api/key" -H "Content-Type: application/json" https://api.mnemonic.no/datastores/v1/store/myStore/search -d '{
"key":["key1","key2"]
}' |
Search for range of keys
| No Format |
|---|
# search for all keys set in the range "key-a" to "key-h" (in lexical ordering)
curl -XPOST -H "Argus-API-Key: my/api/key" -H "Content-Type: application/json" https://api.mnemonic.no/datastores/v1/store/myStore/search -d '{
"fromKey":"key-a",
"toKey":"key-h"
}' |
Search for all updates updates
| No Format |
|---|
# search for all updated or deleted keys since time 1521496196000 (in millismilliseconds since epoch)
curl -XPOST -H "Argus-API-Key: my/api/key" -H "Content-Type: application/json" https://api.mnemonic.no/datastores/v1/store/myStore/search -d '{
"includeDeleted":true,
"startTimestamp": 1521496196000
}' |
See Swagger API documentation for more details on valid search parameters.
Updating a datastore entry
Update a single entry using the store PUT endpoint:
| No Format |
|---|
# put new value "myValue" for entry "myKey" for store "myStore" and the customer of the active user
curl -XPUT -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/store/myStore/myKey/myValue
# put new value "myValue" for entry "myKey" for store "myStore" and customer 1
curl -XPUT -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/store/myStore/myKey/myValue?customerID=1 |
Deleting a datastore entry
To delete datastore entries use the DELETE store endpoint. Each key is listed as a query parameter:.
| No Format |
|---|
# delete entry "myKey" for store "myStore" and the customer of the active user
curl -XDELETE -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/store/myStore?key=myKey
# delete entry "myKey" for store "myStore" and customer 1
curl -XDELETE -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/store/myStore?key=myKey&customerID=1
# delete entries "myKey" and "otherKey"
curl -XDELETE -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/datastores/v1/store/myStore?key=myKey&key=otherKey |
Updating multiple datastore entries
To update multiple entries in a single operation use the bulk PUT endpoint. The customerID is optional. If omitted it will default to the current user's customer.
| No Format |
|---|
# put values for keys "myKey" and "otherKey" for the store "myStore" and customer 1
curl -XPUT -H "Argus-API-Key: my/api/key" -H "Content-Type: application/json" https://api.mnemonic.no/datastores/v1/store/myStore -d '{
"customerID":1,
"entries":{
"myKey": "myValue",
"otherKey": "otherValue"
}
}' |