{"type":"api","title":"Create Device Live Tools Acl Hit Count","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/e92a64d0814b40091de22f4a93378df69809b95e/401c6d5b-0873-3519-be2b-c203501ad95c","info":{"title":"Meraki Dashboard API","description":"A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n\u003e Date: 20 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-beta.2"},"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":"accessControlLists"},{"name":"accessPolicies"},{"name":"accounts"},{"name":"aclHitCount"},{"name":"acls"},{"name":"actionBatches"},{"name":"activities"},{"name":"adaptivePolicy"},{"name":"addresses"},{"name":"admins"},{"name":"afc"},{"name":"airMarshal"},{"name":"alertTypes"},{"name":"alerts"},{"name":"alternateManagementInterface"},{"name":"analytics"},{"name":"api"},{"name":"apiRequests"},{"name":"apnsCert"},{"name":"apple"},{"name":"appliances"},{"name":"applicationCategories"},{"name":"applicationUsage"},{"name":"applications"},{"name":"areas"},{"name":"arpInspection"},{"name":"arpTable"},{"name":"artifacts"},{"name":"assets"},{"name":"assignments"},{"name":"auth"},{"name":"authenticationToken"},{"name":"autoLocate"},{"name":"autoRf"},{"name":"automations"},{"name":"availabilities"},{"name":"bandwidthUsageHistory"},{"name":"bgp"},{"name":"billing"},{"name":"blink"},{"name":"bluetooth"},{"name":"bluetoothClients"},{"name":"bonjourForwarding"},{"name":"boots"},{"name":"boundaries"},{"name":"brandingPolicies"},{"name":"bulk"},{"name":"bulkCreate"},{"name":"bulkDelete"},{"name":"bulkEnrollment"},{"name":"bulkUpdate"},{"name":"byBoundary"},{"name":"byClient"},{"name":"byDevice"},{"name":"byEnergyUsage"},{"name":"byInterval"},{"name":"byMetric"},{"name":"byModel"},{"name":"byNetwork"},{"name":"byStack"},{"name":"byStatus"},{"name":"bySwitch"},{"name":"bySwitchProfile"},{"name":"byType"},{"name":"byUsage"},{"name":"byUtilization"},{"name":"bypassActivationLockAttempts"},{"name":"cableTest"},{"name":"callbacks"},{"name":"captures"},{"name":"categories"},{"name":"cellular"},{"name":"cellularFirewallRules"},{"name":"cellularUsageHistory"},{"name":"certificates"},{"name":"certs"},{"name":"changeHistory"},{"name":"channelUtilization"},{"name":"channelUtilizationHistory"},{"name":"channels"},{"name":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clients"},{"name":"cloud"},{"name":"cloudEnrollment"},{"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":"contents"},{"name":"coterm"},{"name":"current"},{"name":"customAnalytics"},{"name":"customPerformanceClasses"},{"name":"cyclePort"},{"name":"dataRateHistory"},{"name":"delegated"},{"name":"deltas"},{"name":"desktopLogs"},{"name":"details"},{"name":"detections"},{"name":"deviceCertificateAuthorities"},{"name":"deviceCommandLogs"},{"name":"deviceProfiles"},{"name":"deviceTypeGroupPolicies"},{"name":"dhcp"},{"name":"dhcpServerPolicy"},{"name":"discovery"},{"name":"disenrollments"},{"name":"dns"},{"name":"doorLocks"},{"name":"download"},{"name":"dscpTaggingOptions"},{"name":"dscpToCosMappings"},{"name":"eapOverride"},{"name":"earlyAccess"},{"name":"electronicShelfLabel"},{"name":"enrollments"},{"name":"entitlements"},{"name":"esims"},{"name":"ethernet"},{"name":"eventTypes"},{"name":"events"},{"name":"exportEvents"},{"name":"extensions"},{"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":"healthScores"},{"name":"historical"},{"name":"history"},{"name":"hotspot20"},{"name":"httpServers"},{"name":"identities"},{"name":"identityPsks"},{"name":"idps"},{"name":"import"},{"name":"imports"},{"name":"inboundCellularFirewallRules"},{"name":"inboundFirewallRules"},{"name":"integration"},{"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":"leds"},{"name":"license"},{"name":"licenses"},{"name":"licensing"},{"name":"lines"},{"name":"linkAggregations"},{"name":"linkLayer"},{"name":"live"},{"name":"liveTools"},{"name":"lldpCdp"},{"name":"local"},{"name":"locationScanning"},{"name":"loginSecurity"},{"name":"logs"},{"name":"lossAndLatencyHistory"},{"name":"macTable"},{"name":"malware"},{"name":"managementInterface"},{"name":"manufacturers"},{"name":"me"},{"name":"merakiAuthUsers"},{"name":"meshStatuses"},{"name":"mirror"},{"name":"mirrors"},{"name":"models"},{"name":"monitor"},{"name":"monitoredMediaServers"},{"name":"mqttBrokers"},{"name":"mtu"},{"name":"multicast"},{"name":"multicastForwarding"},{"name":"netflow"},{"name":"networkAdapters"},{"name":"networkHealth"},{"name":"objectDetectionModels"},{"name":"onboarding"},{"name":"onboardingHistory"},{"name":"oneToManyNatRules"},{"name":"oneToOneNatRules"},{"name":"openapiSpec"},{"name":"opportunisticPcap"},{"name":"optIns"},{"name":"order"},{"name":"ospf"},{"name":"overview"},{"name":"packetCapture"},{"name":"packetLoss"},{"name":"packets"},{"name":"payloadTemplates"},{"name":"performance"},{"name":"performanceHistory"},{"name":"permissions"},{"name":"pii"},{"name":"piiKeys"},{"name":"ping"},{"name":"pingDevice"},{"name":"planning"},{"name":"policies"},{"name":"policy"},{"name":"policyObjects"},{"name":"portForwardingRules"},{"name":"portSchedules"},{"name":"ports"},{"name":"position"},{"name":"power"},{"name":"powerLimits"},{"name":"powerModules"},{"name":"prefixes"},{"name":"prepare"},{"name":"priorities"},{"name":"privateApplicationGroups"},{"name":"privateApplications"},{"name":"profiles"},{"name":"provisioning"},{"name":"publicApplications"},{"name":"qosRules"},{"name":"qualityAndRetention"},{"name":"qualityRetentionProfiles"},{"name":"radSec"},{"name":"radio"},{"name":"radius"},{"name":"ratePlans"},{"name":"readings"},{"name":"recent"},{"name":"records"},{"name":"redundancy"},{"name":"regions"},{"name":"relationships"},{"name":"remoteAccessLog"},{"name":"remoteAccessLogsExports"},{"name":"remove"},{"name":"rendezvousPoints"},{"name":"requests"},{"name":"requirements"},{"name":"responseCodes"},{"name":"restrictions"},{"name":"revocationList"},{"name":"rfProfiles"},{"name":"roles"},{"name":"rollbacks"},{"name":"routing"},{"name":"routingTable"},{"name":"rules"},{"name":"salesRepresentatives"},{"name":"saml"},{"name":"samlRoles"},{"name":"schedules"},{"name":"sdwan"},{"name":"search"},{"name":"secureConnect"},{"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":"sites"},{"name":"smDevicesForKey"},{"name":"smOwnersForKey"},{"name":"snmp"},{"name":"softwares"},{"name":"spaces"},{"name":"speedTest"},{"name":"speedTestResults"},{"name":"splash"},{"name":"splashAuthorizationStatus"},{"name":"splashLoginAttempts"},{"name":"split"},{"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":"support"},{"name":"supported"},{"name":"swap"},{"name":"swaps"},{"name":"switches"},{"name":"syncJobs"},{"name":"syslogServers"},{"name":"system"},{"name":"targetGroups"},{"name":"tests"},{"name":"themes"},{"name":"thirdPartyVPNPeers"},{"name":"thousandEyes"},{"name":"throughputTest"},{"name":"token"},{"name":"tokens"},{"name":"top"},{"name":"topology"},{"name":"traceRoute"},{"name":"traffic"},{"name":"trafficAnalysis"},{"name":"trafficHistory"},{"name":"trafficShaping"},{"name":"transceivers"},{"name":"traps"},{"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":"webApps"},{"name":"webhookTests"},{"name":"webhooks"},{"name":"wirelessControllers"},{"name":"wirelessProfiles"},{"name":"wlanLists"},{"name":"xdr"},{"name":"zigbee"},{"name":"zones"}],"x-parser-conf":{"overview":{"markdownPath":"docs/overview-early-access.md"},"theme":"meraki","serverConfig":true,"httpBearer":{"bearerToken":"75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}},"groupBy":{"$remoteModule":"config/group_platform.js"},"filterBy":{"$remoteModule":"config/filter_only_beta.js"},"sortBy":{"$remoteModule":"config/sort_by.js"},"exampleAsDefault":true,"expand":0,"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":{"callbacks":{"aclHitCount":{"{$request.body#/callback/url}":{"post":{"requestBody":{"required":true,"description":"Callback payload","content":{"application/json":{"schema":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"network":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"sentAt":{"type":"string"},"callbackId":{"type":"string"},"message":{"type":"object","properties":{"aclHitCountId":{"type":"string","description":"Id of the ACL hit count request. Used to check the status of the request."},"url":{"type":"string","description":"GET this url to check the status of your ACL hit count request."},"request":{"type":"object","properties":{"serial":{"type":"string","description":"Device serial number"}},"description":"ACL hit count request parameters"},"status":{"type":"string","enum":["complete","failed","new","ready","running","scheduled"],"description":"Status of the ACL hit count request."},"acls":{"type":"array","items":{"type":"object","properties":{"policy":{"type":"string","enum":["allow","deny"],"description":"Action to be taken on packets matching the rule"},"ipVersion":{"type":"string","enum":["any","ipv4","ipv6"],"description":"IP Version for the rule, or \"any\""},"ipProtocol":{"type":"object","properties":{"type":{"type":"string","enum":["any","number","objectGroup"],"description":"The type of protocol rule for this ACL"},"number":{"type":"integer","description":"IP Protocol Number for the rule, if the type is \"number\". See https://www.iana.org/assignments/protocol-numbers/protocol-numbers.txt."},"objectGroup":{"type":"string","description":"The object group for this protocol rule, if the type is \"objectGroup\""}},"description":"IP Protocol for the rule. This allows the ACL to filter on specific protocols, such as TCP"},"counts":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of matched packets across all IP versions"},"ipv4":{"type":"integer","description":"Total number of matched IPv4 packets"},"ipv6":{"type":"integer","description":"Total number of matched IPv6 packets"}},"description":"Number of packets matched by this ACL"},"source":{"type":"object","properties":{"address":{"type":"string","description":"Source IP address for the rule, or \"any\""},"port":{"type":"object","properties":{"operator":{"type":"string","enum":["any","equals","greaterThan","lesserThan","notEquals","range"],"description":"Specifies what operator to use while checking if the protocol port matches the given port(s)"},"ports":{"type":"array","items":{"type":"integer"},"description":"When the operator is \"lesserThan\" or \"greaterThan\" then the port list will have one entry for the operator. When the operator is \"range\" then port list will have two values with the range being between the values. When the operator is \"equals\" and \"notEquals\", then there may be any number of ports. When the operator is \"any\", then the port property will not be present."}},"description":"Source port configuration for the rule."}},"description":"Source address and port configuration for the rule"},"destination":{"type":"object","properties":{"address":{"type":"string","description":"Destination IP address for the rule, or \"any\""},"port":{"type":"array","items":{"type":"object","properties":{"operator":{"type":"string","enum":["any","equals","greaterThan","lesserThan","notEquals","range"],"description":"Specifies what operator to use while checking if the protocol port matches the given port(s)"},"ports":{"type":"array","items":{"type":"integer"},"description":"When the operator is \"lesserThan\" or \"greaterThan\" then the port list will have one entry for the operator. When the operator is \"range\" then port list will have two values with the range being between the values. When the operator is \"equals\" and \"notEquals\", then there may be any number of ports. When the operator is \"any\", then the port property will not be present."}}},"description":"Destination port configuration for the rule."}},"description":"Destination address and port configuration for the rule"}}},"description":"Results of the ACL hit count request, one for each ACL rule."},"error":{"type":"string","description":"An error message for a failed execution"}}}}}}}},"responses":{"2XX":{"description":"Your server return this code if it accepts the callback"}}}}}},"description":"Enqueue a job to perform an ACL hit count for the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.","operationId":"createDeviceLiveToolsAclHitCount","parameters":[{"name":"serial","in":"path","description":"Serial","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"callback":{"type":"object","properties":{"url":{"type":"string","description":"The callback URL for the webhook target. If using this field, please also specify a sharedSecret."},"sharedSecret":{"type":"string","description":"A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url."},"httpServer":{"type":"object","properties":{"id":{"type":"string","description":"The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank."}},"description":"The webhook receiver used for the callback webhook."},"payloadTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template."}},"description":"The payload template of the webhook used for the callback"}},"x-release-stage":"general_availability","description":"Details for the callback. Please include either an httpServerId OR url and sharedSecret"}},"example":{"callback":{"url":"https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031","sharedSecret":"secret","httpServer":{"id":"aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M="},"payloadTemplate":{"id":"wpt_2100"}}}}}},"required":false},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"aclHitCountId":{"type":"string","description":"Id of the ACL hit count request. Used to check the status of the request."},"url":{"type":"string","description":"GET this url to check the status of your ACL hit count request."},"request":{"type":"object","properties":{"serial":{"type":"string","description":"Device serial number"}},"description":"ACL hit count request parameters"},"status":{"type":"string","enum":["complete","failed","new","ready","running","scheduled"],"description":"Status of the ACL hit count request."},"callback":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the callback. To check the status of the callback, use this ID in a request to /webhooks/callbacks/statuses/{id}"},"url":{"type":"string","description":"The callback URL for the webhook target. This was either provided in the original request or comes from a configured webhook receiver"},"status":{"type":"string","description":"The status of the callback"}},"description":"Information for callback used to send back results","x-release-stage":"general_availability"}}},"example":{"aclHitCountId":"1284392014819","url":"/devices/Q234-ABCD-5678/liveTools/aclHitCount/1284392014819","request":{"serial":"Q234-ABCD-5678"},"status":"complete","callback":{"id":"1284392014819","url":"https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031","status":"new"}}}}}},"summary":"Enqueue a job to perform an ACL hit count for the device","tags":["devices","liveTools","aclHitCount"],"x-release-stage":"beta","__originalOperationId":"createDeviceLiveToolsAclHitCount","security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"method":"post","path":"/devices/{serial}/liveTools/aclHitCount"}}