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

[
  {
    "id": "94628e8f-2690-4192-bd76-d1ded8b13fc2",
    "name": "Send endpoint data traffic limit warning email",
    "description": "Sends an email when the endpoint data traffic limit warning is triggered for service profile 3.\n",
    "status": "active",
    "organisation": {
      "id": 1550
    },
    "number_of_executions": 3,
    "last_execution": "2025-01-01T00:00:00.000Z",
    "created_at": "2024-01-01T03:00:00.000Z",
    "modified_at": "2024-05-06T05:00:00.000Z",
    "actionable_event": {
      "system_event": {
        "id": "0b721b5e-4208-47fd-8a16-b24ceebb28be",
        "parent_organisation": {
          "id": 2
        },
        "event_type": {
          "id": 65
        },
        "name": "Endpoint data traffic limit warning",
        "translation_key_name": "endpoint_data_traffic_limit_warning_n",
        "description": "Endpoint data traffic limit warning",
        "translation_key_description": "endpoint_data_traffic_limit_warning_d",
        "supported_targeting_parameters": [
          {
            "parameter": "service_policy",
            "type": "number[]",
            "description": "Service Policy"
          },
          {
            "parameter": "endpoint_tag",
            "type": "string[]",
            "description": "Endpoint Tag",
            "validators": [
              {
                "validator_type": "minCount",
                "validator_value": "1"
              }
            ]
          }
        ],
        "event_output_parameters": [
          {
            "parameter": "description",
            "type": "string",
            "description": "Description of the event"
          },
          {
            "parameter": "endpoint_id",
            "type": "number",
            "description": "Endpoint id"
          }
        ],
        "supported_action_ids": [
          "system-send_notification_with_email"
        ]
      }
    },
    "configured_actions": [
      {
        "action": {
          "id": "system-send_notification_with_email",
          "type": "system"
        },
        "properties": [
          {
            "property": "recipients",
            "value": "string",
            "value_array": [
              "foo@bar.emnify"
            ]
          }
        ],
        "recipients": {
          "email": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "recipient": "foo@bar.emnify.com",
              "verified": true,
              "blocked": false
            }
          ]
        }
      }
    ],
    "targeting_properties": [
      {
        "property": "service_policy",
        "value": "string",
        "value_array": [
          "3"
        ]
      }
    ],
    "created_by": {
      "id": 1,
      "name": "John Doe"
    }
  },
  {
    "id": "94628e8f-2690-4192-bd76-d1ded8b13fc2",
    "name": "Event `count_of_pdp` limit email\n",
    "description": "Sends an email when the event `count_of_pdp` exceeds 10 in one week for service profile 2.\n",
    "status": "active",
    "organisation": {
      "id": 1550
    },
    "number_of_executions": 1,
    "last_execution": "2021-09-01T00:00:00.000Z",
    "created_at": "2021-01-01T00:00:00.000Z",
    "modified_at": "2021-02-01T00:00:00.000Z",
    "actionable_event": {
      "custom_event": {
        "organisation": {
          "id": 200
        },
        "template": {
          "id": 1
        },
        "configuration_properties": [
          {
            "property": "count_of_pdp",
            "value": "10",
            "value_array": [
              "string"
            ]
          },
          {
            "property": "duration",
            "value": "1w",
            "value_array": [
              "string"
            ]
          }
        ],
        "name": "PDP Threshold 50 Over One Week",
        "id": "2",
        "supported_targeting_parameters": [
          {
            "parameter": "service_policy",
            "type": "number[]",
            "description": "Service Policy"
          },
          {
            "parameter": "endpoint_tag",
            "type": "string[]",
            "description": "Endpoint Tag"
          }
        ],
        "supported_action_ids": [
          "system-send_notification_with_email"
        ]
      }
    },
    "configured_actions": [
      {
        "action": {
          "id": "system-send_notification_with_email",
          "type": "system"
        },
        "properties": [
          {
            "property": "recipients",
            "value": "string",
            "value_array": [
              "foo@bar.emnify"
            ]
          }
        ],
        "recipients": {
          "email": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "recipient": "foo@bar.emnify.com",
              "verified": true,
              "blocked": false
            }
          ]
        }
      }
    ],
    "targeting_properties": [
      {
        "property": "service_policy",
        "value": "string",
        "value_array": [
          "2"
        ]
      }
    ]
  }
]

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 or null

statusstring

organisationobject

number_of_executionsdouble

last_executionstring or null

created_atstring

modified_atstring or null

actionable_eventobject

configured_actionslist of objects

targeting_propertieslist of objects

created_byobjectOptional