Get AP Profile by ID - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Get AP Profile by ID","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":"getAPProfileByID","tags":["Wireless"],"summary":"Get AP Profile by ID","deprecated":false,"description":"This API allows the user to get a AP Profile by AP Profile ID that captured in wireless settings design","parameters":[{"name":"id","description":"Ap Profile ID","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"responses":{"200":{"description":"Request was successful and 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":"AP Profile unique ID"},"apProfileName":{"type":"string","description":"Name of the Access Point profile. Max length is 32 characters."},"description":{"type":"string","description":"Description of the AP profile. Max length is 241 characters"},"remoteWorkerEnabled":{"type":"boolean","description":"Indicates if remote worker mode is enabled on the AP. Remote teleworker enabled profile cannot support security features like aWIPS,Forensic Capture Enablement, Rogue Detection and Rogue Containment."},"managementSetting":{"type":"object","properties":{"authType":{"type":"string","enum":["NO-AUTH","EAP-TLS","EAP-PEAP","EAP-FAST"],"description":"Authentication type used in the AP profile. These setting are applicable during PnP claim and for day-N authentication of AP. Changing these settings will be service impacting for the PnP onboarded APs and will need a factory-reset for those APs."},"dot1xUsername":{"type":"string","description":"Username for 802.1X authentication. dot1xUsername must have a minimum of 1 character and a maximum of 32 characters."},"dot1xPassword":{"type":"string","description":"Password for 802.1X authentication. AP dot1x password length should not exceed 120."},"sshEnabled":{"type":"boolean","description":"Indicates if SSH is enabled on the AP. Enable SSH add credentials for device management."},"telnetEnabled":{"type":"boolean","description":"Indicates if Telnet is enabled on the AP. Enable Telnet to add credentials for device management."},"managementUserName":{"type":"string","description":"Management username must have a minimum of 1 character and a maximum of 32 characters."},"managementPassword":{"type":"string","description":"Management password for the AP. Length must be 8-120 characters."},"managementEnablePassword":{"type":"string","description":"Enable password for managing the AP. Length must be 8-120 characters."},"cdpState":{"type":"boolean","description":"Indicates if CDP is enabled on the AP. Enable CDP in order to make Cisco Access Points known to its neighboring devices and vice-versa."}},"description":"These setting are applicable during PnP claim and for day-N authentication of AP. Changing these settings will be service impacting for the PnP onboarded APs and will need a factory-reset for those APs and Enable SSH and Telnet to add credentials for device management."},"awipsEnabled":{"type":"boolean","description":"Indicates if AWIPS is enabled on the AP."},"awipsForensicEnabled":{"type":"boolean","description":"Indicates if AWIPS forensic is enabled on the AP. Forensic Capture is supported from IOS-XE version 17.4 and above. Forensic Capture can be activated only if aWIPS is enabled."},"rogueDetectionSetting":{"type":"object","properties":{"rogueDetection":{"type":"boolean","description":"Indicates if rogue detection is enabled on the AP. Detect Access Points that have been installed on a secure network without explicit authorization from a system administrator and configure rogue general configuration parameters"},"rogueDetectionMinRssi":{"type":"integer","description":"Minimum RSSI for rogue detection. Value should be in range -128 decibel milliwatts and -70 decibel milliwatts"},"rogueDetectionTransientInterval":{"type":"integer","description":"Transient interval for rogue detection. Value should be 0 or from 120 to 1800."},"rogueDetectionReportInterval":{"type":"integer","description":"Report interval for rogue detection. Value should be in range 10 and 300."}},"description":"Detect Access Points that have been installed on a secure network without explicit authorization from a system administrator and configure rogue general configuration parameters"},"pmfDenialEnabled":{"type":"boolean","description":"Indicates if PMF denial is active on the AP. PMF Denial is supported from IOS-XE version 17.12 and above."},"meshEnabled":{"type":"boolean","description":"This indicates whether mesh networking is enabled on the AP. For IOS-XE devices, when mesh networking is enabled, a custom mesh profile with the configured parameters will be created and mapped to the AP join profile on the device. When mesh networking is disabled, any existing custom mesh profile will be deleted from the device, and the AP join profile will be mapped to the default mesh profile on the device."},"meshSetting":{"type":"object","properties":{"bridgeGroupName":{"type":"string","description":"Name of the bridge group for mesh settings. If not configured, 'Default' Bridge group name will be used in mesh profile."},"backhaulClientAccess":{"type":"boolean","description":"Indicates if backhaul client access is enabled on the AP."},"range":{"type":"integer","description":"Range of the mesh network. Value should be between 150-132000"},"ghz5BackhaulDataRates":{"type":"string","enum":["auto","802.11abg","802.12ac","802.11ax","802.11n"],"description":"5GHz backhaul data rates."},"ghz24BackhaulDataRates":{"type":"string","enum":["auto","802.11abg","802.11ax","802.11n"],"description":"2.4GHz backhaul data rates."},"rapDownlinkBackhaul":{"type":"string","enum":["5 GHz","2.4 GHz"],"description":"Type of downlink backhaul used."}},"description":"Settings specific to mesh networking. MAC address of APs in mesh mode must be added to the AP Authorization list."},"apPowerProfileName":{"type":"string","description":"Name of the existing AP power profile."},"calendarPowerProfiles":{"type":"object","properties":{"powerProfileName":{"type":"string","description":"Name of the existing AP power profile to be mapped to the calendar power profile. API-/intent/api/v1/wirelessSettings/powerProfiles."},"schedulerType":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY"],"description":"Type of the scheduler."},"duration":{"type":"object","properties":{"schedulerStartTime":{"type":"string","description":"Start time of the duration setting."},"schedulerEndTime":{"type":"string","description":"End time of the duration setting."},"schedulerDay":{"type":"string","description":"Applies every week on the selected days"},"schedulerDate":{"type":"string","description":"Start and End date of the duration setting, applicable for MONTHLY schedulers."}},"description":""}},"description":"Represents a calendar-based power profile setting. You can map multiple Power Profiles to different calendar schedules based on your requirement."},"countryCode":{"type":"string","enum":["(AF|AE|AL|AR|AT|AO|AU|BD|BA|BB|BE|BG|BH|BM|BN|BO|BR|BT|BY|CA|CD|CH|CI|CL|CM|CN|CO|CR|CU|CY|CZ|DE|DK|DO|DZ|EC|EE|EG|EL|ES|ET|FI|FJ|FR|GB|GH|GI|GE|GR|GT|HK|HN|HR|HU|ID|IE|IL|IN|IQ|IS|IT|J2|J4|JM|JO|KE|KH|KN|KW|KZ|LA|LB|LI|LK|LT|LU|LV|LY|MA|MC|MD|ME|MK|MN|MM|MO|MT|MX|MY|NG|NI|NL|NO|NP|NZ|OM|PA|PE|PH|PK|PL|PR|PT|PY|QA|RO|RS|RU|SA|SD|SE|SG|SI|SK|SM|TH|TI|TN|TR|TW|TZ|UA|US|UY|VA|VE|VN|XK|YE|ZA|ZW|MU|ZM|BI|NA|BW|GA|UG|UZ)"],"description":""},"timeZone":{"type":"string","enum":["Not Configured","Controller","Delta from Controller"],"description":" In the Time Zone area, choose one of the following options. Not Configured - APs operate in the UTC time zone. Controller - APs operate in the Cisco Wireless Controller time zone. Delta from Controller - APs operate in the offset time from the wireless controller time zone."},"timeZoneOffsetHour":{"type":"integer","description":"Enter the hour value (HH). The valid range is from -12 through 14."},"timeZoneOffsetMinutes":{"type":"integer","description":"Enter the minute value (MM). The valid range is from 0 through 59."},"clientLimit":{"type":"integer","description":"Number of clients. Value should be between 0-1200."}}},"description":""},"version":{"type":"string","description":"Version"}},"description":"ApProfiles","$$ref":"#/components/schemas/GetAPProfileByIDResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"Request failed because of unknown failure on the server.","content":{}}},"x-rapi-id":"ba9f-5899-4c5b-87f2","x-rapi-overview":"This API allows the user to get a AP Profile by AP Profile ID that captured in wireless settings design","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wireless","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/wirelessSettings/apProfiles/${id}","x-rapi-publicPath":"/dna/intent/api/v1/wirelessSettings/apProfiles/${id}","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getAPProfileByID","method":"get","path":"/dna/intent/api/v1/wirelessSettings/apProfiles/{id}"}}