{"type":"api","title":"Create Network Switch Ports Profile","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/4a73587b50c21afbda73cffb32f23c0279bf8383/401c6d5b-0873-3519-be2b-c203501ad95c","info":{"title":"Meraki Dashboard API","description":"A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n\u003e Date: 04 December, 2024\n\u003e\n\u003e [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.53.0-beta.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":"wirelessController"},{"name":"accessControlLists"},{"name":"accessPolicies"},{"name":"accounts"},{"name":"aclHitCount"},{"name":"acls"},{"name":"actionBatches"},{"name":"activities"},{"name":"adaptivePolicy"},{"name":"addresses"},{"name":"admins"},{"name":"afc"},{"name":"aiRrm"},{"name":"airMarshal"},{"name":"alertTypes"},{"name":"alerts"},{"name":"alternateManagementInterface"},{"name":"analytics"},{"name":"api"},{"name":"apiRequests"},{"name":"apnsCert"},{"name":"apple"},{"name":"appliances"},{"name":"applicationCategories"},{"name":"applicationUsage"},{"name":"applications"},{"name":"areas"},{"name":"arpInspection"},{"name":"arpTable"},{"name":"artifacts"},{"name":"assets"},{"name":"assignments"},{"name":"auth"},{"name":"authenticationToken"},{"name":"autoLocate"},{"name":"autoRf"},{"name":"automations"},{"name":"availabilities"},{"name":"bandwidthUsageHistory"},{"name":"bgp"},{"name":"billing"},{"name":"blink"},{"name":"bluetooth"},{"name":"bluetoothClients"},{"name":"bonjourForwarding"},{"name":"boots"},{"name":"boundaries"},{"name":"brandingPolicies"},{"name":"bulk"},{"name":"bulkCreate"},{"name":"bulkDelete"},{"name":"bulkEnrollment"},{"name":"bulkUpdate"},{"name":"byBoundary"},{"name":"byClient"},{"name":"byDevice"},{"name":"byEnergyUsage"},{"name":"byInterval"},{"name":"byMetric"},{"name":"byModel"},{"name":"byNetwork"},{"name":"byStack"},{"name":"byStatus"},{"name":"bySwitch"},{"name":"bySwitchProfile"},{"name":"byType"},{"name":"byUsage"},{"name":"byUtilization"},{"name":"bypassActivationLockAttempts"},{"name":"cableTest"},{"name":"callbacks"},{"name":"captures"},{"name":"categories"},{"name":"cellular"},{"name":"cellularFirewallRules"},{"name":"cellularUsageHistory"},{"name":"certificates"},{"name":"certs"},{"name":"changeHistory"},{"name":"channelUtilization"},{"name":"channelUtilizationHistory"},{"name":"channels"},{"name":"claim"},{"name":"claimKey"},{"name":"clientCountHistory"},{"name":"clients"},{"name":"cloud"},{"name":"cloudEnrollment"},{"name":"cloudMonitoring"},{"name":"commands"},{"name":"communicationPlans"},{"name":"compliance"},{"name":"configTemplates"},{"name":"configurationChanges"},{"name":"configure"},{"name":"configuredDevices"},{"name":"connectionStats"},{"name":"connections"},{"name":"connectivity"},{"name":"connectivityEvents"},{"name":"connectivityMonitoringDestinations"},{"name":"contentFiltering"},{"name":"contents"},{"name":"coterm"},{"name":"current"},{"name":"customAnalytics"},{"name":"customPerformanceClasses"},{"name":"cyclePort"},{"name":"dataRateHistory"},{"name":"delegated"},{"name":"deltas"},{"name":"desktopLogs"},{"name":"details"},{"name":"detections"},{"name":"deviceCertificateAuthorities"},{"name":"deviceCommandLogs"},{"name":"deviceProfiles"},{"name":"deviceTypeGroupPolicies"},{"name":"dhcp"},{"name":"dhcpServerPolicy"},{"name":"discovery"},{"name":"disenrollments"},{"name":"dns"},{"name":"doorLocks"},{"name":"download"},{"name":"dscpTaggingOptions"},{"name":"dscpToCosMappings"},{"name":"eapOverride"},{"name":"earlyAccess"},{"name":"electronicShelfLabel"},{"name":"enrollments"},{"name":"entitlements"},{"name":"esims"},{"name":"ethernet"},{"name":"eventTypes"},{"name":"events"},{"name":"exportEvents"},{"name":"extensions"},{"name":"failedConnections"},{"name":"failover"},{"name":"features"},{"name":"fields"},{"name":"firewall"},{"name":"firewalledServices"},{"name":"firmware"},{"name":"firmwareUpgrades"},{"name":"floorPlans"},{"name":"groupPolicies"},{"name":"groups"},{"name":"health"},{"name":"healthByTime"},{"name":"healthScores"},{"name":"historical"},{"name":"history"},{"name":"hotspot20"},{"name":"httpServers"},{"name":"identities"},{"name":"identityPsks"},{"name":"idps"},{"name":"import"},{"name":"imports"},{"name":"inboundCellularFirewallRules"},{"name":"inboundFirewallRules"},{"name":"integration"},{"name":"interfaces"},{"name":"internetPolicies"},{"name":"intrusion"},{"name":"inventory"},{"name":"ipv6"},{"name":"jobs"},{"name":"keys"},{"name":"l2"},{"name":"l3"},{"name":"l3FirewallRules"},{"name":"l7FirewallRules"},{"name":"lan"},{"name":"latencyHistory"},{"name":"latencyStats"},{"name":"latest"},{"name":"leds"},{"name":"license"},{"name":"licenses"},{"name":"licensing"},{"name":"lines"},{"name":"linkAggregations"},{"name":"linkLayer"},{"name":"live"},{"name":"liveTools"},{"name":"lldpCdp"},{"name":"local"},{"name":"locationScanning"},{"name":"loginSecurity"},{"name":"logs"},{"name":"lossAndLatencyHistory"},{"name":"macTable"},{"name":"malware"},{"name":"managementInterface"},{"name":"manufacturers"},{"name":"me"},{"name":"merakiAuthUsers"},{"name":"meshStatuses"},{"name":"mirror"},{"name":"mirrors"},{"name":"models"},{"name":"monitor"},{"name":"monitoredMediaServers"},{"name":"mqttBrokers"},{"name":"mtu"},{"name":"multicast"},{"name":"multicastForwarding"},{"name":"netflow"},{"name":"networkAdapters"},{"name":"networkHealth"},{"name":"objectDetectionModels"},{"name":"onboarding"},{"name":"onboardingHistory"},{"name":"oneToManyNatRules"},{"name":"oneToOneNatRules"},{"name":"openapiSpec"},{"name":"opportunisticPcap"},{"name":"optIns"},{"name":"order"},{"name":"ospf"},{"name":"overview"},{"name":"packetCapture"},{"name":"packetLoss"},{"name":"packets"},{"name":"payloadTemplates"},{"name":"performance"},{"name":"performanceHistory"},{"name":"permissions"},{"name":"pii"},{"name":"piiKeys"},{"name":"ping"},{"name":"pingDevice"},{"name":"planning"},{"name":"policies"},{"name":"policy"},{"name":"policyObjects"},{"name":"portForwardingRules"},{"name":"portSchedules"},{"name":"ports"},{"name":"position"},{"name":"power"},{"name":"powerLimits"},{"name":"powerModules"},{"name":"prefixes"},{"name":"prepare"},{"name":"priorities"},{"name":"privateApplicationGroups"},{"name":"privateApplications"},{"name":"privateResources"},{"name":"profiles"},{"name":"provisioning"},{"name":"publicApplications"},{"name":"qosRules"},{"name":"qualityAndRetention"},{"name":"qualityRetentionProfiles"},{"name":"radSec"},{"name":"radio"},{"name":"radius"},{"name":"ratePlans"},{"name":"readings"},{"name":"recent"},{"name":"records"},{"name":"redundancy"},{"name":"regions"},{"name":"relationships"},{"name":"remoteAccessLog"},{"name":"remoteAccessLogsExports"},{"name":"remove"},{"name":"rendezvousPoints"},{"name":"requests"},{"name":"requirements"},{"name":"responseCodes"},{"name":"restrictions"},{"name":"revocationList"},{"name":"rfProfiles"},{"name":"roles"},{"name":"rollbacks"},{"name":"routing"},{"name":"routingTable"},{"name":"rules"},{"name":"salesRepresentatives"},{"name":"saml"},{"name":"samlRoles"},{"name":"schedules"},{"name":"sdwan"},{"name":"search"},{"name":"secureConnect"},{"name":"security"},{"name":"securityCenters"},{"name":"seen"},{"name":"sense"},{"name":"sentry"},{"name":"servers"},{"name":"serviceProviders"},{"name":"settings"},{"name":"signalQualityHistory"},{"name":"sims"},{"name":"singleLan"},{"name":"siteToSiteVpn"},{"name":"sites"},{"name":"smDevicesForKey"},{"name":"smOwnersForKey"},{"name":"snmp"},{"name":"softwares"},{"name":"spaces"},{"name":"speedTest"},{"name":"speedTestResults"},{"name":"splash"},{"name":"splashAuthorizationStatus"},{"name":"splashLoginAttempts"},{"name":"split"},{"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":"support"},{"name":"supported"},{"name":"swap"},{"name":"swaps"},{"name":"switches"},{"name":"syncJobs"},{"name":"syslogServers"},{"name":"system"},{"name":"targetGroups"},{"name":"tests"},{"name":"themes"},{"name":"thirdPartyVPNPeers"},{"name":"thousandEyes"},{"name":"throughputTest"},{"name":"token"},{"name":"tokens"},{"name":"top"},{"name":"topology"},{"name":"traceRoute"},{"name":"traffic"},{"name":"trafficAnalysis"},{"name":"trafficHistory"},{"name":"trafficShaping"},{"name":"transceivers"},{"name":"traps"},{"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":"utilization"},{"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":"webApps"},{"name":"webhookTests"},{"name":"webhooks"},{"name":"wirelessControllers"},{"name":"wirelessProfiles"},{"name":"wlanLists"},{"name":"xdr"},{"name":"zigbee"},{"name":"zones"}],"x-parser-conf":{"overview":{"markdownPath":"docs/overview-early-access.md"},"theme":"meraki","serverConfig":true,"httpBearer":{"bearerToken":"75dd5334bef4d2bc96f26138c163c0a3fa0b5ca6"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}},"groupBy":{"$remoteModule":"config/group_platform.js"},"filterBy":{"$remoteModule":"config/filter_only_beta.js"},"sortBy":{"$remoteModule":"config/sort_by.js"},"exampleAsDefault":true,"expand":0,"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":"Create a port profile in a network","operationId":"createNetworkSwitchPortsProfile","parameters":[{"name":"networkId","in":"path","description":"Network ID","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the profile."},"description":{"type":"string","description":"Text describing the profile."},"tags":{"type":"array","items":{"type":"string"},"description":"Space-seperated list of tags"},"port":{"type":"object","properties":{"type":{"type":"string","enum":["access","stack","trunk"],"description":"The type of the port profile."},"vlan":{"type":"integer","description":"The VLAN of the port profile. A null value will clear the value set for trunk ports."},"voiceVlan":{"type":"integer","description":"The voice VLAN of the port profile. Only applicable to access ports."},"allowedVlans":{"type":"string","description":"The VLANs allowed on the port profile. Only applicable to trunk ports."},"poeEnabled":{"type":"boolean","description":"The PoE status of the port profile."},"isolationEnabled":{"type":"boolean","description":"The isolation status of the port profile."},"rstpEnabled":{"type":"boolean","description":"The rapid spanning tree protocol status."},"stpGuard":{"type":"string","enum":["bpdu guard","disabled","loop guard","root guard"],"description":"The state of the STP guard."},"udld":{"type":"string","enum":["Alert only","Enforce"],"description":"The action to take when Unidirectional Link is detected. LinkDefault configuration is Alert only."},"accessPolicyType":{"type":"string","enum":["Custom access policy","MAC allow list","Open","Sticky MAC allow list"],"description":"The type of the access policy of the port profile. Only applicable to access ports."},"accessPolicyNumber":{"type":"integer","description":"The number of a custom access policy to configure on the port profile. Only applicable when 'accessPolicyType' is 'Custom access policy'."},"macAllowList":{"type":"array","items":{"type":"string"},"description":"Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'."},"stickyMacAllowList":{"type":"array","items":{"type":"string"},"description":"The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'."},"stickyMacAllowListLimit":{"type":"integer","description":"The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'."},"stormControlEnabled":{"type":"boolean","description":"The storm control status of the port profile."},"adaptivePolicyGroupId":{"type":"string","description":"The adaptive policy group ID that will be used to tag traffic through this port profile. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API."},"peerSgtCapable":{"type":"boolean","description":"If true, Peer SGT is enabled for traffic through this port profile. Applicable to trunk ports only."},"daiTrusted":{"type":"boolean","description":"If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic."}},"description":"Configuration settings for port profile"}},"example":{"name":"Phone","description":"IP Phones for all office workers","tags":["tag1","tag2"],"port":{"type":"access","vlan":10,"voiceVlan":20,"allowedVlans":"1-100","poeEnabled":true,"isolationEnabled":false,"rstpEnabled":true,"stpGuard":"disabled","udld":"Alert only","accessPolicyType":"Sticky MAC allow list","accessPolicyNumber":3,"macAllowList":["34:56:fe:ce:8e:b0","34:56:fe:ce:8e:b1"],"stickyMacAllowList":["34:56:fe:ce:8e:b0","34:56:fe:ce:8e:b1"],"stickyMacAllowListLimit":5,"stormControlEnabled":true,"adaptivePolicyGroupId":"1284392014819","peerSgtCapable":false,"daiTrusted":false}}}}},"required":false},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"profileId":{"type":"string","description":"ID of the profile"},"networkId":{"type":"string","description":"ID of the network the profile belongs to"},"name":{"type":"string","description":"The name of the profile."},"description":{"type":"string","description":"Text describing the profile."},"tags":{"type":"array","items":{"type":"string"},"description":"Space-seperated list of tags"},"associatedPorts":{"type":"array","items":{"type":"object","properties":{"portId":{"type":"string","description":"The ID of the switchport"},"portNum":{"type":"integer","description":"Switchport number"},"portName":{"type":"string","description":"Switchport name - a combination of switch name with port number"},"serial":{"type":"string","description":"The serial of parent node of the switchport"},"profile":{"type":"object","properties":{"enabled":{"type":"boolean","description":"The status of static port profile on the port"},"id":{"type":"string","description":"The ID of the associated port profile"}},"description":"Profile attributes"}}},"description":"List of ports configured with port profile"},"associatedSwitches":{"type":"array","items":{"type":"object","properties":{"switchId":{"type":"integer","description":"The ID of the switch"},"name":{"type":"string","description":"The name of the switch"},"mac":{"type":"string","description":"The mac address of the switch"},"serial":{"type":"string","description":"The serial of the switch"},"model":{"type":"string","description":"The model of the switch"}}},"description":"List of switches associated with the port profile"},"assignedSwitchports":{"type":"array","items":{"type":"object","properties":{"portIds":{"type":"array","items":{"type":"string"},"description":"List of associated switchport numbers"},"switch":{"type":"object","properties":{"serial":{"type":"string","description":"The serial of the switch"}},"description":"Switch details"},"template":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the node profile associated to switchport"}},"description":"Template details"}}},"description":"associated switch ports details"},"createdAt":{"type":"string","description":"When the port profile was created."},"updatedAt":{"type":"string","description":"When the port profile was updated."},"port":{"type":"object","properties":{"type":{"type":"string","enum":["access","stack","trunk"],"description":"The type of the port profile."},"vlan":{"type":"integer","description":"The VLAN of the port profile. A null value will clear the value set for trunk ports."},"voiceVlan":{"type":"integer","description":"The voice VLAN of the port profile. Only applicable to access ports."},"allowedVlans":{"type":"string","description":"The VLANs allowed on the port profile. Only applicable to trunk ports."},"poeEnabled":{"type":"boolean","description":"The PoE status of the port profile."},"isolationEnabled":{"type":"boolean","description":"The isolation status of the port profile."},"rstpEnabled":{"type":"boolean","description":"The rapid spanning tree protocol status."},"stpGuard":{"type":"string","enum":["bpdu guard","disabled","loop guard","root guard"],"description":"The state of the STP guard."},"udld":{"type":"string","enum":["Alert only","Enforce"],"description":"The action to take when Unidirectional Link is detected. LinkDefault configuration is Alert only."},"accessPolicyType":{"type":"string","enum":["Custom access policy","MAC allow list","Open","Sticky MAC allow list"],"description":"The type of the access policy of the port profile. Only applicable to access ports."},"accessPolicyNumber":{"type":"integer","description":"The number of a custom access policy to configure on the port profile. Only applicable when 'accessPolicyType' is 'Custom access policy'."},"macAllowList":{"type":"array","items":{"type":"string"},"description":"Only devices with MAC addresses specified in this list will have access to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType' is 'MAC allow list'."},"stickyMacAllowList":{"type":"array","items":{"type":"string"},"description":"The initial list of MAC addresses for sticky Mac allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'."},"stickyMacAllowListLimit":{"type":"integer","description":"The maximum number of MAC addresses for sticky MAC allow list. Only applicable when 'accessPolicyType' is 'Sticky MAC allow list'."},"stormControlEnabled":{"type":"boolean","description":"The storm control status of the port profile."},"adaptivePolicyGroupId":{"type":"string","description":"The adaptive policy group ID that will be used to tag traffic through this port profile. This ID must pre-exist during the configuration, else needs to be created using adaptivePolicy/groups API."},"peerSgtCapable":{"type":"boolean","description":"If true, Peer SGT is enabled for traffic through this port profile. Applicable to trunk ports only."},"daiTrusted":{"type":"boolean","description":"If true, ARP packets for this port will be considered trusted, and Dynamic ARP Inspection will allow the traffic."}},"description":"Port profile attributes"},"isOrganizationWide":{"type":"boolean","description":"Whether or not this profile is a organization wide profile"},"networks":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the network / associated node group"},"name":{"type":"string","description":"The name of network / associated node group"}}},"description":"List of Associated Networks"},"type":{"type":"string","description":"Determines whether network is included or excluded in smart port profile based on isOrganizationWide Flag."}},"description":"Object of Associated Networks"},"automations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the associated automation"},"name":{"type":"string","description":"The name of the associated automation"}}},"description":"List of Associated Automations"},"access":{"type":"string","description":"RBAC -\u003e access computed based on current user's administered networks & associated networks w.r.t switch port profiles"}}},"example":{"profileId":"1284392014819","networkId":"N_24329156","name":"Phone","description":"IP Phones for all office workers","tags":["tag1","tag2"],"associatedPorts":[{"portId":"8","portNum":8,"portName":"Dev - Cheshire Cat / 8","serial":"Q234-ABCD-5678","profile":{"enabled":true,"id":"1284392014819"}}],"associatedSwitches":[{"switchId":247165647951894,"name":"Dev - Cheshire Cat","mac":"e0:cb:bc:a5:98:16","serial":"Q234-ABCD-5678","model":"MS120-48FP"}],"assignedSwitchports":[{"portIds":["1","2","3","1_C3850-NM-8-10G_1","1_C3850-NM-8-10G_2"],"switch":{"serial":"Q234-ABCD-5678"},"template":{"id":1983748489}}],"createdAt":"2022-09-16T09:18:38Z","updatedAt":"2022-09-16T09:18:38Z","port":{"type":"access","vlan":10,"voiceVlan":20,"allowedVlans":"1-100","poeEnabled":true,"isolationEnabled":false,"rstpEnabled":true,"stpGuard":"disabled","udld":"Alert only","accessPolicyType":"Sticky MAC allow list","accessPolicyNumber":3,"macAllowList":["34:56:fe:ce:8e:b0","34:56:fe:ce:8e:b1"],"stickyMacAllowList":["34:56:fe:ce:8e:b0","34:56:fe:ce:8e:b1"],"stickyMacAllowListLimit":5,"stormControlEnabled":true,"adaptivePolicyGroupId":"1284392014819","peerSgtCapable":false,"daiTrusted":false},"isOrganizationWide":false,"networks":{"values":[{"id":"N_11865","name":"Wonderland-Dev"}],"type":"included"},"automations":[{"id":"N_11865","name":"RYOFXAPO"}],"access":"full"}}}}},"summary":"Create a port profile in a network","tags":["switch","configure","ports","profiles"],"x-release-stage":"beta","__originalOperationId":"createNetworkSwitchPortsProfile","security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"method":"post","path":"/networks/{networkId}/switch/ports/profiles"}}