{"type":"api","title":"Get Network Switch Dhcp V 4 Servers Seen","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/4723762d29b3380de018ae8c0d8a59499a6523e0/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> Date: 03 July, 2024\n>\n> [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.48.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":"accessControlLists"},{"name":"accessPolicies"},{"name":"acls"},{"name":"actionBatches"},{"name":"adaptivePolicy"},{"name":"addresses"},{"name":"admins"},{"name":"airMarshal"},{"name":"alertTypes"},{"name":"alerts"},{"name":"alternateManagementInterface"},{"name":"analytics"},{"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":"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":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clients"},{"name":"cloudMonitoring"},{"name":"commands"},{"name":"compliance"},{"name":"configTemplates"},{"name":"configurationChanges"},{"name":"configure"},{"name":"configuredDevices"},{"name":"connectionStats"},{"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":"ethernet"},{"name":"eventTypes"},{"name":"events"},{"name":"exportEvents"},{"name":"failedConnections"},{"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":"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":"policy"},{"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":"readings"},{"name":"recent"},{"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":"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":"swaps"},{"name":"switches"},{"name":"syslogServers"},{"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":"users"},{"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":"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":"Return the network's DHCPv4 servers seen within the selected timeframe (default 1 day)","operationId":"getNetworkSwitchDhcpV4ServersSeen","parameters":[{"name":"networkId","in":"path","description":"Network ID","schema":{"type":"string"},"required":true},{"name":"t0","in":"query","description":"The beginning of the timespan for the data. The maximum lookback period is 31 days from today.","schema":{"type":"string"}},{"name":"timespan","in":"query","description":"The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.","schema":{"type":"number","format":"float","maximum":2678400}},{"name":"perPage","in":"query","description":"The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.","schema":{"type":"integer"}},{"name":"startingAfter","in":"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.","schema":{"type":"string"}},{"name":"endingBefore","in":"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.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"mac":{"type":"string","description":"Mac address of the server."},"vlan":{"type":"integer","description":"Vlan id of the server."},"clientId":{"type":"string","description":"Client id of the server if available."},"isAllowed":{"type":"boolean","description":"Whether the server is allowed or blocked. Always true for configured servers."},"lastSeenAt":{"type":"string","format":"date-time","description":"Last time the server was seen."},"seenBy":{"type":"array","items":{"type":"object","properties":{"serial":{"type":"string","description":"Device serial."},"name":{"type":"string","description":"Device name."},"url":{"type":"string","description":"Url link to device."}}},"description":"Devices that saw the server."},"type":{"type":"string","enum":["device","discovered","stack"],"description":"server type. Can be a 'device', 'stack', or 'discovered' (i.e client)."},"device":{"type":"object","properties":{"serial":{"type":"string","description":"Device serial."},"name":{"type":"string","description":"Device name."},"url":{"type":"string","description":"Url link to device."},"interface":{"type":"object","properties":{"name":{"type":"string","description":"Interface name."},"url":{"type":"string","description":"Url link to interface."}},"description":"Interface attributes of the server. Only for configured servers."}},"description":"Attributes of the server when it's a device."},"ipv4":{"type":"object","properties":{"address":{"type":"string","description":"IPv4 address of the server."},"subnet":{"type":"string","description":"Subnet of the server."},"gateway":{"type":"string","description":"IPv4 gateway address of the server."}},"description":"IPv4 attributes of the server."},"isConfigured":{"type":"boolean","description":"Whether the server is configured."},"lastAck":{"type":"object","properties":{"ts":{"type":"string","format":"date-time","description":"Last time the server was acked."},"ipv4":{"type":"object","properties":{"address":{"type":"string","description":"IPv4 address of the last ack."}},"description":"IPv4 attributes of the last ack."}},"description":"Attributes of the server's last ack."},"lastPacket":{"type":"object","properties":{"source":{"type":"object","properties":{"mac":{"type":"string","description":"Source mac address of the packet."},"ipv4":{"type":"object","properties":{"address":{"type":"string","description":"Source ipv4 address of the packet."}},"description":"Source ipv4 attributes of the packet."},"port":{"type":"integer","description":"Source port of the packet."}},"description":"Source of the packet."},"destination":{"type":"object","properties":{"mac":{"type":"string","description":"Destination mac address of the packet."},"ipv4":{"type":"object","properties":{"address":{"type":"string","description":"Destination ipv4 address of the packet."}},"description":"Destination ipv4 attributes of the packet."},"port":{"type":"integer","description":"Destination port of the packet."}},"description":"Destination of the packet."},"type":{"type":"string","description":"Packet type."},"ethernet":{"type":"object","properties":{"type":{"type":"string","description":"Ethernet type of the packet."}},"description":"Additional ethernet attributes of the packet."},"ip":{"type":"object","properties":{"id":{"type":"string","description":"IP ID of the packet."},"version":{"type":"integer","enum":[4,6],"description":"IP version of the packet."},"length":{"type":"integer","description":"IP length of the packet."},"headerLength":{"type":"integer","description":"IP header length of the packet."},"protocol":{"type":"integer","description":"IP protocol number of the packet."},"ttl":{"type":"integer","description":"Time to live of the packet."},"dscp":{"type":"object","properties":{"tag":{"type":"integer","description":"DSCP tag number of the packet."},"ecn":{"type":"integer","description":"ECN number of the packet."}},"description":"DSCP attributes of the packet."}},"description":"Additional IP attributes of the packet."},"udp":{"type":"object","properties":{"length":{"type":"integer","description":"UDP length of the packet."},"checksum":{"type":"string","description":"UDP checksum of the packet."}},"description":"UDP attributes of the packet."},"fields":{"type":"object","properties":{"op":{"type":"integer","description":"Operation code of the packet."},"htype":{"type":"integer","description":"Hardware type code of the packet."},"hlen":{"type":"integer","description":"Hardware length of the packet."},"hops":{"type":"integer","description":"Number of hops the packet took."},"xid":{"type":"string","description":"Transaction id of the packet."},"secs":{"type":"integer","description":"Number of seconds since receiving the packet."},"flags":{"type":"string","description":"Packet flags."},"ciaddr":{"type":"string","description":"Client IP address of the packet."},"yiaddr":{"type":"string","description":"Assigned IP address of the packet."},"siaddr":{"type":"string","description":"Server IP address of the packet."},"giaddr":{"type":"string","description":"Gateway IP address of the packet."},"chaddr":{"type":"string","description":"Client hardware address of the packet."},"sname":{"type":"string","description":"Server identifier address of the packet."},"magicCookie":{"type":"string","description":"Magic cookie of the packet."},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Option name."},"value":{"type":"string","description":"Option value."}}},"description":"Additional DHCP options of the packet."}},"description":"DHCP-specific fields of the packet."}},"description":"Last packet the server received."}}}},"example":[{"mac":"00:11:22:33:44:55","vlan":100,"clientId":"k74272e","isAllowed":true,"lastSeenAt":"2018-02-11T00:00:00.090210Z","seenBy":[{"serial":"Q234-ABCD-0001","name":"My switch2","url":"https://n1.meraki.com//n//manage/nodes/new_list/0000000000001"}],"type":"device","device":{"serial":"Q234-ABCD-0002","name":"My AP","url":"https://n1.meraki.com//n//manage/nodes/new_list/000000000000","interface":{"name":"My L3 Interface","url":"https://n1.meraki.com//n//manage/configure/switch_l3/l3_interface/00000"}},"ipv4":{"address":"10.0.0.0/24","subnet":"192.168.1.0/24","gateway":"1.2.3.5"},"isConfigured":true,"lastAck":{"ts":"2018-02-11T00:00:00.090210Z","ipv4":{"address":"123.123.123.1"}},"lastPacket":{"source":{"mac":"00:11:22:33:44:55","ipv4":{"address":"1.2.3.4"},"port":443},"destination":{"mac":"22:33:44:55:66:77","ipv4":{"address":"123.123.123.1"},"port":444},"type":"ACK","ethernet":{"type":"0x1212"},"ip":{"id":"0x1313","version":4,"length":24929,"headerLength":1,"protocol":1,"ttl":50,"dscp":{"tag":24,"ecn":1}},"udp":{"length":24929,"checksum":"0x1414"},"fields":{"op":1,"htype":1,"hlen":6,"hops":0,"xid":"0x11111111","secs":1526087474,"flags":"0x0000","ciaddr":"1.2.3.4","yiaddr":"123.123.123.1","siaddr":"1.2.3.4","giaddr":"1.2.3.5","chaddr":"abcdefghijkl","sname":"1.2.3.4","magicCookie":"0x22222222","options":[{"name":"Lease time","value":"86400 seconds"}]}}}]}},"headers":{"Link":{"schema":{"type":"string"},"description":"A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."}}}},"summary":"Return the network's DHCPv4 servers seen within the selected timeframe (default 1 day)","tags":["switch","configure","dhcp","v4","servers","seen"],"__originalOperationId":"getNetworkSwitchDhcpV4ServersSeen","security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"method":"get","path":"/networks/{networkId}/switch/dhcp/v4/servers/seen","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'\n\nresponse = dashboard.switch.getNetworkSwitchDhcpV4ServersSeen(\n network_id, total_pages='all'\n)\n\nprint(response)","highlight":"python"}}}}