{"type":"api","title":"Update Network Wireless Ssid Splash Settings","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/4723762d29b3380de018ae8c0d8a59499a6523e0/5c63a5d4-9452-397a-85eb-8b6fec45147e","info":{"title":"Meraki Dashboard API","description":"A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n> Date: 03 July, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n","contact":{"name":"Meraki Developer Community","url":"https://meraki.io/community"},"version":"1.48.0"},"security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"tags":[{"name":"organizations"},{"name":"networks"},{"name":"devices"},{"name":"insight"},{"name":"wireless"},{"name":"camera"},{"name":"appliance"},{"name":"switch"},{"name":"cellularGateway"},{"name":"sm"},{"name":"sensor"},{"name":"administered"},{"name":"accessControlLists"},{"name":"accessPolicies"},{"name":"acls"},{"name":"actionBatches"},{"name":"adaptivePolicy"},{"name":"addresses"},{"name":"admins"},{"name":"airMarshal"},{"name":"alertTypes"},{"name":"alerts"},{"name":"alternateManagementInterface"},{"name":"analytics"},{"name":"apiRequests"},{"name":"apnsCert"},{"name":"appliances"},{"name":"applicationCategories"},{"name":"applicationUsage"},{"name":"applications"},{"name":"areas"},{"name":"arpInspection"},{"name":"arpTable"},{"name":"artifacts"},{"name":"assets"},{"name":"assignments"},{"name":"authenticationToken"},{"name":"availabilities"},{"name":"bandwidthUsageHistory"},{"name":"bgp"},{"name":"billing"},{"name":"bluetooth"},{"name":"bluetoothClients"},{"name":"bonjourForwarding"},{"name":"boundaries"},{"name":"brandingPolicies"},{"name":"bulk"},{"name":"bulkUpdate"},{"name":"byBoundary"},{"name":"byClient"},{"name":"byDevice"},{"name":"byEnergyUsage"},{"name":"byInterval"},{"name":"byMetric"},{"name":"byModel"},{"name":"byNetwork"},{"name":"byStatus"},{"name":"bySwitch"},{"name":"byType"},{"name":"byUsage"},{"name":"byUtilization"},{"name":"bypassActivationLockAttempts"},{"name":"cableTest"},{"name":"callbacks"},{"name":"categories"},{"name":"cellular"},{"name":"cellularFirewallRules"},{"name":"cellularUsageHistory"},{"name":"certs"},{"name":"changeHistory"},{"name":"channelUtilization"},{"name":"channelUtilizationHistory"},{"name":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clients"},{"name":"cloudMonitoring"},{"name":"commands"},{"name":"compliance"},{"name":"configTemplates"},{"name":"configurationChanges"},{"name":"configure"},{"name":"configuredDevices"},{"name":"connectionStats"},{"name":"connectivity"},{"name":"connectivityEvents"},{"name":"connectivityMonitoringDestinations"},{"name":"contentFiltering"},{"name":"coterm"},{"name":"current"},{"name":"customAnalytics"},{"name":"customPerformanceClasses"},{"name":"dataRateHistory"},{"name":"delegated"},{"name":"desktopLogs"},{"name":"details"},{"name":"detections"},{"name":"deviceCommandLogs"},{"name":"deviceProfiles"},{"name":"deviceTypeGroupPolicies"},{"name":"dhcp"},{"name":"dhcpServerPolicy"},{"name":"dscpTaggingOptions"},{"name":"dscpToCosMappings"},{"name":"eapOverride"},{"name":"earlyAccess"},{"name":"electronicShelfLabel"},{"name":"entitlements"},{"name":"ethernet"},{"name":"eventTypes"},{"name":"events"},{"name":"exportEvents"},{"name":"failedConnections"},{"name":"features"},{"name":"fields"},{"name":"firewall"},{"name":"firewalledServices"},{"name":"firmware"},{"name":"firmwareUpgrades"},{"name":"floorPlans"},{"name":"groupPolicies"},{"name":"groups"},{"name":"health"},{"name":"healthByTime"},{"name":"historical"},{"name":"history"},{"name":"hotspot20"},{"name":"httpServers"},{"name":"identities"},{"name":"identityPsks"},{"name":"idps"},{"name":"imports"},{"name":"inboundCellularFirewallRules"},{"name":"inboundFirewallRules"},{"name":"interfaces"},{"name":"internetPolicies"},{"name":"intrusion"},{"name":"inventory"},{"name":"ipv6"},{"name":"l3FirewallRules"},{"name":"l7FirewallRules"},{"name":"lan"},{"name":"latencyHistory"},{"name":"latencyStats"},{"name":"latest"},{"name":"licenses"},{"name":"licensing"},{"name":"lines"},{"name":"linkAggregations"},{"name":"linkLayer"},{"name":"live"},{"name":"liveTools"},{"name":"lldpCdp"},{"name":"loginSecurity"},{"name":"logs"},{"name":"lossAndLatencyHistory"},{"name":"malware"},{"name":"managementInterface"},{"name":"manufacturers"},{"name":"me"},{"name":"merakiAuthUsers"},{"name":"meshStatuses"},{"name":"models"},{"name":"monitor"},{"name":"monitoredMediaServers"},{"name":"mqttBrokers"},{"name":"mtu"},{"name":"multicast"},{"name":"netflow"},{"name":"networkAdapters"},{"name":"networkHealth"},{"name":"objectDetectionModels"},{"name":"onboarding"},{"name":"oneToManyNatRules"},{"name":"oneToOneNatRules"},{"name":"openapiSpec"},{"name":"optIns"},{"name":"order"},{"name":"ospf"},{"name":"overview"},{"name":"packetLoss"},{"name":"packets"},{"name":"payloadTemplates"},{"name":"performance"},{"name":"performanceHistory"},{"name":"permissions"},{"name":"pii"},{"name":"piiKeys"},{"name":"ping"},{"name":"pingDevice"},{"name":"policies"},{"name":"policy"},{"name":"policyObjects"},{"name":"portForwardingRules"},{"name":"portSchedules"},{"name":"ports"},{"name":"power"},{"name":"powerModules"},{"name":"prefixes"},{"name":"prepare"},{"name":"priorities"},{"name":"profiles"},{"name":"provisioning"},{"name":"qosRules"},{"name":"qualityAndRetention"},{"name":"qualityRetentionProfiles"},{"name":"radio"},{"name":"readings"},{"name":"recent"},{"name":"relationships"},{"name":"rendezvousPoints"},{"name":"requests"},{"name":"responseCodes"},{"name":"restrictions"},{"name":"rfProfiles"},{"name":"roles"},{"name":"rollbacks"},{"name":"routing"},{"name":"rules"},{"name":"saml"},{"name":"samlRoles"},{"name":"schedules"},{"name":"sdwan"},{"name":"search"},{"name":"security"},{"name":"securityCenters"},{"name":"seen"},{"name":"sense"},{"name":"sentry"},{"name":"servers"},{"name":"settings"},{"name":"signalQualityHistory"},{"name":"sims"},{"name":"singleLan"},{"name":"siteToSiteVpn"},{"name":"smDevicesForKey"},{"name":"smOwnersForKey"},{"name":"snmp"},{"name":"softwares"},{"name":"splash"},{"name":"splashAuthorizationStatus"},{"name":"splashLoginAttempts"},{"name":"ssids"},{"name":"stacks"},{"name":"staged"},{"name":"stages"},{"name":"staticRoutes"},{"name":"statics"},{"name":"stats"},{"name":"status"},{"name":"statuses"},{"name":"stormControl"},{"name":"stp"},{"name":"subnetPool"},{"name":"subnets"},{"name":"subscription"},{"name":"subscriptions"},{"name":"summary"},{"name":"swaps"},{"name":"switches"},{"name":"syslogServers"},{"name":"targetGroups"},{"name":"themes"},{"name":"thirdPartyVPNPeers"},{"name":"throughputTest"},{"name":"top"},{"name":"topology"},{"name":"traffic"},{"name":"trafficAnalysis"},{"name":"trafficHistory"},{"name":"trafficShaping"},{"name":"trustedAccessConfigs"},{"name":"trustedServers"},{"name":"upgrades"},{"name":"uplink"},{"name":"uplinkBandwidth"},{"name":"uplinkSelection"},{"name":"uplinks"},{"name":"uplinksLossAndLatency"},{"name":"usage"},{"name":"usageHistories"},{"name":"usageHistory"},{"name":"userAccessDevices"},{"name":"users"},{"name":"v4"},{"name":"video"},{"name":"videoLink"},{"name":"vlanAssignments"},{"name":"vlanProfiles"},{"name":"vlans"},{"name":"vmx"},{"name":"vpn"},{"name":"vpnExclusions"},{"name":"vpnFirewallRules"},{"name":"vppAccounts"},{"name":"wakeOnLan"},{"name":"warmSpare"},{"name":"warnings"},{"name":"webhookTests"},{"name":"webhooks"},{"name":"wirelessProfiles"},{"name":"wlanLists"},{"name":"zones"}],"x-parser-conf":{"overview":{"markdownPath":"docs/overview.md"},"theme":"meraki","serverConfig":true,"meta":{"useProxy":true},"httpBearer":{"bearerToken":"75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}},"groupBy":{"$remoteModule":"config/group_platform.js"},"sortBy":{"$remoteModule":"config/sort_by.js"},"exampleAsDefault":true,"expand":3,"sampleCode":{"python":{"folder":"meraki/sdk/python","name":"Meraki Python Library","highlight":"python"}},"variables":{"organizationId":"1215707","networkId":"N_784752235069315754","serial":"QBSB-VQ3J-XZ54"}},"openapi":"3.0.1","servers":[{"url":"https://api.meraki.com/{basePath}","variables":{"basePath":{"default":"api/v1"}}}],"securitySchemes":{"meraki_api_key":{"type":"apiKey","name":"X-Cisco-Meraki-API-Key","in":"header"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key"}}},"spec":{"description":"Modify the splash page settings for the given SSID","operationId":"updateNetworkWirelessSsidSplashSettings","parameters":[{"name":"networkId","in":"path","description":"Network ID","schema":{"type":"string"},"required":true},{"name":"number","in":"path","description":"Number","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"splashUrl":{"type":"string","description":"[optional] The custom splash URL of the click-through splash page. Note that the URL can be configured without necessarily being used. In order to enable the custom URL, see 'useSplashUrl'"},"useSplashUrl":{"type":"boolean","description":"[optional] Boolean indicating whether the users will be redirected to the custom splash url. A custom splash URL must be set if this is true. Note that depending on your SSID's access control settings, it may not be possible to use the custom splash URL."},"splashTimeout":{"type":"integer","enum":[30,60,120,240,480,720,1080,1440,2880,5760,7200,10080,20160,43200,86400,129600],"description":"Splash timeout in minutes. This will determine how often users will see the splash page."},"redirectUrl":{"type":"string","description":"The custom redirect URL where the users will go after the splash page."},"useRedirectUrl":{"type":"boolean","description":"The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page. A custom redirect URL must be set if this is true."},"welcomeMessage":{"type":"string","description":"The welcome message for the users on the splash page."},"themeId":{"type":"string","description":"The id of the selected splash theme."},"splashLogo":{"type":"object","properties":{"md5":{"type":"string","description":"The MD5 value of the logo file. Setting this to null will remove the logo from the splash page."},"extension":{"type":"string","description":"The extension of the logo file."},"image":{"type":"object","properties":{"format":{"type":"string","enum":["gif","jpg","png"],"description":"The format of the encoded contents. Supported formats are 'png', 'gif', and jpg'."},"contents":{"type":"string","format":"byte","description":"The file contents (a base 64 encoded string) of your new logo."}},"description":"Properties for setting a new image."}},"description":"The logo used in the splash page."},"splashImage":{"type":"object","properties":{"md5":{"type":"string","description":"The MD5 value of the image file. Setting this to null will remove the image from the splash page."},"extension":{"type":"string","description":"The extension of the image file."},"image":{"type":"object","properties":{"format":{"type":"string","enum":["gif","jpg","png"],"description":"The format of the encoded contents. Supported formats are 'png', 'gif', and jpg'."},"contents":{"type":"string","format":"byte","description":"The file contents (a base 64 encoded string) of your new image."}},"description":"Properties for setting a new image."}},"description":"The image used in the splash page."},"splashPrepaidFront":{"type":"object","properties":{"md5":{"type":"string","description":"The MD5 value of the prepaid front image file. Setting this to null will remove the prepaid front from the splash page."},"extension":{"type":"string","description":"The extension of the prepaid front image file."},"image":{"type":"object","properties":{"format":{"type":"string","enum":["gif","jpg","png"],"description":"The format of the encoded contents. Supported formats are 'png', 'gif', and jpg'."},"contents":{"type":"string","format":"byte","description":"The file contents (a base 64 encoded string) of your new prepaid front."}},"description":"Properties for setting a new image."}},"description":"The prepaid front image used in the splash page."},"blockAllTrafficBeforeSignOn":{"type":"boolean","description":"How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged."},"controllerDisconnectionBehavior":{"type":"string","enum":["default","open","restricted"],"description":"How login attempts should be handled when the controller is unreachable. Can be either 'open', 'restricted', or 'default'."},"allowSimultaneousLogins":{"type":"boolean","description":"Whether or not to allow simultaneous logins from different devices."},"guestSponsorship":{"type":"object","properties":{"durationInMinutes":{"type":"integer","description":"Duration in minutes of sponsored guest authorization. Must be between 1 and 60480 (6 weeks)"},"guestCanRequestTimeframe":{"type":"boolean","description":"Whether or not guests can specify how much time they are requesting."}},"description":"Details associated with guest sponsored splash."},"billing":{"type":"object","properties":{"freeAccess":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not free access is enabled."},"durationInMinutes":{"type":"integer","description":"How long a device can use a network for free."}},"description":"Details associated with a free access plan with limits."},"prepaidAccessFastLoginEnabled":{"type":"boolean","description":"Whether or not billing uses the fast login prepaid access option."},"replyToEmailAddress":{"type":"string","description":"The email address that receives replies from clients."}},"description":"Details associated with billing splash."},"sentryEnrollment":{"type":"object","properties":{"systemsManagerNetwork":{"type":"object","properties":{"id":{"type":"string","description":"The network ID of the Systems Manager network."}},"required":["id"],"description":"Systems Manager network targeted for sentry enrollment."},"strength":{"type":"string","enum":["click-through","focused","strict"],"description":"The strength of the enforcement of selected system types. Must be one of: 'focused', 'click-through', and 'strict'."},"enforcedSystems":{"type":"array","items":{"type":"string"},"description":"The system types that the Sentry enforces. Must be included in: 'iOS, 'Android', 'macOS', and 'Windows'."}},"description":"Systems Manager sentry enrollment splash settings."}},"example":{"splashUrl":"https://www.custom_splash_url.com","useSplashUrl":true,"splashTimeout":1440,"redirectUrl":"https://example.com","useRedirectUrl":true,"welcomeMessage":"Welcome!","themeId":"c3ddcb4f16785ee747ab5ffc10867d6c8ea704be","splashLogo":{"md5":"abcd1234","extension":"jpg","image":{"format":"jpg","contents":"Q2lzY28gTWVyYWtp"}},"splashImage":{"md5":"542cccac8d7dedee0f185311d154d194","extension":"jpg","image":{"format":"jpg","contents":"Q2lzY28gTWVyYWtp"}},"splashPrepaidFront":{"md5":"542cccac8d7dedee0f185311d154d194","extension":"jpg","image":{"format":"jpg","contents":"Q2lzY28gTWVyYWtp"}},"blockAllTrafficBeforeSignOn":false,"controllerDisconnectionBehavior":"default","allowSimultaneousLogins":false,"guestSponsorship":{"durationInMinutes":30,"guestCanRequestTimeframe":false},"billing":{"freeAccess":{"enabled":true,"durationInMinutes":120},"prepaidAccessFastLoginEnabled":true,"replyToEmailAddress":"user@email.com"},"sentryEnrollment":{"systemsManagerNetwork":{"id":"N_1234"},"strength":"focused","enforcedSystems":["iOS"]}}}}},"required":false},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"ssidNumber":{"type":"integer","description":"SSID number"},"splashPage":{"type":"string","description":"The type of splash page for this SSID"},"useSplashUrl":{"type":"boolean","description":"Boolean indicating whether the users will be redirected to the custom splash url"},"splashUrl":{"type":"string","description":"The custom splash URL of the click-through splash page."},"splashTimeout":{"type":"integer","enum":[30,60,120,240,480,720,1080,1440,2880,5760,7200,10080,20160,43200,86400,129600],"description":"Splash timeout in minutes."},"redirectUrl":{"type":"string","description":"The custom redirect URL where the users will go after the splash page."},"useRedirectUrl":{"type":"boolean","description":"The Boolean indicating whether the the user will be redirected to the custom redirect URL after the splash page."},"welcomeMessage":{"type":"string","description":"The welcome message for the users on the splash page."},"themeId":{"type":"string","description":"The id of the selected splash theme."},"splashLogo":{"type":"object","properties":{"md5":{"type":"string","description":"The MD5 value of the logo file."},"extension":{"type":"string","description":"The extension of the logo file."}},"description":"The logo used in the splash page."},"splashImage":{"type":"object","properties":{"md5":{"type":"string","description":"The MD5 value of the image file."},"extension":{"type":"string","description":"The extension of the image file."}},"description":"The image used in the splash page."},"splashPrepaidFront":{"type":"object","properties":{"md5":{"type":"string","description":"The MD5 value of the prepaid front image file."},"extension":{"type":"string","description":"The extension of the prepaid front image file."}},"description":"The prepaid front image used in the splash page."},"guestSponsorship":{"type":"object","properties":{"durationInMinutes":{"type":"integer","description":"Duration in minutes of sponsored guest authorization."},"guestCanRequestTimeframe":{"type":"boolean","description":"Whether or not guests can specify how much time they are requesting."}},"description":"Details associated with guest sponsored splash"},"blockAllTrafficBeforeSignOn":{"type":"boolean","description":"How restricted allowing traffic should be. If true, all traffic types are blocked until the splash page is acknowledged. If false, all non-HTTP traffic is allowed before the splash page is acknowledged."},"controllerDisconnectionBehavior":{"type":"string","description":"How login attempts should be handled when the controller is unreachable."},"allowSimultaneousLogins":{"type":"boolean","description":"Whether or not to allow simultaneous logins from different devices."},"billing":{"type":"object","properties":{"freeAccess":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not free access is enabled."},"durationInMinutes":{"type":"integer","description":"How long a device can use a network for free."}},"description":"Details associated with a free access plan with limits"},"prepaidAccessFastLoginEnabled":{"type":"boolean","description":"Whether or not billing uses the fast login prepaid access option."},"replyToEmailAddress":{"type":"string","description":"The email address that reeceives replies from clients"}},"description":"Details associated with billing splash"},"sentryEnrollment":{"type":"object","properties":{"systemsManagerNetwork":{"type":"object","properties":{"id":{"type":"string","description":"The network ID of the Systems Manager network."}},"description":"Systems Manager network targeted for sentry enrollment."},"strength":{"type":"string","enum":["click-through","focused","strict"],"description":"The strength of the enforcement of selected system types."},"enforcedSystems":{"type":"array","items":{"type":"string"},"description":"The system types that the Sentry enforces."}},"description":"Systems Manager sentry enrollment splash settings."},"selfRegistration":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not to allow users to create their own account on the network."},"authorizationType":{"type":"string","enum":["admin","auto","self_email"],"description":"How created user accounts should be authorized."}},"description":"Self-registration for splash with Meraki authentication."}}},"example":{"ssidNumber":0,"splashPage":"Click-through splash page","useSplashUrl":true,"splashUrl":"https://www.custom_splash_url.com","splashTimeout":1440,"redirectUrl":"https://example.com","useRedirectUrl":true,"welcomeMessage":"Welcome!","themeId":"c3ddcb4f16785ee747ab5ffc10867d6c8ea704be","splashLogo":{"md5":"abcd1234","extension":"jpg"},"splashImage":{"md5":"542cccac8d7dedee0f185311d154d194","extension":"jpg"},"splashPrepaidFront":{"md5":"542cccac8d7dedee0f185311d154d194","extension":"jpg"},"guestSponsorship":{"durationInMinutes":30,"guestCanRequestTimeframe":false},"blockAllTrafficBeforeSignOn":false,"controllerDisconnectionBehavior":"default","allowSimultaneousLogins":false,"billing":{"freeAccess":{"enabled":true,"durationInMinutes":120},"prepaidAccessFastLoginEnabled":true,"replyToEmailAddress":"user@email.com"},"sentryEnrollment":{"systemsManagerNetwork":{"id":"N_1234"},"strength":"focused","enforcedSystems":["iOS"]},"selfRegistration":{"enabled":true,"authorizationType":"admin"}}}}}},"summary":"Modify the splash page settings for the given SSID","tags":["wireless","configure","ssids","splash","settings"],"__originalOperationId":"updateNetworkWirelessSsidSplashSettings","security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"method":"put","path":"/networks/{networkId}/wireless/ssids/{number}/splash/settings","sampleCode":{"Meraki Python Library":{"code":"import meraki\n\n# Defining your API key as a variable in source code is discouraged.\n# This API key is for a read-only docs-specific environment.\n# In your own code, use an environment variable as shown under the Usage section\n# @ https://github.com/meraki/dashboard-api-python/\n\nAPI_KEY = '75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6'\n\ndashboard = meraki.DashboardAPI(API_KEY)\n\nnetwork_id = 'L_646829496481105433'\nnumber = ''\n\nresponse = dashboard.wireless.updateNetworkWirelessSsidSplashSettings(\n network_id, number, \n splashUrl='https://www.custom_splash_url.com', \n useSplashUrl=True, \n splashTimeout=1440, \n redirectUrl='https://example.com', \n useRedirectUrl=True, \n welcomeMessage='Welcome!', \n themeId='c3ddcb4f16785ee747ab5ffc10867d6c8ea704be', \n splashLogo={'md5': 'abcd1234', 'extension': 'jpg', 'image': {'format': 'jpg', 'contents': 'Q2lzY28gTWVyYWtp'}}, \n splashImage={'md5': '542cccac8d7dedee0f185311d154d194', 'extension': 'jpg', 'image': {'format': 'jpg', 'contents': 'Q2lzY28gTWVyYWtp'}}, \n splashPrepaidFront={'md5': '542cccac8d7dedee0f185311d154d194', 'extension': 'jpg', 'image': {'format': 'jpg', 'contents': 'Q2lzY28gTWVyYWtp'}}, \n blockAllTrafficBeforeSignOn=False, \n controllerDisconnectionBehavior='default', \n allowSimultaneousLogins=False, \n guestSponsorship={'durationInMinutes': 30, 'guestCanRequestTimeframe': False}, \n billing={'freeAccess': {'enabled': True, 'durationInMinutes': 120}, 'prepaidAccessFastLoginEnabled': True, 'replyToEmailAddress': 'user@email.com'}, \n sentryEnrollment={'systemsManagerNetwork': {'id': 'N_1234'}, 'strength': 'focused', 'enforcedSystems': ['iOS']}\n)\n\nprint(response)","highlight":"python"}}}}