Global Meraki Path Parameter IDs

Each service API path parameter ID has related API operation operations which can be used to get the ID's value.

For example, the following API path requires an organizationId for its scope and an adminId for its service parameter.

/organizations/{organizationId}/admins/{adminId}

Some operations will return the parameter named as id in the body, whereas other operations may return the named ID such as groupId or floorPlanId. This table provides a helpful map of the global Meraki path parameters and their respective operations. It also includes the ID parameter name you should expect to use for related API operations.

Service Parameter Operations

JSON

Path Service Param

Resource Operations

accessPolicyNumber

apiDocs	operationId	method	path	responseParam
Docs	getNetworkSwitchAccessPolicies	get	/networks/{networkId}/switch/accessPolicies	accessPolicyNumber
Docs	createNetworkSwitchAccessPolicy	post	/networks/{networkId}/switch/accessPolicies	accessPolicyNumber

actionBatchId

apiDocs	operationId	method	path	responseParam
Docs	createOrganizationActionBatch	post	/organizations/{organizationId}/actionBatches	id
Docs	getOrganizationActionBatches	get	/organizations/{organizationId}/actionBatches	id

adaptivePolicyId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationAdaptivePolicyPolicies	get	/organizations/{organizationId}/adaptivePolicy/policies	adaptivePolicyId
Docs	createOrganizationAdaptivePolicyPolicy	post	/organizations/{organizationId}/adaptivePolicy/policies	adaptivePolicyId

adminId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationAdmins	get	/organizations/{organizationId}/admins	id
Docs	createOrganizationAdmin	post	/organizations/{organizationId}/admins	id

alertConfigId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationAlertsProfiles	get	/organizations/{organizationId}/alerts/profiles	id
Docs	createOrganizationAlertsProfile	post	/organizations/{organizationId}/alerts/profiles	id

applicationId

attemptId

apiDocs	operationId	method	path	responseParam
Docs	createNetworkSmBypassActivationLockAttempt	post	/networks/{networkId}/sm/bypassActivationLockAttempts	id

bluetoothClientId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkBluetoothClients	get	/networks/{networkId}/bluetoothClients	id

brandingPolicyId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationBrandingPolicies	get	/organizations/{organizationId}/brandingPolicies	brandingPolicyId
Docs	createOrganizationBrandingPolicy	post	/organizations/{organizationId}/brandingPolicies	brandingPolicyId

clientId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkClients	get	/networks/{networkId}/clients	id
Docs	getNetworkWirelessClientsConnectionStats	get	/networks/{networkId}/wireless/clients/connectionStats	id
Docs	getNetworkWirelessClientsLatencyStats	get	/networks/{networkId}/wireless/clients/latencyStats	id

configTemplateId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationConfigTemplates	get	/organizations/{organizationId}/configTemplates	id
Docs	createOrganizationConfigTemplate	post	/organizations/{organizationId}/configTemplates	id

customPerformanceClassId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkApplianceTrafficShapingCustomPerformanceClasses	get	/networks/{networkId}/appliance/trafficShaping/customPerformanceClasses	customPerformanceClassId
Docs	createNetworkApplianceTrafficShapingCustomPerformanceClass	post	/networks/{networkId}/appliance/trafficShaping/customPerformanceClasses	customPerformanceClassId

deviceId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkSmDevices	get	/networks/{networkId}/sm/devices	id
Docs	checkinNetworkSmDevices	post	/networks/{networkId}/sm/devices/checkin	id
Docs	lockNetworkSmDevices	post	/networks/{networkId}/sm/devices/lock	id
Docs	modifyNetworkSmDevicesTags	post	/networks/{networkId}/sm/devices/modifyTags	id
Docs	moveNetworkSmDevices	post	/networks/{networkId}/sm/devices/move	id
Docs	wipeNetworkSmDevices	post	/networks/{networkId}/sm/devices/wipe	id

floorPlanId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkFloorPlans	get	/networks/{networkId}/floorPlans	floorPlanId
Docs	createNetworkFloorPlan	post	/networks/{networkId}/floorPlans	floorPlanId

groupId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationAdaptivePolicyGroups	get	/organizations/{organizationId}/adaptivePolicy/groups	groupId
Docs	createOrganizationAdaptivePolicyGroup	post	/organizations/{organizationId}/adaptivePolicy/groups	groupId

groupPolicyId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkGroupPolicies	get	/networks/{networkId}/groupPolicies	groupPolicyId
Docs	createNetworkGroupPolicy	post	/networks/{networkId}/groupPolicies	groupPolicyId

httpServerId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkWebhooksHttpServers	get	/networks/{networkId}/webhooks/httpServers	id
Docs	createNetworkWebhooksHttpServer	post	/networks/{networkId}/webhooks/httpServers	id

apiDocs	operationId	method	path	responseParam
Docs	createDeviceLiveToolsPing	post	/devices/{serial}/liveTools/ping	id
Docs	createDeviceLiveToolsPingDevice	post	/devices/{serial}/liveTools/pingDevice	id
Docs	getOrganizationAdaptivePolicyAcls	get	/organizations/{organizationId}/adaptivePolicy/acls	id
Docs	createOrganizationAdaptivePolicyAcl	post	/organizations/{organizationId}/adaptivePolicy/acls	id

identityPskId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkWirelessSsidIdentityPsks	get	/networks/{networkId}/wireless/ssids/{number}/identityPsks	id
Docs	createNetworkWirelessSsidIdentityPsk	post	/networks/{networkId}/wireless/ssids/{number}/identityPsks	id

idpId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationSamlIdps	get	/organizations/{organizationId}/saml/idps	idpId
Docs	createOrganizationSamlIdp	post	/organizations/{organizationId}/saml/idps	idpId

interfaceId

apiDocs	operationId	method	path	responseParam
Docs	getDeviceSwitchRoutingInterfaces	get	/devices/{serial}/switch/routing/interfaces	interfaceId
Docs	createDeviceSwitchRoutingInterface	post	/devices/{serial}/switch/routing/interfaces	interfaceId
Docs	getNetworkSwitchStackRoutingInterfaces	get	/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces	interfaceId
Docs	createNetworkSwitchStackRoutingInterface	post	/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces	interfaceId

licenseId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationLicenses	get	/organizations/{organizationId}/licenses	id
Docs	assignOrganizationLicensesSeats	post	/organizations/{organizationId}/licenses/assignSeats	id
Docs	moveOrganizationLicenses	post	/organizations/{organizationId}/licenses/move	id
Docs	moveOrganizationLicensesSeats	post	/organizations/{organizationId}/licenses/moveSeats	licenseId
Docs	renewOrganizationLicensesSeats	post	/organizations/{organizationId}/licenses/renewSeats	id

linkAggregationId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkSwitchLinkAggregations	get	/networks/{networkId}/switch/linkAggregations	id
Docs	createNetworkSwitchLinkAggregation	post	/networks/{networkId}/switch/linkAggregations	id

merakiAuthUserId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkMerakiAuthUsers	get	/networks/{networkId}/merakiAuthUsers	id
Docs	createNetworkMerakiAuthUser	post	/networks/{networkId}/merakiAuthUsers	id

monitoredMediaServerId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationInsightMonitoredMediaServers	get	/organizations/{organizationId}/insight/monitoredMediaServers	id
Docs	createOrganizationInsightMonitoredMediaServer	post	/organizations/{organizationId}/insight/monitoredMediaServers	id

mqttBrokerId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkMqttBrokers	get	/networks/{networkId}/mqttBrokers	id
Docs	createNetworkMqttBroker	post	/networks/{networkId}/mqttBrokers	id

networkId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationNetworks	get	/organizations/{organizationId}/networks	id
Docs	createOrganizationNetwork	post	/organizations/{organizationId}/networks	id
Docs	combineOrganizationNetworks	post	/organizations/{organizationId}/networks/combine	id

number

apiDocs	operationId	method	path	responseParam
Docs	getNetworkWirelessSsids	get	/networks/{networkId}/wireless/ssids	number

organizationId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizations	get	/organizations	id
Docs	createOrganization	post	/organizations	id

portId

apiDocs	operationId	method	path	responseParam
Docs	getDeviceSwitchPorts	get	/devices/{serial}/switch/ports	portId
Docs	getNetworkAppliancePorts	get	/networks/{networkId}/appliance/ports	id
Docs	getOrganizationConfigTemplateSwitchProfilePorts	get	/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports	portId

portScheduleId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkSwitchPortSchedules	get	/networks/{networkId}/switch/portSchedules	id
Docs	createNetworkSwitchPortSchedule	post	/networks/{networkId}/switch/portSchedules	id

profileId

qosRuleId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkSwitchQosRules	get	/networks/{networkId}/switch/qosRules	id
Docs	createNetworkSwitchQosRule	post	/networks/{networkId}/switch/qosRules	id

qualityRetentionProfileId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkCameraQualityRetentionProfiles	get	/networks/{networkId}/camera/qualityRetentionProfiles	id
Docs	createNetworkCameraQualityRetentionProfile	post	/networks/{networkId}/camera/qualityRetentionProfiles	id

rendezvousPointId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkSwitchRoutingMulticastRendezvousPoints	get	/networks/{networkId}/switch/routing/multicast/rendezvousPoints	rendezvousPointId
Docs	createNetworkSwitchRoutingMulticastRendezvousPoint	post	/networks/{networkId}/switch/routing/multicast/rendezvousPoints	rendezvousPointId

requestId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkPiiRequests	get	/networks/{networkId}/pii/requests	id
Docs	createNetworkPiiRequest	post	/networks/{networkId}/pii/requests	id

rfProfileId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkWirelessRfProfiles	get	/networks/{networkId}/wireless/rfProfiles	id
Docs	createNetworkWirelessRfProfile	post	/networks/{networkId}/wireless/rfProfiles	id

samlRoleId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationSamlRoles	get	/organizations/{organizationId}/samlRoles	id
Docs	createOrganizationSamlRole	post	/organizations/{organizationId}/samlRoles	id

serial

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationDevices	get	/organizations/{organizationId}/devices	serial

service

apiDocs	operationId	method	path	responseParam
Docs	getNetworkApplianceFirewallFirewalledServices	get	/networks/{networkId}/appliance/firewall/firewalledServices	service

staticRouteId

apiDocs	operationId	method	path	responseParam
Docs	getDeviceSwitchRoutingStaticRoutes	get	/devices/{serial}/switch/routing/staticRoutes	staticRouteId
Docs	createDeviceSwitchRoutingStaticRoute	post	/devices/{serial}/switch/routing/staticRoutes	staticRouteId
Docs	getNetworkApplianceStaticRoutes	get	/networks/{networkId}/appliance/staticRoutes	id
Docs	createNetworkApplianceStaticRoute	post	/networks/{networkId}/appliance/staticRoutes	id
Docs	getNetworkSwitchStackRoutingStaticRoutes	get	/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes	staticRouteId
Docs	createNetworkSwitchStackRoutingStaticRoute	post	/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes	staticRouteId

switchStackId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkSwitchStacks	get	/networks/{networkId}/switch/stacks	id
Docs	createNetworkSwitchStack	post	/networks/{networkId}/switch/stacks	id

targetGroupId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkSmTargetGroups	get	/networks/{networkId}/sm/targetGroups	id
Docs	createNetworkSmTargetGroup	post	/networks/{networkId}/sm/targetGroups	id

userAccessDeviceId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkSmUserAccessDevices	get	/networks/{networkId}/sm/userAccessDevices	id

userId

vlanId

apiDocs	operationId	method	path	responseParam
Docs	getNetworkApplianceVlans	get	/networks/{networkId}/appliance/vlans	id
Docs	createNetworkApplianceVlan	post	/networks/{networkId}/appliance/vlans	id

vppAccountId

apiDocs	operationId	method	path	responseParam
Docs	getOrganizationSmVppAccounts	get	/organizations/{organizationId}/sm/vppAccounts	id

webhookTestId

apiDocs	operationId	method	path	responseParam
Docs	createNetworkWebhooksWebhookTest	post	/networks/{networkId}/webhooks/webhookTests	id

wirelessProfileId

apiDocs	operationId	method	path	responseParam
Docs	getDeviceCameraWirelessProfiles	get	/devices/{serial}/camera/wirelessProfiles	id
Docs	updateDeviceCameraWirelessProfiles	put	/devices/{serial}/camera/wirelessProfiles	id
Docs	createNetworkCameraWirelessProfile	post	/networks/{networkId}/camera/wirelessProfiles	id
Docs	getNetworkCameraWirelessProfiles	get	/networks/{networkId}/camera/wirelessProfiles	id

zoneId