{"type":"api","title":"Create SSID","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":"createSSID","tags":["Wireless"],"deprecated":false,"summary":"Create SSID","description":"This API allows the user to create an SSID (Service Set Identifier) at the Global site","parameters":[{"name":"Content-Type","description":"Content Type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"siteId","description":"Site UUID of Global site","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"ssid":{"type":"string","description":"Name of the SSID"},"authType":{"type":"string","enum":["WPA2_ENTERPRISE","WPA2_PERSONAL","OPEN","WPA3_ENTERPRISE","WPA3_PERSONAL","WPA2_WPA3_PERSONAL","WPA2_WPA3_ENTERPRISE","OPEN-SECURED"],"description":"L2 Authentication Type (If authType is not open , then atleast one RSN Cipher Suite and corresponding valid AKM must be enabled). Default is L2 Authentication Type if exists else None."},"passphrase":{"type":"string","description":"Passphrase (Only applicable for SSID with PERSONAL security level). Passphrase needs to be between 8 and 63 characters for ASCII type. HEX passphrase needs to be 64 characters"},"isFastLaneEnabled":{"type":"boolean","description":"True if FastLane is enabled, else False"},"isMacFilteringEnabled":{"type":"boolean","description":"When set to true, MAC Filtering will be activated, allowing control over network access based on the MAC address of the device"},"ssidRadioType":{"type":"string","enum":["Triple band operation(2.4GHz, 5GHz and 6GHz)","5GHz only","2.4GHz only","6GHz only","2.4 and 5 GHz","2.4 and 6 GHz","5 and 6 GHz"],"description":"Radio Policy Enum (default: Triple band operation(2.4GHz, 5GHz and 6GHz))"},"isBroadcastSSID":{"type":"boolean","description":"When activated by setting it to true, the Broadcast SSID feature will make the SSID publicly visible to wireless devices searching for available networks"},"fastTransition":{"type":"string","enum":["ADAPTIVE","ENABLE","DISABLE"],"description":"Fast Transition"},"sessionTimeOutEnable":{"type":"boolean","description":"Turn on the feature that imposes a time limit on user sessions"},"sessionTimeOut":{"type":"integer","description":"This denotes the allotted time span, expressed in seconds, before a session is automatically terminated due to inactivity. Default sessionTimeOut is 1800."},"clientExclusionEnable":{"type":"boolean","description":"Activate the feature that allows for the exclusion of clients"},"clientExclusionTimeout":{"type":"integer","description":"This refers to the length of time, in seconds, a client is excluded or blocked from accessing the network after a specified number of unsuccessful attempts. Default is Client Exclusion Timeout if exists else 180."},"basicServiceSetMaxIdleEnable":{"type":"boolean","description":"Activate the maximum idle feature for the Basic Service Set"},"basicServiceSetClientIdleTimeout":{"type":"integer","description":"This refers to the duration of inactivity, measured in seconds, before a client connected to the Basic Service Set is considered idle and timed out. Default is Basic ServiceSet ClientIdle Timeout if exists else 300."},"directedMulticastServiceEnable":{"type":"boolean","description":"The Directed Multicast Service feature becomes operational when it is set to true"},"neighborListEnable":{"type":"boolean","description":"The Neighbor List feature is enabled when it is set to true"},"managementFrameProtectionClientprotection":{"type":"string","enum":["OPTIONAL","DISABLED","REQUIRED"],"description":"Default is Management Frame Protection Client if exists else Optional."},"nasOptions":{"type":"array","items":{"type":"string"},"description":"Pre-Defined NAS Options : AP ETH Mac Address, AP IP address, AP Location , AP MAC Address, AP Name, AP Policy Tag, AP Site Tag, SSID, System IP Address, System MAC Address, System Name."},"profileName":{"type":"string","description":"WLAN Profile Name, if not passed autogenerated profile name will be assigned. The same wlanProfileName will also be used for policyProfileName"},"aaaOverride":{"type":"boolean","description":"Activate the AAA Override feature when set to true"},"coverageHoleDetectionEnable":{"type":"boolean","description":"Activate Coverage Hole Detection feature when set to true"},"protectedManagementFrame":{"type":"string","enum":["OPTIONAL","DISABLED","REQUIRED"],"description":"(REQUIRED is applicable for authType WPA3_PERSONAL, WPA3_ENTERPRISE, OPEN_SECURED) and (OPTIONAL/REQUIRED is applicable for authType WPA2_WPA3_PERSONAL and WPA2_WPA3_ENTERPRISE)"},"multiPSKSettings":{"type":"array","items":{"type":"object","properties":{"priority":{"type":"integer","description":"Priority"},"passphraseType":{"type":"string","enum":["ASCII","HEX"],"description":"Passphrase Type(default: ASCII)"},"passphrase":{"type":"string","description":"Passphrase needs to be between 8 and 63 characters for ASCII type. HEX passphrase needs to be 64 characters"}}},"description":"Multi PSK Settings (Only applicable for SSID with PERSONAL auth type and PSK)"},"clientRateLimit":{"type":"integer","description":"This pertains to the maximum data transfer rate, specified in bits per second, that a client is permitted to achieve. It should be in mutliples of 500 . Default is Client Rate Limit if exists else 0."},"rsnCipherSuiteGcmp256":{"type":"boolean","description":"When set to true, the Robust Security Network (RSN) Cipher Suite GCMP256 encryption protocol is activated"},"rsnCipherSuiteCcmp256":{"type":"boolean","description":"When set to true, the Robust Security Network (RSN) Cipher Suite CCMP256 encryption protocol is activated"},"rsnCipherSuiteGcmp128":{"type":"boolean","description":"When set to true, the Robust Security Network (RSN) Cipher Suite GCMP128 encryption protocol is activated"},"rsnCipherSuiteCcmp128":{"type":"boolean","description":"When set to true, the Robust Security Network (RSN) Cipher Suite CCMP128 encryption protocol is activated"},"ghz6PolicyClientSteering":{"type":"boolean","description":"True if 6 GHz Policy Client Steering is enabled, else False"},"isAuthKey8021x":{"type":"boolean","description":"When set to true, the 802.1X authentication key is in use"},"isAuthKey8021xPlusFT":{"type":"boolean","description":"When set to true, the 802.1X-Plus-FT authentication key is in use"},"isAuthKey8021x_SHA256":{"type":"boolean","description":"When set to true, the feature that enables 802.1X authentication using the SHA256 algorithm is turned on"},"isAuthKeySae":{"type":"boolean","description":"When set to true, the feature enabling the Simultaneous Authentication of Equals (SAE) authentication key is activated"},"isAuthKeySaePlusFT":{"type":"boolean","description":"Activating this setting by switching it to true turns on the authentication key feature that supports both Simultaneous Authentication of Equals (SAE) and Fast Transition (FT)"},"isAuthKeyPSK":{"type":"boolean","description":"When set to true, the Pre-shared Key (PSK) authentication feature is enabled"},"isAuthKeyPSKPlusFT":{"type":"boolean","description":"When set to true, the feature that enables the combination of Pre-shared Key (PSK) and Fast Transition (FT) authentication keys is activated"},"isAuthKeyOWE":{"type":"boolean","description":"When set to true, the Opportunistic Wireless Encryption (OWE) authentication key feature is turned on"},"isAuthKeyEasyPSK":{"type":"boolean","description":"When set to true, the feature that enables the use of Easy Pre-shared Key (PSK) authentication is activated"},"isAuthKeyPSKSHA256":{"type":"boolean","description":"The feature that allows the use of Pre-shared Key (PSK) authentication with the SHA256 algorithm is enabled when it is set to true"},"openSsid":{"type":"string","description":"Open SSID which is already created in the design and not associated to any other OPEN-SECURED SSID"},"wlanBandSelectEnable":{"type":"boolean","description":"Band select is allowed only when band options selected contains at least 2.4 GHz and 5 GHz band else false."},"isEnabled":{"type":"boolean","description":"Set SSID's admin status as 'Enabled' when set to true"},"authServers":{"type":"array","items":{"type":"string"},"description":"List of Authentication/Authorization server IpAddresses"},"acctServers":{"type":"array","items":{"type":"string"},"description":"List of Accounting server IpAddresses"},"egressQos":{"type":"string","enum":["PLATINUM","SILVER","GOLD","BRONZE"],"description":"Egress QOS"},"ingressQos":{"type":"string","enum":["PLATINUM-UP","SILVER-UP","GOLD-UP","BRONZE-UP"],"description":"Ingress QOS"},"wlanType":{"type":"string","enum":["Enterprise","Guest"],"description":"Wlan Type"},"l3AuthType":{"type":"string","enum":["open","web_auth"],"description":"Default is L3 Authentication Type if exists else None."},"authServer":{"type":"string","enum":["auth_ise","auth_external","auth_internal"],"description":"Authentication Server, Mandatory for Guest SSIDs with wlanType=Guest and l3AuthType=web_auth"},"externalAuthIpAddress":{"type":"string","description":"External WebAuth URL (Mandatory for Guest SSIDs with wlanType = Guest, l3AuthType = web_auth and authServer = auth_external)"},"webPassthrough":{"type":"boolean","description":"When set to true, the Web-Passthrough feature will be activated for the Guest SSID, allowing guests to bypass certain login requirements"},"sleepingClientEnable":{"type":"boolean","description":"When set to true, this will activate the timeout settings that apply to clients in sleep mode"},"sleepingClientTimeout":{"type":"integer","description":"This refers to the amount of time, measured in minutes, before a sleeping (inactive) client is timed out of the network. Default is Sleeping Client Timeout if exists else 720."},"aclName":{"type":"string","description":"Pre-Auth Access Control List (ACL) Name"},"isPosturingEnabled":{"type":"boolean","description":"Applicable only for Enterprise SSIDs. When set to True, Posturing will enabled. Required to be set to True if ACL needs to be mapped for Enterprise SSID. "},"isAuthKeySuiteB1x":{"type":"boolean","description":"When activated by setting it to true, the SuiteB-1x authentication key feature is engaged."},"isAuthKeySuiteB1921x":{"type":"boolean","description":"When set to true, the SuiteB192-1x authentication key feature is enabled."},"isAuthKeySaeExt":{"type":"boolean","description":"When set to true, the Simultaneous Authentication of Equals (SAE) Extended Authentication key feature is turned on."},"isAuthKeySaeExtPlusFT":{"type":"boolean","description":"When set to true, the Simultaneous Authentication of Equals (SAE) combined with Fast Transition (FT) Authentication Key feature is enabled."},"isApBeaconProtectionEnabled":{"type":"boolean","description":"When set to true, the Access Point (AP) Beacon Protection feature is activated, enhancing the security of the network."},"ghz24Policy":{"type":"string","enum":["dot11-bg-only","dot11-g-only"],"description":"2.4 Ghz Band Policy value. Allowed only when 2.4 Radio Band is enabled in ssidRadioType"},"cckmTsfTolerance":{"type":"integer","description":"he default value is the Cckm Timestamp Tolerance (in milliseconds, if specified); otherwise, it is 0."},"isCckmEnabled":{"type":"boolean","description":"True if CCKM is enabled, else False"},"isHex":{"type":"boolean","description":"True if passphrase is in Hex format, else False."},"isRandomMacFilterEnabled":{"type":"boolean","description":"Deny clients using randomized MAC addresses when set to true"},"fastTransitionOverTheDistributedSystemEnable":{"type":"boolean","description":"Enable Fast Transition over the Distributed System when set to true"}},"description":"","$$ref":"#/components/schemas/CreateSSIDRequest"}}},"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"}},"description":"Response"},"version":{"type":"string","description":"Version"}},"description":"","$$ref":"#/components/schemas/CreateSSIDResponse"}}}},"202":{"description":"Request has been accepted for execution","content":{}},"400":{"description":"Request failed due to malformed request syntax","content":{}},"405":{"description":"Request failed because the resource already exists","content":{}},"406":{"description":"Not acceptable parameter or parameter combinations passed","content":{}},"500":{"description":"Request failed because of unknown failure on the server","content":{}}},"x-rapi-id":"0193-8858-4789-9a53","x-rapi-overview":"This API allows the user to create an SSID (Service Set Identifier) at the Global site","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wireless","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/sites/${siteId}/wirelessSettings/ssids","x-rapi-publicPath":"/dna/intent/api/v1/sites/${siteId}/wirelessSettings/ssids","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"50~MINUTE","__originalOperationId":"createSSID","method":"post","path":"/dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids"}}