For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Request featuresContact support
DocsAPI ReferenceGraphQLIntegrationsDeveloper Tools
DocsAPI ReferenceGraphQLIntegrationsDeveloper Tools
  • Authentication
    • POSTRetrieve authentication token
    • POSTCreate an MFA key
    • PATCHActivate MFA key
    • DELDelete an MFA key
    • GETList MFA key statuses
    • GETList MFA key types
    • GETList trusted devices
    • DELDelete a trusted device
  • Password Management and Activation
    • POSTInvite a user
    • POSTActivate user
    • POSTResend user activation email
    • PATCHChange password
  • Endpoint
    • GETList endpoints
    • POSTCreate an endpoint
    • POSTBulk create endpoints
    • DELBulk delete endpoints
    • PATCHBulk update endpoints
    • GETList endpoint statuses
    • GETEndpoint details
    • DELDelete an endpoint
    • PATCHUpdate an endpoint
    • GETEndpoint connectivity status
    • PATCHReset endpoint connectivity
    • GETList endpoint events
    • GETEndpoint usage and cost statistics
    • GETRetrieve daily usage statistics for an endpoint
    • GETList sent and received SMS
    • POSTSend SMS to an endpoint
    • GETSMS details
    • DELCancel SMS
    • GETRetrieve connectivity information for an endpoint
    • GETList active traffic limit extensions
    • POSTCreate traffic limit extension
    • DELDelete all traffic limit extensions for an endpoint
    • GETList operator blacklist for endpoint
    • PUTAdd an operator to the blacklist
    • DELRemove an operator from the blacklist
    • GETRetrieve data quota details
    • POSTSet data quota
    • DELRemove data quota
    • GETShow SMS quota details
    • POSTSet SMS quota
    • DELRemove SMS quota
  • Organization
    • GETOrganization usage and costs statistics per day for the current month
    • GETMy organization details
    • GETList organization statuses
    • GETMonthly organization traffic and cost statistics
    • GETDaily organization traffic and cost statistics
    • GETHourly organization traffic statistics
    • PATCHUpdate assigned tariff
    • PUTAssign a ratezone inclusive volume to an organization
    • GETGet list of active organization inclusive volumes
  • Sim
    • GETList SIMs
    • GETList SIM statuses
    • GETSIM details
    • DELDelete a SIM
    • PATCHUpdate a SIM
    • GETSIM usage and cost statistics
    • GETDaily SIM usage statistics
    • GETList SIM events
    • GETValidate SIM batch by BIC
    • PATCHRegister a given batch by BIC
    • DELBulk delete SIMs
    • POSTMigrate SIMs between Workspaces
  • Events
    • GETList events
    • GETList event types
  • Lookups
    • GETList country codes
    • GETList currencies
    • GETList data blocksizes
    • GETList data throttles
    • GETList breakout regions
    • GETList ESME interface types
    • GETList RAT types
    • GETGet list of service levels
  • Operator
    • GETList operators
  • Application Tokens
    • GETList application tokens
    • POSTCreate application token
    • PATCHUpdate application token
  • Tariff Profiles
    • GETList tariff profiles
    • POSTCreate tariff profile
    • GETTariff profile details
    • DELDelete tariff profile
    • PATCHUpdate tariff profile
    • PUTAssign ratezone to tarriff profile
    • DELDelete ratezone from tariff profile
    • GETGet the operator blocklist for a specific tariff profile
    • GETGet operator blocklist for a specific tariff profile
    • PUTBlock the operator completely for a given tariff profile
    • DELRemove an operator from the blocklist
    • POSTBlock specific RAT types
    • DELUnblock a specific RAT type
    • GETList tariff profile coverage
    • PUTAssign inclusive volume to tarriff profile
    • DELUnassign inclusive volume from tariff profile
  • Service Profiles
    • GETList service profiles
    • POSTCreate service profile
    • GETRetrieve a service profile
    • DELDelete a service profile
    • PATCHUpdate service profile
    • DELRemove all quotas of assigned endpoints
    • PUTAdd a service to a service profile
    • DELRemove a service from a service profile
    • PUTAdd SMS limit to service profile
    • DELRemove SMS limit from a service profile
    • GETList data limits of service profile
    • POSTAdd data limit to service profile
    • DELDelete all data limits of a service profile
    • DELRemove data limit from a service profile
  • Service Lookups and Configuration
    • GETList services
    • GETGet service SMS limit
    • GETList traffic limits
    • GETList DNS configs
    • POSTCreate DNS config
    • DELDelete DNS config
  • User Management
    • GETList user accounts
    • POSTCreate user
    • GETList user statuses
    • GETList user roles
    • GETGet user by ID or username
    • DELDelete user by ID
    • PATCHUpdate user by ID
    • GETList user events
    • GETList user role permissions
    • PUTAssign role to user
    • DELDelete user role
    • DELDelete user by ID
    • POSTCreate support access token for given user
  • IP Address Spaces
    • GETList IP address spaces
    • POSTCreate an IP address space
    • GETGet random address spaces
    • PUTAssign an IP address space to an organization
    • DELRelease an IP address space from an organization
  • Integrations
    • GETList data stream configurations of your organization
    • POSTCreate data stream
    • GETGet data stream statuses
    • GETGet data stream types
    • GETGet data stream filter fields
    • GETGet details on existing data stream
    • DELDelete existing data stream
    • PATCHModify existing data stream
    • POSTRestart existing data stream
    • GETRetrieve list of API callback URLs
    • POSTCreate a callback URL
    • GETGet a callback URL by ID
    • DELDelete a callback URL
    • GETList API callback secrets
    • POSTCreate a callback secret
    • GETGet a callback secret by ID
    • DELDelete a callback secret
  • Cloud Connect
    • GETList all Cloud Connect attachments of an organization
    • GETList Cloud Connect breakout types
    • GETView details of a Cloud Connect attachment
    • DELDelete a specific Cloud Connect attachment
    • PATCHRetry creation of an expired TGW breakout
    • POSTCreate a Cloud Connect attachment via Transit Gateway
    • POSTCreate a Cloud Connect attachment via IPSec VPN
    • GETList Cloud Connect prices
    • GETGet list of available Cloud Connect regions by breakout type
  • Tariff Plans
    • GETList organization tariff plans
    • GETRetrieve your organization's active tariff plan
    • GETGet the active tariff plan for the given organization
  • Workspaces
    • POSTSwitch to an assigned Workspace
    • POSTAccept user invitation
    • PUTAssign a role to a Workspace user
    • DELRemove a role from a Workspace user
    • PUTUpdate a user's default Workspace
    • GETList assigned Workspaces
    • DELUnassign a Workspace
    • PATCHUpdate user status in a Workspace
    • GETRetrieve Workspace daily stats
  • Tag Management
    • GETReturns the list of available tag colors
    • GETList tags
    • POSTCreate a tag
    • DELDelete a tag
    • PATCHUpdate a tag
    • GETList endpoint tags
    • POSTAssign a tag to an endpoint
    • DELUnassign a tag from an endpoint
    • POSTBulk assign tags
    • POSTBulk unassign tags
    • POSTBulk delete tags
  • Automations
    • GETList action logs
    • GETList available actions
    • GETGet an action by ID
    • GETList configured automations
    • POSTCreate an automation
    • GETGet configured automation by ID
    • DELDelete a configured automation
    • PATCHUpdate an automation
    • POSTVerify an automation recipient's email address
  • System Events
    • GETList system events
    • GETGet a system event by ID
  • Custom Events
    • GETList custom event templates
    • GETGet a custom event template by ID
    • GETList custom events
    • POSTDeploy custom event
    • GETGet a custom event by ID
    • DELDelete custom event
  • euicc
    • GETList eUICCs
    • GETList eUICC status
    • GETList eUICC Profile status
    • GETGet eUICC
    • POSTUnlinked eUICC validation
  • Euicc Operation
    • GETList operation action for eUICC
    • GETList operation status for eUICC
    • GETList operation for eUICC
    • POSTSchedule eUICC operations
    • GETGet operation details
    • DELCancel operation
  • Sim Unlinked Product Statistics
    • GETGet product statistics on unlinked eSIMs
  • Sim Operation
    • GETList SIM operation actions
    • GETList SIM operation status
    • GETList SIM operations for organization
    • POSTTrigger SIM operation
    • GETGet SIM operation details
LogoLogo
Request featuresContact support
Automations

List configured automations

Pre-release
GET
https://cdn.emnify.net/api/v1/automation
GET
/api/v1/automation
$curl https://cdn.emnify.net/api/v1/automation \
>     -H "Authorization: Bearer <token>"
200Configured Automations
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": 1.1
18        },
19        "template": {
20          "id": 1.1
21        },
22        "configuration_properties": [
23          {
24            "property": "string",
25            "value": "string",
26            "value_array": [
27              "string"
28            ]
29          }
30        ],
31        "name": "string",
32        "id": "string",
33        "supportedTargetingParameters": [
34          "string"
35        ],
36        "supportedActions": [
37          "string"
38        ]
39      },
40      "system_event": {
41        "id": "605",
42        "parentOrg": {
43          "id": 1.1
44        },
45        "eventType": {
46          "id": 1.1
47        },
48        "name": "Endpoint data traffic limit warning",
49        "translationKeyName": "string",
50        "description": "Endpoint data traffic limit warning",
51        "translationKeyDescription": "string",
52        "supportedTargetingParameters": [
53          "string"
54        ],
55        "eventOutputParameters": [
56          {
57            "parameter": "string",
58            "type": "string",
59            "description": "string"
60          }
61        ],
62        "supportedActions": [
63          "string"
64        ],
65        "parent_organisation": {
66          "id": 2
67        },
68        "event_type": {
69          "id": 65
70        },
71        "translation_key_name": "endpoint_data_traffic_limit_warning_n",
72        "translation_key_description": "endpoint_data_traffic_limit_warning_d",
73        "supported_targeting_parameters": [
74          {
75            "parameter": "service_policy",
76            "type": "number[]",
77            "description": "Service Policy"
78          },
79          {
80            "parameter": "endpoint_tag",
81            "type": "string[]",
82            "description": "Endpoint Tag",
83            "validators": [
84              {
85                "type": "minCount",
86                "value": 1
87              }
88            ]
89          }
90        ],
91        "supported_actions": [
92          {
93            "id": "system-send_notification_with_email",
94            "status": "active",
95            "type": "system",
96            "configuration_properties": [
97              {
98                "property": "recipients",
99                "type": "email[]",
100                "default": null,
101                "required": true,
102                "description": "List of email addresses to notify"
103              }
104            ],
105            "name": "Send notification via email",
106            "description": "Send notification via email",
107            "translation_key_name": "Send notification with email N",
108            "translation_key_description": "Send notification with email D",
109            "required_event_output_parameters": [
110              {
111                "parameter": "event_description",
112                "type": "string",
113                "description": "Standard description of the event"
114              }
115            ]
116          }
117        ]
118      }
119    },
120    "configured_actions": [
121      {
122        "action": {
123          "id": "system-send_notification_with_email",
124          "status": "active",
125          "type": "system",
126          "configuration_properties": [
127            {
128              "property": "recipients",
129              "type": "email[]",
130              "default": null,
131              "required": true,
132              "description": "List of email addresses to notify"
133            }
134          ],
135          "name": "Send notification via email",
136          "description": "Send notification via email",
137          "translation_key_name": "Send notification with email N",
138          "translation_key_description": "Send notification with email D",
139          "required_event_output_parameters": [
140            {
141              "parameter": "event_description",
142              "type": "string",
143              "description": "Standard description of the event"
144            }
145          ]
146        },
147        "properties": [
148          {
149            "property": "recipients",
150            "value": "string",
151            "value_array": [
152              "foo@bar.emnify"
153            ]
154          }
155        ],
156        "recipients": {
157          "email": [
158            "string"
159          ]
160        }
161      }
162    ],
163    "targeting_properties": [
164      {
165        "property": "service_policy",
166        "value": "string",
167        "value_array": [
168          "3"
169        ]
170      }
171    ],
172    "created_by": {
173      "id": 1,
174      "name": "John Doe"
175    }
176  },
177  {
178    "id": "56",
179    "name": "Event `count_of_pdp` limit email\n",
180    "description": "Sends an email when the event `count_of_pdp` exceeds 10 in one week for service profile 2.\n",
181    "status": "active",
182    "organisation": {
183      "id": 1550
184    },
185    "number_of_executions": 1,
186    "last_execution": "2021-09-01T00:00:00.000Z",
187    "created_at": "2021-01-01T00:00:00.000Z",
188    "modified_at": "2021-02-01T00:00:00.000Z",
189    "actionable_event": {
190      "custom_event": {
191        "organisation": {
192          "id": 200
193        },
194        "template": {
195          "id": 1
196        },
197        "configuration_properties": [
198          {
199            "property": "count_of_pdp",
200            "value": "10",
201            "value_array": [
202              "string"
203            ]
204          },
205          {
206            "property": "duration",
207            "value": "1w",
208            "value_array": [
209              "string"
210            ]
211          }
212        ],
213        "name": "PDP Threshold 50 Over One Week",
214        "id": "2",
215        "supportedTargetingParameters": [
216          "string"
217        ],
218        "supportedActions": [
219          "string"
220        ],
221        "supported_targeting_parameters": [
222          {
223            "parameter": "service_policy",
224            "type": "number[]",
225            "description": "Service Policy"
226          },
227          {
228            "parameter": "endpoint_tag",
229            "type": "string[]",
230            "description": "Endpoint Tag"
231          }
232        ],
233        "supported_actions": [
234          {
235            "id": "system-send_notification_with_email",
236            "status": "active",
237            "type": "system",
238            "configuration_properties": [
239              {
240                "property": "recipients",
241                "type": "email[]",
242                "default": null,
243                "required": true,
244                "description": "List of email addresses to notify"
245              }
246            ],
247            "name": "Send notification via email",
248            "description": "Send notification via email",
249            "translation_key_name": "Send notification with email N",
250            "translation_key_description": "Send notification with email D",
251            "required_event_output_parameters": [
252              {
253                "parameter": "event_description",
254                "type": "string",
255                "description": "standard description of the event"
256              }
257            ]
258          }
259        ]
260      },
261      "system_event": {
262        "id": "string",
263        "parentOrg": {
264          "id": 1.1
265        },
266        "eventType": {
267          "id": 1.1
268        },
269        "name": "string",
270        "translationKeyName": "string",
271        "description": "string",
272        "translationKeyDescription": "string",
273        "supportedTargetingParameters": [
274          "string"
275        ],
276        "eventOutputParameters": [
277          {
278            "parameter": "string",
279            "type": "string",
280            "description": "string"
281          }
282        ],
283        "supportedActions": [
284          "string"
285        ]
286      }
287    },
288    "configured_actions": [
289      {
290        "action": {
291          "id": "system-send_notification_with_email",
292          "status": "active",
293          "type": "system",
294          "configuration_properties": [
295            {
296              "property": "recipients",
297              "type": "email[]",
298              "default": null,
299              "required": true,
300              "description": "List of email addresses to notify"
301            }
302          ],
303          "name": "Send notification with email",
304          "description": "Send notification with email",
305          "translation_key_name": "Send notification with email N",
306          "translation_key_description": "Send notification with email D",
307          "required_event_output_parameters": [
308            {
309              "parameter": "event_description",
310              "type": "string",
311              "description": "Standard description of the event"
312            }
313          ]
314        },
315        "properties": [
316          {
317            "property": "recipients",
318            "value": "string",
319            "value_array": [
320              "foo@bar.emnify"
321            ]
322          }
323        ],
324        "recipients": {
325          "email": [
326            "string"
327          ]
328        }
329      }
330    ],
331    "targeting_properties": [
332      {
333        "property": "service_policy",
334        "value": "string",
335        "value_array": [
336          "2"
337        ]
338      }
339    ]
340  }
341]
Returns a list of all configured automations for the organization.
Was this page helpful?
Previous

Get an action by ID

Next

Create an automation

Built with

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