Add, Update or Remove SSID mapping to a VLAN - Cisco Catalyst Center 2.3.7

{"type":"api","title":"Add, Update or Remove SSID mapping to a VLAN","meta":{"id":"/apps/pubhub/media/cisco-dna-center-api-2-3-7/cfd5b603aed2287d655a303aa675cd87535c542b/dbf2de2b-cd1c-3bea-8b53-7a764448a2d6","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7","version":"2.3.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.1","servers":[{"url":"/"}]},"spec":{"operationId":"add_UpdateOrRemoveSSIDMappingToAVLAN","tags":["Fabric Wireless"],"summary":"Add, Update or Remove SSID mapping to a VLAN","description":"Add, update, or remove SSID mappings to a VLAN. If the payload doesn't contain a 'vlanName' which has SSIDs mapping done earlier then all the mapped SSIDs of the 'vlanName' is cleared. The request must include all SSIDs currently mapped to a VLAN, as determined by the response from the GET operation for the same fabricId used in the request. If an already-mapped SSID is not included in the payload, its mapping will be removed by this API. Conversely, if a new SSID is provided, it will be added to the Mapping. Ensure that any new SSID added is a Fabric SSID. This API can also be used to add a VLAN and associate the relevant SSIDs with it. The 'vlanName' must be 'Fabric Wireless Enabled' and should be part of the Fabric Site representing 'Fabric ID' specified in the API request.","parameters":[{"name":"Content-Type","description":"Content Type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"fabricId","description":"The 'fabricId' represents the Fabric ID of a particular Fabric Site","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"vlanName":{"type":"string","description":""},"ssidDetails":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the SSID"},"securityGroupTag":{"type":"string","description":"Represents the name of the Security Group. Example: Auditors, BYOD, Developers, etc."}},"required":["name"]},"description":""}}},"description":"","$$ref":"#/components/schemas/AddUpdateOrRemoveSSIDMappingToAVLANRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":"Task ID"},"url":{"type":"string","description":"Task URL"}},"required":["taskId","url"],"description":"Response"},"version":{"type":"string","description":"Version"}},"required":["response","version"],"description":"","$$ref":"#/components/schemas/AddUpdateOrRemoveSSIDMappingToAVLANResponse"}}}},"202":{"description":"Successful Operation","content":{}},"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":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"07af-b879-4c2a-983b","x-rapi-overview":"Add, update, or remove SSID mappings to a VLAN. If the payload doesn't contain a 'vlanName' which has SSIDs mapping done earlier then all the mapped SSIDs of the 'vlanName' is cleared. The request must include all SSIDs currently mapped to a VLAN, as determined by the response from the GET operation for the same fabricId used in the request. If an already-mapped SSID is not included in the payload, its mapping will be removed by this API. Conversely, if a new SSID is provided, it will be added to the Mapping. Ensure that any new SSID added is a Fabric SSID. This API can also be used to add a VLAN and associate the relevant SSIDs with it. The 'vlanName' must be 'Fabric Wireless Enabled' and should be part of the Fabric Site representing 'Fabric ID' specified in the API request.","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Fabric Wireless","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/sda/fabrics/${fabricId}/vlanToSsids","x-rapi-publicPath":"/dna/intent/api/v1/sda/fabrics/${fabricId}/vlanToSsids","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"add,UpdateOrRemoveSSIDMappingToAVLAN","method":"put","path":"/dna/intent/api/v1/sda/fabrics/{fabricId}/vlanToSsids"}}