List configured automations

GET

https://cdn.emnify.net/api/v1/automation

GET

/api/v1/automation

1 import requests
2 
3 url = "https://cdn.emnify.net/api/v1/automation"
4 
5 headers = {"Authorization": "Bearer <token>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

Try it

200Retrieved

1 [
2   {
3     "id": "56",
4     "name": "Send endpoint data traffic limit warning email",
5     "description": "Sends an email when the endpoint data traffic limit warning is triggered for service profile 3.\n",
6     "status": "active",
7     "organisation": {
8       "id": 1550
9     },
10     "number_of_executions": 3,
11     "last_execution": "2025-01-01T00:00:00.000Z",
12     "created_at": "2024-01-01T03:00:00.000Z",
13     "modified_at": "2024-05-06T05:00:00.000Z",
14     "actionable_event": {
15       "custom_event": {
16         "organisation": {
17           "id": 1550
18         },
19         "template": {
20           "id": 10
21         },
22         "configuration_properties": [
23           {
24             "property": "service_policy",
25             "value": "3",
26             "value_array": [
27               "3"
28             ]
29           }
30         ],
31         "name": "Data Traffic Limit Warning",
32         "id": "dtlw-001",
33         "supportedTargetingParameters": [
34           "service_policy",
35           "endpoint_tag"
36         ],
37         "supportedActions": [
38           "system-send_notification_with_email"
39         ]
40       },
41       "system_event": {
42         "id": "605",
43         "parentOrg": {
44           "id": 1550
45         },
46         "eventType": {
47           "id": 65
48         },
49         "name": "Endpoint data traffic limit warning",
50         "translationKeyName": "endpoint_data_traffic_limit_warning_n",
51         "description": "Endpoint data traffic limit warning",
52         "translationKeyDescription": "endpoint_data_traffic_limit_warning_d",
53         "supportedTargetingParameters": [
54           "service_policy",
55           "endpoint_tag"
56         ],
57         "eventOutputParameters": [
58           {
59             "parameter": "event_description",
60             "type": "string",
61             "description": "Standard description of the event"
62           }
63         ],
64         "supportedActions": [
65           "system-send_notification_with_email"
66         ]
67       }
68     },
69     "configured_actions": [
70       {
71         "action": {
72           "id": "system-send_notification_with_email"
73         },
74         "properties": [
75           {
76             "property": "recipients",
77             "value": "foo@bar.emnify.com",
78             "value_array": [
79               "foo@bar.emnify.com"
80             ]
81           }
82         ],
83         "recipients": {
84           "email": [
85             "foo@bar.emnify.com"
86           ]
87         }
88       }
89     ],
90     "targeting_properties": [
91       {
92         "property": "service_policy",
93         "value": "3",
94         "value_array": [
95           "3"
96         ]
97       }
98     ]
99   },
100   {
101     "id": "57",
102     "name": "Event `count_of_pdp` limit email\n",
103     "description": "Sends an email when the event `count_of_pdp` exceeds 10 in one week for service profile 2.\n",
104     "status": "active",
105     "organisation": {
106       "id": 1550
107     },
108     "number_of_executions": 1,
109     "last_execution": "2021-09-01T00:00:00.000Z",
110     "created_at": "2021-01-01T00:00:00.000Z",
111     "modified_at": "2021-02-01T00:00:00.000Z",
112     "actionable_event": {
113       "custom_event": {
114         "organisation": {
115           "id": 200
116         },
117         "template": {
118           "id": 1
119         },
120         "configuration_properties": [
121           {
122             "property": "count_of_pdp",
123             "value": "10",
124             "value_array": [
125               "10"
126             ]
127           },
128           {
129             "property": "duration",
130             "value": "1w",
131             "value_array": [
132               "1w"
133             ]
134           }
135         ],
136         "name": "PDP Threshold 50 Over One Week",
137         "id": "2",
138         "supportedTargetingParameters": [
139           "service_policy",
140           "endpoint_tag"
141         ],
142         "supportedActions": [
143           "system-send_notification_with_email"
144         ]
145       },
146       "system_event": {
147         "id": "606",
148         "parentOrg": {
149           "id": 200
150         },
151         "eventType": {
152           "id": 66
153         },
154         "name": "Count of PDP limit exceeded",
155         "translationKeyName": "count_of_pdp_limit_exceeded_n",
156         "description": "Triggered when count_of_pdp exceeds threshold",
157         "translationKeyDescription": "count_of_pdp_limit_exceeded_d",
158         "supportedTargetingParameters": [
159           "service_policy",
160           "endpoint_tag"
161         ],
162         "eventOutputParameters": [
163           {
164             "parameter": "event_description",
165             "type": "string",
166             "description": "Standard description of the event"
167           }
168         ],
169         "supportedActions": [
170           "system-send_notification_with_email"
171         ]
172       }
173     },
174     "configured_actions": [
175       {
176         "action": {
177           "id": "system-send_notification_with_email"
178         },
179         "properties": [
180           {
181             "property": "recipients",
182             "value": "foo@bar.emnify.com",
183             "value_array": [
184               "foo@bar.emnify.com"
185             ]
186           }
187         ],
188         "recipients": {
189           "email": [
190             "foo@bar.emnify.com"
191           ]
192         }
193       }
194     ],
195     "targeting_properties": [
196       {
197         "property": "service_policy",
198         "value": "2",
199         "value_array": [
200           "2"
201         ]
202       }
203     ]
204   }
205 ]

Returns a list of all configured automations for the organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

idstring

namestring

descriptionstring

statusstring

organisationobject

number_of_executionsdouble

last_executionstring

created_atstring

modified_atstring

actionable_eventobject

configured_actionslist of objects

targeting_propertieslist of objects