{
  "info": {
    "_postman_id": "apeiron-action_framework",
    "name": "Apeiron API - Action Framework",
    "description": "Event-driven automation: profiles, conditions, and actions with logging.\n\nCollection Version: 1.0.0\nBase URL: https://api.apeiron.io/v2\nAuth: HTTP Basic (email + API token) or JWT Bearer token\nAPI Reference: https://api.apeiron.io/v2/",
    "version": "1.0.0",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "basic",
    "basic": [
      {
        "key": "username",
        "value": "{{username}}",
        "type": "string"
      },
      {
        "key": "password",
        "value": "{{api_token}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.apeiron.io",
      "type": "string"
    },
    {
      "key": "username",
      "value": "",
      "type": "string"
    },
    {
      "key": "api_token",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Action Framework",
      "description": "Action Framework endpoints",
      "item": [
        {
          "name": "List Action Framework Profiles",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/profiles?profile_id=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "profiles"
              ],
              "query": [
                {
                  "key": "profile_id",
                  "value": "",
                  "description": "ID of an Action Framework Profile to query",
                  "disabled": true
                }
              ]
            },
            "description": "List Action Framework Profiles"
          }
        },
        {
          "name": "Create Action Framework Profile",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/profiles",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "profiles"
              ]
            },
            "description": "Create Action Framework Profile",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "monitor_type",
                  "description": "",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "label",
                  "description": "A user defined label",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Get Action Framework Profile",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/profiles/{profile_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "profiles",
                "{profile_id}"
              ]
            },
            "description": "Get Action Framework Profile details"
          }
        },
        {
          "name": "Update Action Framework Profile",
          "request": {
            "method": "PUT",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/profiles/{profile_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "profiles",
                "{profile_id}"
              ]
            },
            "description": "Update Action Framework Profile",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "label",
                  "description": "A user defined label",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Delete Action Framework Profile",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/profiles/{profile_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "profiles",
                "{profile_id}"
              ]
            },
            "description": "Delete an existing Action Framework Profile"
          }
        },
        {
          "name": "List Action Framework Conditions",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/conditions?condition_id=&profile_id=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "conditions"
              ],
              "query": [
                {
                  "key": "condition_id",
                  "value": "",
                  "description": "ID of an Action Framework Condition to query",
                  "disabled": true
                },
                {
                  "key": "profile_id",
                  "value": "",
                  "description": "ID of an Action Framework Profile to query",
                  "disabled": true
                }
              ]
            },
            "description": "List Action Framework Conditions"
          }
        },
        {
          "name": "Create Action Framework Condition",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/conditions",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "conditions"
              ]
            },
            "description": "Create an Action Framework Condition",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "profile_id",
                  "description": "The ID of an Action Framework Profile",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "trigger",
                  "description": "Usage to be considered for this condition to trigger. The choices for this parameter depend on the profile type.\n\nFor LTE, the individual triggers will apply for any individual SIM that exceeds the configured threshold.\n\n* **LTE**: `lte_domestic`, `lte_intl`, `all_lte`, `lte_domestic_individual`, `lte_intl_individual`, `all_lte_individual`\n* **Voice Usage**: `charge_limit`, `intl_charge_limit`, `offs_charge_limit`\n",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "trigger_frequency_seconds",
                  "description": "How frequently this condition may trigger, in seconds.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "threshold",
                  "description": "Minimum value before this condition will trigger. The units depend on the profile type. For example, a \ncondition on an LTE profile with a value of 100 will trigger after 100 Mb of usage.\n\n* **LTE**: MB\n* **Voice Usage**: US Dollars\n",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "data_range",
                  "description": "The oldest any data point should be considered when checking this condition, in seconds.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "reset_criteria",
                  "description": "When this condition should reset",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "reset_criteria_value",
                  "description": "The value for the `reset_criteria`, if necessary. Required for `day_of_week`.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "target_type",
                  "description": "Entity type to monitor for this condition. Required when `lte_domestic_individual`, `lte_intl_individual`, \n`all_lte_individual`, `charge_limit`, `intl_charge_limit`, or `offs_charge_limit` are provided for `trigger`.\n",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "target",
                  "description": "Specified entities to monitor for this condition. This is a comma separated string of entity identifiers. \nFor LTE target types, this will be ICCIDs. For trunk group target types, this will be trunk group ids. \nRequired when `target_type` is provided.\n",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Get Action Framework Condition",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/conditions/{condition_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "conditions",
                "{condition_id}"
              ]
            },
            "description": "Get Action Framework Condition details"
          }
        },
        {
          "name": "Update Action Framework Condition",
          "request": {
            "method": "PUT",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/conditions/{condition_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "conditions",
                "{condition_id}"
              ]
            },
            "description": "Update Action Framework Condition",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "trigger_frequency_seconds",
                  "description": "How frequently this condition may trigger, in seconds.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "threshold",
                  "description": "Minimum value before this condition will trigger. The units depend on the profile type. For example, a \ncondition on an LTE profile with a value of 100 will trigger after 100 Mb of usage.\n\n* **LTE**: MB\n* **Voice Usage**: US Dollars\n",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "data_range",
                  "description": "The oldest any data point should be considered when checking this condition, in seconds.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "reset_criteria",
                  "description": "When this condition should reset",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "reset_criteria_value",
                  "description": "The value for the `reset_criteria`, if necessary. Required for `day_of_week`.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "target_type",
                  "description": "Entity type to monitor for this condition. Required when `lte_domestic_individual`, `lte_intl_individual`, \n`all_lte_individual`, `charge_limit`, `intl_charge_limit`, or `offs_charge_limit` are provided for `trigger`.\n",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "target",
                  "description": "Specified entities to monitor for this condition. This is a comma separated string of entity identifiers. \nFor LTE target types, this will be ICCIDs. For trunk group target types, this will be trunk group ids. \nRequired when `target_type` is provided.\n",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Delete Action Framework Condition",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/conditions/{condition_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "conditions",
                "{condition_id}"
              ]
            },
            "description": "Delete an existing Action Framework Condition"
          }
        },
        {
          "name": "Reset Action Framework Condition",
          "request": {
            "method": "PUT",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/conditions/{condition_id}/reset",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "conditions",
                "{condition_id}",
                "reset"
              ]
            },
            "description": "Reset the running total for data collected on an Action Framework Condition"
          }
        },
        {
          "name": "List Action Framework Condition Logs",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/conditions/{condition_id}/log",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "conditions",
                "{condition_id}",
                "log"
              ]
            },
            "description": "List Action Framework Condition Logs"
          }
        },
        {
          "name": "List Action Framework Actions",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/actions?action_id=&condition_id=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "actions"
              ],
              "query": [
                {
                  "key": "action_id",
                  "value": "",
                  "description": "ID of an Action Framework Action",
                  "disabled": true
                },
                {
                  "key": "condition_id",
                  "value": "",
                  "description": "ID of an Action Framework Condition",
                  "disabled": true
                }
              ]
            },
            "description": "List Action Framework Actions"
          }
        },
        {
          "name": "Create Action Framework Action",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/actions",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "actions"
              ]
            },
            "description": "Create an Action Framework Action",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "condition_id",
                  "description": "The ID of an Action Framework Condition",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "action",
                  "description": "The action to take when this action is triggered. Only certain actions are allowed for certain profile types.\n\n* **LTE**: `send_notification`\n* **Voice Usage**: `disable_intl`, `suspend_tg`, `send_notification`\n",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "target_type",
                  "description": "Target type for this action to act upon.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "target",
                  "description": "Specified entities to action upon for this action. This is a comma separated string of entity identifiers. \nFor trunk group target types, this will be trunk group ids (example `\"'10000,20000'\"`). \nRequired when `target_type` is `specific_tgs`.\n",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Get Action Framework Action",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/actions/{action_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "actions",
                "{action_id}"
              ]
            },
            "description": "Get Action Framework Action details"
          }
        },
        {
          "name": "Update Action Framework Action",
          "request": {
            "method": "PUT",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/actions/{action_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "actions",
                "{action_id}"
              ]
            },
            "description": "Update an Action Framework Action",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "action",
                  "description": "The action to take when this action is triggered. Only certain actions are allowed for certain profile types.\n\n* **LTE**: `send_notification`\n* **Voice Usage**: `disable_intl`, `suspend_tg`, `send_notification`\n",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "target_type",
                  "description": "Target type for this action to act upon.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "target",
                  "description": "Specified entities to action upon for this action. This is a comma separated string of entity identifiers. \nFor trunk group target types, this will be trunk group ids (example `\"'10000,20000'\"`). \nRequired when `target_type` is `specific_tgs`.\n",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Delete Action Framework Action",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/actions/{action_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "actions",
                "{action_id}"
              ]
            },
            "description": "Delete an existing Action Framework Action"
          }
        },
        {
          "name": "List Action Framework Action Logs",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/action_framework/actions/{action_id}/log",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "action_framework",
                "actions",
                "{action_id}",
                "log"
              ]
            },
            "description": "List Action Framework Action Logs"
          }
        }
      ]
    }
  ]
}