{"type":"api","title":"Get Organization Switch Routing Bgp Routers Deployments","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/ba391890275963fcab94d52a253a289cedb71223/401c6d5b-0873-3519-be2b-c203501ad95c","info":{"title":"Meraki Dashboard API","description":"A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n\u003e Date: 01 October, 2025\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":"1.63.0-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":"accelerometer"},{"name":"accessControlLists"},{"name":"accessPolicies"},{"name":"account"},{"name":"accounts"},{"name":"aclHitCount"},{"name":"acls"},{"name":"actionBatches"},{"name":"activities"},{"name":"adaptivePolicy"},{"name":"addressFamilies"},{"name":"addresses"},{"name":"admins"},{"name":"afc"},{"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":"assets"},{"name":"assign"},{"name":"assignments"},{"name":"auth"},{"name":"authZones"},{"name":"authenticationToken"},{"name":"authorities"},{"name":"authorization"},{"name":"authorizations"},{"name":"autoLocate"},{"name":"autoRf"},{"name":"automations"},{"name":"autonomousSystems"},{"name":"availabilities"},{"name":"bandwidthUsageHistory"},{"name":"bgp"},{"name":"billing"},{"name":"blink"},{"name":"bluetooth"},{"name":"bluetoothClients"},{"name":"bonjourForwarding"},{"name":"boots"},{"name":"boundaries"},{"name":"brandingPolicies"},{"name":"bulk"},{"name":"bulkAdd"},{"name":"bulkCreate"},{"name":"bulkDelete"},{"name":"bulkEnrollment"},{"name":"bulkRemove"},{"name":"bulkUpdate"},{"name":"byAutonomousSystem"},{"name":"byBoundary"},{"name":"byClient"},{"name":"byDevice"},{"name":"byEnergyUsage"},{"name":"byFilterList"},{"name":"byInterval"},{"name":"byMetric"},{"name":"byModel"},{"name":"byNetwork"},{"name":"byPeerGroup"},{"name":"byPrefixList"},{"name":"byProfile"},{"name":"byRouter"},{"name":"bySsid"},{"name":"byStack"},{"name":"byStatus"},{"name":"bySwitch"},{"name":"bySwitchProfile"},{"name":"byType"},{"name":"byUsage"},{"name":"byUtilization"},{"name":"bypassActivationLockAttempts"},{"name":"cableTest"},{"name":"callbacks"},{"name":"captures"},{"name":"categories"},{"name":"cellular"},{"name":"cellularFirewallRules"},{"name":"cellularUsageHistory"},{"name":"certificateAuthority"},{"name":"certificates"},{"name":"certs"},{"name":"change"},{"name":"changeHistory"},{"name":"channelUtilization"},{"name":"channelUtilizationHistory"},{"name":"channels"},{"name":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clientExclusion"},{"name":"clients"},{"name":"cloud"},{"name":"cloudEnrollment"},{"name":"cloudMonitoring"},{"name":"clusters"},{"name":"commands"},{"name":"communicationPlans"},{"name":"compliance"},{"name":"compute"},{"name":"configTemplates"},{"name":"configurationChanges"},{"name":"configurations"},{"name":"configure"},{"name":"configuredDevices"},{"name":"connectionStats"},{"name":"connections"},{"name":"connectivity"},{"name":"connectivityEvents"},{"name":"connectivityMonitoringDestinations"},{"name":"contentFiltering"},{"name":"contents"},{"name":"controller"},{"name":"coterm"},{"name":"cpu"},{"name":"crls"},{"name":"current"},{"name":"customAnalytics"},{"name":"customPerformanceClasses"},{"name":"cyclePort"},{"name":"dataRate"},{"name":"dataRateHistory"},{"name":"delegated"},{"name":"deltas"},{"name":"deploy"},{"name":"deployments"},{"name":"desktopLogs"},{"name":"details"},{"name":"detections"},{"name":"deviceCommandLogs"},{"name":"deviceProfiles"},{"name":"deviceTypeGroupPolicies"},{"name":"dhcp"},{"name":"dhcpLeases"},{"name":"dhcpServerPolicy"},{"name":"disconnect"},{"name":"discovery"},{"name":"disenrollments"},{"name":"dns"},{"name":"doorLocks"},{"name":"download"},{"name":"downloadUrl"},{"name":"dscpTaggingOptions"},{"name":"dscpToCosMappings"},{"name":"eapOverride"},{"name":"earlyAccess"},{"name":"electronicShelfLabel"},{"name":"enrollments"},{"name":"entitlements"},{"name":"entries"},{"name":"errors"},{"name":"esims"},{"name":"ethernet"},{"name":"eventTypes"},{"name":"events"},{"name":"exclusions"},{"name":"exportEvents"},{"name":"extensions"},{"name":"failedConnections"},{"name":"failover"},{"name":"featureTiers"},{"name":"features"},{"name":"fields"},{"name":"filter"},{"name":"filterLists"},{"name":"filters"},{"name":"firewall"},{"name":"firewalledServices"},{"name":"firmware"},{"name":"firmwareUpgrades"},{"name":"floorPlans"},{"name":"gateways"},{"name":"groupPolicies"},{"name":"groupPolicy"},{"name":"groups"},{"name":"health"},{"name":"healthByTime"},{"name":"healthScores"},{"name":"historical"},{"name":"history"},{"name":"hotspot20"},{"name":"httpServers"},{"name":"iam"},{"name":"identities"},{"name":"identityPsks"},{"name":"idps"},{"name":"import"},{"name":"imports"},{"name":"inboundCellularFirewallRules"},{"name":"inboundFirewallRules"},{"name":"integrate"},{"name":"integration"},{"name":"integrations"},{"name":"interconnects"},{"name":"interfaces"},{"name":"internetPolicies"},{"name":"intrusion"},{"name":"inventory"},{"name":"ipsec"},{"name":"ipv6"},{"name":"isolation"},{"name":"jobs"},{"name":"keys"},{"name":"l2"},{"name":"l3"},{"name":"l3FirewallRules"},{"name":"l7FirewallRules"},{"name":"lan"},{"name":"latency"},{"name":"latencyHistory"},{"name":"latencyStats"},{"name":"latest"},{"name":"leds"},{"name":"license"},{"name":"licenses"},{"name":"licensing"},{"name":"lines"},{"name":"linkAggregations"},{"name":"linkLayer"},{"name":"listenRanges"},{"name":"live"},{"name":"liveTools"},{"name":"lldpCdp"},{"name":"load"},{"name":"local"},{"name":"localOverrides"},{"name":"location"},{"name":"locationScanning"},{"name":"loginSecurity"},{"name":"logs"},{"name":"lossAndLatencyHistory"},{"name":"macTable"},{"name":"malware"},{"name":"managementInterface"},{"name":"manufacturers"},{"name":"me"},{"name":"memory"},{"name":"merakiAuthUsers"},{"name":"meshStatuses"},{"name":"migrations"},{"name":"mirror"},{"name":"mirrors"},{"name":"mode"},{"name":"models"},{"name":"monitor"},{"name":"monitoredMediaServers"},{"name":"moves"},{"name":"mqtt"},{"name":"mqttBrokers"},{"name":"mtu"},{"name":"multicast"},{"name":"multicastForwarding"},{"name":"multicastRouting"},{"name":"nac"},{"name":"neighbors"},{"name":"netflow"},{"name":"networkAdapters"},{"name":"networkHealth"},{"name":"objectDetectionModels"},{"name":"onboarding"},{"name":"onboardingHistory"},{"name":"oneToManyNatRules"},{"name":"oneToOneNatRules"},{"name":"openRoaming"},{"name":"openapiSpec"},{"name":"opportunisticPcap"},{"name":"optIns"},{"name":"order"},{"name":"orders"},{"name":"ospf"},{"name":"ospfNeighbors"},{"name":"overview"},{"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":"planning"},{"name":"policies"},{"name":"policy"},{"name":"policyObjects"},{"name":"portForwardingRules"},{"name":"portSchedules"},{"name":"ports"},{"name":"position"},{"name":"power"},{"name":"powerLimits"},{"name":"powerModules"},{"name":"prefixLists"},{"name":"prefixes"},{"name":"prepare"},{"name":"priorities"},{"name":"privateApplicationGroups"},{"name":"privateApplications"},{"name":"privateResourceGroups"},{"name":"privateResources"},{"name":"productAnnouncements"},{"name":"productIntegrations"},{"name":"profiles"},{"name":"provisionDefaults"},{"name":"provisioning"},{"name":"publicApplications"},{"name":"qosRules"},{"name":"qualityAndRetention"},{"name":"qualityRetentionProfiles"},{"name":"queues"},{"name":"raGuardPolicy"},{"name":"radio"},{"name":"radius"},{"name":"radsec"},{"name":"ratePlans"},{"name":"readings"},{"name":"reboot"},{"name":"receivers"},{"name":"recent"},{"name":"records"},{"name":"redundancy"},{"name":"regions"},{"name":"regulatoryDomain"},{"name":"relationships"},{"name":"remoteAccessLog"},{"name":"remoteAccessLogsExports"},{"name":"remove"},{"name":"rendezvousPoints"},{"name":"requests"},{"name":"requirements"},{"name":"responseCodes"},{"name":"restrictions"},{"name":"rfProfiles"},{"name":"roles"},{"name":"rollbacks"},{"name":"routers"},{"name":"routing"},{"name":"routingTable"},{"name":"rrm"},{"name":"rules"},{"name":"salesRepresentatives"},{"name":"saml"},{"name":"samlRoles"},{"name":"scanning"},{"name":"schedules"},{"name":"scores"},{"name":"sdwan"},{"name":"sdwanmanager"},{"name":"search"},{"name":"searchRulesExactMatch"},{"name":"secureConnect"},{"name":"security"},{"name":"securityCenters"},{"name":"seen"},{"name":"sense"},{"name":"sentry"},{"name":"servers"},{"name":"serviceProviders"},{"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":"softwares"},{"name":"speedTest"},{"name":"speedTestResults"},{"name":"splash"},{"name":"splashAuthorizationStatus"},{"name":"splashLoginAttempts"},{"name":"split"},{"name":"ssids"},{"name":"stacks"},{"name":"staged"},{"name":"stages"},{"name":"static"},{"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":"summaryPanel"},{"name":"supported"},{"name":"swap"},{"name":"swaps"},{"name":"switches"},{"name":"sync"},{"name":"syncJobs"},{"name":"syslog"},{"name":"syslogServers"},{"name":"system"},{"name":"targetGroups"},{"name":"tasks"},{"name":"taxonomy"},{"name":"testConnectivity"},{"name":"tests"},{"name":"themes"},{"name":"thirdPartyVPNPeers"},{"name":"thousandEyes"},{"name":"throughputTest"},{"name":"token"},{"name":"tokens"},{"name":"top"},{"name":"topology"},{"name":"traceRoute"},{"name":"traffic"},{"name":"trafficAnalysis"},{"name":"trafficHistory"},{"name":"trafficShaping"},{"name":"transceivers"},{"name":"traps"},{"name":"trustedAccessConfigs"},{"name":"trustedServers"},{"name":"types"},{"name":"umbrella"},{"name":"unassigned"},{"name":"upgrades"},{"name":"uplink"},{"name":"uplinkBandwidth"},{"name":"uplinkSelection"},{"name":"uplinks"},{"name":"uplinksLossAndLatency"},{"name":"usage"},{"name":"usageHistories"},{"name":"usageHistory"},{"name":"userAccessDevices"},{"name":"utilization"},{"name":"v2"},{"name":"v4"},{"name":"video"},{"name":"videoLink"},{"name":"videoWalls"},{"name":"vlanAssignments"},{"name":"vlanProfiles"},{"name":"vlans"},{"name":"vmx"},{"name":"vpn"},{"name":"vpnExclusions"},{"name":"vpnFirewallRules"},{"name":"vppAccounts"},{"name":"vrrpTable"},{"name":"wakeOnLan"},{"name":"warmSpare"},{"name":"warnings"},{"name":"webApps"},{"name":"webhookTests"},{"name":"webhooks"},{"name":"wirelessControllers"},{"name":"wirelessProfiles"},{"name":"wlanLists"},{"name":"workflows"},{"name":"xdr"},{"name":"zigbee"},{"name":"zones"}],"x-parser-conf":{"overview":{"markdownPath":"docs/overview-early-access.md"},"theme":"meraki","serverConfig":true,"httpBearer":{"bearerToken":"75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}},"groupBy":{"$remoteModule":"config/group_platform.js"},"filterBy":{"$remoteModule":"config/filter_only_beta.js"},"sortBy":{"$remoteModule":"config/sort_by.js"},"exampleAsDefault":true,"expand":0,"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"},"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:energy:telemetry:read":"Data for electricity rate and carbon intensity for calculating energy consumption","dashboard:general:config:read":"Entire dashboard, excluding identity and access management","dashboard:general:config:write":"Entire dashboard, excluding identity and access management","dashboard:general:networks:groups:config:write":"Network groups configuration management","dashboard:general:telemetry:packetcapture:read":"Dashboard packet capture","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":"IoT Gateway Control using NIPC","iot:gateway:general:config:write":"IoT Gateway Control using NIPC","iot:gateway:general:telemetry:read":"IoT Gateway telemetry using NIPC","iot:gateway:general:telemetry:write":"IoT Gateway telemetry using NIPC","iot:gateway:onboarding:config:read":"IoT Gateway Onboarding using SCIM","iot:gateway:onboarding:config:write":"IoT Gateway Onboarding using SCIM","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 routers configured in a given organization, including all address families. Border Gateway Protocol requires IOS XE 17.18 or higher","operationId":"getOrganizationSwitchRoutingBgpRoutersDeployments","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 - 50. Default is 20.","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 router deployments by network ID. This filter uses multiple exact matches.","schema":{"type":"array","items":{"type":"string"}}},{"name":"serials","in":"query","description":"Optional parameter to filter router deployments by serial. This filter uses multiple exact matches.","schema":{"type":"array","items":{"type":"string"}}},{"name":"switchNames","in":"query","description":"Optional parameter to filter router deployments by switch name. The filter uses multiple exact matches.","schema":{"type":"array","items":{"type":"string"}}},{"name":"asNumbers","in":"query","description":"Optional parameter to filter router deployments by autonomous system number. This filter uses multiple exact matches.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"routerIds","in":"query","description":"Optional parameter to filter router deployments by router ID. This filter uses multiple exact matches.","schema":{"type":"array","items":{"type":"string"}}},{"name":"switchStackIds","in":"query","description":"Optional parameter to filter router deployments by switch stack id. This filter uses multiple exact matches.","schema":{"type":"array","items":{"type":"string"}}},{"name":"afi","in":"query","description":"Optional parameter to filter deployments on each router by address family identifier (AFI).","schema":{"type":"string","enum":["ipv4"]}},{"name":"safi","in":"query","description":"Optional parameter to filter deployments on each router by subsequent address family identifier (SAFI).","schema":{"type":"string","enum":["unicast"]}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"autonomousSystem":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the autonomous system"},"number":{"type":"integer","description":"The autonomous system number (CLI: 'router bgp \u003cnumber\u003e')"},"description":{"type":"string","description":"A description for the autonomous system"}},"description":"Information regarding the autonomous system the BGP router belongs to"},"network":{"type":"object","properties":{"id":{"type":"string","description":"The network ID"},"name":{"type":"string","description":"The network name"}},"description":"Information regarding the network the router belongs to"},"stack":{"type":"object","properties":{"id":{"type":"string","description":"The switch stack object ID"},"name":{"type":"string","description":"The switch stack name"},"members":{"type":"array","items":{"type":"string"},"description":"The switch stack member serials"}},"description":"Information regarding the switch stack the router belongs to, if applicable"},"switch":{"type":"object","properties":{"serial":{"type":"string","description":"Unique serial number for the router's switch"},"name":{"type":"string","description":"The name of the router's switch"},"model":{"type":"string","description":"The model of the router's switch"}},"description":"The router's switch node. When the router is part of a switch stack, this is the switch stack's active node"},"router":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the router"},"enabled":{"type":"boolean","description":"Whether the router is enabled"},"bgpIdentifier":{"type":"object","properties":{"address":{"type":"string","description":"The router's IP address (CLI: 'bgp router-id \u003caddress\u003e')"},"interfaces":{"type":"object","properties":{"loopback":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the router's loopback L3 interface"},"name":{"type":"string","description":"The name of the router's loopback L3 interface (CLI: 'bgp router-id interface Loopback\u003cname\u003e')"},"number":{"type":"integer","description":"The number of the router's loopback L3 interface "}},"description":"Information regarding the router's loopback L3 interface"}},"description":"Information regarding the router's interfaces, if used instead of a direct IP address"}},"description":"Information regarding the router's bgp identifier, either an IP address or loopback L3 interface. Exactly one of these fields must be be present"}},"description":"Information regarding the BPG router"},"deployments":{"type":"array","items":{"type":"object","properties":{"addressFamily":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the address family"},"afi":{"type":"string","description":"The address family identifier (AFI) denoting the network layer protocol of the address family (e.g. 'ipv4') (CLI: 'address-family \u003cafi\u003e unicast')"},"safi":{"type":"string","description":"The subsequent address family identifier (SAFI) denoting the route type and usage of the address family (e.g. 'unicast') (CLI: 'address-family ipv4 \u003csafi\u003e')"},"vrf":{"type":"object","properties":{"name":{"type":"string","description":"The name of the VRF instance"}},"description":"The Virtual Routing and Forwarding (VRF) options for the address family"}},"description":"Information regarding the address family"},"addressFamilyPrefixes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the address family's prefix"},"prefix":{"type":"string","description":"The IP prefix in CIDR notation (CLI: network \u003cip-address\u003e)"},"enabled":{"type":"boolean","description":"A boolean indicating whether the address family prefix is enabled"},"description":{"type":"string","description":"A description of the address family prefix"}}},"description":"The list of network prefixes to which the address family applies"},"addressFamilyProfile":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the address family profile"},"name":{"type":"string","description":"The name describing the address family profile"},"ebgp":{"type":"object","properties":{"paths":{"type":"object","properties":{"maximum":{"type":"integer","description":"An integer from 1 to 32, which determines how many paths can be installed in the routing table (CLI: 'maximum-paths \u003cmaximum\u003e)'"}},"description":"Options related to the installation of paths in the routing table"}},"description":"Options related to eBGP configuration"},"metrics":{"type":"object","properties":{"default":{"type":"integer","description":"An integer from 0 to 4,294,967,295, which indicates the IGP cost. A lower number indicates a preferred route. (CLI: 'default-metric \u003cdefault\u003e')"}},"description":"Options related to metrics for redistributing routes"},"summarization":{"type":"object","properties":{"auto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"An option allowing BGP to automatically aggregate routes based on their network address (CLI: 'auto-summary')"}},"description":"Options related to the BGP auto summary feature"}},"description":"Options related to summarizing routing information in routing tables"},"redistribution":{"type":"object","properties":{"static":{"type":"object","properties":{"enabled":{"type":"boolean","description":"An option allowing static routes to be injected into the BGP routing table (CLI: 'redistribute static')"}},"description":"Options related to the BGP redistribute static feature"},"connected":{"type":"object","properties":{"enabled":{"type":"boolean","description":"An option allowing the router to inject locally connected network routes into the BGP routing table (CLI: 'redistribute connected')"}},"description":"Options related to the BGP redistribute connected feature"}},"description":"Options related to redistribution of routes from one routing domain into another routing domain"}},"description":"Information regarding the profile applied to the address family"}}},"description":"The list of currently configured address family deployments for this BGP router"}}},"description":"The top-level propery containing all router deployments"},"meta":{"type":"object","properties":{"counts":{"type":"object","properties":{"items":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of router deployments"},"remaining":{"type":"integer","description":"The number of router deployments remaining based on current pagination location within the dataset"}},"description":"The count metadata"}},"description":"Count metadata related to this result set"}},"description":"Other metadata related to this result set"}}},"example":{"items":[{"autonomousSystem":{"id":"123","number":65000,"description":"Core AS"},"network":{"id":"L_123","name":"My network name"},"stack":{"id":"12345","name":"A Switch Stack","members":["Q234-ABCD-0001","Q234-ABCD-0002"]},"switch":{"serial":"Q234-ABCD-0001","name":"Core S1","model":"C9300X-24Y"},"router":{"id":"123","enabled":true,"bgpIdentifier":{"address":"1.2.3.4","interfaces":{"loopback":{"id":"789","name":"1","number":1}}}},"deployments":[{"addressFamily":{"id":"987","afi":"ipv4","safi":"unicast","vrf":{"name":"Default"}},"addressFamilyPrefixes":[{"id":"987","prefix":"10.128.0.0/16","enabled":true,"description":"My prefix description"}],"addressFamilyProfile":{"id":"456","name":"Default address family","ebgp":{"paths":{"maximum":4}},"metrics":{"default":300},"summarization":{"auto":{"enabled":true}},"redistribution":{"static":{"enabled":true},"connected":{"enabled":true}}}}]}],"meta":{"counts":{"items":{"total":1,"remaining":0}}}}}},"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 routers configured in a given organization, including all address families","tags":["switch","configure","routing","bgp","routers","deployments"],"x-release-stage":"beta","__originalOperationId":"getOrganizationSwitchRoutingBgpRoutersDeployments","method":"get","path":"/organizations/{organizationId}/switch/routing/bgp/routers/deployments"}}