API documentation for the Datonis platform

Resources

Session

Resource Description
POST /api_sign_in Authenticate and return auth_token
POST /azure_api_sign_in Authenticate using OAuth and return auth_token

Sensor

Resource Description
GET /api/v2/sensors List all sensors
GET /api/v2/sensors/:sensor_key Fetch information for a sensor
POST /api/v2/sensors Create a sensor
PUT /api/v2/sensors/:sensor_key Updates a sensor
DELETE /api/v2/sensors/:sensor_key Delete a sensor
PUT /api/v2/sensors/:sensor_key/tag Adds tags to a sensor
PUT /api/v2/sensors/:sensor_key/untag Removes tags from a sensor
PUT /api/v2/sensors/:sensor_key/set_traits Set user defined traits (properties) on a sensor
PUT /api/v2/sensors/:sensor_key/remove_traits Remove user defined traits (properties) on a sensor

Data query

Resource Description
POST /api/v2/datonis_query/sensor_event_data Get aggregated sensor event data
POST /api/v2/datonis_query/sensor_event_raw_data Get raw event data for a sensor

Group

Resource Description
GET /api/v2/groups List all groups
GET /api/v2/groups/:group_key Fetch details of a specific group
POST /api/v2/groups Create a group
PUT /api/v2/groups/:group_key Updates a group
DELETE /api/v2/groups/:group_key Delete the specified group
PUT /api/v2/groups/:group_key/tag Add specified tags to a group
PUT /api/v2/groups/:group_key/untag Remove specified tags from the group

Rule

Resource Description
GET /api/v2/rules List all rules
GET /api/v2/rules/:rule_key Fetch details of a specific rule
POST /api/v2/rules Create a rule
PUT /api/v2/rules/:rule_key Updates a rule
DELETE /api/v2/rules/:rule_key Deletes the specified rule

Notification action

Resource Description
GET /api/v2/notification_actions List all notification actions
GET /api/v2/notification_actions/:notification_key Fetch details of a notification action
POST /api/v2/notification_actions Create a notification action
PUT /api/v2/notification_actions/:notification_action_key Updates a notification action
DELETE /api/v2/notification_actions/:notification_key Delete a notification action

Rule trigger event

Resource Description
GET /api/v2/rule_trigger_events Read a rule trigger event

Sensor alert

Resource Description
GET /api/v2/sensor_alerts List all groups
GET /api/v2/sensor_alerts/:sensor_alert_key Fetch an alert

License

Resource Description
GET /api/v2/licenses/details Get license details

Instruction

Resource Description
GET /api/v2/instructions List all instructions
POST /api/v2/instructions Create an instruction
GET /api/v2/instructions/:instruction_key Fetch an instruction
PUT /api/v2/instructions/:instruction_key Update an instruction
DELETE /api/v2/instructions/:instruction_key Delete an instruction
PUT /api/v2/instructions/:instruction_key/execute Execute an instruction