Get a system event by ID

Pre-release

GET

https://cdn.emnify.net/api/v1/event/system/configuration/:system_event_id

GET

/api/v1/event/system/configuration/:system_event_id

$ curl https://cdn.emnify.net/api/v1/event/system/configuration/system_event_id \
>      -H "Authorization: Bearer <token>"

200System Event by ID

1 {
2   "id": "605",
3   "parentOrg": {
4     "id": 1.1
5   },
6   "eventType": {
7     "id": 1.1
8   },
9   "name": "Endpoint data traffic limit warning",
10   "translationKeyName": "string",
11   "description": "Endpoint data traffic limit warning",
12   "translationKeyDescription": "string",
13   "supportedTargetingParameters": [
14     "string"
15   ],
16   "eventOutputParameters": [
17     {
18       "parameter": "string",
19       "type": "string",
20       "description": "string"
21     }
22   ],
23   "supportedActions": [
24     "string"
25   ],
26   "parent_organisation": {
27     "id": 2
28   },
29   "event_type": {
30     "id": 65
31   },
32   "translation_key_name": "endpoint_data_traffic_limit_warning_n",
33   "translation_key_description": "endpoint_data_traffic_limit_warning_d",
34   "supported_targeting_parameters": [
35     {
36       "parameter": "service_policy",
37       "type": "number[]",
38       "description": "Service Policy"
39     },
40     {
41       "parameter": "endpoint_tag",
42       "type": "string[]",
43       "description": "Endpoint Tag",
44       "validators": [
45         {
46           "type": "minCount",
47           "value": 1
48         }
49       ]
50     }
51   ],
52   "supported_actions": [
53     {
54       "id": "system-send_notification_with_email",
55       "status": "active",
56       "type": "system",
57       "configuration_properties": [
58         {
59           "property": "recipients",
60           "type": "email[]",
61           "default": null,
62           "required": true,
63           "description": "List of email addresses to notify"
64         }
65       ],
66       "name": "Send notification via email",
67       "description": "Send notification via email",
68       "translation_key_name": "Send notification with email N",
69       "translation_key_description": "Send notification with email D",
70       "required_event_output_parameters": [
71         {
72           "parameter": "event_description",
73           "type": "string",
74           "description": "Standard description of the event"
75         }
76       ]
77     }
78   ]
79 }

Retrieves a specific system event and its supported targeting options.

Get a system event by ID

Get a system event by ID

Authentication

Path parameters

Response

Authentication

Path parameters

Response

$	curl https://cdn.emnify.net/api/v1/event/system/configuration/system_event_id \
>	-H "Authorization: Bearer <token>"

1	{
2	"id": "605",
3	"parentOrg": {
4	"id": 1.1
5	},
6	"eventType": {
7	"id": 1.1
8	},
9	"name": "Endpoint data traffic limit warning",
10	"translationKeyName": "string",
11	"description": "Endpoint data traffic limit warning",
12	"translationKeyDescription": "string",
13	"supportedTargetingParameters": [
14	"string"
15	],
16	"eventOutputParameters": [
17	{
18	"parameter": "string",
19	"type": "string",
20	"description": "string"
21	}
22	],
23	"supportedActions": [
24	"string"
25	],
26	"parent_organisation": {
27	"id": 2
28	},
29	"event_type": {
30	"id": 65
31	},
32	"translation_key_name": "endpoint_data_traffic_limit_warning_n",
33	"translation_key_description": "endpoint_data_traffic_limit_warning_d",
34	"supported_targeting_parameters": [
35	{
36	"parameter": "service_policy",
37	"type": "number[]",
38	"description": "Service Policy"
39	},
40	{
41	"parameter": "endpoint_tag",
42	"type": "string[]",
43	"description": "Endpoint Tag",
44	"validators": [
45	{
46	"type": "minCount",
47	"value": 1
48	}
49	]
50	}
51	],
52	"supported_actions": [
53	{
54	"id": "system-send_notification_with_email",
55	"status": "active",
56	"type": "system",
57	"configuration_properties": [
58	{
59	"property": "recipients",
60	"type": "email[]",
61	"default": null,
62	"required": true,
63	"description": "List of email addresses to notify"
64	}
65	],
66	"name": "Send notification via email",
67	"description": "Send notification via email",
68	"translation_key_name": "Send notification with email N",
69	"translation_key_description": "Send notification with email D",
70	"required_event_output_parameters": [
71	{
72	"parameter": "event_description",
73	"type": "string",
74	"description": "Standard description of the event"
75	}
76	]
77	}
78	]
79	}