{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pepperdata REST Alarms API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Alarms",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List configured alarms",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dashboard.pepperdata.com/{realm}/api/alarms"
          },
          "docs": "Retrieve a list of configured alarms in JSON format for the realm."
        },
        {
          "info": {
            "name": "Create an alarm",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dashboard.pepperdata.com/{realm}/api/alarms",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an alarm for the realm."
        },
        {
          "info": {
            "name": "List firing alarms",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dashboard.pepperdata.com/{realm}/api/alarms/status"
          },
          "docs": "Retrieve a list of firing (active) alarms."
        },
        {
          "info": {
            "name": "List alarms for an app/job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dashboard.pepperdata.com/{realm}/api/alarms/app/:appId",
            "params": [
              {
                "name": "appId",
                "value": "",
                "type": "path",
                "description": "The app/job ID."
              }
            ]
          },
          "docs": "Retrieve a list of alarms associated with a specific app/job ID."
        },
        {
          "info": {
            "name": "Get an alarm",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dashboard.pepperdata.com/{realm}/api/alarms/:alarmId",
            "params": [
              {
                "name": "alarmId",
                "value": "",
                "type": "path",
                "description": "Pepperdata-assigned unique alarm ID."
              }
            ]
          },
          "docs": "Retrieve the configuration of a specific alarm by ID."
        },
        {
          "info": {
            "name": "Revise an alarm",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dashboard.pepperdata.com/{realm}/api/alarms/:alarmId",
            "params": [
              {
                "name": "alarmId",
                "value": "",
                "type": "path",
                "description": "Pepperdata-assigned unique alarm ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Revise an existing alarm. For fields that should remain unchanged, match the alarm's existing values exactly; omitted fields are overwritten with their defaults."
        },
        {
          "info": {
            "name": "Delete an alarm",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://dashboard.pepperdata.com/{realm}/api/alarms/:alarmId",
            "params": [
              {
                "name": "alarmId",
                "value": "",
                "type": "path",
                "description": "Pepperdata-assigned unique alarm ID."
              }
            ]
          },
          "docs": "Delete an alarm by ID."
        }
      ]
    }
  ],
  "bundled": true
}