{"type":"api","title":"Create Organization Switch Routing Bgp Peers Groups Deploy","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":"Create or update a peer group, in addition to an associated peer group profile, peer group address family binding, peer group address family binding profile and routing policies associated with the peer group. Border Gateway Protocol requires IOS XE 17.18 or higher","operationId":"createOrganizationSwitchRoutingBgpPeersGroupsDeploy","parameters":[{"name":"organizationId","in":"path","description":"Organization ID","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addressFamily":{"type":"object","properties":{"id":{"type":"string","description":"The address family object ID"}},"description":"Information regarding the address family the peer group address family binding belongs to"},"network":{"type":"object","properties":{"id":{"type":"string","description":"The network ID"}},"description":"Information regarding the network the peer group profile belongs to"},"peerGroup":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the peer group. Only required when updating."},"name":{"type":"string","description":"Name of the peer group (CLI: 'neighbor \u003cname\u003e peer-group')"}},"description":"Information regarding the peer group"},"peerGroupAddressFamilyBinding":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the peer group address family binding. Only required when updating."}},"description":"Information regarding the peer group address family binding. Only required when updating."},"peerGroupAddressFamilyBindingProfile":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the peer group address family binding profile Only required when updating."},"advertisement":{"type":"object","properties":{"interval":{"type":"integer","description":"Minimal interval between sending BGP routing updates (CLI: 'neighbor IBGP advertisement-interval \u003cinterval\u003e')"},"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","enum":["inbound"],"description":"The direction of soft reconfiguration being enabled (CLI: 'neighbor IBGP soft-reconfiguration \u003csoft_reconfiguration\u003e')"}},"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')"}},"description":"Information regarding the peer group address family binding profile"},"peerGroupProfile":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the peer group profile. Only required when updating."},"description":{"type":"string","description":"The description of the peer group profile (CLI: 'neighbor EBGP description \u003cdescription\u003e')"},"ebgp":{"type":"object","properties":{"connectedCheck":{"type":"object","properties":{"enabled":{"type":"boolean","description":"The option to enable the precautionary check as to whether the client is on a directly connected network (CLI: 'neighbor IBGP 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 IBGP ebgp-multihop \u003cmaximum\u003e')"}},"description":"Options related to the time to live (TTL) value for the packets carrying BGP messages"}},"description":"Options related to eBGP configuration"},"password":{"type":"string","description":"BGP password used to authenticate BGP peers and prevent unauthorized access (CLI: 'neighbor IBGP password \u003cpassword\u003e)"},"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 IBGP timers 60 \u003chold\u003e')"},"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 IBGP timers \u003ckeepalive\u003e 180')"}},"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 EBGP remote-as \u003cnumber\u003e')"}},"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"}},"description":"Options related to the BGP loopback source interface"}},"description":"Options related to BGP loopback interfaces"}},"description":"Options related to BGP interfaces"}},"description":"Information regarding the peer group profile"},"policies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the filter policy. Only required when updating."},"direction":{"type":"string","enum":["in","out"],"description":"The direction of traffic the policy is applied to (CLI: 'neighbor IBGP filter-list 5 \u003cdirection\u003e' or 'neighbor 10.10.248.254 prefix-list NoPrivateNets \u003cdirection\u003e')"},"ruleList":{"type":"object","properties":{"type":{"type":"string","enum":["Filter list","Prefix list"],"description":"The type of filter list"},"id":{"type":"string","description":"The filter list object ID"}},"description":"Information regarding the list of filter rules that the policy uses"},"destroy":{"type":"boolean","description":"Flag to indicate if the filter policy should be destroyed"}}},"description":"Information regarding the routing policies"},"router":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the router"}},"description":"Information regarding the router this peer group belongs to"}},"example":{"addressFamily":{"id":"456"},"network":{"id":"L_123"},"peerGroup":{"id":"123","name":"MyPeerGroup"},"peerGroupAddressFamilyBinding":{"id":"123"},"peerGroupAddressFamilyBindingProfile":{"id":"123","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},"peerGroupProfile":{"id":"123","description":"Standard settings","ebgp":{"connectedCheck":{"enabled":true},"multihop":{"maximum":10}},"password":"my password","timers":{"hold":90,"keepalive":30},"autonomousSystem":{"remote":{"number":65000}},"interfaces":{"loopback":{"source":{"id":"555"}}}},"policies":[{"id":"123","direction":"in","ruleList":{"type":"Prefix list","id":"789"},"destroy":true}],"router":{"id":"888"}},"required":["addressFamily","network","peerGroup","peerGroupAddressFamilyBindingProfile","peerGroupProfile","policies","router"]}}},"required":true},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"addressFamily":{"type":"object","properties":{"id":{"type":"string","description":"The address family object ID"},"description":{"type":"string","description":"The address family afi and safi (i.e. 'ipv4 unicast') (CLI: 'address-family \u003cdescription\u003e')"}},"description":"Information regarding the address family the peer group address family binding 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 peer group belongs to"},"peerGroup":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the peer group"},"name":{"type":"string","description":"Name of the peer group (CLI: 'neighbor \u003cname\u003e peer-group')"}},"description":"Information regarding the peer group"},"peerGroupAddressFamilyBinding":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the peer group address family binding"}},"description":"Information regarding the peer group address family binding. Only required when updating."},"peerGroupAddressFamilyBindingProfile":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the peer group address family binding profile"},"advertisement":{"type":"object","properties":{"interval":{"type":"integer","description":"Minimal interval between sending BGP routing updates (CLI: 'neighbor IBGP advertisement-interval \u003cinterval\u003e')"},"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"},"name":{"type":"string","description":"The name of the peer group address family binding profile"},"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')"}},"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')"}},"description":"Information regarding the peer group address family binding profile"},"peerGroupProfile":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the peer group profile"},"name":{"type":"string","description":"The name for the peer group profile"},"description":{"type":"string","description":"The description of the peer group profile (CLI: 'neighbor EBGP description \u003cdescription\u003e')"},"ebgp":{"type":"object","properties":{"connectedCheck":{"type":"object","properties":{"enabled":{"type":"boolean","description":"The option to enable the precautionary check as to whether the client is on a directly connected network (CLI: 'neighbor IBGP 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 IBGP ebgp-multihop \u003cmaximum\u003e')"}},"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 profile has a password configured"},"password":{"type":"string","description":"BGP password used to authenticate BGP peers and prevent unauthorized access (CLI: 'neighbor IBGP password \u003cpassword\u003e)"}},"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 IBGP timers 60 \u003chold\u003e')"},"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 IBGP timers \u003ckeepalive\u003e 180')"}},"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 EBGP remote-as \u003cnumber\u003e')"}},"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"},"name":{"type":"string","description":"The loopback interface descriptive number (CLI: neighbor IBGP update-source Loopback\u003cname\u003e)"},"number":{"type":"integer","description":"The loopback interface number "}},"description":"Options related to the BGP loopback source interface"}},"description":"Options related to BGP loopback interfaces"}},"description":"Options related to BGP interfaces"}},"description":"Information regarding the peer group profile"},"policies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the policy"},"ruleList":{"type":"object","properties":{"type":{"type":"string","enum":["Filter list","Prefix list"],"description":"The type of filter list"},"name":{"type":"string","description":"The name of the rule list For filter lists, this value corresponds to the list number (CLI: 'neighbor IBGP filter-list \u003cname\u003e in' or 'neighbor 10.10.248.254 prefix-list \u003cname\u003e in')"},"id":{"type":"string","description":"The filter list object ID"}},"description":"Information regarding the list of filter rules that the policy uses"},"direction":{"type":"string","enum":["in","out"],"description":"The direction of traffic the policy is applied to (CLI: 'neighbor IBGP filter-list 5 \u003cdirection\u003e' or 'neighbor 10.10.248.254 prefix-list NoPrivateNets \u003cdirection\u003e')"}}},"description":"Information regarding the routing policies"},"router":{"type":"object","properties":{"id":{"type":"string","description":"Object ID for the router"}},"description":"Information regarding the router this peer group belongs to"}}},"example":{"addressFamily":{"id":"456","description":"ipv4 unicast"},"network":{"id":"L_123","name":"My network name"},"peerGroup":{"id":"999","name":"MyPeerGroup"},"peerGroupAddressFamilyBinding":{"id":"123"},"peerGroupAddressFamilyBindingProfile":{"id":"123","advertisement":{"interval":20,"defaultRoutes":{"enabled":true}},"communityAttribute":{"send":{"enabled":true}},"name":"Sample binding profile","nextHop":{"self":{"enabled":true},"unchanged":{"enabled":false}},"removePrivateAs":{"enabled":true},"routeReflector":{"client":{"enabled":false}},"softReconfiguration":{"direction":"inbound"},"weight":30},"peerGroupProfile":{"id":"456","name":"DefaultPeerGroup","description":"Standard settings","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}}}},"policies":[{"id":"123","ruleList":{"type":"Prefix list","name":"SamplePrefixListName","id":"789"},"direction":"in"}],"router":{"id":"888"}}}}}},"security":[{"oauth2":["switch:config:write"]}],"summary":"Create or update a peer group, in addition to an associated peer group profile, peer group address family binding, peer group address family binding profile and routing policies associated with the peer group","tags":["switch","configure","routing","bgp","peers","groups","deploy"],"x-release-stage":"beta","__originalOperationId":"createOrganizationSwitchRoutingBgpPeersGroupsDeploy","method":"post","path":"/organizations/{organizationId}/switch/routing/bgp/peers/groups/deploy"}}