Configure Access Points V1 - Cisco Catalyst Center API 2.3.7.7

{"type":"api","title":"Configure Access Points V1","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-7/3b279f20e8e625c794c96f307ed82cded7945b01/4d9020fd-168f-35ec-acc2-076e9170d62e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.7","version":"2.3.7.7"},"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.3","servers":[{"url":"/"}]},"spec":{"operationId":"configureAccessPointsV1","tags":["Wireless"],"deprecated":false,"summary":"Configure Access Points V1","description":"User can configure multiple access points with required options using this intent API.\nThis API does not support configuration of CleanAir or SI for IOS-XE devices with version greater than or equal to 17.9","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."}},"required":["macAddress"]},"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"],"description":"Configure the band on the specified radio for an access point: for 2.4 GHz, set \"RADIO24\"; for 5 GHz, set \"RADIO5\". 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\"."},"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."},"configureCleanAirSI":{"type":"boolean","description":"To enable or disable either CleanAir or Spectrum Intelligence on the specified radio for an access point, set this parameter's value to \"true\"."},"cleanAirSI":{"type":"integer","description":"Configure CleanAir or Spectrum Intelligence on the specified radio for an access point. Set this parameter's value to \"0\" to disable the feature or \"1\" to enable it."},"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."},"isAssignedSiteAsLocation":{"type":"boolean","description":"If AP is assigned to a site, then to assign AP location as the site name, set this parameter's value to \"true\"."}},"required":["apList","radioConfigurations"],"description":"","$$ref":"#/components/schemas/configureAccessPointsV1Request"}}},"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/configureAccessPointsV1Response"}}}},"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":"0081-cb89-4708-888f","x-rapi-overview":"User can configure multiple access points with required options using this intent API.\nThis API does not support configuration of CleanAir or SI for IOS-XE devices with version greater than or equal to 17.9","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/v1/wireless/accesspoint-configuration","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-deprecationMessage":null,"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"configureAccessPointsV1","method":"post","path":"/dna/intent/api/v1/wireless/accesspoint-configuration"}}