{"type":"api","title":"Get Reserve IP Subpool","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":"getReserveIPSubpool","tags":["Network Settings"],"summary":"Get Reserve IP Subpool","deprecated":false,"description":"Deprecated since Catalyst Center Release 2.3.7.9\nAlternative:\nGET: /dna/intent/api/v1/ipam/siteIpAddressPools\nAPI to get the ip subpool info.","parameters":[{"name":"siteId","description":"site id of site from which to retrieve associated reserve pools. Either siteId (per site queries) or ignoreInheritedGroups must be used. They can also be used together. ","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"offset/starting row. Indexed from 1.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Number of reserve pools to be retrieved. Default is 25 if not specified. Maximum allowed limit is 500.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"ignoreInheritedGroups","description":"Ignores pools inherited from parent site. Either siteId or ignoreInheritedGroups must be passed. They can also be used together.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"poolUsage","description":"Can take values empty, partially-full or empty-partially-full","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"groupName","description":"Name of the group","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"groupName":{"type":"string","description":""},"ipPools":{"type":"array","items":{"type":"object","properties":{"ipPoolName":{"type":"string","description":""},"dhcpServerIps":{"type":"array","items":{"type":"object"},"description":""},"gateways":{"type":"array","items":{"type":"string"},"description":""},"createTime":{"type":"integer","description":""},"lastUpdateTime":{"type":"integer","description":""},"totalIpAddressCount":{"type":"integer","description":""},"usedIpAddressCount":{"type":"integer","description":""},"parentUuid":{"type":"string","description":""},"owner":{"type":"string","description":""},"shared":{"type":"boolean","description":""},"overlapping":{"type":"boolean","description":""},"configureExternalDhcp":{"type":"boolean","description":""},"usedPercentage":{"type":"string","description":""},"clientOptions":{"type":"object","properties":{},"description":""},"groupUuid":{"type":"string","description":""},"dnsServerIps":{"type":"array","items":{"type":"object"},"description":""},"context":{"type":"array","items":{"type":"object","properties":{"owner":{"type":"string","description":""},"contextKey":{"type":"string","description":""},"contextValue":{"type":"string","description":""}}},"description":""},"ipv6":{"type":"boolean","description":""},"id":{"type":"string","description":""},"ipPoolCidr":{"type":"string","description":""}}},"description":""},"siteId":{"type":"string","description":""},"siteHierarchy":{"type":"string","description":""},"type":{"type":"string","description":""},"groupOwner":{"type":"string","description":""}}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetReserveIPSubpoolResponse"}}}},"202":{"description":"The request has been accepted for execution.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"4586-0917-4fab-87e2","x-rapi-overview":"API to get the ip subpool info.","x-rapi-domain":"Site Management","x-rapi-subdomain":"Network Settings","x-rapi-version":"1.0.0","x-rapi-banner":["Intent","Sunset"],"x-rapi-rateLimiting":"100~1","__originalOperationId":"getReserveIPSubpool","method":"get","path":"/dna/intent/api/v1/reserve-ip-subpool"}}