recurringaction

Available methods

Description

Provides methods to handle recurring actions for minions, system groups and organizations.

Deprecated - This namespace will be removed in a future API version. To work with recurring actions,
please check out the newer 'recurring' namespace.

Namespace:

recurringaction

Method: create (Deprecated)

HTTP POST

Description:

Create a new recurring highstate action.

Deprecated - This method will be removed in a future API version. To create recurring actions, please use either 'recurring.highstate.create' or 'recurring.custom.create' instead.

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 action

    • string "cron_expr" - the execution frequency of the action

    • boolean "test" - whether the action should be executed in test mode (optional)

Returns:

  • int id - the ID of the recurring action

Method: delete (Deprecated)

HTTP POST

Description:

Delete a recurring action with the given action ID.

Deprecated - This method will be removed in a future API version. To work with recurring actions, please check out the newer 'recurring' namespace.

Parameters:

  • string sessionKey

  • int actionId - the action ID

Returns:

  • int id - the ID of the recurring action

Method: listByEntity (Deprecated)

HTTP GET

Description:

Return a list of recurring actions for a given entity.

Deprecated - This method will be removed in a future API version. To work with recurring actions, please check out the newer 'recurring' namespace.

Parameters:

  • string sessionKey

  • string "entityType" - the type of the target entity. One of the following:

    • MINION

    • GROUP

    • ORG

  • int entityId - the ID of the target entity

Returns:

  • array :

  • struct recurring action information (some fields may be absent for some action types)

    • int "id"

    • string "name"

    • int "entity_id"

    • string "entity_type"

    • string "cron_expr"

    • dateTime.iso8601 "created"

    • string "creator"

    • boolean "test"

    • string array "states" - the ordered list of states to be executed by a custom state action

    • boolean "active"

Method: lookupById (Deprecated)

HTTP GET

Description:

Find a recurring action with the given action ID.

Deprecated - This method will be removed in a future API version. To work with recurring actions, please check out the newer 'recurring' namespace.

Parameters:

  • string sessionKey

  • int actionId - the action ID

Returns:

  • * struct recurring action information (some fields may be absent for some action types)

    • int "id"

    • string "name"

    • int "entity_id"

    • string "entity_type"

    • string "cron_expr"

    • dateTime.iso8601 "created"

    • string "creator"

    • boolean "test"

    • string array "states" - the ordered list of states to be executed by a custom state action

    • boolean "active"

Method: update (Deprecated)

HTTP POST

Description:

Update a recurring highstate action.

Deprecated - This method will be removed in a future API version. To update recurring actions, please use either 'recurring.highstate.update' or 'recurring.custom.update' instead.

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)

    • 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 recurring action