Configure Access Points V2 - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Configure Access Points V2","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/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":"configureAccessPointsV2","tags":["Wireless"],"deprecated":false,"summary":"Configure Access Points V2","description":"User can configure multiple access points with required options using this intent API","parameters":[{"name":"Content-Type","description":"Request body content type","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"apList":{"type":"array","items":{"type":"object","properties":{"apName":{"type":"string","description":"The current host name of the access point."},"macAddress":{"type":"string","description":"The ethernet MAC address of the access point."},"apNameNew":{"type":"string","description":"The modified hostname of the access point."}}},"description":"The list of access points to configure."},"configureAdminStatus":{"type":"boolean","description":"To change the access point's admin status, set this parameter's value to \"true\"."},"adminStatus":{"type":"boolean","description":"Configure the access point's admin status. Set this parameter's value to \"true\" to enable it and \"false\" to disable it."},"configureApMode":{"type":"boolean","description":"To change the access point's mode, set this parameter's value to \"true\"."},"apMode":{"type":"integer","description":"Configure the access point's mode: for local/flexconnect mode, set \"0\"; for monitor mode, set \"1\"; for sniffer mode, set \"4\"; and for bridge/flex+bridge mode, set \"5\"."},"configureFailoverPriority":{"type":"boolean","description":"To change the access point's failover priority, set this parameter's value to \"true\"."},"failoverPriority":{"type":"integer","description":"Configure the acess point's failover priority: for low, set \"1\"; for medium, set \"2\"; for high, set \"3\"; and for critical, set \"4\"."},"configureLedStatus":{"type":"boolean","description":"To change the access point's LED status, set this parameter's value to \"true\"."},"ledStatus":{"type":"boolean","description":"Configure the access point's LED status. Set \"true\" to enable its status and \"false\" to disable it."},"configureLedBrightnessLevel":{"type":"boolean","description":"To change the access point's LED brightness level, set this parameter's value to \"true\"."},"ledBrightnessLevel":{"type":"integer","description":"Configure the access point's LED brightness level by setting a value between 1 and 8."},"configureLocation":{"type":"boolean","description":"To change the access point's location, set this parameter's value to \"true\"."},"location":{"type":"string","description":"Configure the access point's location."},"configureHAController":{"type":"boolean","description":"To change the access point's HA controller, set this parameter's value to \"true\"."},"primaryControllerName":{"type":"string","description":"Configure the hostname for an access point's primary controller."},"primaryIpAddress":{"type":"object","properties":{"address":{"type":"string","description":"Configure the IP address for an access point's primary controller."}},"description":"The list of IP address for an access point's primary controller."},"secondaryControllerName":{"type":"string","description":"Configure the hostname for an access point's secondary controller."},"secondaryIpAddress":{"type":"object","properties":{"address":{"type":"string","description":"Configure the IP address for an access point's secondary controller."}},"description":": The list of IP address for an access point's secondary controller."},"tertiaryControllerName":{"type":"string","description":"Configure the hostname for an access point's tertiary controller."},"tertiaryIpAddress":{"type":"object","properties":{"address":{"type":"string","description":"Configure the IP address for an access point's tertiary controller."}},"description":"The list of IP address for an access point's tertiary controller."},"radioConfigurations":{"type":"array","items":{"type":"object","properties":{"configureRadioRoleAssignment":{"type":"boolean","description":"To change the radio role on the specified radio for an access point, set this parameter's value to \"true\"."},"radioRoleAssignment":{"type":"string","enum":["auto","serving","monitor"],"description":"Configure only one of the following roles on the specified radio for an access point as \"AUTO\", \"SERVING\", or \"MONITOR\". Any other string is invalid, including empty string."},"radioBand":{"type":"string","enum":["RADIO24","RADIO5","RADIO6"],"description":"Configure the band on the specified radio for an access point: for 2.4 GHz, set \"RADIO24\"; for 5 GHz, set \"RADIO5\"; for 6 GHz, set \"RADIO6\". Any other string is invalid, including empty string."},"configureAdminStatus":{"type":"boolean","description":"To change the admin status on the specified radio for an access point, set this parameter's value to \"true\"."},"adminStatus":{"type":"boolean","description":"Configure the admin status on the specified radio for an access point. Set this parameter's value to \"true\" to enable it and \"false\" to disable it."},"configureAntennaPatternName":{"type":"boolean","description":"To change the antenna gain on the specified radio for an access point, set the value for this parameter to \"true\"."},"antennaPatternName":{"type":"string","description":"Specify the antenna name on the specified radio for an access point. The antenna name is used to calculate the gain on the radio slot."},"antennaGain":{"type":"integer","description":"Configure the antenna gain on the specified radio for an access point by setting a decimal value (in dBi). To configure \"antennaGain\", set \"antennaPatternName\" value to \"other\". The External Antenna Gain value will be applied in 0.5 dBi increments on the controller. Therefore, the value entered will be multiplied by 2 to configure the absolute gain value. AntennaGain should be in range of 0-20."},"configureAntennaCable":{"type":"boolean","description":"To change the antenna cable name on the specified radio for an access point, set this parameter's value to \"true\"."},"antennaCableName":{"type":"string","description":"Configure the antenna cable name on the specified radio for an access point. If cable loss needs to be configured, set this parameter's value to \"other\". "},"cableLoss":{"type":"number","description":"Configure the cable loss on the specified radio for an access point by setting a decimal value (in dBi)."},"configureChannel":{"type":"boolean","description":"To change the channel on the specified radio for an access point, set this parameter's value to \"true\"."},"channelAssignmentMode":{"type":"integer","description":"Configure the channel assignment mode on the specified radio for an access point: for global mode, set \"1\"; and for custom mode, set \"2\"."},"channelNumber":{"type":"integer","description":"Configure the channel number on the specified radio for an access point."},"configureChannelWidth":{"type":"boolean","description":"To change the channel width on the specified radio for an access point, set this parameter's value to \"true\"."},"channelWidth":{"type":"integer","description":"Configure the channel width on the specified radio for an access point: for 20 MHz, set \"3\"; for 40 MHz, set \"4\"; for 80 MHz, set \"5\"; for 160 MHz, set \"6\", and for 320 MHz, set \"7\"."},"configurePower":{"type":"boolean","description":"To change the power assignment mode on the specified radio for an access point, set this parameter's value to \"true\"."},"powerAssignmentMode":{"type":"integer","description":"Configure the power assignment mode on the specified radio for an access point: for global mode, set \"1\"; and for custom mode, set \"2\"."},"powerlevel":{"type":"integer","description":"Configure the power level on the specified radio for an access point by setting a value between 1 and 8."},"radioType":{"type":"integer","description":"Configure an access point's radio band: for 2.4 GHz, set \"1\"; for 5 GHz, set \"2\"; for XOR, set \"3\"; and for 6 GHz, set \"6\"."}}},"description":"Radio parameters configuration for the selected access points."},"configureCleanAirSI24Ghz":{"type":"boolean","description":"To change the clean air status for radios that are in 2.4 Ghz band, set this parameter's value to \"true\"."},"cleanAirSI24":{"type":"boolean","description":"Configure clean air status for radios that are in 2.4 Ghz band. Set this parameter's value to \"true\" to enable it and \"false\" to disable it."},"configureCleanAirSI5Ghz":{"type":"boolean","description":"To change the clean air status for radios that are in 5 Ghz band, set this parameter's value to \"true\"."},"cleanAirSI5":{"type":"boolean","description":"Configure clean air status for radios that are in 5 Ghz band. Set this parameter's value to \"true\" to enable it and \"false\" to disable it."},"configureCleanAirSI6Ghz":{"type":"boolean","description":"To change the clean air status for radios that are in 6 Ghz band, set this parameter's value to \"true\"."},"cleanAirSI6":{"type":"boolean","description":"Configure clean air status for radios that are in 6 Ghz band. Set this parameter's value to \"true\" to enable it and \"false\" to disable it."},"isAssignedSiteAsLocation":{"type":"boolean","description":"To configure the access point's location as the site assigned to the access point, set this parameter's value to \"true\"."}},"description":"","$$ref":"#/components/schemas/ConfigureAccessPointsVRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":""},"url":{"type":"string","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/ConfigureAccessPointsVResponse"}}}},"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":"5ca7-4a81-4329-9506","x-rapi-overview":"User can configure multiple access points with required options using this intent API","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wireless","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/ap-configuration/deployByEthernetMAC","x-rapi-publicPath":"/dna/intent/api/v2/wireless/accesspoint-configuration","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"configureAccessPointsV2","method":"post","path":"/dna/intent/api/v2/wireless/accesspoint-configuration"}}