{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cisco Meraki Dashboard API — sensor",
    "version": "1.72.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Cisco-Meraki-API-Key",
      "value": "{{X-Cisco-Meraki-API-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "sensor",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns a historical log of all commands",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/devices/:serial/sensor/commands",
            "params": [
              {
                "name": "serial",
                "value": "",
                "type": "path",
                "description": "Serial"
              },
              {
                "name": "operations",
                "value": "",
                "type": "query",
                "description": "Optional parameter to filter commands by operation. Allowed values are disableDownstreamPower, enableDownstreamPower, cycleDownstreamPower, and refreshData."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10."
              },
              {
                "name": "startingAfter",
                "value": "",
                "type": "query",
                "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it."
              },
              {
                "name": "endingBefore",
                "value": "",
                "type": "query",
                "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'descending'."
              },
              {
                "name": "t0",
                "value": "",
                "type": "query",
                "description": "The beginning of the timespan for the data. The maximum lookback period is 30 days from today."
              },
              {
                "name": "t1",
                "value": "",
                "type": "query",
                "description": "The end of the timespan for the data. t1 can be a maximum of 30 days after t0."
              },
              {
                "name": "timespan",
                "value": "",
                "type": "query",
                "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 30 days. The default is 30 days."
              }
            ]
          },
          "docs": "Returns a historical log of all commands"
        },
        {
          "info": {
            "name": "Sends a command to a sensor",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.meraki.com/{basePath}/devices/:serial/sensor/commands",
            "params": [
              {
                "name": "serial",
                "value": "",
                "type": "path",
                "description": "Serial"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sends a command to a sensor"
        },
        {
          "info": {
            "name": "Returns information about the command's execution, including the status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/devices/:serial/sensor/commands/:commandId",
            "params": [
              {
                "name": "serial",
                "value": "",
                "type": "path",
                "description": "Serial"
              },
              {
                "name": "commandId",
                "value": "",
                "type": "path",
                "description": "Command ID"
              }
            ]
          },
          "docs": "Returns information about the command's execution, including the status"
        },
        {
          "info": {
            "name": "List the sensor roles for a given sensor or camera device.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/devices/:serial/sensor/relationships",
            "params": [
              {
                "name": "serial",
                "value": "",
                "type": "path",
                "description": "Serial"
              }
            ]
          },
          "docs": "List the sensor roles for a given sensor or camera device."
        },
        {
          "info": {
            "name": "Assign one or more sensor roles to a given sensor or camera device.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.meraki.com/{basePath}/devices/:serial/sensor/relationships",
            "params": [
              {
                "name": "serial",
                "value": "",
                "type": "path",
                "description": "Serial"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign one or more sensor roles to a given sensor or camera device."
        },
        {
          "info": {
            "name": "Return an overview of currently alerting sensors by metric",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/alerts/current/overview/byMetric",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              }
            ]
          },
          "docs": "Return an overview of currently alerting sensors by metric"
        },
        {
          "info": {
            "name": "Return an overview of alert occurrences over a timespan, by metric",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/alerts/overview/byMetric",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              },
              {
                "name": "t0",
                "value": "",
                "type": "query",
                "description": "The beginning of the timespan for the data. The maximum lookback period is 731 days from today."
              },
              {
                "name": "t1",
                "value": "",
                "type": "query",
                "description": "The end of the timespan for the data. t1 can be a maximum of 366 days after t0."
              },
              {
                "name": "timespan",
                "value": "",
                "type": "query",
                "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 366 days. The default is 7 days. If interval is provided, the timespan will be autocalculated."
              },
              {
                "name": "interval",
                "value": "",
                "type": "query",
                "description": "The time interval in seconds for returned data. The valid intervals are: 900, 3600, 86400, 604800, 2629746. The default is 604800. Interval is calculated if time params are provided."
              }
            ]
          },
          "docs": "Return an overview of alert occurrences over a timespan, by metric"
        },
        {
          "info": {
            "name": "Lists all sensor alert profiles for a network.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/alerts/profiles",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              }
            ]
          },
          "docs": "Lists all sensor alert profiles for a network."
        },
        {
          "info": {
            "name": "Creates a sensor alert profile for a network.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/alerts/profiles",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a sensor alert profile for a network."
        },
        {
          "info": {
            "name": "Show details of a sensor alert profile for a network.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/alerts/profiles/:id",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID"
              }
            ]
          },
          "docs": "Show details of a sensor alert profile for a network."
        },
        {
          "info": {
            "name": "Updates a sensor alert profile for a network.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/alerts/profiles/:id",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a sensor alert profile for a network."
        },
        {
          "info": {
            "name": "Deletes a sensor alert profile from a network.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/alerts/profiles/:id",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID"
              }
            ]
          },
          "docs": "Deletes a sensor alert profile from a network."
        },
        {
          "info": {
            "name": "List the sensor settings of all MQTT brokers for this network",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/mqttBrokers",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              }
            ]
          },
          "docs": "List the sensor settings of all MQTT brokers for this network. To get the brokers themselves, use /networks/{networkId}/mqttBrokers."
        },
        {
          "info": {
            "name": "Return the sensor settings of an MQTT broker",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/mqttBrokers/:mqttBrokerId",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              },
              {
                "name": "mqttBrokerId",
                "value": "",
                "type": "path",
                "description": "Mqtt broker ID"
              }
            ]
          },
          "docs": "Return the sensor settings of an MQTT broker. To get the broker itself, use /networks/{networkId}/mqttBrokers/{mqttBrokerId}."
        },
        {
          "info": {
            "name": "Update the sensor settings of an MQTT broker",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/mqttBrokers/:mqttBrokerId",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              },
              {
                "name": "mqttBrokerId",
                "value": "",
                "type": "path",
                "description": "Mqtt broker ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the sensor settings of an MQTT broker. To update the broker itself, use /networks/{networkId}/mqttBrokers/{mqttBrokerId}."
        },
        {
          "info": {
            "name": "List the sensor roles for devices in a given network",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/networks/:networkId/sensor/relationships",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Network ID"
              }
            ]
          },
          "docs": "List the sensor roles for devices in a given network"
        },
        {
          "info": {
            "name": "Returns latest sensor-gateway connectivity data.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sensor/gateways/connections/latest",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "sensorSerials",
                "value": "",
                "type": "query",
                "description": "List of sensor serials to filter connectivity data by sensor."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000."
              },
              {
                "name": "startingAfter",
                "value": "",
                "type": "query",
                "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it."
              },
              {
                "name": "endingBefore",
                "value": "",
                "type": "query",
                "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it."
              }
            ]
          },
          "docs": "Returns latest sensor-gateway connectivity data."
        },
        {
          "info": {
            "name": "Return all reported readings from sensors in a given timespan, sorted by timestamp",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sensor/readings/history",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000."
              },
              {
                "name": "startingAfter",
                "value": "",
                "type": "query",
                "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it."
              },
              {
                "name": "endingBefore",
                "value": "",
                "type": "query",
                "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it."
              },
              {
                "name": "t0",
                "value": "",
                "type": "query",
                "description": "The beginning of the timespan for the data. The maximum lookback period is 365 days, 5 hours, 49 minutes, and 12 seconds from today."
              },
              {
                "name": "t1",
                "value": "",
                "type": "query",
                "description": "The end of the timespan for the data. t1 can be a maximum of 7 days after t0."
              },
              {
                "name": "timespan",
                "value": "",
                "type": "query",
                "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 2 hours."
              },
              {
                "name": "networkIds",
                "value": "",
                "type": "query",
                "description": "Optional parameter to filter readings by network."
              },
              {
                "name": "serials",
                "value": "",
                "type": "query",
                "description": "Optional parameter to filter readings by sensor."
              },
              {
                "name": "metrics",
                "value": "",
                "type": "query",
                "description": "Types of sensor readings to retrieve. If no metrics are supplied, all available types of readings will be retrieved."
              }
            ]
          },
          "docs": "Return all reported readings from sensors in a given timespan, sorted by timestamp"
        },
        {
          "info": {
            "name": "Return the latest available reading for each metric from each sensor, sorted by sensor serial",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sensor/readings/latest",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000."
              },
              {
                "name": "startingAfter",
                "value": "",
                "type": "query",
                "description": "A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it."
              },
              {
                "name": "endingBefore",
                "value": "",
                "type": "query",
                "description": "A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it."
              },
              {
                "name": "networkIds",
                "value": "",
                "type": "query",
                "description": "Optional parameter to filter readings by network."
              },
              {
                "name": "serials",
                "value": "",
                "type": "query",
                "description": "Optional parameter to filter readings by sensor."
              },
              {
                "name": "metrics",
                "value": "",
                "type": "query",
                "description": "Types of sensor readings to retrieve. If no metrics are supplied, all available types of readings will be retrieved."
              }
            ]
          },
          "docs": "Return the latest available reading for each metric from each sensor, sorted by sensor serial"
        }
      ]
    }
  ],
  "bundled": true
}