Get devices that are assigned to a site - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Get devices that are assigned to a site","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getDevicesThatAreAssignedToASite","tags":["Sites"],"summary":"Get devices that are assigned to a site","deprecated":false,"description":"API to get devices that are assigned to a site.","parameters":[{"name":"id","description":"Site Id","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"offset","description":"Offset/starting index for pagination","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"limit","description":"Number of devices to be listed. Default and max supported value is 500","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"memberType","description":"Member type (This API only supports the 'networkdevice' type)","required":true,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"level","description":"Depth of site hierarchy to be considered to list the devices. If the provided value is -1, devices for all child sites will be listed.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"instanceUuid":{"type":"string","description":"Device UUID (E.g. 48eebb3e-b3fc-4928-a7df-1c80e216f930)"},"instanceId":{"type":"integer","description":"Device Id (E.g. 230230)"},"authEntityId":{"type":"integer","description":"Authentication Entity Id (Internal record)"},"authEntityClass":{"type":"integer","description":"Authentication entity class (Internal record)"},"instanceTenantId":{"type":"string","description":"Device tenant Id (E.g. 64472cc32d3bc1658597669c)"},"deployPending":{"type":"string","description":"Deploy pending (Internal record)"},"instanceVersion":{"type":"integer","description":"Instance version (Internal record)"},"apManagerInterfaceIp":{"type":"string","description":"Access Point manager interface IP"},"associatedWlcIp":{"type":"string","description":"Associated Wireless Controller IP"},"bootDateTime":{"type":"string","description":"Device boot date and time"},"collectionInterval":{"type":"string","description":"Device resync interval type (E.g. Global Default)"},"collectionIntervalValue":{"type":"string","description":"Device resync interval value"},"collectionStatus":{"type":"string","description":"Device inventory collection status (E.g. Managed)"},"description":{"type":"string","description":"Device description"},"deviceSupportLevel":{"type":"string","description":"Device support level (E.g. Supported)"},"dnsResolvedManagementAddress":{"type":"string","description":"DNS resolved management address"},"family":{"type":"string","description":"Device family (E.g. Routers)"},"hostname":{"type":"string","description":"Device hostname"},"interfaceCount":{"type":"string","description":"Device interface count"},"inventoryStatusDetail":{"type":"string","description":"Device inventory collection status detail"},"lastUpdateTime":{"type":"integer","description":"Last update time"},"lastUpdated":{"type":"string","description":"Last updated date and time"},"lineCardCount":{"type":"string","description":"Line card count"},"lineCardId":{"type":"string","description":"Line card Id"},"lastDeviceResyncStartTime":{"type":"string","description":"Last device inventory resync start date and time"},"macAddress":{"type":"string","description":"MAC address"},"managedAtleastOnce":{"type":"boolean","description":"If device managed atleast once, value will be true otherwise false"},"managementIpAddress":{"type":"string","description":"Management IP address"},"managementState":{"type":"string","description":"Device management state (E.g. Managed)"},"memorySize":{"type":"string","description":"Memory size"},"paddedMgmtIpAddress":{"type":"string","description":"Padded management IP address. Internal record"},"pendingSyncRequestsCount":{"type":"string","description":"Pending sync requests count. Internal record"},"platformId":{"type":"string","description":"Device platform Id (E.g. CSR1000V)"},"reachabilityFailureReason":{"type":"string","description":"Device reachability failure reason"},"reachabilityStatus":{"type":"string","description":"Device reachability status (E.g. Reachable)"},"reasonsForDeviceResync":{"type":"string","description":"Reasons for device resync (E.g. Periodic)"},"reasonsForPendingSyncRequests":{"type":"string","description":"Reasons for pending device sync requests"},"role":{"type":"string","description":"Device role (E.g. BORDER ROUTER)"},"roleSource":{"type":"string","description":"Device role source. Internal record"},"serialNumber":{"type":"string","description":"Device serial Number"},"series":{"type":"string","description":"Device series"},"snmpContact":{"type":"string","description":"Device snmp contact. Internal record"},"snmpLocation":{"type":"string","description":"Device snmp location"},"softwareType":{"type":"string","description":"Device software type"},"softwareVersion":{"type":"string","description":"Device software version"},"tagCount":{"type":"string","description":"Device tag Count"},"type":{"type":"string","description":"Device type (E.g. Cisco Cloud Services Router 1000V)"},"upTime":{"type":"string","description":"Device up time (E.g. 112 days, 6:09:13.86)"},"uptimeSeconds":{"type":"integer","description":"Device uptime in seconds"},"vendor":{"type":"string","description":"Vendor (E.g. Cisco)"},"displayName":{"type":"string","description":"Device display name"}}},"description":"List of devices"}},"description":"","$$ref":"#/components/schemas/GetDevicesThatAreAssignedToASiteResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"ae86-1be7-4d39-b0d1","x-rapi-overview":"API to get devices that are assigned to a site.","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Sites","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/group/${id}/member","x-rapi-publicPath":"/dna/intent/api/v1/site-member/${id}/member","x-rapi-registerInKONG":true,"x-rapi-banner":["Sunset"],"__originalOperationId":"getDevicesThatAreAssignedToASite","method":"get","path":"/dna/intent/api/v1/site-member/{id}/member"}}