Get port channels - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Get port channels","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":"getPortChannels_2","tags":["SDA"],"summary":"Get port channels","deprecated":false,"description":"Returns a list of port channels that match the provided query parameters.","parameters":[{"name":"fabricId","description":"ID of the fabric the device is assigned to.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceId","description":"ID of the network device.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"portChannelName","description":"Name of the port channel.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"connectedDeviceType","description":"Connected device type of the port channel. The allowed values are [TRUNK, 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 port channel."},"fabricId":{"type":"string","description":"ID of the fabric the device is assigned to."},"networkDeviceId":{"type":"string","description":"ID of the network device."},"portChannelName":{"type":"string","description":"Name of the port channel."},"interfaceNames":{"type":"array","items":{"type":"string"},"description":"Interface names of this port channel."},"connectedDeviceType":{"type":"string","description":"Connected device type of the port channel."},"protocol":{"type":"string","description":"Protocol of the port channel."},"description":{"type":"string","description":"Description of the port channel."},"nativeVlanId":{"type":"integer","description":"Native VLAN of the port channel, this option is only applicable to TRUNK connectedDeviceType. (VLAN must be between 1 and 4094. In cases value not set when connectedDeviceType is TRUNK, default value will be 1)."},"allowedVlanRanges":{"type":"string","description":"Allowed VLAN of the port channel, this option is only applicable to TRUNK connectedDeviceType. (VLAN must be between 1 and 4094 (Ex 100,200,300-400) or 'all'. In cases value not set when connectedDeviceType is TRUNK, default value will be 'all')."}}},"description":"Port channel get response body."},"version":{"type":"string","description":"Version number."}},"description":"Port channel get response body (Maximum number of records to return in each response is 500)..","$$ref":"#/components/schemas/GetPortChannelsResponse"}}}},"400":{"description":"Bad Request. The client made a request that the server could not understand.","content":{}}},"x-rapi-id":"dea6-fbe3-4469-8d79","x-rapi-overview":"Returns a list of port channels that match the provided query parameters.","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/portChannels","x-rapi-publicPath":"/dna/intent/api/v1/sda/portChannels","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getPortChannels-2","method":"get","path":"/dna/intent/api/v1/sda/portChannels"}}