{"type":"api","title":"Get fabric devices","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/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":"getFabricDevices","tags":["SDA"],"summary":"Get fabric devices","deprecated":false,"description":"Returns a list of fabric devices that match the provided query parameters.\n","parameters":[{"name":"fabricId","description":"ID of the fabric this device belongs to.","required":true,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceId","description":"Network device ID of the fabric device.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"deviceRoles","description":"Device roles of the fabric device. Allowed values are [CONTROL_PLANE_NODE, EDGE_NODE, BORDER_NODE, WIRELESS_CONTROLLER_NODE, EXTENDED_NODE].","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"Starting record for pagination.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of records to return. The maximum number of objects supported in a single request is 500.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Response body contains the result data based on search criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the fabric device."},"networkDeviceId":{"type":"string","description":"Network device ID of the fabric device."},"fabricId":{"type":"string","description":"ID of the fabric of this fabric device."},"deviceRoles":{"type":"array","items":{"type":"string"},"description":"List of the roles of the fabric device. Allowed values are [CONTROL_PLANE_NODE, EDGE_NODE, BORDER_NODE, WIRELESS_CONTROLLER_NODE, EXTENDED_NODE]."},"borderDeviceSettings":{"type":"object","properties":{"borderTypes":{"type":"array","items":{"type":"string"},"description":"List of the border types of the fabric device. Allowed values are [LAYER_2, LAYER_3]."},"layer3Settings":{"type":"object","properties":{"localAutonomousSystemNumber":{"type":"string","description":"BGP Local autonomous system number of the fabric border device."},"isDefaultExit":{"type":"boolean","description":"Is default exit value of the fabric border device."},"importExternalRoutes":{"type":"boolean","description":"Import external routes value of the fabric border device."},"borderPriority":{"type":"integer","description":"Border priority of the fabric border device. A lower value indicates higher priority. E.g., a priority of 1 takes precedence over 5."},"prependAutonomousSystemCount":{"type":"integer","description":"Prepend autonomous system count of the fabric border device."}},"description":"Layer 3 settings of the fabric border device."}},"description":"Border settings of the fabric device."}}},"description":"Response body."},"version":{"type":"string","description":"Version number."}},"description":"Fabric device get response root element. (Maximum number of records to return in each response is 500).","$$ref":"#/components/schemas/GetFabricDevicesResponse"}}}},"400":{"description":"Bad Request. The client made a request that the server could not understand.","content":{}},"500":{"description":"Internal Server Error. The server could not fulfill the request.","content":{}}},"x-rapi-id":"e680-7a97-47db-99e5","x-rapi-overview":"Returns a list of fabric devices that match the provided query parameters.\n","x-rapi-domain":"Connectivity","x-rapi-subdomain":"SDA","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/sda-helper-service/sda-open-api/fabricDevices","x-rapi-publicPath":"/dna/intent/api/v1/sda/fabricDevices","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getFabricDevices","method":"get","path":"/dna/intent/api/v1/sda/fabricDevices"}}