Add fabric devices layer 3 handoffs with ip transit - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Add fabric devices layer 3 handoffs with ip transit","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"addFabricDevicesLayer3HandoffsWithIpTransit","tags":["SDA"],"deprecated":false,"summary":"Add fabric devices layer 3 handoffs with ip transit","description":"Adds layer 3 handoffs with ip transit in fabric devices based on user input.","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"networkDeviceId":{"type":"string","description":"Network device ID of the fabric device."},"fabricId":{"type":"string","description":"ID of the fabric this device is assigned to."},"transitNetworkId":{"type":"string","description":"ID of the transit network of the layer 3 handoff ip transit."},"interfaceName":{"type":"string","description":"Interface name of the layer 3 handoff ip transit."},"externalConnectivityIpPoolName":{"type":"string","description":"External connectivity ip pool will be used by Catalyst Center to allocate IP address for the connection between the border node and peer."},"virtualNetworkName":{"type":"string","description":"Name of the virtual network associated with this fabric site."},"vlanId":{"type":"integer","description":"VLAN number for the Switch Virtual Interface (SVI) used to establish BGP peering with the external domain for the virtual network. Allowed VLAN range is 2-4094 except for reserved vlans (1, 1002-1005, 2046, 4094)."},"tcpMssAdjustment":{"type":"integer","description":"TCP maximum segment size (mss) value for the layer 3 handoff. Allowed range is [500-1440]. TCP MSS Adjustment value is applicable for the TCP sessions over both IPv4 and IPv6."},"localIpAddress":{"type":"string","description":"Local ipv4 address for the selected virtual network. Enter the IP addresses and subnet mask in the CIDR notation (IP address/prefix-length). Not applicable if you have already provided an external connectivity ip pool name."},"remoteIpAddress":{"type":"string","description":"Remote ipv4 address for the selected virtual network. Enter the IP addresses and subnet mask in the CIDR notation (IP address/prefix-length). Not applicable if you have already provided an external connectivity ip pool name."},"localIpv6Address":{"type":"string","description":"Local ipv6 address for the selected virtual network. Enter the IP addresses and subnet mask in the CIDR notation (IP address/prefix-length). Not applicable if you have already provided an external connectivity ip pool name."},"remoteIpv6Address":{"type":"string","description":"Remote ipv6 address for the selected virtual network. Enter the IP addresses and subnet mask in the CIDR notation (IP address/prefix-length). Not applicable if you have already provided an external connectivity ip pool name."}}},"description":"Layer 3 handoff ip transit create request root element.","$$ref":"#/components/schemas/AddFabricDevicesLayerHandoffsWithIpTransitRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":"ID of the task."},"url":{"type":"string","description":"Task status lookup url."}},"description":"Response body."},"version":{"type":"string","description":"Version number."}},"description":"Asynchronous response.","$$ref":"#/components/schemas/AddFabricDevicesLayerHandoffsWithIpTransitResponse"}}}},"202":{"description":"Request Accepted. Further tracking information available in response body.","content":{}},"400":{"description":"Bad Request. The client made a request that the server could not understand.","content":{}},"404":{"description":"Not Found. The client made a request for a resource that does not exist.","content":{}},"500":{"description":"Internal Server Error. The server could not fulfill the request.","content":{}}},"x-rapi-id":"248b-d8b2-4c69-b397","x-rapi-overview":"Adds layer 3 handoffs with ip transit in fabric devices based on user input.","x-rapi-domain":"Connectivity","x-rapi-subdomain":"SDA","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/sda-helper-service/sda-open-api/fabricDevices/layer3Handoffs/ipTransits","x-rapi-publicPath":"/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"addFabricDevicesLayer3HandoffsWithIpTransit","method":"post","path":"/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits"}}