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.
- Instance launching and query
- Instances search
- Workflows management
- Workflows listing
- Datastore
- Queues management
- Queues listing
- Retry schedules management
- Retry schedules management listing
- Scheduled workflows management
- Scheduled workflows listing
- Notifications mangement
- Notifications listing
- Notifications plugins management
- Notifications plugins listing
- Users management
- Users listing
- Tags management
- Tags listing
- evQueue daemon control
- evQueue engine status
- evQueue daemon logs access
- evQueue API logs access
- evQueue notifications logs access
- Statistics query and reset
- Git
- Events
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.
- INSTANCE_STARTED : an instance has been started.
- INSTANCE_TERMINATED : an instance has terminated.
- INSTANCE_REMOVED : an instance have been removed.
- INSTANCE_TAGGED : a tag has been added to an instance.
- INSTANCE_UNTAGGED : a tag has been removed from an instance.
- TASK_ENQUEUE : a task has beed put in a queue for execution. It might execute now or later, depending on the queue state (filled or not). TASK_EXECUTE event will be issued when task is executed. This event is attached to the workflow instance.
- TASK_EXECUTE : a task has been executed and is curruntly running
- TASK_TERMINATE : a task is terminated
- TASK_PROGRESS : a task has updated it's progression
- QUEUE_ENQUEUE : this event is similar to TASK_ENQUEUE but is attached to the queue instead of the workflow instance.
- QUEUE_DEQUEUE : a task has been removed from the queue to be executed.
- QUEUE_EXECUTE : same as TASK_EXECUTE but attached to the queue.
- QUEUE_TERMINATE : same as TASK_TERMINATE but attached to the queue.
- QUEUE_CREATED : a queue has been created.
- QUEUE_MODIFIED : a queue has been modified.
- QUEUE_REMOVED : a queue has been removed.
- TAG_CREATED : a tag has been created.
- TAG_MODIFIED : a tag has been modified.
- TAG_REMOVED : a tag has been removed.
- WORKFLOW_CREATED : a workflow has been created.
- WORKFLOW_MODIFIED : a workflow has been modified.
- WORKFLOW_REMOVED : a workflow has been removed.
- WORKFLOW_SUBSCRIBED : a workflow has subscribed to a notification.
- WORKFLOW_UNSUBSCRIBED : a workflow has unsubscribed from a notification.
- GIT_PULLED : git repository has been pulled (see git API).
- GIT_SAVED : a workflow has been saved in the git repository.
- GIT_LOADED : a workflow has been loaded from the git repository.
- GIT_REMOVED : a workflow has been removed from the git repository.
- LOG_ENGINE : the engine has emitted a new log (see logs API).
- LOG_NOTIFICATION : a notification plugin has emitted a new log (see logs API).
- LOG_API : the API has emitted a new log (see logs API).
- RETRYSCHEDULE_CREATED : a retry schedule has been created.
- RETRYSCHEDULE_MODIFIED : a retry schedule has been modified.
- RETRYSCHEDULE_REMOVED : a retry schedule has been removed.
- WORKFLOWSCHEDULE_CREATED : a workflow schedule has been created.
- WORKFLOWSCHEDULE_MODIFIED : a workflow schedule has been modified.
- WORKFLOWSCHEDULE_REMOVED : a workflow schedule has been removed.
- WORKFLOWSCHEDULE_STARTED : a new instance has been started by workflow scheduler.
- WORKFLOWSCHEDULE_STOPPED : an instance started by workflow scheduler has stopped.
- NOTIFICATION_TYPE_CREATED : a notification plugin has been loaded.
- NOTIFICATION_TYPE_REMOVED : a notification plugin has been removed.
- NOTIFICATION_CREATED : a notification has been created.
- NOTIFICATION_MODIFIED : a notification has been modified.
- NOTIFICATION_REMOVED : a notification has been removed.
- USER_CREATED : a user has been created.
- USER_MODIFIED : a user has been modified.
- USER_REMOVED : a user has been removed.