Get Organization Switch Routing Bgp Peers Groups Address Families Deployments - Meraki Dashboard API v1 - Cisco Meraki Developer Hub

{"type":"api","title":"Get Organization Switch Routing Bgp Peers Groups Address Families Deployments","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/9d30a16886a116eb6fb996e5d66f67d0df0da886/906c5292-7ca5-3d85-bb6d-da1ee73c8be6","info":{"title":"Meraki Dashboard API","description":"A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n\u003e Date: 16 October, 2026\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":"v1.75.1-beta.0"},"security":[{"meraki_api_key":[]},{"bearerAuth":[]},{"oauth2":[]}],"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":"campusGateway"},{"name":"users"},{"name":"wirelessController"},{"name":"spaces"},{"name":"support"},{"name":"assistant"},{"name":"accelerometer"},{"name":"accessControlLists"},{"name":"accessGroups"},{"name":"accessPolicies"},{"name":"account"},{"name":"accounts"},{"name":"aclHitCount"},{"name":"acls"},{"name":"actionBatches"},{"name":"activities"},{"name":"adaptivePolicy"},{"name":"adaptivePolicyGroups"},{"name":"addressFamilies"},{"name":"addresses"},{"name":"administrators"},{"name":"admins"},{"name":"afc"},{"name":"aggregated"},{"name":"airMarshal"},{"name":"alertTypes"},{"name":"alerts"},{"name":"allowlist"},{"name":"alternateManagementInterface"},{"name":"analytics"},{"name":"api"},{"name":"apiRequests"},{"name":"apnsCert"},{"name":"apple"},{"name":"appliances"},{"name":"application"},{"name":"applicationCategories"},{"name":"applicationUsage"},{"name":"applications"},{"name":"areas"},{"name":"arpInspection"},{"name":"arpTable"},{"name":"artifacts"},{"name":"assetTracking"},{"name":"assets"},{"name":"assignments"},{"name":"association"},{"name":"attributes"},{"name":"auth"},{"name":"authZones"},{"name":"authentication"},{"name":"authenticationToken"},{"name":"authorities"},{"name":"authorization"},{"name":"authorizations"},{"name":"autoLocate"},{"name":"autoRf"},{"name":"automate"},{"name":"automations"},{"name":"autonomousSystems"},{"name":"autovpn"},{"name":"availabilities"},{"name":"azure"},{"name":"bands"},{"name":"bandwidthUsageHistory"},{"name":"batch"},{"name":"batchCreate"},{"name":"batches"},{"name":"bgp"},{"name":"bgpSessionStatus"},{"name":"billing"},{"name":"blink"},{"name":"bluetooth"},{"name":"bluetoothClients"},{"name":"bonjourForwarding"},{"name":"boots"},{"name":"boundaries"},{"name":"brandingPolicies"},{"name":"buildings"},{"name":"bulk"},{"name":"bulkAdd"},{"name":"bulkCreate"},{"name":"bulkDelete"},{"name":"bulkEdit"},{"name":"bulkEnrollment"},{"name":"bulkRemove"},{"name":"bulkUpdate"},{"name":"bulkUpload"},{"name":"byAdmin"},{"name":"byApplication"},{"name":"byAutonomousSystem"},{"name":"byBand"},{"name":"byBoundary"},{"name":"byClient"},{"name":"byClientOs"},{"name":"byClientType"},{"name":"byCluster"},{"name":"byDevice"},{"name":"byEnergyUsage"},{"name":"byFilterList"},{"name":"byGroup"},{"name":"byInterval"},{"name":"byMetric"},{"name":"byModel"},{"name":"byNetwork"},{"name":"byNewDevice"},{"name":"byOperation"},{"name":"byPeerGroup"},{"name":"byPipeline"},{"name":"byPort"},{"name":"byPrefixList"},{"name":"byProfile"},{"name":"byRouter"},{"name":"byServer"},{"name":"byServerType"},{"name":"bySite"},{"name":"bySourceIp"},{"name":"bySsid"},{"name":"byStack"},{"name":"byStatus"},{"name":"bySwitch"},{"name":"bySwitchProfile"},{"name":"byTunnel"},{"name":"byType"},{"name":"byUsage"},{"name":"byUtilization"},{"name":"byVlan"},{"name":"byVrf"},{"name":"bypassActivationLockAttempts"},{"name":"cableTest"},{"name":"callbacks"},{"name":"candidates"},{"name":"capabilities"},{"name":"captures"},{"name":"categories"},{"name":"cellular"},{"name":"cellularFirewallRules"},{"name":"cellularUsageHistory"},{"name":"certificateAuthority"},{"name":"certificates"},{"name":"certs"},{"name":"changeHistory"},{"name":"changelogs"},{"name":"channelAvailability"},{"name":"channelUtilization"},{"name":"channelUtilizationHistory"},{"name":"channels"},{"name":"chat"},{"name":"checkup"},{"name":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clientExclusion"},{"name":"clients"},{"name":"cloud"},{"name":"cloudEnrollment"},{"name":"clusters"},{"name":"commands"},{"name":"communicationPlans"},{"name":"completions"},{"name":"compliance"},{"name":"compute"},{"name":"config"},{"name":"configTemplates"},{"name":"configurationChanges"},{"name":"configurations"},{"name":"configure"},{"name":"configuredDevices"},{"name":"connectedCountHistory"},{"name":"connectionStats"},{"name":"connections"},{"name":"connectivity"},{"name":"connectivityEvents"},{"name":"connectivityMonitoringDestinations"},{"name":"connectors"},{"name":"contentFiltering"},{"name":"contents"},{"name":"controller"},{"name":"correlated"},{"name":"coterm"},{"name":"coverage"},{"name":"cpu"},{"name":"credentials"},{"name":"crls"},{"name":"current"},{"name":"custom"},{"name":"customAnalytics"},{"name":"customPerformanceClasses"},{"name":"cycle"},{"name":"dailyConsumerMetrics"},{"name":"data"},{"name":"dataRate"},{"name":"dataRateHistory"},{"name":"defaultContent"},{"name":"delegated"},{"name":"deltas"},{"name":"deploy"},{"name":"deployable"},{"name":"deployed"},{"name":"deployments"},{"name":"descriptors"},{"name":"desktopLogs"},{"name":"details"},{"name":"detections"},{"name":"deviceCategories"},{"name":"deviceCommandLogs"},{"name":"deviceProfiles"},{"name":"deviceTypeGroupPolicies"},{"name":"dhcp"},{"name":"dhcpLeases"},{"name":"dhcpServerPolicy"},{"name":"dictionaries"},{"name":"disconnect"},{"name":"discover"},{"name":"discovered"},{"name":"discovery"},{"name":"disenrollments"},{"name":"dns"},{"name":"domains"},{"name":"doorLocks"},{"name":"download"},{"name":"downloadUrl"},{"name":"dscpTaggingOptions"},{"name":"dscpToCosMappings"},{"name":"eapOverride"},{"name":"earlyAccess"},{"name":"electronicShelfLabel"},{"name":"eligible"},{"name":"enrollable"},{"name":"enrollments"},{"name":"entitlements"},{"name":"entries"},{"name":"eox"},{"name":"errors"},{"name":"esims"},{"name":"ethernet"},{"name":"eventLogs"},{"name":"eventTypes"},{"name":"events"},{"name":"exclusions"},{"name":"experience"},{"name":"extensions"},{"name":"facets"},{"name":"failedConnections"},{"name":"failover"},{"name":"failures"},{"name":"featureTiers"},{"name":"features"},{"name":"feedback"},{"name":"fetchTableQuery"},{"name":"fields"},{"name":"filterLists"},{"name":"filters"},{"name":"firewall"},{"name":"firewalledServices"},{"name":"firmware"},{"name":"firmwareUpgrades"},{"name":"floorPlans"},{"name":"gateways"},{"name":"gcp"},{"name":"geolocations"},{"name":"global"},{"name":"group"},{"name":"groupPolicies"},{"name":"groups"},{"name":"health"},{"name":"healthByTime"},{"name":"healthScores"},{"name":"histogram"},{"name":"historical"},{"name":"history"},{"name":"hosts"},{"name":"hotspot20"},{"name":"httpServers"},{"name":"httpsInspection"},{"name":"httpsi"},{"name":"hubBudget"},{"name":"hubs"},{"name":"iam"},{"name":"identities"},{"name":"identity"},{"name":"identityPsks"},{"name":"idps"},{"name":"impacted"},{"name":"impactedDevice"},{"name":"import"},{"name":"inboundCellularFirewallRules"},{"name":"inboundFirewallRules"},{"name":"insights"},{"name":"integrate"},{"name":"integration"},{"name":"integrations"},{"name":"interconnects"},{"name":"interfaces"},{"name":"internetPolicies"},{"name":"intrusion"},{"name":"inventory"},{"name":"iot"},{"name":"ipAssignment"},{"name":"ipsec"},{"name":"ipv6"},{"name":"isolation"},{"name":"jobs"},{"name":"json"},{"name":"keys"},{"name":"l2"},{"name":"l3"},{"name":"l3FirewallRules"},{"name":"l7FirewallRules"},{"name":"lan"},{"name":"lanLink"},{"name":"lanStp"},{"name":"latency"},{"name":"latencyHistory"},{"name":"latencyStats"},{"name":"latest"},{"name":"leds"},{"name":"license"},{"name":"licenses"},{"name":"licensing"},{"name":"lines"},{"name":"linkAggregations"},{"name":"linkLayer"},{"name":"links"},{"name":"listenRanges"},{"name":"live"},{"name":"liveTools"},{"name":"lldpCdp"},{"name":"load"},{"name":"local"},{"name":"localOverrides"},{"name":"location"},{"name":"locationScanning"},{"name":"loginSecurity"},{"name":"logins"},{"name":"logs"},{"name":"lookups"},{"name":"lossAndLatencyHistory"},{"name":"lowPower"},{"name":"macTable"},{"name":"malware"},{"name":"managementInterface"},{"name":"manufacturers"},{"name":"masks"},{"name":"mcf"},{"name":"mdns"},{"name":"me"},{"name":"measurements"},{"name":"memory"},{"name":"merakiAuth"},{"name":"merakiAuthUsers"},{"name":"mesh"},{"name":"meshStatuses"},{"name":"messages"},{"name":"metrics"},{"name":"migrations"},{"name":"mirror"},{"name":"mirrors"},{"name":"mode"},{"name":"models"},{"name":"monitor"},{"name":"monitoredMediaServers"},{"name":"mostImpactedClientNetworks"},{"name":"mostImpactedNetworks"},{"name":"mostImpactedXMs"},{"name":"moves"},{"name":"mqtt"},{"name":"mqttBrokers"},{"name":"mtu"},{"name":"multicast"},{"name":"multicastForwarding"},{"name":"multicastRouting"},{"name":"nac"},{"name":"nat"},{"name":"neighbors"},{"name":"netflow"},{"name":"networkAdapters"},{"name":"networkHealth"},{"name":"networkServices"},{"name":"new"},{"name":"nodes"},{"name":"objectDetectionModels"},{"name":"offboard"},{"name":"onboard"},{"name":"onboarding"},{"name":"onboardingHistory"},{"name":"oneToManyNatRules"},{"name":"oneToOneNatRules"},{"name":"openRoaming"},{"name":"openapiSpec"},{"name":"opportunistic"},{"name":"opportunisticPcap"},{"name":"optIns"},{"name":"optimization"},{"name":"order"},{"name":"orders"},{"name":"ospf"},{"name":"ospfNeighbors"},{"name":"override"},{"name":"overrides"},{"name":"overview"},{"name":"overviews"},{"name":"owe"},{"name":"package"},{"name":"packetCapture"},{"name":"packetCaptures"},{"name":"packetLoss"},{"name":"packets"},{"name":"payloadTemplates"},{"name":"peers"},{"name":"performance"},{"name":"performanceHistory"},{"name":"permissions"},{"name":"pii"},{"name":"piiKeys"},{"name":"ping"},{"name":"pingDevice"},{"name":"pipelines"},{"name":"placement"},{"name":"planning"},{"name":"poe"},{"name":"policies"},{"name":"policy"},{"name":"policyObjects"},{"name":"portForwardingRules"},{"name":"portSchedules"},{"name":"ports"},{"name":"position"},{"name":"positions"},{"name":"power"},{"name":"powerLimits"},{"name":"powerModules"},{"name":"preferred"},{"name":"prefixLists"},{"name":"prefixes"},{"name":"priorities"},{"name":"privateApplicationGroups"},{"name":"privateApplications"},{"name":"privateResourceGroups"},{"name":"privateResources"},{"name":"productAnnouncements"},{"name":"productIntegrations"},{"name":"profiles"},{"name":"provisioning"},{"name":"publicApplications"},{"name":"push"},{"name":"qosRules"},{"name":"qualityAndRetention"},{"name":"qualityRetentionProfiles"},{"name":"queues"},{"name":"raGuardPolicy"},{"name":"radio"},{"name":"radius"},{"name":"radsec"},{"name":"ranging"},{"name":"ratePlans"},{"name":"rca"},{"name":"readings"},{"name":"reboot"},{"name":"receivers"},{"name":"recent"},{"name":"recommendations"},{"name":"records"},{"name":"redundancy"},{"name":"regions"},{"name":"regulatoryDomain"},{"name":"relationships"},{"name":"remoteAccess"},{"name":"remoteAccessLog"},{"name":"remoteAccessLogsExports"},{"name":"removedResources"},{"name":"rendezvousPoints"},{"name":"requests"},{"name":"requirements"},{"name":"responseCodes"},{"name":"rest"},{"name":"restrictions"},{"name":"retries"},{"name":"revocationLists"},{"name":"rfHealth"},{"name":"rfProfiles"},{"name":"roaming"},{"name":"roles"},{"name":"rollbacks"},{"name":"route"},{"name":"routers"},{"name":"routing"},{"name":"routingTable"},{"name":"rrm"},{"name":"rssi"},{"name":"ruleGroups"},{"name":"rules"},{"name":"rulesets"},{"name":"salesRepresentatives"},{"name":"saml"},{"name":"samlRoles"},{"name":"sase"},{"name":"scanning"},{"name":"schedules"},{"name":"scores"},{"name":"sdwan"},{"name":"sdwanmanager"},{"name":"search"},{"name":"secureClient"},{"name":"secureConnect"},{"name":"security"},{"name":"securityCenters"},{"name":"seen"},{"name":"sense"},{"name":"sentry"},{"name":"serverHealth"},{"name":"servers"},{"name":"serviceProviders"},{"name":"services"},{"name":"sessions"},{"name":"settings"},{"name":"signalQuality"},{"name":"signalQualityHistory"},{"name":"sims"},{"name":"singleLan"},{"name":"siteToSite"},{"name":"siteToSiteVpn"},{"name":"sites"},{"name":"slas"},{"name":"smDevicesForKey"},{"name":"smOwnersForKey"},{"name":"snmp"},{"name":"software"},{"name":"softwares"},{"name":"spanningTree"},{"name":"speedTest"},{"name":"speedTestResults"},{"name":"splash"},{"name":"splashAuthorizationStatus"},{"name":"splashLoginAttempts"},{"name":"split"},{"name":"spokes"},{"name":"ssids"},{"name":"stacks"},{"name":"staged"},{"name":"stages"},{"name":"states"},{"name":"static"},{"name":"staticRoutes"},{"name":"statics"},{"name":"stats"},{"name":"status"},{"name":"statuses"},{"name":"stickyEvents"},{"name":"stormControl"},{"name":"stp"},{"name":"subnetPool"},{"name":"subnets"},{"name":"subscription"},{"name":"subscriptions"},{"name":"successfulConnections"},{"name":"successfulConnects"},{"name":"summaries"},{"name":"summary"},{"name":"summaryConsumerMetrics"},{"name":"summaryPanel"},{"name":"supported"},{"name":"sustainability"},{"name":"swap"},{"name":"swaps"},{"name":"switchPortStatus"},{"name":"switches"},{"name":"sync"},{"name":"syncJobs"},{"name":"syslog"},{"name":"syslogServers"},{"name":"system"},{"name":"tags"},{"name":"targetGroups"},{"name":"targets"},{"name":"tasks"},{"name":"taxonomy"},{"name":"telemetry"},{"name":"testConnectivity"},{"name":"tests"},{"name":"themes"},{"name":"thirdPartyVPNPeers"},{"name":"thousandEyes"},{"name":"threads"},{"name":"throughputTest"},{"name":"timeToConnect"},{"name":"token"},{"name":"tokens"},{"name":"top"},{"name":"topics"},{"name":"topology"},{"name":"towers"},{"name":"traceRoute"},{"name":"traffic"},{"name":"trafficAnalysis"},{"name":"trafficHistory"},{"name":"trafficShaping"},{"name":"transceivers"},{"name":"traps"},{"name":"trustedAccessConfigs"},{"name":"trustedServers"},{"name":"tunnelCreation"},{"name":"tunnelStatus"},{"name":"tunnelable"},{"name":"tunneling"},{"name":"types"},{"name":"umbrella"},{"name":"unassigned"},{"name":"update"},{"name":"updates"},{"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":"values"},{"name":"versions"},{"name":"video"},{"name":"videoLink"},{"name":"videoWalls"},{"name":"vlanAssignments"},{"name":"vlanProfiles"},{"name":"vlans"},{"name":"vmx"},{"name":"vpcOnboardingBatches"},{"name":"vpcs"},{"name":"vpn"},{"name":"vpnExclusions"},{"name":"vpnFirewallRules"},{"name":"vpnPeers"},{"name":"vppAccounts"},{"name":"vrfs"},{"name":"vrrp"},{"name":"vrrpTable"},{"name":"wakeOnLan"},{"name":"warmSpare"},{"name":"warnings"},{"name":"webApps"},{"name":"webhookTests"},{"name":"webhooks"},{"name":"wired"},{"name":"wirelessControllers"},{"name":"wirelessProfiles"},{"name":"wlanLists"},{"name":"workflows"},{"name":"xdr"},{"name":"zigbee"},{"name":"zones"},{"name":"ztrIntents"}],"x-parser-conf":{"exampleAsDefault":true,"expand":0,"filterBy":{"$remoteModule":"config/filter_only_beta.js"},"groupBy":{"$remoteModule":"config/group_platform.js"},"httpBearer":{"bearerToken":"75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}},"overview":{"markdownPath":"docs/overview-early-access.md"},"serverConfig":true,"sortBy":{"$remoteModule":"config/sort_by.js"},"theme":"meraki","variables":{"networkId":"N_784752235069315754","organizationId":"1215707","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"},"oauth2":{"type":"oauth2","description":"This API uses OAuth 2 with the authorization code grant flow. [More info](https://developer.cisco.com/meraki/api-v1/authorization/)","flows":{"authorizationCode":{"authorizationUrl":"https://as.meraki.com/oauth/authorize","tokenUrl":"https://as.meraki.com/oauth/token","scopes":{"camera:config:read":"Cameras (MV)","camera:config:write":"Cameras (MV)","camera:telemetry:read":"Cameras (MV)","camera:telemetry:write":"Cameras (MV)","dashboard:general:config:read":"Entire dashboard, excluding identity and access management","dashboard:general:config:write":"Entire dashboard, excluding identity and access management","dashboard:general:telemetry:read":"Entire dashboard, excluding identity and access management","dashboard:general:telemetry:write":"Entire dashboard, excluding identity and access management","dashboard:iam:config:read":"Dashboard related to identity and access management, including early access features","dashboard:iam:config:write":"Dashboard related to identity and access management, including early access features","dashboard:iam:telemetry:read":"Dashboard related to identity and access management, including early access features","dashboard:iam:telemetry:write":"Dashboard related to identity and access management, including early access features","dashboard:licensing:config:read":"Licensing","dashboard:licensing:config:write":"Licensing","dashboard:licensing:telemetry:read":"Licensing","dashboard:licensing:telemetry:write":"Licensing","iot:gateway:general:config:read":"Sensor Connect (IoT Control)","iot:gateway:general:config:write":"Sensor Connect (IoT Control)","iot:gateway:general:telemetry:read":"Sensor Connect (IoT Control)","iot:gateway:general:telemetry:write":"Sensor Connect (IoT Control)","iot:gateway:onboarding:config:read":"Sensor Connect (IoT Onboarding)","iot:gateway:onboarding:config:write":"Sensor Connect (IoT Onboarding)","policy:config:read":"Provides granular authorization over all global policy resources including policy objects, adaptive policy, and Organization Group Policy","policy:config:write":"Provides granular authorization over all global policy resources including policy objects, adaptive policy, and Organization Group Policy","policy:telemetry:read":"Provides granular authorization over all global policy resources including policy objects, adaptive policy, and Organization Group Policy","policy:telemetry:write":"Provides granular authorization over all global policy resources including policy objects, adaptive policy, and Organization Group Policy","sdwan:config:read":"Secure SD-WAN (MX including MXIGZ)","sdwan:config:write":"Secure SD-WAN (MX including MXIGZ)","sdwan:telemetry:read":"Secure SD-WAN (MX including MXIGZ)","sdwan:telemetry:write":"Secure SD-WAN (MX including MXIGZ)","sensor:config:read":"Sensors (MT)","sensor:config:write":"Sensors (MT)","sensor:telemetry:read":"Sensors (MT)","sensor:telemetry:write":"Sensors (MT)","sm:config:read":"Endpoint Management (SM)","sm:config:write":"Endpoint Management (SM)","sm:telemetry:read":"Endpoint Management (SM)","sm:telemetry:write":"Endpoint Management (SM)","switch:config:read":"Switches (MS)","switch:config:write":"Switches (MS)","switch:telemetry:read":"Switches (MS)","switch:telemetry:write":"Switches (MS)","wireless:config:read":"Wireless (MR)","wireless:config:write":"Wireless (MR)","wireless:telemetry:read":"Wireless (MR)","wireless:telemetry:write":"Wireless (MR)"}}}}}},"spec":{"description":"List all BGP deployment information for multiple peer groups or address families configured in the given organization, including profile information, peer group address family information, neighbors, and listen ranges. Border Gateway Protocol requires IOS XE 17.18 or higher","operationId":"getOrganizationSwitchRoutingBgpPeersGroupsAddressFamiliesDeployments","parameters":[{"name":"organizationId","in":"path","description":"Organization ID","schema":{"type":"string"},"required":true},{"name":"perPage","in":"query","description":"The number of entries per page returned. Acceptable range is 3 - 100. Default is 50.","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"}},{"name":"networkIds","in":"query","description":"Optional parameter to filter peer group address family deployments by network ID. This filter uses multiple exact matches.","schema":{"type":"array","items":{"type":"string"}}},{"name":"peerGroupIds","in":"query","description":"Optional parameter to filter peer group address family deployments by peer group","schema":{"type":"array","items":{"type":"string"}}},{"name":"addressFamilyIds","in":"query","description":"Optional parameter to filter peer group address family deployments by address family","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"peerGroupId":{"type":"string","description":"Object ID for the peer group. Only required when updating."},"addressFamily":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the address family"},"description":{"type":"string","description":"Text description of the address family afi, safi and VRF (e.g. 'ipv4 unicast VRF Blue') (CLI: 'address-family \u003cafi\u003e \u003csafi\u003e vrf \u003cvrf_name\u003e')"}},"description":"Information regarding the address family the peer group address family binding belongs to"},"esiMhPair":{"type":"object","properties":{"id":{"type":"string","description":"The ESI-MH pair object ID","nullable":true},"name":{"type":"string","description":"The ESI-MH pair name","nullable":true}},"description":"Information regarding the ESI-MH pair the peer group belongs to, if applicable"},"listenRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the listen range"},"cidr":{"type":"string","description":"The range of IP addresses this listen range responds to (CLI: 'bgp listen range \u003ccidr\u003e')"},"description":{"type":"string","description":"A description for the listen range","nullable":true},"peering":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag to indicate if the listen range should be activated"}},"description":"Information regarding peering for the listen range"}}},"description":"Information regarding the listen ranges for the peer group"},"neighbors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the neighbor"},"description":{"type":"string","description":"Text description of the neighbor (CLI: 'neighbor 10.0.42.1 description \u003cdescription\u003e')","nullable":true},"address":{"type":"string","description":"The IP address of the neighbor (CLI: 'neighbor \u003caddress\u003e')"},"peering":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag to indicate if the neighbor should be activated"}},"description":"Information regarding the peering configuration for the neighbor"}}},"description":"Information regarding the neighbors for the peer group and address family"},"network":{"type":"object","properties":{"id":{"type":"string","description":"The network ID"},"name":{"type":"string","description":"The network name"}},"description":"Information regarding the network the peer group belongs to"},"router":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the router"}},"description":"Information regarding the router this peer group belongs to"},"switchFabric":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the fabric associated with the peer group","nullable":true},"name":{"type":"string","description":"Name of the fabric associated with the peer group","nullable":true}},"description":"Information regarding the switch fabric the peer group belongs to, if applicable"},"name":{"type":"string","description":"Name of the peer group (CLI: 'neighbor \u003cname\u003e peer-group')"},"description":{"type":"string","description":"Text description of the peer group (CLI: 'neighbor \u003cname\u003e description \u003cdescription\u003e')","nullable":true},"ebgp":{"type":"object","properties":{"connectedCheck":{"type":"object","properties":{"enabled":{"type":"boolean","description":"The option to activate the precautionary check as to whether the client is on a directly connected network (Inverse of CLI: 'neighbor \u003cname\u003e disable-connected-check')"}},"description":"Options related to the precautionary check as to whether the client is on a directly connected network"},"multihop":{"type":"object","properties":{"maximum":{"type":"integer","description":"An integer that configures a BGP device to establish an eBGP peer relationship with indirectly connected networks, setting a max-hop value between the two devices (CLI: 'neighbor \u003cname\u003e ebgp-multihop \u003cmaximum\u003e')","nullable":true}},"description":"Options related to the time to live (TTL) value for the packets carrying BGP messages"}},"description":"Options related to eBGP configuration"},"authentication":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Signifies if the peer group has a password configured"},"password":{"type":"string","description":"BGP password used to authenticate BGP peers and prevent unauthorized access (CLI: 'neighbor \u003cname\u003e password \u003cpassword\u003e')","nullable":true}},"description":"Options related to BGP peer authentication"},"timers":{"type":"object","properties":{"hold":{"type":"integer","description":"Option specifying the maximum time a router will wait for a message from its peer before considering the connection down (CLI: 'neighbor \u003cname\u003e timers 60 \u003chold\u003e')","nullable":true},"keepalive":{"type":"integer","description":"Option specifying the interval at which periodic keep-alive messages are sent to verify the peer is still reachable (CLI: 'neighbor \u003cname\u003e timers \u003ckeepalive\u003e 180')","nullable":true}},"description":"Options related to timers used to maintain connectivity between BGP peers"},"autonomousSystem":{"type":"object","properties":{"remote":{"type":"object","properties":{"number":{"type":"integer","description":"Specifies the remote autonomous system number (CLI: 'neighbor \u003cname\u003e remote-as \u003cnumber\u003e')","nullable":true}},"description":"Information regarding the remote eBGP autonomous system"}},"description":"Information regarding the autonomous system for the BGP neighbors in the peer group"},"interfaces":{"type":"object","properties":{"loopback":{"type":"object","properties":{"source":{"type":"object","properties":{"id":{"type":"string","description":"The object ID for the loopback source interface","nullable":true},"name":{"type":"string","description":"The loopback interface descriptive number (CLI: 'neighbor \u003cname\u003e update-source Loopback\u003cname\u003e')","nullable":true},"number":{"type":"integer","description":"The loopback interface number","nullable":true}},"description":"Options related to the BGP loopback source interface","nullable":true}},"description":"Options related to BGP loopback interfaces"}},"description":"Options related to BGP interfaces"},"advertisement":{"type":"object","properties":{"interval":{"type":"integer","description":"Minimal interval between sending BGP routing updates (CLI: 'neighbor IBGP advertisement-interval \u003cinterval\u003e')","nullable":true},"defaultRoutes":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether default route advertisement is enabled for this peer group (CLI: 'neighbor IBGP default-originate')"}},"description":"Options related to default route advertisement"}},"description":"Options related to route advertisement"},"communityAttribute":{"type":"object","properties":{"send":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indication for send community attribute to this peer group (CLI: 'neighbor IBGP send-community')"}},"description":"Information regarding the send community attribute to this peer group"}},"description":"Information regarding the community attribute for peer groups for a given address family"},"nextHop":{"type":"object","properties":{"self":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Disables the next hop calculation for this peer group (CLI: 'neighbor IBGP next-hop-self')"}},"description":"Information regarding the next hop calculation for this neigbor"},"unchanged":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable next-hop-self for both eBGP and iBGP received paths (CLI: 'neighbor IBGP next-hop-unchanged')"}},"description":"Information regarding propagating the iBGP paths' next hop unchanged for this peer group"}},"description":"Information regarding next hop for peer groups for a given address family"},"removePrivateAs":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Removes private AS number from outbound updates (CLI: 'neighbor IBGP remove-private-as')"}},"description":"Information regarding removal of private AS number from outbound updates"},"routeReflector":{"type":"object","properties":{"client":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Configures a peer group as Route Reflect client (CLI: 'neighbor IBGP route-reflector-client')"}},"description":"Information regarding route reflector clients"}},"description":"Information regarding route reflectors"},"softReconfiguration":{"type":"object","properties":{"direction":{"type":"string","description":"The direction of soft reconfiguration being enabled (CLI: 'neighbor IBGP soft-reconfiguration \u003csoft_reconfiguration\u003e')","nullable":true}},"description":"Options related to soft reconfiguration"},"weight":{"type":"integer","description":"Set default weight for routes from this peer group (CLI: 'neighbor IBGP weight \u003cweight\u003e')","nullable":true}}},"description":"The top-level property containing all address family peer groups deployments"},"meta":{"type":"object","properties":{"counts":{"type":"object","properties":{"items":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of available objects"},"remaining":{"type":"integer","description":"The number of objects that are available on subsequent pages"}},"description":"Counts relating to the paginated items"}},"description":"Counts relating to the paginated dataset"}},"description":"Metadata relevant to the paginated dataset"}}},"example":{"items":[{"peerGroupId":"123","addressFamily":{"id":"456","description":"ipv4 unicast VRF Default"},"esiMhPair":{"id":"456","name":"ESI Pair 1"},"listenRanges":[{"id":"999","cidr":"192.0.2.0/24","description":"Campus-Bldg-1","peering":{"enabled":true}}],"neighbors":[{"id":"999","description":"BGP gateway","address":"10.0.0.1","peering":{"enabled":true}}],"network":{"id":"L_123","name":"My network name"},"router":{"id":"888"},"switchFabric":{"id":"123","name":"Fabric 1"},"name":"MyPeerGroup","description":"A Peer Group","ebgp":{"connectedCheck":{"enabled":true},"multihop":{"maximum":10}},"authentication":{"enabled":true,"password":"my password"},"timers":{"hold":90,"keepalive":30},"autonomousSystem":{"remote":{"number":65000}},"interfaces":{"loopback":{"source":{"id":"555","name":"0","number":0}}},"advertisement":{"interval":20,"defaultRoutes":{"enabled":true}},"communityAttribute":{"send":{"enabled":true}},"nextHop":{"self":{"enabled":true},"unchanged":{"enabled":false}},"removePrivateAs":{"enabled":true},"routeReflector":{"client":{"enabled":false}},"softReconfiguration":{"direction":"inbound"},"weight":30}],"meta":{"counts":{"items":{"total":100,"remaining":10}}}}}},"headers":{"Link":{"schema":{"type":"string"},"description":"A comma-separated list of first, last, prev, and next relative links used for subsequent paginated requests."}}}},"security":[{"oauth2":["switch:config:read"]}],"summary":"List all BGP deployment information for multiple peer groups or address families configured in the given organization, including profile information, peer group address family information, neighbors, and listen ranges","tags":["switch","configure","routing","bgp","peers","groups","addressFamilies","deployments"],"x-release-stage":"beta","__originalOperationId":"getOrganizationSwitchRoutingBgpPeersGroupsAddressFamiliesDeployments","method":"get","path":"/organizations/{organizationId}/switch/routing/bgp/peers/groups/addressFamilies/deployments"}}