recurring.custom
+Available methods
+-
+
- + + +
- + + +
- + + +
Description
+Provides methods to handle recurring custom states for minions, system groups and organizations.
+Namespace:
+recurring.custom
+Method: create
+HTTP POST
Description:
+Create a new recurring custom state action.
+Parameters:
+-
+
-
+
string sessionKey
+
+ -
+
struct actionProps
+++-
+
-
+
string "entity_type" - the type of the target entity. One of the following:
+++-
+
-
+
minion
+
+ -
+
group
+
+ -
+
org
+
+
+ -
+
-
+
int "entity_id" - the ID of the target entity
+
+ -
+
string "name" - the name of the recurring action
+
+ -
+
string "cron_expr" - the execution frequency of the action as a cron expression
+
+ -
+
string array "states" - the ordered list of custom state names to be executed
+
+ -
+
boolean "test" - whether the action should be executed in test mode (optional)
+
+
+ -
+
Returns:
+-
+
-
+
int id - the ID of the newly created recurring action
+
+
Method: listAvailable
+HTTP GET
Description:
+List all the custom states available to the user.
+Parameters:
+-
+
-
+
string sessionKey
+
+
Returns:
+-
+
-
+
string array the list of custom channels available to the user
+
+
Method: update
+HTTP POST
Description:
+Update a recurring custom state action.
+Parameters:
+-
+
-
+
string sessionKey
+
+ -
+
struct actionProps
+++-
+
-
+
int "id" - the ID of the action to update
+
+ -
+
string "name" - the name of the action (optional)
+
+ -
+
string "cron_expr" - the execution frequency of the action (optional)
+
+ -
+
string array "states" - the ordered list of custom state names to be executed (optional)
+
+ -
+
boolean "test" - whether the action should be executed in test mode (optional)
+
+ -
+
boolean "active" - whether the action should be active (optional)
+
+
+ -
+
Returns:
+-
+
-
+
int id - the ID of the updated recurring action
+
+