{"type":"api","title":"Get Network Sensor Alerts Profile","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/e92a64d0814b40091de22f4a93378df69809b95e/5c63a5d4-9452-397a-85eb-8b6fec45147e","info":{"title":"Meraki Dashboard API","description":"A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n\u003e Date: 06 November, 2024\n\u003e\n\u003e [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n","contact":{"name":"Meraki Developer Community","url":"https://meraki.io/community"},"version":"1.52.0"},"security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"tags":[{"name":"organizations"},{"name":"networks"},{"name":"devices"},{"name":"insight"},{"name":"wireless"},{"name":"camera"},{"name":"appliance"},{"name":"switch"},{"name":"cellularGateway"},{"name":"sm"},{"name":"sensor"},{"name":"administered"},{"name":"wirelessController"},{"name":"policy"},{"name":"accessControlLists"},{"name":"accessPolicies"},{"name":"accounts"},{"name":"acls"},{"name":"actionBatches"},{"name":"adaptivePolicy"},{"name":"addresses"},{"name":"admins"},{"name":"airMarshal"},{"name":"alertTypes"},{"name":"alerts"},{"name":"alternateManagementInterface"},{"name":"analytics"},{"name":"api"},{"name":"apiRequests"},{"name":"apnsCert"},{"name":"appliances"},{"name":"applicationCategories"},{"name":"applicationUsage"},{"name":"applications"},{"name":"areas"},{"name":"arpInspection"},{"name":"arpTable"},{"name":"artifacts"},{"name":"assets"},{"name":"assignments"},{"name":"authenticationToken"},{"name":"autoLocate"},{"name":"autoRf"},{"name":"availabilities"},{"name":"bandwidthUsageHistory"},{"name":"bgp"},{"name":"billing"},{"name":"bluetooth"},{"name":"bluetoothClients"},{"name":"bonjourForwarding"},{"name":"boundaries"},{"name":"brandingPolicies"},{"name":"bulk"},{"name":"bulkUpdate"},{"name":"byBoundary"},{"name":"byClient"},{"name":"byDevice"},{"name":"byEnergyUsage"},{"name":"byInterval"},{"name":"byMetric"},{"name":"byModel"},{"name":"byNetwork"},{"name":"byStatus"},{"name":"bySwitch"},{"name":"byType"},{"name":"byUsage"},{"name":"byUtilization"},{"name":"bypassActivationLockAttempts"},{"name":"cableTest"},{"name":"callbacks"},{"name":"categories"},{"name":"cellular"},{"name":"cellularFirewallRules"},{"name":"cellularUsageHistory"},{"name":"certs"},{"name":"changeHistory"},{"name":"channelUtilization"},{"name":"channelUtilizationHistory"},{"name":"channels"},{"name":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clients"},{"name":"cloudMonitoring"},{"name":"commands"},{"name":"communicationPlans"},{"name":"compliance"},{"name":"configTemplates"},{"name":"configurationChanges"},{"name":"configure"},{"name":"configuredDevices"},{"name":"connectionStats"},{"name":"connections"},{"name":"connectivity"},{"name":"connectivityEvents"},{"name":"connectivityMonitoringDestinations"},{"name":"contentFiltering"},{"name":"coterm"},{"name":"current"},{"name":"customAnalytics"},{"name":"customPerformanceClasses"},{"name":"dataRateHistory"},{"name":"delegated"},{"name":"desktopLogs"},{"name":"details"},{"name":"detections"},{"name":"deviceCommandLogs"},{"name":"deviceProfiles"},{"name":"deviceTypeGroupPolicies"},{"name":"dhcp"},{"name":"dhcpServerPolicy"},{"name":"dscpTaggingOptions"},{"name":"dscpToCosMappings"},{"name":"eapOverride"},{"name":"earlyAccess"},{"name":"electronicShelfLabel"},{"name":"entitlements"},{"name":"esims"},{"name":"ethernet"},{"name":"eventTypes"},{"name":"events"},{"name":"exportEvents"},{"name":"failedConnections"},{"name":"failover"},{"name":"features"},{"name":"fields"},{"name":"firewall"},{"name":"firewalledServices"},{"name":"firmware"},{"name":"firmwareUpgrades"},{"name":"floorPlans"},{"name":"groupPolicies"},{"name":"groups"},{"name":"health"},{"name":"healthByTime"},{"name":"historical"},{"name":"history"},{"name":"hotspot20"},{"name":"httpServers"},{"name":"identities"},{"name":"identityPsks"},{"name":"idps"},{"name":"imports"},{"name":"inboundCellularFirewallRules"},{"name":"inboundFirewallRules"},{"name":"interfaces"},{"name":"internetPolicies"},{"name":"intrusion"},{"name":"inventory"},{"name":"ipv6"},{"name":"jobs"},{"name":"keys"},{"name":"l2"},{"name":"l3"},{"name":"l3FirewallRules"},{"name":"l7FirewallRules"},{"name":"lan"},{"name":"latencyHistory"},{"name":"latencyStats"},{"name":"latest"},{"name":"licenses"},{"name":"licensing"},{"name":"lines"},{"name":"linkAggregations"},{"name":"linkLayer"},{"name":"live"},{"name":"liveTools"},{"name":"lldpCdp"},{"name":"loginSecurity"},{"name":"logs"},{"name":"lossAndLatencyHistory"},{"name":"malware"},{"name":"managementInterface"},{"name":"manufacturers"},{"name":"me"},{"name":"merakiAuthUsers"},{"name":"meshStatuses"},{"name":"models"},{"name":"monitor"},{"name":"monitoredMediaServers"},{"name":"mqttBrokers"},{"name":"mtu"},{"name":"multicast"},{"name":"netflow"},{"name":"networkAdapters"},{"name":"networkHealth"},{"name":"objectDetectionModels"},{"name":"onboarding"},{"name":"oneToManyNatRules"},{"name":"oneToOneNatRules"},{"name":"openapiSpec"},{"name":"optIns"},{"name":"order"},{"name":"ospf"},{"name":"overview"},{"name":"packetLoss"},{"name":"packets"},{"name":"payloadTemplates"},{"name":"performance"},{"name":"performanceHistory"},{"name":"permissions"},{"name":"pii"},{"name":"piiKeys"},{"name":"ping"},{"name":"pingDevice"},{"name":"policies"},{"name":"policyObjects"},{"name":"portForwardingRules"},{"name":"portSchedules"},{"name":"ports"},{"name":"power"},{"name":"powerModules"},{"name":"prefixes"},{"name":"prepare"},{"name":"priorities"},{"name":"profiles"},{"name":"provisioning"},{"name":"qosRules"},{"name":"qualityAndRetention"},{"name":"qualityRetentionProfiles"},{"name":"radio"},{"name":"ratePlans"},{"name":"readings"},{"name":"recent"},{"name":"redundancy"},{"name":"relationships"},{"name":"rendezvousPoints"},{"name":"requests"},{"name":"responseCodes"},{"name":"restrictions"},{"name":"rfProfiles"},{"name":"roles"},{"name":"rollbacks"},{"name":"routing"},{"name":"rules"},{"name":"saml"},{"name":"samlRoles"},{"name":"schedules"},{"name":"sdwan"},{"name":"search"},{"name":"security"},{"name":"securityCenters"},{"name":"seen"},{"name":"sense"},{"name":"sentry"},{"name":"servers"},{"name":"serviceProviders"},{"name":"settings"},{"name":"signalQualityHistory"},{"name":"sims"},{"name":"singleLan"},{"name":"siteToSiteVpn"},{"name":"smDevicesForKey"},{"name":"smOwnersForKey"},{"name":"snmp"},{"name":"softwares"},{"name":"splash"},{"name":"splashAuthorizationStatus"},{"name":"splashLoginAttempts"},{"name":"ssids"},{"name":"stacks"},{"name":"staged"},{"name":"stages"},{"name":"staticRoutes"},{"name":"statics"},{"name":"stats"},{"name":"status"},{"name":"statuses"},{"name":"stormControl"},{"name":"stp"},{"name":"subnetPool"},{"name":"subnets"},{"name":"subscription"},{"name":"subscriptions"},{"name":"summary"},{"name":"swap"},{"name":"swaps"},{"name":"switches"},{"name":"syslogServers"},{"name":"system"},{"name":"targetGroups"},{"name":"themes"},{"name":"thirdPartyVPNPeers"},{"name":"throughputTest"},{"name":"top"},{"name":"topology"},{"name":"traffic"},{"name":"trafficAnalysis"},{"name":"trafficHistory"},{"name":"trafficShaping"},{"name":"trustedAccessConfigs"},{"name":"trustedServers"},{"name":"upgrades"},{"name":"uplink"},{"name":"uplinkBandwidth"},{"name":"uplinkSelection"},{"name":"uplinks"},{"name":"uplinksLossAndLatency"},{"name":"usage"},{"name":"usageHistories"},{"name":"usageHistory"},{"name":"userAccessDevices"},{"name":"utilization"},{"name":"v4"},{"name":"video"},{"name":"videoLink"},{"name":"vlanAssignments"},{"name":"vlanProfiles"},{"name":"vlans"},{"name":"vmx"},{"name":"vpn"},{"name":"vpnExclusions"},{"name":"vpnFirewallRules"},{"name":"vppAccounts"},{"name":"wakeOnLan"},{"name":"warmSpare"},{"name":"warnings"},{"name":"webhookTests"},{"name":"webhooks"},{"name":"wirelessControllers"},{"name":"wirelessProfiles"},{"name":"wlanLists"},{"name":"zones"}],"x-parser-conf":{"overview":{"markdownPath":"docs/overview.md"},"theme":"meraki","serverConfig":true,"meta":{"useProxy":true},"httpBearer":{"bearerToken":"75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}},"groupBy":{"$remoteModule":"config/group_platform.js"},"sortBy":{"$remoteModule":"config/sort_by.js"},"exampleAsDefault":true,"expand":3,"sampleCode":{"python":{"folder":"meraki/sdk/python","name":"Meraki Python Library","highlight":"python"}},"variables":{"organizationId":"1215707","networkId":"N_784752235069315754","serial":"QBSB-VQ3J-XZ54"}},"openapi":"3.0.1","servers":[{"url":"https://api.meraki.com/{basePath}","variables":{"basePath":{"default":"api/v1"}}}],"securitySchemes":{"meraki_api_key":{"type":"apiKey","name":"X-Cisco-Meraki-API-Key","in":"header"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key"}}},"spec":{"description":"Show details of a sensor alert profile for a network.","operationId":"getNetworkSensorAlertsProfile","parameters":[{"name":"networkId","in":"path","description":"Network ID","schema":{"type":"string"},"required":true},{"name":"id","in":"path","description":"ID","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"profileId":{"type":"string","description":"ID of the sensor alert profile."},"name":{"type":"string","description":"Name of the sensor alert profile."},"schedule":{"type":"object","properties":{"id":{"type":"string","description":"ID of the sensor schedule to use with the alert profile. If not defined, the alert profile will be active at all times."},"name":{"type":"string","description":"Name of the sensor schedule to use with the alert profile."}},"description":"The sensor schedule to use with the alert profile."},"conditions":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","enum":["apparentPower","co2","current","door","frequency","humidity","indoorAirQuality","noise","pm25","powerFactor","realPower","temperature","tvoc","upstreamPower","voltage","water"],"description":"The type of sensor metric that will be monitored for changes."},"threshold":{"type":"object","properties":{"temperature":{"type":"object","properties":{"celsius":{"type":"number","format":"float","description":"Alerting threshold in degrees Celsius."},"fahrenheit":{"type":"number","format":"float","description":"Alerting threshold in degrees Fahrenheit."},"quality":{"type":"string","enum":["fair","good","inadequate","poor"],"description":"Alerting threshold as a qualitative temperature level."}},"description":"Temperature threshold. One of 'celsius', 'fahrenheit', or 'quality' must be provided."},"humidity":{"type":"object","properties":{"relativePercentage":{"type":"integer","description":"Alerting threshold in %RH."},"quality":{"type":"string","enum":["fair","good","inadequate","poor"],"description":"Alerting threshold as a qualitative humidity level."}},"description":"Humidity threshold. One of 'relativePercentage' or 'quality' must be provided."},"water":{"type":"object","properties":{"present":{"type":"boolean","description":"Alerting threshold for a water detection event. Must be set to true."}},"required":["present"],"description":"Water detection threshold. 'present' must be provided and set to true."},"door":{"type":"object","properties":{"open":{"type":"boolean","description":"Alerting threshold for a door open event. Must be set to true."}},"required":["open"],"description":"Door open threshold. 'open' must be provided and set to true."},"tvoc":{"type":"object","properties":{"concentration":{"type":"integer","description":"Alerting threshold as TVOC micrograms per cubic meter."},"quality":{"type":"string","enum":["fair","good","inadequate","poor"],"description":"Alerting threshold as a qualitative TVOC level."}},"description":"TVOC concentration threshold. One of 'concentration' or 'quality' must be provided."},"co2":{"type":"object","properties":{"concentration":{"type":"integer","description":"Alerting threshold as CO2 parts per million."},"quality":{"type":"string","enum":["fair","good","inadequate","poor"],"description":"Alerting threshold as a qualitative CO2 level."}},"description":"CO2 concentration threshold. One of 'concentration' or 'quality' must be provided."},"pm25":{"type":"object","properties":{"concentration":{"type":"integer","description":"Alerting threshold as PM2.5 parts per million."},"quality":{"type":"string","enum":["fair","good","inadequate","poor"],"description":"Alerting threshold as a qualitative PM2.5 level."}},"description":"PM2.5 concentration threshold. One of 'concentration' or 'quality' must be provided."},"noise":{"type":"object","properties":{"ambient":{"type":"object","properties":{"level":{"type":"integer","description":"Alerting threshold as adjusted decibels."},"quality":{"type":"string","enum":["fair","good","inadequate","poor"],"description":"Alerting threshold as a qualitative ambient noise level."}},"description":"Ambient noise threshold. One of 'level' or 'quality' must be provided."}},"required":["ambient"],"description":"Noise threshold. 'ambient' must be provided."},"indoorAirQuality":{"type":"object","properties":{"score":{"type":"integer","description":"Alerting threshold as indoor air quality score."},"quality":{"type":"string","enum":["fair","good","inadequate","poor"],"description":"Alerting threshold as a qualitative indoor air quality level."}},"description":"Indoor air quality score threshold. One of 'score' or 'quality' must be provided."},"realPower":{"type":"object","properties":{"draw":{"type":"number","format":"float","description":"Alerting threshold in watts. Must be between 0 and 3750."}},"required":["draw"],"description":"Real power threshold. 'draw' must be provided."},"apparentPower":{"type":"object","properties":{"draw":{"type":"number","format":"float","description":"Alerting threshold in volt-amps. Must be between 0 and 3750."}},"required":["draw"],"description":"Apparent power threshold. 'draw' must be provided."},"powerFactor":{"type":"object","properties":{"percentage":{"type":"integer","description":"Alerting threshold as the ratio of active power to apparent power. Must be between 0 and 100."}},"required":["percentage"],"description":"Power factor threshold. 'percentage' must be provided."},"current":{"type":"object","properties":{"draw":{"type":"number","format":"float","description":"Alerting threshold in amps. Must be between 0 and 15."}},"required":["draw"],"description":"Electrical current threshold. 'level' must be provided."},"voltage":{"type":"object","properties":{"level":{"type":"number","format":"float","description":"Alerting threshold in volts. Must be between 0 and 250."}},"required":["level"],"description":"Voltage threshold. 'level' must be provided."},"frequency":{"type":"object","properties":{"level":{"type":"number","format":"float","description":"Alerting threshold in hertz. Must be between 0 and 60."}},"required":["level"],"description":"Electrical frequency threshold. 'level' must be provided."},"upstreamPower":{"type":"object","properties":{"outageDetected":{"type":"boolean","description":"Alerting threshold for an upstream power event. Must be set to true."}},"required":["outageDetected"],"description":"Upstream power threshold. 'outageDetected' must be provided and set to true."}},"description":"Threshold for sensor readings that will cause an alert to be sent. This object should contain a single property key matching the condition's 'metric' value."},"direction":{"type":"string","enum":["above","below"],"description":"If 'above', an alert will be sent when a sensor reads above the threshold. If 'below', an alert will be sent when a sensor reads below the threshold. Only applicable for temperature, humidity, realPower, apparentPower, powerFactor, voltage, current, and frequency thresholds."},"duration":{"type":"integer","enum":[0,60,120,180,240,300,600,900,1800,3600,7200,14400,28800],"description":"Length of time in seconds that the triggering state must persist before an alert is sent. Available options are 0 seconds, 1 minute, 2 minutes, 3 minutes, 4 minutes, 5 minutes, 10 minutes, 15 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, and 8 hours. Default is 0.","default":0}},"required":["metric","threshold"]},"description":"List of conditions that will cause the profile to send an alert."},"recipients":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"},"description":"A list of emails that will receive information about the alert."},"smsNumbers":{"type":"array","items":{"type":"string"},"description":"A list of SMS numbers that will receive information about the alert."},"httpServerIds":{"type":"array","items":{"type":"string"},"description":"A list of webhook endpoint IDs that will receive information about the alert."}},"description":"List of recipients that will receive the alert."},"serials":{"type":"array","items":{"type":"string"},"description":"List of device serials assigned to this sensor alert profile."}},"required":["conditions"]},"example":{"profileId":"1","name":"My Sensor Alert Profile","schedule":{"id":"5","name":"My Schedule"},"conditions":[{"metric":"temperature","threshold":{"temperature":{"celsius":20.5,"fahrenheit":70,"quality":"good"},"humidity":{"relativePercentage":65,"quality":"inadequate"},"water":{"present":true},"door":{"open":true},"tvoc":{"concentration":400,"quality":"poor"},"co2":{"concentration":400,"quality":"poor"},"pm25":{"concentration":90,"quality":"fair"},"noise":{"ambient":{"level":120,"quality":"poor"}},"indoorAirQuality":{"score":80,"quality":"fair"},"realPower":{"draw":14.1},"apparentPower":{"draw":17.2},"powerFactor":{"percentage":81},"current":{"draw":0.14},"voltage":{"level":119.5},"frequency":{"level":58.8},"upstreamPower":{"outageDetected":true}},"direction":"above","duration":60}],"recipients":{"emails":["miles@meraki.com"],"smsNumbers":["+15555555555"],"httpServerIds":["aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M="]},"serials":["Q234-ABCD-0001","Q234-ABCD-0002","Q234-ABCD-0003"]}}}}},"summary":"Show details of a sensor alert profile for a network.","tags":["sensor","configure","alerts","profiles"],"__originalOperationId":"getNetworkSensorAlertsProfile","security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"method":"get","path":"/networks/{networkId}/sensor/alerts/profiles/{id}","sampleCode":{"Meraki Python Library":{"code":"import meraki\n\n# Defining your API key as a variable in source code is discouraged.\n# This API key is for a read-only docs-specific environment.\n# In your own code, use an environment variable as shown under the Usage section\n# @ https://github.com/meraki/dashboard-api-python/\n\nAPI_KEY = '75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6'\n\ndashboard = meraki.DashboardAPI(API_KEY)\n\nnetwork_id = 'L_646829496481105433'\nid_ = ''\n\nresponse = dashboard.sensor.getNetworkSensorAlertsProfile(\n network_id, id_\n)\n\nprint(response)","highlight":"python"}}}}