API Groups

All API commands use 2 common parameters: "group" and "action". A group is a set of actions that work on the same objects (instance, task, queue...). Actions then have their own parameters which are described in the action API documentation. Below you can find all the available API command groups. Follow the links to view the actions available for each group.

  1. Instance launching and query
  2. Instances search
  3. Workflows management
  4. Workflows listing
  5. Datastore
  6. Queues management
  7. Queues listing
  8. Retry schedules management
  9. Retry schedules management listing
  10. Scheduled workflows management
  11. Scheduled workflows listing
  12. Notifications mangement
  13. Notifications listing
  14. Notifications plugins management
  15. Notifications plugins listing
  16. Users management
  17. Users listing
  18. Tags management
  19. Tags listing
  20. evQueue daemon control
  21. evQueue engine status
  22. evQueue daemon logs access
  23. evQueue API logs access
  24. evQueue notifications logs access
  25. Statistics query and reset
  26. Git
  27. Events


Using Websockets, a client can subscribre to events, in order to be notified when they happen. When subscribing, the client provides an API command which result is to be sent when the event occurs. See events API group for more informations.