Group "events"
Action "subscribe"
Request to be notified when a specific event occurs.
Here is a list of all available events :
INSTANCE_STARTED,
INSTANCE_TERMINATED,
INSTANCE_REMOVED,
INSTANCE_TAGGED,
INSTANCE_UNTAGGED,
TASK_ENQUEUE,
TASK_EXECUTE,
TASK_TERMINATE,
TASK_PROGRESS,
QUEUE_ENQUEUE,
QUEUE_DEQUEUE,
QUEUE_EXECUTE,
QUEUE_TERMINATE,
QUEUE_CREATED,
QUEUE_MODIFIED,
QUEUE_REMOVED,
TAG_CREATED,
TAG_MODIFIED,
TAG_REMOVED,
WORKFLOW_CREATED,
WORKFLOW_MODIFIED,
WORKFLOW_REMOVED,
WORKFLOW_SUBSCRIBED,
WORKFLOW_UNSUBSCRIBED,
GIT_PULLED,
GIT_SAVED,
GIT_LOADED,
GIT_REMOVED,
LOG_ENGINE,
LOG_NOTIFICATION,
LOG_API,
RETRYSCHEDULE_CREATED,
RETRYSCHEDULE_MODIFIED,
RETRYSCHEDULE_REMOVED,
WORKFLOWSCHEDULE_CREATED,
WORKFLOWSCHEDULE_MODIFIED,
WORKFLOWSCHEDULE_REMOVED,
WORKFLOWSCHEDULE_STARTED,
WORKFLOWSCHEDULE_STOPPED,
NOTIFICATION_TYPE_CREATED,
NOTIFICATION_TYPE_REMOVED,
NOTIFICATION_CREATED,
NOTIFICATION_MODIFIED,
NOTIFICATION_REMOVED,
USER_CREATED,
USER_MODIFIED,
USER_REMOVED
Input parameters
- type :
required : yes
- api_cmd :
required : yes
- object_id :
required : no ; default : Ø
- external_id :
required : no ; default : Ø
- send_now :
required : no ; default : no
Errors
- MISSING_PARAMETER
- INVALID_PARAMETER
- UNKNOWN_OBJECT
Action "unsubscribe"
Unsubscribe from events notifications
Input parameters
- type :
required : yes
- object_id :
required : no ; default : Ø
- external_id :
required : no ; default : Ø
Errors
- MISSING_PARAMETER
- INVALID_PARAMETER
- UNKNOWN_OBJECT
Action "unsubscribeall"
Unsubscribe all events for this connection
This action takes no parameters
This action returns no error
Action "ack"
Acknoledges an event reception. This is mandatory in order to receive more events of this type. This mecanism is used to prevent congestion on the client side.
Input parameters
- event_id :
required : yes
Errors
- MISSING_PARAMETER
- INVALID_INTEGER
