{"type":"api","title":"Get Access Point Configuration","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-5/fb6bd2fd4ed9881b625f158495cc80008cb57474/7474746f-141d-3c2c-ab50-b10e1b2b093f","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.5","version":"2.3.7.5"},"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":"getAccessPointConfiguration","tags":["Wireless"],"summary":"Get Access Point Configuration","deprecated":false,"description":"Users can query the access point configuration information per device using the ethernet MAC address","parameters":[{"name":"key","description":"The ethernet MAC address of Access point","required":true,"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":{"instanceUuid":{"type":"object","properties":{},"description":""},"instanceId":{"type":"number","description":""},"authEntityId":{"type":"object","properties":{},"description":""},"displayName":{"type":"string","description":""},"authEntityClass":{"type":"object","properties":{},"description":""},"instanceTenantId":{"type":"string","description":""},"_orderedListOEIndex":{"type":"number","description":""},"_orderedListOEAssocName":{"type":"object","properties":{},"description":""},"_creationOrderIndex":{"type":"number","description":""},"_isBeingChanged":{"type":"boolean","description":""},"deployPending":{"type":"string","description":""},"instanceCreatedOn":{"type":"object","properties":{},"description":""},"instanceUpdatedOn":{"type":"object","properties":{},"description":""},"changeLogList":{"type":"object","properties":{},"description":""},"instanceOrigin":{"type":"object","properties":{},"description":""},"lazyLoadedEntities":{"type":"object","properties":{},"description":""},"instanceVersion":{"type":"number","description":""},"adminStatus":{"type":"string","description":""},"apHeight":{"type":"number","description":""},"apMode":{"type":"string","description":""},"apName":{"type":"string","description":""},"ethMac":{"type":"string","description":""},"failoverPriority":{"type":"string","description":""},"ledBrightnessLevel":{"type":"integer","description":""},"ledStatus":{"type":"string","description":""},"location":{"type":"string","description":""},"macAddress":{"type":"string","description":""},"primaryControllerName":{"type":"string","description":""},"primaryIpAddress":{"type":"string","description":""},"secondaryControllerName":{"type":"string","description":""},"secondaryIpAddress":{"type":"string","description":""},"tertiaryControllerName":{"type":"string","description":""},"tertiaryIpAddress":{"type":"string","description":""},"meshDTOs":{"type":"array","items":{"type":"object","properties":{}},"description":""},"radioDTOs":{"type":"array","items":{"type":"object","properties":{"instanceUuid":{"type":"object","properties":{},"description":""},"instanceId":{"type":"number","description":""},"authEntityId":{"type":"object","properties":{},"description":""},"displayName":{"type":"string","description":""},"authEntityClass":{"type":"object","properties":{},"description":""},"instanceTenantId":{"type":"string","description":""},"_orderedListOEIndex":{"type":"number","description":""},"_orderedListOEAssocName":{"type":"object","properties":{},"description":""},"_creationOrderIndex":{"type":"number","description":""},"_isBeingChanged":{"type":"boolean","description":""},"deployPending":{"type":"string","description":""},"instanceCreatedOn":{"type":"object","properties":{},"description":""},"instanceUpdatedOn":{"type":"object","properties":{},"description":""},"changeLogList":{"type":"object","properties":{},"description":""},"instanceOrigin":{"type":"object","properties":{},"description":""},"lazyLoadedEntities":{"type":"object","properties":{},"description":""},"instanceVersion":{"type":"number","description":""},"adminStatus":{"type":"string","description":""},"antennaAngle":{"type":"number","description":""},"antennaElevAngle":{"type":"number","description":""},"antennaGain":{"type":"integer","description":""},"antennaPatternName":{"type":"string","description":""},"channelAssignmentMode":{"type":"string","description":""},"channelNumber":{"type":"integer","description":""},"channelWidth":{"type":"string","description":""},"cleanAirSI":{"type":"string","description":""},"ifType":{"type":"integer","description":""},"ifTypeValue":{"type":"string","description":""},"macAddress":{"type":"string","description":""},"powerAssignmentMode":{"type":"string","description":""},"powerlevel":{"type":"integer","description":""},"radioBand":{"type":"object","properties":{},"description":""},"radioRoleAssignment":{"type":"object","properties":{},"description":""},"slotId":{"type":"integer","description":""},"internalKey":{"type":"object","properties":{"type":{"type":"string","description":""},"id":{"type":"number","description":""},"longType":{"type":"string","description":""},"url":{"type":"string","description":""}},"description":""}}},"description":""},"internalKey":{"type":"object","properties":{"type":{"type":"string","description":""},"id":{"type":"number","description":""},"longType":{"type":"string","description":""},"url":{"type":"string","description":""}},"description":""}},"description":"","$$ref":"#/components/schemas/getAccessPointConfigurationResponse"}}}},"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":"a191-f9f2-4cb8-9a55","x-rapi-overview":"Users can query the access point configuration information per device using the ethernet MAC address","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wireless","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/ap-configuration/getApByEthernetMacAddress","x-rapi-publicPath":"/dna/intent/api/v1/wireless/accesspoint-configuration/summary","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"getAccessPointConfiguration","method":"get","path":"/dna/intent/api/v1/wireless/accesspoint-configuration/summary"}}