Category Filter

Initiate Automation

Overview

This API executes an Automation created in the Hexnode UEM console based on the provided automation profiles and target parameters.

Argument	Type	Description
automationList	Array	A list of identifiers for the automation profiles you wish to run (e.g., [1, 2, 3, 4]). These IDs determine which specific configurations or policies will be applied.
applyFilter	Boolean	A boolean value (true or false) that determines whether the system should cross-check and filter the provided device list against the target criteria before execution. Default value: false
targets	Dictionary	Defines the scope of the deployment. See the target parameters below.

Note: Finding Automation Identifiers
Automation IDs can be retrieved using either of the following methods based on your preference:

Via the Console URL: Open the specific automation in the Hexnode Console. The identifier is the numeric value embedded in the browser URL (for example, the ID is 178 in https://.hexnodemdm.com/deployments/#/178/info/).
Via the API: Execute a List all Automations API call to retrieve all currently created automations in the Hexnode UEM console. The API response will include the IDs for each automation.

Target Parameters

The targets dictionary defines the scope of the deployment. You must provide a valid entry for at least one target type (devices, deviceGroups, users, userGroups, domains, or ou) within this dictionary to proceed.

Argument	Type	Description
devices	Array	A list of unique IDs for individual devices (e.g., [1, 2, 3, 4]).
deviceGroups	Array	A list of IDs for specific device groups (e.g., [1, 2, 3, 4]).
users	Array	A list of unique IDs for individual users (e.g., [1, 2, 3, 4]).
userGroups	Array	A list of IDs for specific user groups (e.g., [1, 2, 3, 4]).
domains	Array	A list of IDs for managed network domains (e.g., [1, 2, 3, 4]).
ou	Array	A list of IDs for Organizational Units (OUs) (e.g., [1, 2, 3, 4]).

curl

HTTP Request:

POST https://<portal>.hexnodemdm.com/api/v1/automations/run-now/
headers:-
Authorization: <api key>
Content-Type: application/json
Sample Post Data:-
{   
  "automationList": [1],    
  "applyFilter": true,    
  "targets": {   
    "devices": [1, 2],    
    "deviceGroups": [],    
    "users": [],    
    "userGroups": [],    
    "domains": [],    
    "ou": []   
  }   
}

POST https://<portal>.hexnodemdm.com/api/v1/automations/run-now/

headers:-

Authorization: <api key>

Content-Type: application/json

Sample Post Data:-

{

"automationList": [1],

"applyFilter": true,

"targets": {

"devices": [1, 2],

"deviceGroups": [],

"users": [],

"userGroups": [],

"domains": [],

"ou": []

}

Shell Command:

 curl -H "Authorization: <api key>" -H "Content-Type: application/json" -d '{"automationList": [1,2,3,4,5], "applyFilter": false, "targets": {"devices": [], "deviceGroups": [], "users": [], "userGroups": [], "domains": [], "ou": []}}' https://<portal>.hexnodemdm.com/api/v1/automations/run-now/

1	curl -H "Authorization: <api key>" -H "Content-Type: application/json" -d '{"automationList": [1,2,3,4,5], "applyFilter": false, "targets": {"devices": [], "deviceGroups": [], "users": [], "userGroups": [], "domains": [], "ou": []}}' https://<portal>.hexnodemdm.com/api/v1/automations/run-now/

HTTP Response:

{   
  "message": "Automation execution initiated",    
  "profiles": [1]   
}

{

"message": "Automation execution initiated",

"profiles": [1]

}