Networks

Schedule auto locate jobs for one or more floor plans in a network.

API documentation: batchNetworkFloorPlansAutoLocateJobs

Parameters:

• network_id (str) –

  Network ID.

• jobs (list[BatchNetworkFloorPlansAutoLocateJobsJobsItem]) –

  The list of auto locate jobs to be scheduled. Up to 100 jobs can be provided in a request.

Returns:

• BatchNetworkFloorPlansAutoLocateJobsResponse –

  Successful operation.

{
  "jobs": [
    {
      "id": "1234",
      "networkId": "N_24329156",
      "floorPlanId": "g_2176982374",
      "status": "error",
      "scheduledAt": "2018-02-11T00:00:00Z",
      "completed": {
        "percentage": 50
      },
      "ranging": {
        "status": "in progress",
        "completed": {
          "percentage": 24
        }
      },
      "gnss": {
        "status": "in progress",
        "completed": {
          "percentage": 4
        }
      },
      "errors": [
        {
          "source": "ranging",
          "type": "missing anchors"
        }
      ]
    }
  ]
}

Update floorplan assignments for a batch of devices.

API documentation: batchNetworkFloorPlansDevicesUpdate

Parameters:

• network_id (str) –

  Network ID.

• assignments (list[BatchNetworkFloorPlansDevicesUpdateAssignmentsItem]) –

  List of floorplan assignments to update. Up to 100 floor plan assignments can be provided in a request.

Returns:

• PublishNetworkFloorPlansAutoLocateJobResponse –

  Successful operation.

{
  "success": true
}

Bind a network to a template.

API documentation: bindNetwork

Parameters:

• network_id (str) –

  Network ID.

• config_template_id (str) –

  The ID of the template to which the network should be bound.

• auto_bind (bool | None, default: None ) –

  Optional boolean indicating whether the network's switches should automatically bind to profiles of the same model. Defaults to false if left unspecified. This option only affects switch networks and switch templates. Auto-bind is not valid unless the switch template has at least one profile and has at most one profile per switch model.

Returns:

• BindNetworkResponse –

  Successful operation.

{
  "id": "N_24329156",
  "organizationId": "2930418",
  "name": "Main Office",
  "productTypes": [
    "appliance",
    "switch",
    "wireless"
  ],
  "timeZone": "America/Los_Angeles",
  "tags": [
    "tag1",
    "tag2"
  ],
  "enrollmentString": "my-enrollment-string",
  "url": "https://n1.meraki.com//n//manage/nodes/list",
  "notes": "Additional description of the network",
  "isBoundToConfigTemplate": false,
  "configTemplateId": "N_24329156"
}

Cancel a scheduled or running auto locate job.

API documentation: cancelNetworkFloorPlansAutoLocateJob

Parameters:

• network_id (str) –

  Network ID.

• job_id (str) –

  Job ID.

Returns:

• None –

  Successful operation.

Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requests against that device to succeed).

API documentation: claimNetworkDevices

Parameters:

• network_id (str) –

  Network ID.

• add_atomically (bool | None, default: None ) –

  Whether to claim devices atomically. If true, all devices will be claimed or none will be claimed. Default is true.

• serials (list[str]) –

  A list of serials of devices to claim.

• details_by_device (list[ClaimNetworkDevicesDetailsByDeviceItem] | None, default: None ) –

  Optional details for claimed devices (currently only used for Catalyst devices).

Returns:

• ClaimNetworkDevicesResponse –

  Successful operation.

{
  "serials": [
    "Q234-ABCD-0001",
    "Q234-ABCD-0002",
    "Q234-ABCD-0003"
  ],
  "errors": [
    {
      "serial": "Q234-ABCD-5678",
      "errors": [
        "Device already claimed"
      ]
    }
  ]
}

Rollback a Firmware Upgrade For A Network.

API documentation: createNetworkFirmwareUpgradesRollback

Parameters:

• network_id (str) –

  Network ID.

• product (CreateNetworkFirmwareUpgradesRollbackProduct | None, default: None ) –

  Product type to rollback (if the network is a combined network).

• time (str | None, default: None ) –

  Scheduled time for the rollback.

• reasons (list[CreateNetworkFirmwareUpgradesRollbackReasonsItem]) –

  Reasons for the rollback.

• to_version (CreateNetworkFirmwareUpgradesRollbackToVersion | None, default: None ) –

  Version to downgrade to (if the network has firmware flexibility).

• predownload (CreateNetworkFirmwareUpgradesRollbackPredownload | None, default: None ) –

  Predownload settings for the firmware upgrade.

Returns:

• CreateNetworkFirmwareUpgradesRollbackResponse –

  Successful operation.

{
  "product": "switch",
  "status": "pending",
  "upgradeBatchId": "23456",
  "time": "2020-10-21T02:00:00Z",
  "toVersion": {
    "id": "7857",
    "firmware": "switch-15-5-2",
    "shortName": "MS 25.5.2",
    "releaseType": "stable",
    "releaseDate": "2020-03-28T17:22:52Z"
  },
  "reasons": [
    {
      "category": "performance",
      "comment": "Network was slower with the upgrade"
    }
  ],
  "predownload": {
    "enabled": false
  }
}

Create a Staged Upgrade Event for a network.

API documentation: createNetworkFirmwareUpgradesStagedEvent

Parameters:

• network_id (str) –

  Network ID.

• products (CreateNetworkFirmwareUpgradesStagedEventProducts | None, default: None ) –

  Contains firmware upgrade version information.

• stages (list[CreateNetworkFirmwareUpgradesStagedEventStagesItem]) –

  All firmware upgrade stages in the network with their start time.

Returns:

• GetNetworkFirmwareUpgradesStagedEventsResponse –

  Successful operation.

{
  "products": {
    "switch": {
      "nextUpgrade": {
        "toVersion": {
          "id": "1234",
          "shortName": "MS 15.2.1"
        }
      }
    }
  },
  "stages": [
    {
      "group": {
        "id": "1234",
        "name": "My Staged Upgrade Group",
        "description": "My Staged Upgrade Group Description"
      },
      "milestones": {
        "scheduledFor": "2018-02-11T00:00:00Z",
        "startedAt": "2018-02-11T00:00:00Z",
        "completedAt": "2018-02-11T00:00:00Z",
        "canceledAt": "2018-02-11T00:00:00Z"
      },
      "status": "Completed"
    }
  ],
  "reasons": [
    {
      "category": "performance",
      "comment": "Network was slower with the upgrade"
    }
  ]
}

Create a Staged Upgrade Group for a network.

API documentation: createNetworkFirmwareUpgradesStagedGroup

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  Name of the Staged Upgrade Group. Length must be 1 to 255 characters.

• description (str | None, default: None ) –

  Description of the Staged Upgrade Group. Length must be 1 to 255 characters.

• is_default (bool) –

  Boolean indicating the default Group. Any device that does not have a group explicitly assigned will upgrade with this group.

• assigned_devices (CreateNetworkFirmwareUpgradesStagedGroupAssignedDevices | None, default: None ) –

  The devices and Switch Stacks assigned to the Group.

Returns:

• NetworkFirmwareUpgradesStagedGroupResponse –

  Successful operation.

{
  "groupId": "1234",
  "name": "My Staged Upgrade Group",
  "description": "The description of the group",
  "isDefault": false,
  "assignedDevices": {
    "devices": [
      {
        "serial": "Q234-ABCD-5678",
        "name": "Device Name"
      }
    ],
    "switchStacks": [
      {
        "id": "1234",
        "name": "Stack Name"
      }
    ]
  }
}

Upload a floor plan.

API documentation: createNetworkFloorPlan

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name of your floor plan.

• center (CreateNetworkFloorPlanCenter | None, default: None ) –

  The longitude and latitude of the center of your floor plan. The 'center' or two adjacent corners (e.g. 'topLeftCorner' and 'bottomLeftCorner') must be specified. If 'center' is specified, the floor plan is placed over that point with no rotation. If two adjacent corners are specified, the floor plan is rotated to line up with the two specified points. The aspect ratio of the floor plan's image is preserved regardless of which corners/center are specified. (This means if that more than two corners are specified, only two corners may be used to preserve the floor plan's aspect ratio.). No two points can have the same latitude, longitude pair.

• bottom_left_corner (CreateNetworkFloorPlanBottomLeftCorner | None, default: None ) –

  The longitude and latitude of the bottom left corner of your floor plan.

• bottom_right_corner (CreateNetworkFloorPlanBottomRightCorner | None, default: None ) –

  The longitude and latitude of the bottom right corner of your floor plan.

• top_left_corner (CreateNetworkFloorPlanTopLeftCorner | None, default: None ) –

  The longitude and latitude of the top left corner of your floor plan.

• top_right_corner (CreateNetworkFloorPlanTopRightCorner | None, default: None ) –

  The longitude and latitude of the top right corner of your floor plan.

• floor_number (float | None, default: None ) –

  The floor number of the floors within the building.

• image_contents (str) –

  The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.

Returns:

• NetworkFloorPlanResponse –

  Successful operation.

{
  "floorPlanId": "g_1234567",
  "imageUrl": "https://meraki-na.s3.amazonaws.com/assets/...",
  "imageUrlExpiresAt": "2019-06-11 16:04:54 +00:00",
  "imageExtension": "png",
  "imageMd5": "2a9edd3f4ffd80130c647d13eacb59f3",
  "name": "HQ Floor Plan",
  "devices": [
    {
      "name": "My AP",
      "lat": 37.4180951010362,
      "lng": -122.098531723022,
      "address": "1600 Pennsylvania Ave",
      "notes": "My AP's note",
      "tags": [
        "recently-added"
      ],
      "networkId": "N_24329156",
      "serial": "Q234-ABCD-5678",
      "model": "MR34",
      "imei": "123456789000000",
      "mac": "00:11:22:33:44:55",
      "lanIp": "1.2.3.4",
      "firmware": "wireless-25-14",
      "productType": "wireless",
      "details": [
        {
          "name": "Catalyst serial",
          "value": "123ABC"
        }
      ]
    }
  ],
  "width": 100.0,
  "height": 150.1,
  "center": {
    "lat": 37.770040510499996,
    "lng": -122.38714009525
  },
  "bottomLeftCorner": {
    "lat": 37.7696461495,
    "lng": -122.3880815506
  },
  "bottomRightCorner": {
    "lat": 37.771524649766654,
    "lng": -122.38795275055205
  },
  "topLeftCorner": {
    "lat": 37.769700101836364,
    "lng": -122.3888684251381
  },
  "topRightCorner": {
    "lat": 37.77157860210302,
    "lng": -122.38873962509012
  },
  "floorNumber": 5.0
}

Create a group policy.

API documentation: createNetworkGroupPolicy

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name for your group policy. Required.

• scheduling (CreateNetworkGroupPolicyScheduling | None, default: None ) –

  The schedule for the group policy. Schedules are applied to days of the week.

• bandwidth (CreateNetworkGroupPolicyBandwidth | None, default: None ) –

  The bandwidth settings for clients bound to your group policy.

• firewall_and_traffic_shaping (CreateNetworkGroupPolicyFirewallAndTrafficShaping | None, default: None ) –

  The firewall and traffic shaping rules and settings for your policy.

• content_filtering (CreateNetworkGroupPolicyContentFiltering | None, default: None ) –

  The content filtering settings for your group policy.

• splash_auth_settings (CreateNetworkGroupPolicySplashAuthSettings | None, default: None ) –

  Whether clients bound to your policy will bypass splash authorization or behave according to the network's rules. Can be one of 'network default' or 'bypass'. Only available if your network has a wireless configuration.

• vlan_tagging (CreateNetworkGroupPolicyVlanTagging | None, default: None ) –

  The VLAN tagging settings for your group policy. Only available if your network has a wireless configuration.

• bonjour_forwarding (CreateNetworkGroupPolicyBonjourForwarding | None, default: None ) –

  The Bonjour settings for your group policy. Only valid if your network has a wireless configuration.

Returns:

• NetworkGroupPolicyResponse –

  Successful operation.

{
  "groupPolicyId": "101",
  "scheduling": {
    "enabled": true,
    "monday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "tuesday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "wednesday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "thursday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "friday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "saturday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    },
    "sunday": {
      "active": true,
      "from": "9:00",
      "to": "17:00"
    }
  },
  "bandwidth": {
    "settings": "custom",
    "bandwidthLimits": {
      "limitUp": 1000000,
      "limitDown": 1000000
    }
  },
  "firewallAndTrafficShaping": {
    "settings": "custom",
    "trafficShapingRules": [
      {
        "definitions": [
          {
            "type": "host",
            "value": "google.com"
          }
        ],
        "perClientBandwidthLimits": {
          "settings": "custom",
          "bandwidthLimits": {
            "limitUp": 1000000,
            "limitDown": 1000000
          }
        },
        "dscpTagValue": 0,
        "pcpTagValue": 0,
        "priority": "normal"
      }
    ],
    "l3FirewallRules": [
      {
        "comment": "Allow TCP traffic to subnet with HTTP servers.",
        "policy": "allow",
        "protocol": "tcp",
        "destPort": "443",
        "destCidr": "192.168.1.0/24"
      }
    ],
    "l7FirewallRules": [
      {
        "policy": "deny",
        "type": "host",
        "value": "google.com"
      }
    ]
  },
  "contentFiltering": {
    "allowedUrlPatterns": {
      "settings": "network default",
      "patterns": []
    },
    "blockedUrlPatterns": {
      "settings": "append",
      "patterns": [
        "http://www.example.com",
        "http://www.betting.com"
      ]
    },
    "blockedUrlCategories": {
      "settings": "override",
      "categories": [
        "meraki:contentFiltering/category/1",
        "meraki:contentFiltering/category/7"
      ]
    }
  },
  "splashAuthSettings": "bypass",
  "vlanTagging": {
    "settings": "custom",
    "vlanId": "1"
  },
  "bonjourForwarding": {
    "settings": "custom",
    "rules": [
      {
        "description": "A simple bonjour rule",
        "vlanId": "1",
        "services": [
          "All Services"
        ]
      }
    ]
  }
}

Authorize a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap).

API documentation: createNetworkMerakiAuthUser

Parameters:

• network_id (str) –

  Network ID.

• email (str) –

  Email address of the user.

• name (str | None, default: None ) –

  Name of the user. Only required If the user is not a Dashboard administrator.

• password (str | None, default: None ) –

  The password for this user account. Only required If the user is not a Dashboard administrator.

• account_type (CreateNetworkMerakiAuthUserAccountType | None, default: None ) –

  Authorization type for user. Can be 'Guest' or '802.1X' for wireless networks, or 'Client VPN' for MX networks. Defaults to '802.1X'.

• email_password_to_user (bool | None, default: None ) –

  Whether or not Meraki should email the password to user. Default is false.

• is_admin (bool | None, default: None ) –

  Whether or not the user is a Dashboard administrator.

• authorizations (list[CreateNetworkMerakiAuthUserAuthorizationsItem]) –

  Authorization zones and expiration dates for the user.

Returns:

• NetworkMerakiAuthUserResponse –

  Successful operation.

{
  "id": "aGlAaGkuY29t",
  "email": "miles@meraki.com",
  "name": "Miles Meraki",
  "createdAt": "2018-02-11T00:00:00.090210Z",
  "accountType": "802.1X",
  "isAdmin": false,
  "authorizations": [
    {
      "ssidNumber": 1,
      "authorizedZone": "Store WiFi",
      "expiresAt": "2018-03-13T00:00:00.090210Z",
      "authorizedByName": "Miles Meraki",
      "authorizedByEmail": "miles@meraki.com"
    }
  ]
}

Add an MQTT broker.

API documentation: createNetworkMqttBroker

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  Name of the MQTT broker.

• host (str) –

  Host name/IP address where the MQTT broker runs.

• port (int) –

  Host port though which the MQTT broker can be reached.

• security (CreateNetworkMqttBrokerSecurity | None, default: None ) –

  Security settings of the MQTT broker.

• authentication (CreateNetworkMqttBrokerAuthentication | None, default: None ) –

  Authentication settings of the MQTT broker.

Returns:

• NetworkMqttBrokerResponse –

  Successful operation.

{
  "id": "1234",
  "name": "MQTT_Broker_1",
  "host": "1.2.3.4",
  "port": 443,
  "security": {
    "mode": "tls",
    "tls": {
      "hasCaCertificate": true,
      "verifyHostnames": true
    }
  },
  "authentication": {
    "username": "milesmeraki"
  }
}

Submit a new delete or restrict processing PII request.

API documentation: createNetworkPiiRequest

Parameters:

• network_id (str) –

  Network ID.

• type_ (CreateNetworkPiiRequestType | None, default: None ) –

  One of "delete" or "restrict processing".

• datasets (list[str] | None, default: None ) –

  The datasets related to the provided key that should be deleted. Only applies to "delete" requests. The value "all" will be expanded to all datasets applicable to this type. The datasets by applicable to each type are: mac (usage, events, traffic), email (users, loginAttempts), username (users, loginAttempts), bluetoothMac (client, connectivity), smDeviceId (device), smUserId (user).

• username (str | None, default: None ) –

  The username of a network log in. Only applies to "delete" requests.

• email (str | None, default: None ) –

  The email of a network user account. Only applies to "delete" requests.

• mac (str | None, default: None ) –

  The MAC of a network client device. Applies to both "restrict processing" and "delete" requests.

• sm_device_id (str | None, default: None ) –

  The sm_device_id of a Systems Manager device. The only way to "restrict processing" or "delete" a Systems Manager device. Must include "device" in the dataset for a "delete" request to destroy the device.

• sm_user_id (str | None, default: None ) –

  The sm_user_id of a Systems Manager user. The only way to "restrict processing" or "delete" a Systems Manager user. Must include "user" in the dataset for a "delete" request to destroy the user.

Returns:

• NetworkPiiRequestResponse –

  Successful operation.

{
  "id": "1234",
  "organizationWide": false,
  "networkId": "N_1234",
  "type": "delete",
  "mac": "00:77:00:77:00:77",
  "datasets": "['usage', 'events']",
  "status": "Completed",
  "createdAt": 1524692227,
  "completedAt": 1524702227
}

Create a VLAN profile for a network.

API documentation: createNetworkVlanProfile

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  Name of the profile, string length must be from 1 to 255 characters.

• vlan_names (list[CreateNetworkVlanProfileVlanNamesItem]) –

  An array of named VLANs.

• vlan_groups (list[CreateNetworkVlanProfileVlanGroupsItem]) –

  An array of VLAN groups.

• iname (str) –

  IName of the profile.

Returns:

• NetworkVlanProfileResponse –

  Successful operation.

{
  "iname": "Profile1",
  "name": "My VLAN profile name",
  "isDefault": false,
  "vlanNames": [
    {
      "name": "named-1",
      "vlanId": "1",
      "adaptivePolicyGroup": {
        "id": "791",
        "name": "Infrastructure"
      }
    }
  ],
  "vlanGroups": [
    {
      "name": "named-group-1",
      "vlanIds": "2,5-7"
    }
  ]
}

Add an HTTP server to a network.

API documentation: createNetworkWebhooksHttpServer

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  A name for easy reference to the HTTP server.

• url (str) –

  The URL of the HTTP server. Once set, cannot be updated.

• shared_secret (str | None, default: None ) –

  A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.

• payload_template (CreateNetworkWebhooksHttpServerPayloadTemplate | None, default: None ) –

  The payload template to use when posting data to the HTTP server.

Returns:

• NetworkWebhooksHttpServerResponse –

  Successful operation.

{
  "id": "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vbXlfY3VzdG9tX3dlYmhvb2s=",
  "name": "Example Webhook Server",
  "url": "https://www.example.com/my_custom_webhook",
  "networkId": "N_12345678",
  "payloadTemplate": {
    "payloadTemplateId": "wpt_00001",
    "name": "Meraki (included)"
  }
}

Create a webhook payload template for a network.

API documentation: createNetworkWebhooksPayloadTemplate

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name of the new template.

• body (str | None, default: None ) –

  The liquid template used for the body of the webhook message. Either body or bodyFile must be specified.

• headers (list[CreateNetworkWebhooksPayloadTemplateHeadersItem] | None, default: None ) –

  The liquid template used with the webhook headers.

• body_file (str | None, default: None ) –

  A Base64 encoded file containing liquid template used for the body of the webhook message. Either body or bodyFile must be specified.

• headers_file (str | None, default: None ) –

  A Base64 encoded file containing the liquid template used with the webhook headers.

Returns:

• NetworkWebhooksPayloadTemplateResponse –

  Successful operation.

{
  "payloadTemplateId": "wpt_343",
  "type": "custom",
  "name": "Custom Template",
  "headers": [
    {
      "name": "Authorization",
      "template": "Bearer {{sharedSecret}}"
    }
  ],
  "body": "{\"event_type\":\"{{alertTypeId}}\",\"client_payload\":{\"text\":\"{{alertData}}\"}}",
  "sharing": {
    "byNetwork": {
      "adminsCanModify": false
    }
  }
}

Send a test webhook for a network.

API documentation: createNetworkWebhooksWebhookTest

Parameters:

• network_id (str) –

  Network ID.

• url (str) –

  The URL where the test webhook will be sent.

• shared_secret (str | None, default: None ) –

  The shared secret the test webhook will send. Optional. Defaults to HTTP server's shared secret. Otherwise, defaults to an empty string.

• payload_template_id (str | None, default: None ) –

  The ID of the payload template of the test webhook. Defaults to the HTTP server's template ID if one exists for the given URL, or Generic template ID otherwise.

• payload_template_name (str | None, default: None ) –

  The name of the payload template.

• alert_type_id (str | None, default: None ) –

  The type of alert which the test webhook will send. Optional. Defaults to power_supply_down.

Returns:

• NetworkWebhooksWebhookTestResponse –

  Successful operation.

{
  "id": "1234",
  "url": "https://www.example.com/path",
  "status": "enqueued"
}

Postpone by 1 week all pending staged upgrade stages for a network.

API documentation: deferNetworkFirmwareUpgradesStagedEvents

Parameters:

• network_id (str) –

  Network ID.

Returns:

• GetNetworkFirmwareUpgradesStagedEventsResponse –

  Successful operation.

{
  "products": {
    "switch": {
      "nextUpgrade": {
        "toVersion": {
          "id": "1234",
          "shortName": "MS 15.2.1"
        }
      }
    }
  },
  "stages": [
    {
      "group": {
        "id": "1234",
        "name": "My Staged Upgrade Group",
        "description": "My Staged Upgrade Group Description"
      },
      "milestones": {
        "scheduledFor": "2018-02-11T00:00:00Z",
        "startedAt": "2018-02-11T00:00:00Z",
        "completedAt": "2018-02-11T00:00:00Z",
        "canceledAt": "2018-02-11T00:00:00Z"
      },
      "status": "Completed"
    }
  ],
  "reasons": [
    {
      "category": "performance",
      "comment": "Network was slower with the upgrade"
    }
  ]
}

Delete a network.

API documentation: deleteNetwork

Parameters:

• network_id (str) –

  Network ID.

Returns:

• None –

  Successful operation.

Delete a Staged Upgrade Group.

API documentation: deleteNetworkFirmwareUpgradesStagedGroup

Parameters:

• network_id (str) –

  Network ID.

• group_id (str) –

  Group ID.

Returns:

• None –

  Successful operation.

Destroy a floor plan.

API documentation: deleteNetworkFloorPlan

Parameters:

• network_id (str) –

  Network ID.

• floor_plan_id (str) –

  Floor plan ID.

Returns:

• None –

  Successful operation.

{
  "floorPlanId": "g_1234567",
  "imageUrl": "https://meraki-na.s3.amazonaws.com/assets/...",
  "imageUrlExpiresAt": "2019-06-11 16:04:54 +00:00",
  "imageExtension": "png",
  "imageMd5": "2a9edd3f4ffd80130c647d13eacb59f3",
  "name": "HQ Floor Plan",
  "devices": [
    {
      "name": "My AP",
      "lat": 37.4180951010362,
      "lng": -122.098531723022,
      "address": "1600 Pennsylvania Ave",
      "notes": "My AP's note",
      "tags": [
        "recently-added"
      ],
      "networkId": "N_24329156",
      "serial": "Q234-ABCD-5678",
      "model": "MR34",
      "imei": "123456789000000",
      "mac": "00:11:22:33:44:55",
      "lanIp": "1.2.3.4",
      "firmware": "wireless-25-14",
      "productType": "wireless",
      "details": [
        {
          "name": "Catalyst serial",
          "value": "123ABC"
        }
      ]
    }
  ],
  "width": 100.0,
  "height": 150.1,
  "center": {
    "lat": 37.770040510499996,
    "lng": -122.38714009525
  },
  "bottomLeftCorner": {
    "lat": 37.7696461495,
    "lng": -122.3880815506
  },
  "bottomRightCorner": {
    "lat": 37.771524649766654,
    "lng": -122.38795275055205
  },
  "topLeftCorner": {
    "lat": 37.769700101836364,
    "lng": -122.3888684251381
  },
  "topRightCorner": {
    "lat": 37.77157860210302,
    "lng": -122.38873962509012
  },
  "floorNumber": 5.0
}

Delete a group policy.

API documentation: deleteNetworkGroupPolicy

Parameters:

• network_id (str) –

  Network ID.

• group_policy_id (str) –

  Group policy ID.

• force (bool | None, default: None ) –

  If true, the system deletes the GP even if there are active clients using the GP. After deletion, active clients that were assigned to that Group Policy will be left without any policy applied. Default is false.

Returns:

• None –

  Successful operation.

Delete an 802.1X RADIUS user, or deauthorize and optionally delete a splash guest or client VPN user.

API documentation: deleteNetworkMerakiAuthUser

Parameters:

• network_id (str) –

  Network ID.

• meraki_auth_user_id (str) –

  Meraki auth user ID.

• delete (bool | None, default: None ) –

  If the ID supplied is for a splash guest or client VPN user, and that user is not authorized for any other networks in the organization, then also delete the user. 802.1X RADIUS users are always deleted regardless of this optional attribute.

Returns:

• None –

  Successful operation.

Delete an MQTT broker.

API documentation: deleteNetworkMqttBroker

Parameters:

• network_id (str) –

  Network ID.

• mqtt_broker_id (str) –

  Mqtt broker ID.

Returns:

• None –

  Successful operation.

Delete a restrict processing PII request.

API documentation: deleteNetworkPiiRequest

Parameters:

• network_id (str) –

  Network ID.

• request_id (str) –

  Request ID.

Returns:

• None –

  Successful operation.

Delete a VLAN profile of a network.

API documentation: deleteNetworkVlanProfile

Parameters:

• network_id (str) –

  Network ID.

• iname (str) –

  Iname.

Returns:

• None –

  Successful operation.

Delete an HTTP server from a network.

API documentation: deleteNetworkWebhooksHttpServer

Parameters:

• network_id (str) –

  Network ID.

• http_server_id (str) –

  Http server ID.

Returns:

• None –

  Successful operation.

Destroy a webhook payload template for a network.

API documentation: deleteNetworkWebhooksPayloadTemplate

Parameters:

• network_id (str) –

  Network ID.

• payload_template_id (str) –

  Payload template ID.

Returns:

• None –

  Successful operation.

Return a network.

API documentation: getNetwork

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkResponse –

  Successful operation.

{
  "id": "N_24329156",
  "organizationId": "2930418",
  "name": "Main Office",
  "productTypes": [
    "appliance",
    "switch",
    "wireless"
  ],
  "timeZone": "America/Los_Angeles",
  "tags": [
    "tag1",
    "tag2"
  ],
  "enrollmentString": "my-enrollment-string",
  "url": "https://n1.meraki.com//n//manage/nodes/list",
  "notes": "Additional description of the network",
  "isBoundToConfigTemplate": false
}

Return the alert history for this network.

API documentation: getNetworkAlertsHistory

Parameters:

• network_id (str) –

  Network ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkAlertsHistoryResponseItem] –

  Successful operation.

[
  {
    "occurredAt": "2022-07-11T22:35:34Z",
    "alertTypeId": "settings_changed",
    "alertType": "Settings changed",
    "device": {
      "serial": "Q3CG-G6W8-BEVR"
    },
    "destinations": {
      "email": {
        "sentAt": "2022-07-11T22:40:34Z"
      },
      "push": {
        "sentAt": "2022-07-11T22:40:34Z"
      },
      "sms": {
        "sentAt": "2022-07-11T22:40:34Z"
      },
      "webhook": {
        "sentAt": "2022-07-11T22:40:34Z"
      }
    }
  }
]

Return the alert configuration for this network.

API documentation: getNetworkAlertsSettings

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkAlertsSettingsResponse –

  Successful operation.

{
  "defaultDestinations": {
    "emails": [
      "miles@meraki.com"
    ],
    "allAdmins": true,
    "snmp": true,
    "httpServerIds": [
      "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M="
    ]
  },
  "alerts": [
    {
      "type": "gatewayDown",
      "enabled": true,
      "alertDestinations": {
        "emails": [
          "miles@meraki.com"
        ],
        "smsNumbers": [
          "+15555555555"
        ],
        "allAdmins": false,
        "snmp": false,
        "httpServerIds": [
          "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M="
        ]
      },
      "filters": {
        "conditions": [
          {
            "type": "temperature",
            "unit": "celsius",
            "duration": 0,
            "direction": "+",
            "threshold": 72.5
          }
        ],
        "failureType": "802.1X auth fail",
        "lookbackWindow": 360,
        "minDuration": 60,
        "name": "Filter",
        "period": 1800,
        "priority": "",
        "regex": "[a-z]",
        "selector": "{\"smartSensitivity\":\"medium\",\"smartEnabled\":false,\"eventReminderPeriodSecs\":10800}",
        "serials": [
          "Q234-ABCD-0001",
          "Q234-ABCD-0002",
          "Q234-ABCD-0003"
        ],
        "ssidNum": 1,
        "tag": "tag1",
        "threshold": 30,
        "timeout": 60
      }
    }
  ],
  "muting": {
    "byPortSchedules": {
      "enabled": true
    }
  }
}

Return a Bluetooth client.

API documentation: getNetworkBluetoothClient

Parameters:

• network_id (str) –

  Network ID.

• bluetooth_client_id (str) –

  Bluetooth client ID.

• include_connectivity_history (bool | None, default: None ) –

  Include the connectivity history for this client.

• connectivity_history_timespan (int | None, default: None ) –

  The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used.

Returns:

• GetNetworkBluetoothClientResponse –

  Successful operation.

{
  "id": "1284392014819",
  "mac": "22:33:44:55:66:77",
  "networkId": "N_24329156",
  "name": "My Device",
  "deviceName": "Bose QuietComfort 35",
  "manufacturer": "Bose",
  "lastSeen": 1526087474,
  "seenByDeviceMac": "00:11:22:33:44:55",
  "inSightAlert": false,
  "outOfSightAlert": false,
  "tags": [
    "tag1",
    "tag2"
  ]
}

List the Bluetooth clients seen by APs in this network.

API documentation: getNetworkBluetoothClients

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 7 days from today.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 7 days. The default is 1 day.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• include_connectivity_history (bool | None, default: None ) –

  Include the connectivity history for this client.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkBluetoothClientResponse] –

  Successful operation.

[
  {
    "id": "1284392014819",
    "mac": "22:33:44:55:66:77",
    "networkId": "N_24329156",
    "name": "My Device",
    "deviceName": "Bose QuietComfort 35",
    "manufacturer": "Bose",
    "lastSeen": 1526087474,
    "seenByDeviceMac": "00:11:22:33:44:55",
    "inSightAlert": false,
    "outOfSightAlert": false,
    "tags": [
      "tag1",
      "tag2"
    ]
  }
]

Return the client associated with the given identifier.

API documentation: getNetworkClient

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

Returns:

• GetNetworkClientResponse –

  Successful operation.

{
  "id": "k74272e",
  "mac": "22:33:44:55:66:77",
  "ip": "1.2.3.4",
  "ip6": "2001:db8:3c4d:15::1",
  "ip6Local": "fe80:0:0:0:1430:aac1:6826:75ab",
  "description": "Miles's phone",
  "firstSeen": 1518365681,
  "lastSeen": 1526087474,
  "manufacturer": "Apple",
  "model": "iPhone",
  "os": "iOS",
  "user": "milesmeraki",
  "vlan": "100",
  "namedVlan": "100",
  "ssid": "My SSID",
  "switchport": "My switch port",
  "wirelessCapabilities": "802.11b - 2.4 GHz",
  "smInstalled": true,
  "recentDeviceMac": "22:33:44:55:66:77",
  "recentDeviceId": "15551677676480",
  "recentDeviceName": "00:11:22:33:44:55",
  "recentDeviceSerial": "Q234-ABCD-5678",
  "recentDeviceConnection": "Wired",
  "clientVpnConnections": [
    {
      "remoteIp": "1.2.3.4",
      "connectedAt": 1522613355,
      "disconnectedAt": 1522613360
    }
  ],
  "lldp": [
    [
      "System name",
      "Some system name"
    ],
    [
      "System description",
      "Some system description"
    ],
    [
      "Port ID",
      "1"
    ],
    [
      "Chassis ID",
      "00:18:0a:00:00:00"
    ],
    [
      "Port description",
      "eth0"
    ],
    [
      "System capabilities",
      "Two-port MAC Relay"
    ]
  ],
  "cdp": [
    [
      "System name",
      "Some system name"
    ],
    [
      "System description",
      "Some system description"
    ],
    [
      "Port ID",
      "1"
    ],
    [
      "Chassis ID",
      "00:18:0a:00:00:00"
    ],
    [
      "Port description",
      "eth0"
    ],
    [
      "System capabilities",
      "Two-port MAC Relay"
    ]
  ],
  "status": "Online",
  "notes": "My client note",
  "deviceTypePrediction": "iPhone SE, iOS9.3.5"
}

Return the policy assigned to a client on the network.

API documentation: getNetworkClientPolicy

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

Returns:

• NetworkClientPolicyResponse –

  Successful operation.

{
  "mac": "00:11:22:33:44:55",
  "devicePolicy": "Different policies by SSID",
  "groupPolicyId": "101",
  "policiesBySsid": [
    {
      "ssidNumber": 2,
      "devicePolicy": "Group policy",
      "groupPolicyId": "101"
    }
  ]
}

Return the splash authorization for a client, for each SSID they've associated with through splash.

API documentation: getNetworkClientSplashAuthorizationStatus

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

Returns:

• NetworkClientSplashAuthorizationStatusResponse –

  Successful operation.

{
  "ssids": {
    "0": {
      "isAuthorized": true,
      "authorizedAt": "2018-05-12T00:00:00Z",
      "expiresAt": "2018-05-12T01:00:00Z"
    }
  }
}

Return the client's network traffic data over time.

API documentation: getNetworkClientTrafficHistory

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkClientTrafficHistoryResponseItem] –

  Successful operation.

[
  {
    "ts": "2018-02-11T00:00:00.090210Z",
    "application": "Google",
    "destination": "www.google.com",
    "protocol": "TCP",
    "port": 443,
    "recv": 61.0,
    "sent": 138.0,
    "numFlows": 5,
    "activeSeconds": 240
  }
]

Return the client's daily usage history.

API documentation: getNetworkClientUsageHistory

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

Returns:

• PaginatedResponse[GetNetworkClientUsageHistoryResponseItem] –

  Successful operation.

[
  {
    "received": 61.0,
    "sent": 138.0,
    "ts": "2018-02-11T00:00:00.090210Z"
  }
]

List the clients that have used this network in the timespan.

API documentation: getNetworkClients

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 5000. Default is 10.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• statuses (GetNetworkClientsStatuses | None, default: None ) –

  Filters clients based on status. Can be one of 'Online' or 'Offline'.

• ip (str | None, default: None ) –

  Filters clients based on a partial or full match for the ip address field.

• ip6 (str | None, default: None ) –

  Filters clients based on a partial or full match for the ip6 address field.

• ip6_local (str | None, default: None ) –

  Filters clients based on a partial or full match for the ip6Local address field.

• mac (str | None, default: None ) –

  Filters clients based on a partial or full match for the mac address field.

• os (str | None, default: None ) –

  Filters clients based on a partial or full match for the os (operating system) field.

• psk_group (str | None, default: None ) –

  Filters clients based on partial or full match for the iPSK name field.

• description (str | None, default: None ) –

  Filters clients based on a partial or full match for the description field.

• vlan (str | None, default: None ) –

  Filters clients based on the full match for the VLAN field.

• named_vlan (str | None, default: None ) –

  Filters clients based on the partial or full match for the named VLAN field.

• recent_device_connections (GetNetworkClientsRecentDeviceConnections | None, default: None ) –

  Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkClientsResponseItem] –

  Successful operation.

[
  {
    "id": "k74272e",
    "mac": "22:33:44:55:66:77",
    "ip": "1.2.3.4",
    "ip6": "2001:db8:3c4d:15::1",
    "description": "Miles's phone",
    "firstSeen": 1518365681,
    "lastSeen": 1526087474,
    "manufacturer": "Apple",
    "os": "iOS",
    "user": "milesmeraki",
    "vlan": "100",
    "ssid": "My SSID",
    "switchport": "My switch port",
    "wirelessCapabilities": "802.11b - 2.4 GHz",
    "smInstalled": true,
    "recentDeviceMac": "22:33:44:55:66:77",
    "status": "Online",
    "usage": {
      "sent": 138.0,
      "recv": 61.0
    },
    "namedVlan": "My VLAN",
    "adaptivePolicyGroup": "2: Infrastructure",
    "deviceTypePrediction": "iPhone SE, iOS9.3.5",
    "recentDeviceSerial": "Q234-ABCD-5678",
    "recentDeviceName": "00:11:22:33:44:55",
    "recentDeviceConnection": "Wired",
    "notes": "My AP's note",
    "ip6Local": "fe80:0:0:0:1430:aac1:6826:75ab",
    "groupPolicy8021x": "Student_Access",
    "pskGroup": "Group 1"
  }
]

Return the application usage data for clients.

API documentation: getNetworkClientsApplicationUsage

Parameters:

• network_id (str) –

  Network ID.

• clients (str) –

  A list of client keys, MACs or IPs separated by comma.

• ssid_number (GetNetworkClientsApplicationUsageSsidNumber | None, default: None ) –

  An SSID number to include. If not specified, events for all SSIDs will be returned.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkClientsApplicationUsageResponseItem] –

  Successful operation.

[
  {
    "clientId": "k74272e",
    "clientIp": "1.2.3.4",
    "clientMac": "00:11:22:33:44:55",
    "applicationUsage": [
      {
        "application": "Meraki HTTPS",
        "received": 61,
        "sent": 138
      }
    ]
  }
]

Returns a timeseries of total traffic consumption rates for all clients on a network within a given timespan, in megabits per second.

API documentation: getNetworkClientsBandwidthUsageHistory

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 30 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkClientsBandwidthUsageHistoryResponseItem] –

  Successful operation.

[
  {
    "ts": "2018-02-11T00:00:00.090210Z",
    "total": 345.0,
    "upstream": 200.0,
    "downstream": 145.0
  }
]

Return overview statistics for network clients.

API documentation: getNetworkClientsOverview

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

• resolution (int | None, default: None ) –

  The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2629746. The default is 604800.

Returns:

• GetNetworkClientsOverviewResponse –

  Successful operation.

{
  "counts": {
    "total": 100,
    "withHeavyUsage": 2
  },
  "usages": {
    "average": 2048,
    "withHeavyUsageAverage": 5345
  }
}

Return the usage histories for clients.

API documentation: getNetworkClientsUsageHistories

Parameters:

• network_id (str) –

  Network ID.

• clients (str) –

  A list of client keys, MACs or IPs separated by comma.

• ssid_number (GetNetworkClientsUsageHistoriesSsidNumber | None, default: None ) –

  An SSID number to include. If not specified, events for all SSIDs will be returned.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkClientsUsageHistoriesResponseItem] –

  Successful operation.

[
  {
    "clientId": "k74272e",
    "clientIp": "1.2.3.4",
    "clientMac": "00:11:22:33:44:55",
    "usageHistory": [
      {
        "received": 61.0,
        "sent": 138.0,
        "ts": "2018-02-11T00:00:00.090210Z"
      }
    ]
  }
]

List the devices in a network.

API documentation: getNetworkDevices

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[GetNetworkDevicesResponseItem] –

  Successful operation.

[
  {
    "name": "My AP",
    "lat": 37.4180951010362,
    "lng": -122.098531723022,
    "address": "1600 Pennsylvania Ave",
    "notes": "My AP's note",
    "tags": [
      " recently-added "
    ],
    "networkId": "N_24329156",
    "serial": "Q234-ABCD-5678",
    "model": "MR34",
    "mac": "00:11:22:33:44:55",
    "lanIp": "1.2.3.4",
    "firmware": "wireless-25-14",
    "floorPlanId": "g_2176982374",
    "details": [
      {
        "name": "Catalyst serial",
        "value": "123ABC"
      }
    ],
    "beaconIdParams": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "major": 5,
      "minor": 3
    }
  }
]

List the events for the network.

API documentation: getNetworkEvents

Parameters:

• network_id (str) –

  Network ID.

• product_type (GetNetworkEventsProductType | None, default: None ) –

  The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, wirelessController, campusGateway, and secureConnect.

• included_event_types (list[str] | None, default: None ) –

  A list of event types. The returned events will be filtered to only include events with these types.

• excluded_event_types (list[str] | None, default: None ) –

  A list of event types. The returned events will be filtered to exclude events with these types.

• device_mac (str | None, default: None ) –

  The MAC address of the Meraki device which the list of events will be filtered with.

• device_serial (str | None, default: None ) –

  The serial of the Meraki device which the list of events will be filtered with.

• device_name (str | None, default: None ) –

  The name of the Meraki device which the list of events will be filtered with.

• client_ip (str | None, default: None ) –

  The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks.

• client_mac (str | None, default: None ) –

  The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks.

• client_name (str | None, default: None ) –

  The name, or partial name, of the client which the list of events will be filtered with.

• sm_device_mac (str | None, default: None ) –

  The MAC address of the Systems Manager device which the list of events will be filtered with.

• sm_device_name (str | None, default: None ) –

  The name of the Systems Manager device which the list of events will be filtered with.

• event_details (str | None, default: None ) –

  The details of the event(Catalyst device only) which the list of events will be filtered with.

• event_severity (str | None, default: None ) –

  The severity of the event(Catalyst device only) which the list of events will be filtered with.

• is_catalyst (bool | None, default: None ) –

  Boolean indicating that whether it is a Catalyst device. For Catalyst device, eventDetails and eventSeverity can be used to filter events.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'prev' ) –

  direction to paginate, either "next" or "prev" (default) page.

• event_log_end_time (str | None, default: None ) –

  ISO8601 Zulu/UTC time, to use in conjunction with starting_after, to retrieve events within a time window.

Returns:

• PaginatedResponse[GetNetworkEventsResponseEventsItem] –

  Successful operation.

{
  "message": "Some error",
  "pageStartAt": "2018-02-11T00:00:00.090210Z",
  "pageEndAt": "2018-02-11T00:00:00.090210Z",
  "events": [
    {
      "occurredAt": "2018-02-11T00:00:00.090210Z",
      "networkId": "N_24329156",
      "type": "association",
      "description": "802.11 association",
      "category": "80211",
      "clientId": "k74272e",
      "clientDescription": "Miles's phone",
      "clientMac": "22:33:44:55:66:77",
      "deviceSerial": "Q234-ABCD-5678",
      "deviceName": "My AP",
      "ssidNumber": 1,
      "eventData": {
        "radio": "1",
        "vap": "1",
        "client_mac": "22:33:44:55:66:77",
        "client_ip": "1.2.3.4",
        "channel": "36",
        "rssi": "12",
        "aid": "2104009183"
      }
    }
  ]
}

List the event type to human-readable description.

API documentation: getNetworkEventsEventTypes

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[GetNetworkEventsEventTypesResponseItem] –

  Successful operation.

[
  {
    "category": "802.11",
    "type": "association",
    "description": "802.11 association"
  }
]

Get firmware upgrade information for a network.

API documentation: getNetworkFirmwareUpgrades

Parameters:

• network_id (str) –

  Network ID.

Returns:

• GetNetworkFirmwareUpgradesResponse –

  Successful operation.

{
  "upgradeWindow": {
    "dayOfWeek": "sun",
    "hourOfDay": "4:00"
  },
  "timezone": "America/Los_Angeles",
  "products": {
    "wireless": {
      "currentVersion": {
        "id": "4321",
        "firmware": "camera-11-2-1",
        "shortName": "MV 11.2.1",
        "releaseType": "stable",
        "releaseDate": "2020-03-17T17:22:52Z"
      },
      "lastUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "fromVersion": {
          "id": "1234",
          "firmware": "camera-10-8-1",
          "shortName": "MV 10.8.1",
          "releaseType": "stable",
          "releaseDate": "2021-03-17T17:22:52Z"
        },
        "toVersion": {
          "id": "4321",
          "firmware": "camera-11-2-1",
          "shortName": "MV 11.2.1",
          "releaseType": "stable",
          "releaseDate": "2019-03-17T17:22:52Z"
        }
      },
      "nextUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "predownload": {
          "enabled": false
        },
        "toVersion": {
          "id": "2134",
          "firmware": "camera-15-5-2",
          "shortName": "MV 25.5.2",
          "releaseType": "stable",
          "releaseDate": "2021-05-28T17:22:52Z"
        }
      },
      "isUpgradeAvailable": false,
      "availableVersions": [
        {
          "id": "3421",
          "firmware": "camera-16-x-y",
          "shortName": "MV 16.x.y",
          "releaseType": "beta",
          "releaseDate": "2020-11-28T17:22:52Z"
        }
      ],
      "participateInNextBetaRelease": false
    },
    "appliance": {
      "currentVersion": {
        "id": "4321",
        "firmware": "camera-11-2-1",
        "shortName": "MV 11.2.1",
        "releaseType": "stable",
        "releaseDate": "2020-03-17T17:22:52Z"
      },
      "lastUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "fromVersion": {
          "id": "1234",
          "firmware": "camera-10-8-1",
          "shortName": "MV 10.8.1",
          "releaseType": "stable",
          "releaseDate": "2021-03-17T17:22:52Z"
        },
        "toVersion": {
          "id": "4321",
          "firmware": "camera-11-2-1",
          "shortName": "MV 11.2.1",
          "releaseType": "stable",
          "releaseDate": "2019-03-17T17:22:52Z"
        }
      },
      "nextUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "toVersion": {
          "id": "2134",
          "firmware": "camera-15-5-2",
          "shortName": "MV 25.5.2",
          "releaseType": "stable",
          "releaseDate": "2021-05-28T17:22:52Z"
        }
      },
      "isUpgradeAvailable": false,
      "availableVersions": [
        {
          "id": "3421",
          "firmware": "camera-16-x-y",
          "shortName": "MV 16.x.y",
          "releaseType": "beta",
          "releaseDate": "2020-11-28T17:22:52Z"
        }
      ],
      "participateInNextBetaRelease": false
    },
    "switch": {
      "currentVersion": {
        "id": "4321",
        "firmware": "camera-11-2-1",
        "shortName": "MV 11.2.1",
        "releaseType": "stable",
        "releaseDate": "2020-03-17T17:22:52Z"
      },
      "lastUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "fromVersion": {
          "id": "1234",
          "firmware": "camera-10-8-1",
          "shortName": "MV 10.8.1",
          "releaseType": "stable",
          "releaseDate": "2021-03-17T17:22:52Z"
        },
        "toVersion": {
          "id": "4321",
          "firmware": "camera-11-2-1",
          "shortName": "MV 11.2.1",
          "releaseType": "stable",
          "releaseDate": "2019-03-17T17:22:52Z"
        }
      },
      "nextUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "toVersion": {
          "id": "2134",
          "firmware": "camera-15-5-2",
          "shortName": "MV 25.5.2",
          "releaseType": "stable",
          "releaseDate": "2021-05-28T17:22:52Z"
        }
      },
      "isUpgradeAvailable": false,
      "availableVersions": [
        {
          "id": "3421",
          "firmware": "camera-16-x-y",
          "shortName": "MV 16.x.y",
          "releaseType": "beta",
          "releaseDate": "2020-11-28T17:22:52Z"
        }
      ],
      "participateInNextBetaRelease": false
    },
    "camera": {
      "currentVersion": {
        "id": "4321",
        "firmware": "camera-11-2-1",
        "shortName": "MV 11.2.1",
        "releaseType": "stable",
        "releaseDate": "2020-03-17T17:22:52Z"
      },
      "lastUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "fromVersion": {
          "id": "1234",
          "firmware": "camera-10-8-1",
          "shortName": "MV 10.8.1",
          "releaseType": "stable",
          "releaseDate": "2021-03-17T17:22:52Z"
        },
        "toVersion": {
          "id": "4321",
          "firmware": "camera-11-2-1",
          "shortName": "MV 11.2.1",
          "releaseType": "stable",
          "releaseDate": "2019-03-17T17:22:52Z"
        }
      },
      "nextUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "toVersion": {
          "id": "2134",
          "firmware": "camera-15-5-2",
          "shortName": "MV 25.5.2",
          "releaseType": "stable",
          "releaseDate": "2021-05-28T17:22:52Z"
        }
      },
      "isUpgradeAvailable": false,
      "availableVersions": [
        {
          "id": "3421",
          "firmware": "camera-16-x-y",
          "shortName": "MV 16.x.y",
          "releaseType": "beta",
          "releaseDate": "2020-11-28T17:22:52Z"
        }
      ],
      "participateInNextBetaRelease": false
    },
    "cellularGateway": {
      "currentVersion": {
        "id": "4321",
        "firmware": "camera-11-2-1",
        "shortName": "MV 11.2.1",
        "releaseType": "stable",
        "releaseDate": "2020-03-17T17:22:52Z"
      },
      "lastUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "fromVersion": {
          "id": "1234",
          "firmware": "camera-10-8-1",
          "shortName": "MV 10.8.1",
          "releaseType": "stable",
          "releaseDate": "2021-03-17T17:22:52Z"
        },
        "toVersion": {
          "id": "4321",
          "firmware": "camera-11-2-1",
          "shortName": "MV 11.2.1",
          "releaseType": "stable",
          "releaseDate": "2019-03-17T17:22:52Z"
        }
      },
      "nextUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "toVersion": {
          "id": "2134",
          "firmware": "camera-15-5-2",
          "shortName": "MV 25.5.2",
          "releaseType": "stable",
          "releaseDate": "2021-05-28T17:22:52Z"
        }
      },
      "isUpgradeAvailable": false,
      "availableVersions": [
        {
          "id": "3421",
          "firmware": "camera-16-x-y",
          "shortName": "MV 16.x.y",
          "releaseType": "beta",
          "releaseDate": "2020-11-28T17:22:52Z"
        }
      ],
      "participateInNextBetaRelease": false
    },
    "sensor": {
      "currentVersion": {
        "id": "4321",
        "firmware": "camera-11-2-1",
        "shortName": "MV 11.2.1",
        "releaseType": "stable",
        "releaseDate": "2020-03-17T17:22:52Z"
      },
      "lastUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "fromVersion": {
          "id": "1234",
          "firmware": "camera-10-8-1",
          "shortName": "MV 10.8.1",
          "releaseType": "stable",
          "releaseDate": "2021-03-17T17:22:52Z"
        },
        "toVersion": {
          "id": "4321",
          "firmware": "camera-11-2-1",
          "shortName": "MV 11.2.1",
          "releaseType": "stable",
          "releaseDate": "2019-03-17T17:22:52Z"
        }
      },
      "nextUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "toVersion": {
          "id": "2134",
          "firmware": "camera-15-5-2",
          "shortName": "MV 25.5.2",
          "releaseType": "stable",
          "releaseDate": "2021-05-28T17:22:52Z"
        }
      },
      "isUpgradeAvailable": false,
      "availableVersions": [
        {
          "id": "3421",
          "firmware": "camera-16-x-y",
          "shortName": "MV 16.x.y",
          "releaseType": "beta",
          "releaseDate": "2020-11-28T17:22:52Z"
        }
      ],
      "participateInNextBetaRelease": false
    },
    "wirelessController": {
      "currentVersion": {
        "id": "4321",
        "firmware": "camera-11-2-1",
        "shortName": "MV 11.2.1",
        "releaseType": "stable",
        "releaseDate": "2020-03-17T17:22:52Z"
      },
      "lastUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "fromVersion": {
          "id": "1234",
          "firmware": "camera-10-8-1",
          "shortName": "MV 10.8.1",
          "releaseType": "stable",
          "releaseDate": "2021-03-17T17:22:52Z"
        },
        "toVersion": {
          "id": "4321",
          "firmware": "camera-11-2-1",
          "shortName": "MV 11.2.1",
          "releaseType": "stable",
          "releaseDate": "2019-03-17T17:22:52Z"
        }
      },
      "nextUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "toVersion": {
          "id": "2134",
          "firmware": "camera-15-5-2",
          "shortName": "MV 25.5.2",
          "releaseType": "stable",
          "releaseDate": "2021-05-28T17:22:52Z"
        }
      },
      "isUpgradeAvailable": false,
      "availableVersions": [
        {
          "id": "3421",
          "firmware": "camera-16-x-y",
          "shortName": "MV 16.x.y",
          "releaseType": "beta",
          "releaseDate": "2020-11-28T17:22:52Z"
        }
      ],
      "participateInNextBetaRelease": false
    },
    "secureConnect": {
      "currentVersion": {
        "id": "4321",
        "firmware": "camera-11-2-1",
        "shortName": "MV 11.2.1",
        "releaseType": "stable",
        "releaseDate": "2020-03-17T17:22:52Z"
      },
      "lastUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "fromVersion": {
          "id": "1234",
          "firmware": "camera-10-8-1",
          "shortName": "MV 10.8.1",
          "releaseType": "stable",
          "releaseDate": "2021-03-17T17:22:52Z"
        },
        "toVersion": {
          "id": "4321",
          "firmware": "camera-11-2-1",
          "shortName": "MV 11.2.1",
          "releaseType": "stable",
          "releaseDate": "2019-03-17T17:22:52Z"
        }
      },
      "nextUpgrade": {
        "time": "2021-05-17T17:22:52Z",
        "toVersion": {
          "id": "2134",
          "firmware": "camera-15-5-2",
          "shortName": "MV 25.5.2",
          "releaseType": "stable",
          "releaseDate": "2021-05-28T17:22:52Z"
        }
      },
      "isUpgradeAvailable": false,
      "availableVersions": [
        {
          "id": "3421",
          "firmware": "camera-16-x-y",
          "shortName": "MV 16.x.y",
          "releaseType": "beta",
          "releaseDate": "2020-11-28T17:22:52Z"
        }
      ],
      "participateInNextBetaRelease": false
    }
  }
}