{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}
If authentication is enabled you must specify username and password in every req

​
SET

Creates an object
​
key
string
A key for accessing the object, if not provied, an uuid will be generated
​
data
string, json, number, any[]
required
This is the body that will be associated to your key, this can be anything you want
​
vertices
string[]
This array relates your object with other nodes, relations can be keys to object or just strings with any other meaning.
​
type
string
This is used to order your data by classes like users, posts, etc…
​
expires
bool
If the objects expires it must be set to true
​
expiration_time
number
The time in milliseconds that the object must live
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
GET

Get an object or a series of objects
​
key
string
​
encryption_key
string
You must pass it as a parameter if the object is encrypted
​
field_array
field[]
Make a bulk operation in all objects that match the criteria
​
one
bool
If true, only modify one object that matches the field_array criteria
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE", "data" : "REQUESTED DATA"}

​
PUT

Modify an object or a series of objects
​
key
string
​
encryption_key
string
You must pass it as a parameter if the object is encrypted
​
replace_field
string
required
The field to be updated
​
replace_value
any
required
The new value
​
field_array
field[]
Make a bulk operation in all objects that match the criteria
​
one
bool
If true, only modify one object that matches the field_array criteria
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
DELETE

Delete an object
​
key
string
required
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
PUSH

Push a value into an array of an object or a series of object
​
key
string
​
array
string
required
The array to modify
​
value
string
required
The value to push
​
encryption_key
string
You must pass it as a parameter if the object is encrypted
​
field_array
field[]
Make a bulk operation in all objects that match the criteria
​
one
bool
If true, only modify one object that matches the field_array criteria
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
POP

Pop from an array of an object or a series of objects
​
key
string
​
array
string
required
The array to modify
​
encryption_key
string
You must pass it as a parameter if the object is encrypted
​
field_array
field[]
Make a bulk operation in all objects that match the criteria
​
one
bool
If true, only modify one object that matches the field_array criteria
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
SPLICE

Splice from an array of an object or a series of objects
​
key
string
​
array
string
required
The array to modify
​
encryption_key
string
You must pass it as a parameter if the object is encrypted
​
field_array
field[]
Make a bulk operation in all objects that match the criteria
​
one
bool
If true, only modify one object that matches the field_array criteria
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
REMOVE

Remove a value from an array of an object or a series of objects
​
key
string
​
array
string
required
The array to modify
​
value
string
required
The value to be removed
​
encryption_key
string
You must pass it as a parameter if the object is encrypted
​
field_array
field[]
Make a bulk operation in all objects that match the criteria
​
one
bool
If true, only modify one object that matches the field_array criteria
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
ENCRYPT

Encrypt an object
​
key
string
​
encryption_key
string
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
DECRYPT

Decrypt an object
​
key
string
​
encryption_key
string
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
SET_VERTEX

Add a vertex to an object
​
key
string
​
vertex
string
Vertex name, it doesn’t need to be a key
​
relation
string
Relation between vertices, ex: friends
​
encryption_key
string
You must pass it as a parameter if the object is encrypted
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
GET_VERTEX

List all vertices of a key
​
key
string
​
encryption_key
string
You must pass it as a parameter if the object is encrypted
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE", "data" : [vertices]}

​
DELETE_VERTEX

Delete a vertex
​
key
string
​
vertex
string
Vertex name, it doesn’t need to be a key
​
encryption_key
string
You must pass it as a parameter if the object is encrypted
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE"}

​
DFS

Make a DFS walk in the graph
​
node
string
Key of the object.
​
relation
string
If you want to make a DFS and only go through nodes with an specific type of relation
{"status" : "SUCCESS" || "ERROR", "message" : "OK" || "ERROR MESSAGE", "data" : [vertices]}