From 13bbc4a080b6df78c860153e94d5227454821826 Mon Sep 17 00:00:00 2001 From: amabdulr <148323982+amabdulr@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:09:19 +0530 Subject: [PATCH 1/3] Update Introduction.md --- docs/Introduction.md | 73 +++++++++++++++++++------------------------- 1 file changed, 32 insertions(+), 41 deletions(-) diff --git a/docs/Introduction.md b/docs/Introduction.md index 76209c3..233e621 100755 --- a/docs/Introduction.md +++ b/docs/Introduction.md @@ -1,73 +1,64 @@ -# Meraki Dashboard API +# Introduction to Meraki Dashboard API -A RESTful API to programmatically manage and monitor Meraki networks at scale. +The Meraki Dashboard API (referred to as Meraki API) is a RESTful API interface that allows you to programmatically manage and monitor Meraki networks at scale. -## What can you do with it? -- Add new organizations, admins, networks, devices, VLANs, and more -- Configure thousands of networks in minutes -- On-board and off-board new employees’ teleworker setup automatically -- Build your own dashboard for store managers, field techs, or unique use cases - -Checkout out the [Explore](https://developer.cisco.com/meraki/explore/) section for open source projects, or browse the [Marketplace](https://apps.meraki.io/) for partner solutions. +Meraki APIs provide a range of operations to -## What's New in v1 - -The Dashboard API has evolved significantly, providing hundreds of operations to manage your Meraki networks! - -We want to do so much more. But in order for us to include many of these new features or improvements, we need to break a few things. +- Add new organizations, administrators, networks, devices, VLANs, and more +- Configure thousands of networks in minutes +- On-board and Off-board new employees’ teleworker setup automatically, and +- Build custom dashboards for store managers, field technicians, or other unique use cases. -The focus of this **major** version is on **Simplicity** and **Scale**, by providing an enjoyable developer experience. -The API documentation, Postman collection, and Python library will remain synced and up-to-date with improved navigation and features. +Checkout out the [Explore](https://developer.cisco.com/meraki/explore/) section for open source projects, or browse the [Marketplace](https://apps.meraki.io/) for partner solutions. -In addition, several improvements and new operations have been included with this major release. +## What is a Resource +A resource is an entity or component within the Meraki ecosystem. Resources represent the various elements of a network. Here are some examples of Meraki resources: -### API Documentation +- **Organizations**: A collection of networks, representing the top-level structure in the Meraki hierarchy. +- **Networks**: Specific networks within an organization, which contain devices and configurations. +- **Devices**: Individual hardware units such as routers, switches, or access points within a network. +- **VLANs**: Virtual local area networks configured within a network for segmenting traffic. +- **SSIDs**: Wireless network identifiers that can be configured and managed. -The API operation documentation and complimenting Postman Collection have a new folder structure for navigating the API. +Each resource is typically represented by a unique URL. You can use APIs to configure or retrieve information about these resources. +## What is a Service +A service is a functionality or a set of API operations that interact with the resources of a Meraki product. (These operations are specific actions performed on a resource, such as GET, POST, PUT, or DELETE.) -#### Categories +Here are some services: -The services are grouped into categories, providing a collection of operations that behave in a similar way. +- CONFIGURE service: is a set of operations to manage cloud configurations +- MONITOR service: is a set of operations return status and history information, and +- LIVE TOOL service: is a set of operations that directly interacts with the device. -**CONFIGURE** operations are for managing cloud configurations +## What is a Meraki Product -**MONITOR** operations will return status and history information +A Meraki product refers to the hardware and software solutions offered by Cisco Meraki that are used to build and manage network infrastructure. These products include wireless access points, switches, or security appliances. -**LIVE TOOL** operations will directly interact with the device +## What is a Resource URL or Path -### Resource Path changes +The path or URL of a resource contains the name of the Meraki product to reduce ambiguity when working with resources that have similar yet unique functionality. -The operation URL paths will always contain the Meraki product if required, reducing ambiguity when working with resources that have similar yet unique functionality. +The format of the path is 'product/service'. -> **Examples of a product and service** +> **Examples of a Path:** > > `/appliance/ports` > > `/switch/ports` -### Base URI - -In most parts of the world, every API request will begin with the following **base URI**: - -> `https://api.meraki.com/api/v1` - -For organizations hosted in different country dashboards, please refer to their [respective base URI](https://developer.cisco.com/meraki/api-v1/getting-started/#base-uri) - -### See all the changes +## What is the Base URI -Visit the [Changelog](https://developer.cisco.com/meraki/whats-new/#!v1-0-0-beta-0) for all the details. +A base URI is the root address or endpoint that serves as the starting point for accessing the API's resources. The base URI includes the protocol, domain, and base path. All API requests append specific resource paths to this base URI. -### SDKs +For most regions, the base URI for API requests is `https://api.meraki.com/api/v1`. -Going forward, the custom Meraki [Python library](pythonLibrary.md) will be the recommended SDK for simplified API scripting. The previously auto-generated Python, Node.js, and Ruby SDKs for **v0** will remain in the Meraki GitHub but will no longer be maintained. +For organizations hosted in different countries, see the [respective base URI section](https://developer.cisco.com/meraki/api-v1/getting-started/#base-uri). -#### Python -The Meraki [Python Library](pythonLibrary.md) has been updated to take advantage of all the new API enhancements plus many custom features to help both beginners and experienced programmers. From 1c157b083de7976fbb5007c6aa4efc743f65b662 Mon Sep 17 00:00:00 2001 From: amabdulr <148323982+amabdulr@users.noreply.github.com> Date: Wed, 21 May 2025 09:39:28 +0530 Subject: [PATCH 2/3] Update RateLimit.md --- docs/RateLimit.md | 185 +++++++++++++++++++++++++++++----------------- 1 file changed, 117 insertions(+), 68 deletions(-) diff --git a/docs/RateLimit.md b/docs/RateLimit.md index 37e6259..97e03b5 100644 --- a/docs/RateLimit.md +++ b/docs/RateLimit.md @@ -1,108 +1,157 @@ -# Rate limit +# API Call Budgets -## Purpose and importance +Your API call budget: +- limits how many API calls you can make within a specific time. +- safeguards your network against runaway applications and malicious behavior. +- helps you manage huge API call volumes. -API call budgets define the number of API calls that an API client can make in a given amount of time and are a safeguard against runaway applications and malicious behavior. Call budgets (or rate limits) are a standard feature of high performance APIs across industries and working within the provided call budget is table stakes for any developer building an application that consumes the API. The best practice is for applications to manage API call budgets effectively and avoid making API calls in excess of the limit. +Key attributes of an API call budget include: +- defined number of requests per second, +- shared budgets among applications, and +- mechanisms to handle excess calls. -## Per organization +In this article, you will: +- Learn **key concepts**, such as action batches and configuration templates. +- Find **rate limits** for organizations and IP addresses. +- Learn **how to detect** an exceeded rate limit. +- Learn **how to recover gracefully** and keep your application running. +- Discover **best practices** to provision and monitor your network and avoid exceeding the rate limit. +- Get **troubleshooting tips** to pinpoint and resolve the root causes of an exceeded rate limit. -Each Meraki organization has a call budget of **10 requests per second**, regardless of the number of API applications interacting with that organization. -* A burst of 10 additional requests are allowed in the first second, yielding a maximum of 30 requests in the first 2 seconds. -* The rate limiting technique is based off of the [token bucket model](https://en.wikipedia.org/wiki/Token_bucket). +## Action batches -This budget is shared across all API applications in the organization that leverage [API authentication](https://developer.cisco.com/meraki/api-v1/authorization/). You can [check the recent API activity](https://developer.cisco.com/meraki/api-v1/get-organization-api-requests-overview-response-codes-by-interval/) for the given organization to understand if you are sharing the budget with other applications. -On the Meraki dashboard, as an organization admin you can view this information on the API Analytics page by accessing Organization > Configure > API & Webhooks. +An action batch is a tool that: +- bundles multiple configuration requests into a single transaction, +- supports bulk POST, PUT, and DELETE operations synchronously or asynchronously, and +- reduces individual API calls to optimize budgets. +For more information, visit these resources: +- [Action Batches](https://developer.cisco.com/meraki/api-v1/action-batches-overview/#action-batches) +- [The GitHub Demo](https://developer.cisco.com/codeexchange/github/repo/shiyuechengineer/action-batches/) +- [The Meraki Blog](https://meraki.cisco.com/blog/2019/06/action-batches-a-recipe-for-success/) + +## Configuration templates -## Per source IP address +Use a configuration template to define a standard set of network settings. Apply the template across multiple networks to manage your network consistently and at scale. -Each source IP address making API requests has a call budget of **100 requests per second**, regardless of the number of API clients working from that IP address. +Use configuration templates to set up VLAN settings, firewall rules, and Software-Defined Wide Area Network (SD-WAN) policies from the Meraki dashboard. -## Response codes +For more information, see [Meraki configuration templates](https://documentation.meraki.com/General_Administration/Templates_and_Config_Sync/Managing_Multiple_Networks_with_Configuration_Templates). -* A `429` status code will be returned when the rate limit has been exceeded, with the `Retry-After` header. -* When an application exceeds the rate limit, the following message will be returned in the response body: +## Rate limits per organization +You can make up to 10 requests per second per organization, regardless of the number of applications interacting with that organization. -```JSON -{ - "errors": [ - "API rate limit exceeded for organization" - ] -} -``` - -## Best practices and tips for managing call budgets +To accommodate short bursts of activity, you can send an extra 10 requests in the first second. As a result, you can send a total of 30 requests in two seconds. -### Handle limiting gracefully +This limit is shared across all API applications that use [API authentication](https://developer.cisco.com/meraki/api-v1/authorization/) in the organization. Coordinate API usage across systems and monitor your organization’s request patterns to stay within rate limits. -If the defined budget is exceeded, the dashboard API will reply with the `429` (rate limit exceeded) error code. This response also returns a `Retry-After` header indicating how long the client should wait before making a follow-up request. Ensure that appropriate action is being taken to handle `429` responses if you incur them. Utilize the `Retry-After` header and backoff to minimize compounded rate limit issues. +| Metric | Value | +|-------------------------|-------------------------------------------------------------| +| **Steady-state budget** | 10 requests per second per organization | +| **Burst allowance** | +10 requests in the first second (max 30 requests in 2s) | +| **Scope** | Shared across all API applications using the organization’s API key | -> The Retry-After header contains the number of seconds the client should wait. The number will vary based on the organization's API consumption. The number may often be 1 or 2 (indicating a suggested backoff of 1 or 2 seconds), but the number may be higher if a large number of requests were made within this timeframe. +As an organization administrator, check whether multiple applications are using your API budget. Navigate to **Organization > Configure > API & Webhooks** and choose **API Analytics**. For more information, see the [API Analytics Overview](https://documentation.meraki.com/General_Administration/Other_Topics/Cisco_Meraki_Dashboard_API#API_Analytics_Overview) +You can also use an API to get [an overview of the organization's API activity](https://developer.cisco.com/meraki/api-v1/get-organization-api-requests-overview-response-codes-by-interval/). -If you are using Python, [the official Meraki Python library](https://github.com/meraki/dashboard-api-python) handles retries and automatic backoff for you so you can focus elsewhere in your application.​ +## Rate limits per source IP address +You can send up to 100 requests per second from each source IP address, regardless of the number of API clients using that address. +| Metric | Value | +|-------------------------|-------------------------------------------------------------| +| **Quota** | 100 requests per second per source IP | +| **Scope** | Shared by all clients using that IP | -A simple Python script example which minimizes rate limit errors: - -```Python -response = requests.request("GET", url, headers=headers) -​ -if response.status_code == 200: - # Success logic -elif response.status_code == 429: - time.sleep(int(response.headers["Retry-After"])) -else: - # Handle other response codes -``` +## Response codes for exceeding rate limit +If your application exceeds the rate limit, the API returns a 429 status code. -### Monitoring best practices +The response includes a `Retry-After` header that tells you how long to wait before sending the next request. -Strategize your data polling. The most common cause of `429` responses is unnecessarily frequent polling of information that changes infrequently after day 1 of a network deployment, such as the list of [networks](https://developer.cisco.com/meraki/api-v1/get-organization-networks/) or [policy objects](https://developer.cisco.com/meraki/api-v1/get-organization-policy-objects/) in an organization. +The response body generally includes an error message structured as: -#### Use the most efficient operations for your use case - -Develop your application using the most efficient API calls available for your use case, especially if your application provides monitoring features. - -##### Retrieving network topology information including LLDP/CDP +```JSON +{ + "errors": [ + "API rate limit exceeded for organization" + ] +} +``` -Call the network-wide [getNetworkTopologyLinkLayer](https://developer.cisco.com/meraki/api-v1/get-network-topology-link-layer/), which provides the complete topology for the network, instead of the less efficient single-device operation [getDeviceLldpCdp](https://developer.cisco.com/meraki/api-v1/get-device-lldp-cdp/). +## Handle exceeded rate limits +**Purpose**: Helps keep your application running smoothly even when your application exceeds the API rate limits. -##### Retrieving device uplink information (IP addressing) +**Context**: Rate limits protect resources and ensure fair API usage. If your application exceeds these limits, you receive a `429` response. Handle this response in code to prevent application failures. -Call the organization-wide [getOrganizationDevicesUplinksAddressesByDevice](https://developer.cisco.com/meraki/api-v1/get-organization-devices-uplinks-addresses-by-device/) instead of looking for IP information in per-device operations. +**Before you begin**: +- Review the rate limit policies listed above. +- Understand how to interpret HTTP status codes, especially status code `429`. -##### Retrieving device hardware details +Follow these steps when your application exceeds the rate-limit: +1. Monitor the HTTP response code of each API call. +2. If you receive a `429` status code, retrieve the `Retry-After` header to determine the wait duration. +3. Implement a backoff mechanism: + - Pause for one or two seconds before making the next API call. + - Increase the wait time when API call volumes are high. +4. For Python applications: + - Use [the official Meraki Python library](https://github.com/meraki/dashboard-api-python), which includes automatic retry and backoff handling. Here is an example implementation: -Call the organization-wide [getOrganizationDevices](https://developer.cisco.com/meraki/api-v1/get-organization-devices/), which provides the information for hundreds devices at a time in a paginated list, instead of the less efficient single-device operation [getDevice](https://developer.cisco.com/meraki/api-v1/get-device/) or the network-wide operation [getNetworkDevices](https://developer.cisco.com/meraki/api-v1/get-network-devices/). + ```Python + response = requests.request("GET", url, headers=headers) + ​ + if response.status_code == 200: + # Success logic + elif response.status_code == 429: + time.sleep(int(response.headers["Retry-After"])) + else: + # Handle other response codes + ``` -##### Monitoring device availability (status) +**Result**: Your application handles exceeded rate limits gracefully and minimizes downtime and errors. -Call the organization-wide [getOrganizationDevicesAvailabilitiesChangeHistory](https://developer.cisco.com/meraki/api-v1/get-organization-devices-availabilities-change-history/) to catch up on availability (status) changes since your last org-wide poll of [getOrganizationDevicesAvailabilities](https://developer.cisco.com/meraki/api-v1/get-organization-devices-availabilities/) or [getOrganizationDevicesStatuses](https://developer.cisco.com/meraki/api-v1/get-organization-devices-statuses/), rather than re-polling the information for all devices all over again. +## Best practices for optimizing API usage -##### Retrieving network clients +Follow these best practices during provisioning and monitoring to ensure that your network performs efficiently. The overall API calls are reduced, and rate limits are not exceeded. -Call the network-wide API call [getNetworkClients](https://developer.cisco.com/meraki/api-v1/get-network-clients/) once for the network, instead of calling the less efficient single-device API operation [getDeviceClients](https://developer.cisco.com/meraki/api-v1/get-device-clients/). +### Best Practices for Provisioning +- **Use action batches** to group multiple POST, PUT, and DELETE calls into a single request. This reduces overhead and speeds up execution. +- **Retrieve configuration changes efficiently** + - Most 429 errors happen when you poll information too often after the first day of network deployment. For example, requesting a list of [networks](https://developer.cisco.com/meraki/api-v1/get-organization-networks/) or [policy objects](https://developer.cisco.com/meraki/api-v1/get-organization-policy-objects/) in an organization. These values rarely change after initial deployment. A better strategy is to use [getOrganizationConfigurationChanges](https://developer.cisco.com/meraki/api-v1/get-organization-configuration-changes/) to retrieve a snapshot of all configuration changes. +- **Use configuration templates** + - Combine multiple network-specific requests into a single template update. + - Let Meraki handle updates to all bound networks for you, reducing your API calls. +### Best Practices for Monitoring +- **Replace an inefficient API operation with an efficient one** + - Use the most efficient API calls available for your needs, especially if your application includes monitoring features. -### Provisioning +| **Use Case** | **Less Efficient Operation** | **More Efficient Operation** | +|--------------------------------------------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------| +| Retrieving Network Topology Information | Single-device operation [getDeviceLldpCdp](https://developer.cisco.com/meraki/api-v1/get-device-lldp-cdp/) | Network-wide [getNetworkTopologyLinkLayer](https://developer.cisco.com/meraki/api-v1/get-network-topology-link-layer/) provides the complete topology for the network | +| Retrieving Device Uplink Information | Per-device IP information retrieval | Organization-wide [getOrganizationDevicesUplinksAddressesByDevice](https://developer.cisco.com/meraki/api-v1/get-organization-devices-uplinks-addresses-by-device/) | +| Retrieving Device Hardware Details | Single-device operation [getDevice](https://developer.cisco.com/meraki/api-v1/get-device/) | Organization-wide [getOrganizationDevices](https://developer.cisco.com/meraki/api-v1/get-organization-devices/) | +| Retrieving Device Hardware Details | Network-wide operation [getNetworkDevices](https://developer.cisco.com/meraki/api-v1/get-network-devices/) | Organization-wide [getOrganizationDevices](https://developer.cisco.com/meraki/api-v1/get-organization-devices/) provides information for hundreds of devices at a time in a paginated list | +| Monitoring Device Availability (Status) | Re-polling all device statuses | Organization-wide [getOrganizationDevicesAvailabilitiesChangeHistory](https://developer.cisco.com/meraki/api-v1/get-organization-devices-availabilities-change-history/) catches up on device availability (status) changes since your last org-wide poll instead of re-polling the information for all devices. | +| Retrieving Network Clients | Single-device API operation [getDeviceClients](https://developer.cisco.com/meraki/api-v1/get-device-clients/) | Network-wide [getNetworkClients](https://developer.cisco.com/meraki/api-v1/get-network-clients/) | -#### Use action batches -[**Action Batches**](https://developer.cisco.com/meraki/api-v1/action-batches-overview/#action-batches) are a perfect tool for submitting batched configuration requests in a single synchronous or asynchronous transaction. Leverage them for bulk constructive/destructive operations (`POST`, `PUT`, `DELETE`). To read more about Action Batches, visit [our overview](https://developer.cisco.com/meraki/api-v1/action-batches-overview/#action-batches), the [GitHub Demo](https://developer.cisco.com/codeexchange/github/repo/shiyuechengineer/action-batches/), or the [Meraki Blog](https://meraki.cisco.com/blog/2019/06/action-batches-a-recipe-for-success/). +# Troubleshoot rate limit issues -#### Configuration sync and "golden template" enforcement +**Purpose**: Find and resolve exceeded rate limits so you can restore uninterrupted API operation. -Once you are confident that an organization is configured correctly, leverage [getOrganizationConfigurationChanges](https://developer.cisco.com/meraki/api-v1/get-organization-configuration-changes/) to identify deviations from the last known intended configuration. This is more efficient than re-polling every configuration setting and then running diffs in your application. +**Context**: When your application (or another application sharing your organization or IP) receives `429` errors despite backoff strategies. -#### Use configuration templates +**Before you begin**: + - Understand the organization- and IP-level call budgets. + - Implement basic `429` handling using the `Retry-After` header. -[Meraki configuration templates](https://documentation.meraki.com/General_Administration/Templates_and_Config_Sync/Managing_Multiple_Networks_with_Configuration_Templates) are an easy way to ensure a highly consistent configuration is deployed across networks. +Follow these steps to troubleshoot rate limit issues: -## Troubleshooting +1. **Verify adherence to best practices** by reviewing the “Best practices for optimizing API usage” section. If you use a [partner application](https://marketplace.cisco.com/en-US/home), contact the developer to discuss the application behavior or budget consumption. +2. **Check recent API activity** on the Meraki dashboard using this [guide](https://developer.cisco.com/meraki/api-v1/get-organization-api-requests-overview-response-codes-by-interval/) +3. **Audit your scripts** that run without regular maintenance. Such scripts can degrade performance and consume your call budget. To monitor usage, [audit your organization's API consumption](https://developer.cisco.com/meraki/api-v1/get-organization-api-requests/). -If your application is rate limited, your application or another application in the organization, or from your application's source IP address, may not be managing the call budget effectively. +**Result**: You can identify the cause of the exceeded rate limits. -1. Ensure your application is following [our best practices](https://developer.cisco.com/meraki/api-v1/rate-limit/#best-practices-and-tips-for-managing-call-budgets). If you are using an [ecosystem partner application](https://apps.meraki.io), our partners are committed to following our best practices. Please reach out to the developer for your application if you have any questions about partner application behavior or budget consumption. -2. You can [check the recent API activity](https://developer.cisco.com/meraki/api-v1/get-organization-api-requests-overview-response-codes-by-interval/) for the given organization to understand if you are sharing the budget with other applications. -3. Scripts that run with little to no maintenance can degrade the performance of your organization's API requests and use up your budget unnecessarily. [Audit your organization's API consumption](https://developer.cisco.com/meraki/api-v1/search/api%20requests/) on a regular basis. +# References +- For more information about call budgets and rate limits, visit the [Meraki developer community](https://community.meraki.com/t5/Developers-APIs/bd-p/api). +- Meraki uses the [token bucket model](https://en.wikipedia.org/wiki/Token_bucket) to implement this rate-limiting mechanism. -You can find more answers about call budgets in [our developer community](https://community.meraki.com/t5/Developers-APIs/bd-p/api). From bdc56c28d30f4f78911c79486013597ccbca3ccd Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Wed, 21 May 2025 04:09:42 +0000 Subject: [PATCH 3/3] Update API Index --- docs/api-index/meraki-api-index.csv | 188 ++++++++++++-------- docs/api-index/meraki-api-index.html | 248 ++++++++++++++++++--------- docs/api-index/meraki-api-index.md | 190 ++++++++++++-------- 3 files changed, 397 insertions(+), 229 deletions(-) diff --git a/docs/api-index/meraki-api-index.csv b/docs/api-index/meraki-api-index.csv index 7d02920..0b74a02 100644 --- a/docs/api-index/meraki-api-index.csv +++ b/docs/api-index/meraki-api-index.csv @@ -4,7 +4,8 @@ "GA","generateAdministeredIdentitiesMeApiKeys","Generates an API key for an identity","https://developer.cisco.com/meraki/api-v1/generate-administered-identities-me-api-keys/","post","/administered/identities/me/api/keys/generate","","","key","administered, configure, identities, me, api, keys","administered.generateAdministeredIdentitiesMeApiKeys","" "GA","revokeAdministeredIdentitiesMeApiKeys","Revokes an identity's API key, using the last four characters of the key","https://developer.cisco.com/meraki/api-v1/revoke-administered-identities-me-api-keys/","post","/administered/identities/me/api/keys/{suffix}/revoke","suffix","","","administered, configure, identities, me, api, keys","administered.revokeAdministeredIdentitiesMeApiKeys","" "GA","getAdministeredLicensingSubscriptionEntitlements","Retrieve the list of purchasable entitlements","https://developer.cisco.com/meraki/api-v1/get-administered-licensing-subscription-entitlements/","get","/administered/licensing/subscription/entitlements","skus","","featureTier, isAddOn, name, productClass, productType, sku","licensing, configure, subscription, entitlements","licensing.getAdministeredLicensingSubscriptionEntitlements","" -"GA","getAdministeredLicensingSubscriptionSubscriptions","List available subscriptions","https://developer.cisco.com/meraki/api-v1/get-administered-licensing-subscription-subscriptions/","get","/administered/licensing/subscription/subscriptions","perPage, startingAfter, endingBefore, subscriptionIds, organizationIds, statuses, productTypes, name, startDate, endDate","","account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId","licensing, configure, subscription, subscriptions","licensing.getAdministeredLicensingSubscriptionSubscriptions","" +"beta","batchAdministeredLicensingSubscriptionNetworksFeatureTiersUpdate","Batch change networks to their desired feature tier for specified product types","https://developer.cisco.com/meraki/api-v1/batch-administered-licensing-subscription-networks-feature-tiers-update/","post","/administered/licensing/subscription/networks/featureTiers/batchUpdate","","featureTier, id, isAtomic, items, network, productType, productTypes","error, errors, featureTier, id, items, network, productType, productTypes","licensing, configure, subscription, featureTiers","licensing.batchAdministeredLicensingSubscriptionNetworksFeatureTiersUpdate","" +"GA","getAdministeredLicensingSubscriptionSubscriptions","List available subscriptions","https://developer.cisco.com/meraki/api-v1/get-administered-licensing-subscription-subscriptions/","get","/administered/licensing/subscription/subscriptions","perPage, startingAfter, endingBefore, subscriptionIds, organizationIds, statuses, productTypes, skus, name, startDate, endDate","","account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId","licensing, configure, subscription, subscriptions","licensing.getAdministeredLicensingSubscriptionSubscriptions","" "GA","claimAdministeredLicensingSubscriptionSubscriptions","Claim a subscription into an organization.","https://developer.cisco.com/meraki/api-v1/claim-administered-licensing-subscription-subscriptions/","post","/administered/licensing/subscription/subscriptions/claim","validate","claimKey, description, name, organizationId","account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId","licensing, configure, subscription, subscriptions","licensing.claimAdministeredLicensingSubscriptionSubscriptions","" "GA","validateAdministeredLicensingSubscriptionSubscriptionsClaimKey","Find a subscription by claim key","https://developer.cisco.com/meraki/api-v1/validate-administered-licensing-subscription-subscriptions-claim-key/","post","/administered/licensing/subscription/subscriptions/claimKey/validate","","claimKey","account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId","licensing, configure, subscription, subscriptions, claimKey","licensing.validateAdministeredLicensingSubscriptionSubscriptionsClaimKey","" "GA","getAdministeredLicensingSubscriptionSubscriptionsComplianceStatuses","Get compliance status for requested subscriptions","https://developer.cisco.com/meraki/api-v1/get-administered-licensing-subscription-subscriptions-compliance-statuses/","get","/administered/licensing/subscription/subscriptions/compliance/statuses","organizationIds, subscriptionIds","","byProductClass, entitlements, gracePeriodEndsAt, id, missing, name, productClass, quantity, sku, status, subscription, violations","licensing, configure, subscription, subscriptions, compliance, statuses","licensing.getAdministeredLicensingSubscriptionSubscriptionsComplianceStatuses","" @@ -24,11 +25,11 @@ "deprecated","getDeviceCameraAnalyticsLive","Returns live state from camera analytics zones","https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-live/","get","/devices/{serial}/camera/analytics/live","serial","","person, ts, zoneId, zones","camera, monitor, analytics, live","camera.getDeviceCameraAnalyticsLive","" "deprecated","getDeviceCameraAnalyticsOverview","Returns an overview of aggregate analytics data for a timespan","https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-overview/","get","/devices/{serial}/camera/analytics/overview","serial, t0, t1, timespan, objectType","","averageCount, endTs, entrances, startTs, zoneId","camera, monitor, analytics, overview","camera.getDeviceCameraAnalyticsOverview","" "deprecated","getDeviceCameraAnalyticsRecent","Returns most recent record for analytics zones","https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-recent/","get","/devices/{serial}/camera/analytics/recent","serial, objectType","","averageCount, endTs, entrances, startTs, zoneId","camera, monitor, analytics, recent","camera.getDeviceCameraAnalyticsRecent","" -"deprecated","getDeviceCameraAnalyticsZones","Returns all configured analytic zones for this camera","https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-zones/","get","/devices/{serial}/camera/analytics/zones","serial","","id, label, regionOfInterest, type, x0, x1, y0, y1","camera, monitor, analytics, zones","camera.getDeviceCameraAnalyticsZones","" +"deprecated","getDeviceCameraAnalyticsZones","Returns all configured analytic zones for this camera","https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-zones/","get","/devices/{serial}/camera/analytics/zones","serial","","id, label, regionOfInterest, type, x0, x1, y0, y1","camera, monitor, analytics, zones","camera.getDeviceCameraAnalyticsZones","camera:config:read" "deprecated","getDeviceCameraAnalyticsZoneHistory","Return historical records for analytic zones","https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-zone-history/","get","/devices/{serial}/camera/analytics/zones/{zoneId}/history","serial, zoneId, t0, t1, timespan, resolution, objectType","","averageCount, endTs, entrances, startTs","camera, monitor, analytics, zones, history","camera.getDeviceCameraAnalyticsZoneHistory","" "GA","getDeviceCameraCustomAnalytics","Return custom analytics settings for a camera","https://developer.cisco.com/meraki/api-v1/get-device-camera-custom-analytics/","get","/devices/{serial}/camera/customAnalytics","serial","","artifactId, enabled, name, parameters, value","camera, configure, customAnalytics","camera.getDeviceCameraCustomAnalytics","camera:config:read" "GA","updateDeviceCameraCustomAnalytics","Update custom analytics settings for a camera","https://developer.cisco.com/meraki/api-v1/update-device-camera-custom-analytics/","put","/devices/{serial}/camera/customAnalytics","serial","artifactId, enabled, name, parameters, value","artifactId, enabled, name, parameters, value","camera, configure, customAnalytics","camera.updateDeviceCameraCustomAnalytics","camera:config:write" -"GA","generateDeviceCameraSnapshot","Generate a snapshot of what the camera sees at the specified time and return a link to that image.","https://developer.cisco.com/meraki/api-v1/generate-device-camera-snapshot/","post","/devices/{serial}/camera/generateSnapshot","serial","fullframe, timestamp","expiry, url","camera, monitor","camera.generateDeviceCameraSnapshot","camera:config:write" +"GA","generateDeviceCameraSnapshot","Generate a snapshot of what the camera sees at the specified time and return a link to that image.","https://developer.cisco.com/meraki/api-v1/generate-device-camera-snapshot/","post","/devices/{serial}/camera/generateSnapshot","serial","fullframe, timestamp","expiry, url","camera, monitor","camera.generateDeviceCameraSnapshot","camera:telemetry:write" "GA","getDeviceCameraQualityAndRetention","Returns quality and retention settings for the given camera","https://developer.cisco.com/meraki/api-v1/get-device-camera-quality-and-retention/","get","/devices/{serial}/camera/qualityAndRetention","serial","","","camera, configure, qualityAndRetention","camera.getDeviceCameraQualityAndRetention","camera:config:read" "GA","updateDeviceCameraQualityAndRetention","Update quality and retention settings for the given camera","https://developer.cisco.com/meraki/api-v1/update-device-camera-quality-and-retention/","put","/devices/{serial}/camera/qualityAndRetention","serial","audioRecordingEnabled, motionBasedRetentionEnabled, motionDetectorVersion, profileId, quality, resolution, restrictedBandwidthModeEnabled","","camera, configure, qualityAndRetention","camera.updateDeviceCameraQualityAndRetention","camera:config:write" "GA","getDeviceCameraSense","Returns sense settings for a given camera","https://developer.cisco.com/meraki/api-v1/get-device-camera-sense/","get","/devices/{serial}/camera/sense","serial","","","camera, configure, sense","camera.getDeviceCameraSense","camera:config:read" @@ -54,10 +55,16 @@ "GA","getDeviceLiveToolsCableTest","Return a cable test live tool job.","https://developer.cisco.com/meraki/api-v1/get-device-live-tools-cable-test/","get","/devices/{serial}/liveTools/cableTest/{id}","serial, id","","cableTestId, error, index, lengthMeters, pairs, port, ports, request, results, serial, speedMbps, status, url","devices, liveTools, cableTest","devices.getDeviceLiveToolsCableTest","dashboard:general:config:read" "beta","createDeviceLiveToolsCyclePort","Enqueue a job to perform a cycle port for the device on the specified ports","https://developer.cisco.com/meraki/api-v1/create-device-live-tools-cycle-port/","post","/devices/{serial}/liveTools/cyclePort","serial","callback, httpServer, id, payloadTemplate, ports, sharedSecret, url","callback, cyclePortId, id, ports, request, serial, status, url","devices, liveTools, cyclePort","devices.createDeviceLiveToolsCyclePort","dashboard:general:config:write" "beta","getDeviceLiveToolsCyclePort","Return a cycle port live tool job.","https://developer.cisco.com/meraki/api-v1/get-device-live-tools-cycle-port/","get","/devices/{serial}/liveTools/cyclePort/{id}","serial, id","","cyclePortId, error, ports, request, serial, status, url","devices, liveTools, cyclePort","devices.getDeviceLiveToolsCyclePort","dashboard:general:config:read" +"beta","createDeviceLiveToolsDhcpLease","Enqueue a job to perform a DHCP leases request for the device","https://developer.cisco.com/meraki/api-v1/create-device-live-tools-dhcp-lease/","post","/devices/{serial}/liveTools/dhcpLeases","serial","callback, httpServer, id, payloadTemplate, sharedSecret, url","callback, dhcpLeasesId, id, request, serial, status, url","devices, liveTools, dhcpLeases","devices.createDeviceLiveToolsDhcpLease","" +"beta","getDeviceLiveToolsDhcpLease","Return a DHCP leases live tool job.","https://developer.cisco.com/meraki/api-v1/get-device-live-tools-dhcp-lease/","get","/devices/{serial}/liveTools/dhcpLeases/{dhcpLeasesId}","serial, dhcpLeasesId","","dhcpLeases, dhcpLeasesId, error, expiresAt, ip, mac, request, serial, status, url","devices, liveTools, dhcpLeases","devices.getDeviceLiveToolsDhcpLease","" "GA","createDeviceLiveToolsLedsBlink","Enqueue a job to blink LEDs on a device","https://developer.cisco.com/meraki/api-v1/create-device-live-tools-leds-blink/","post","/devices/{serial}/liveTools/leds/blink","serial","callback, duration, httpServer, id, payloadTemplate, sharedSecret, url","callback, duration, error, id, ledsBlinkId, request, serial, status, url","devices, liveTools, leds, blink","devices.createDeviceLiveToolsLedsBlink","dashboard:general:config:write" "GA","getDeviceLiveToolsLedsBlink","Return a blink LEDs job","https://developer.cisco.com/meraki/api-v1/get-device-live-tools-leds-blink/","get","/devices/{serial}/liveTools/leds/blink/{ledsBlinkId}","serial, ledsBlinkId","","duration, error, ledsBlinkId, request, serial, status, url","devices, liveTools, leds, blink","devices.getDeviceLiveToolsLedsBlink","dashboard:general:config:read" -"beta","createDeviceLiveToolsMacTable","Enqueue a job to request the MAC table from the device","https://developer.cisco.com/meraki/api-v1/create-device-live-tools-mac-table/","post","/devices/{serial}/liveTools/macTable","serial","callback, httpServer, id, payloadTemplate, sharedSecret, url","callback, id, macTableId, request, serial, status, url","devices, liveTools, macTable","devices.createDeviceLiveToolsMacTable","dashboard:general:telemetry:write" -"beta","getDeviceLiveToolsMacTable","Return a MAC table live tool job.","https://developer.cisco.com/meraki/api-v1/get-device-live-tools-mac-table/","get","/devices/{serial}/liveTools/macTable/{macTableId}","serial, macTableId","","entries, error, mac, macTableId, port, request, serial, status, url, vlanId","devices, liveTools, macTable","devices.getDeviceLiveToolsMacTable","dashboard:general:telemetry:read" +"GA","createDeviceLiveToolsMacTable","Enqueue a job to request the MAC table from the device","https://developer.cisco.com/meraki/api-v1/create-device-live-tools-mac-table/","post","/devices/{serial}/liveTools/macTable","serial","callback, httpServer, id, payloadTemplate, sharedSecret, url","callback, id, macTableId, request, serial, status, url","devices, liveTools, macTable","devices.createDeviceLiveToolsMacTable","dashboard:general:telemetry:write" +"GA","getDeviceLiveToolsMacTable","Return a MAC table live tool job.","https://developer.cisco.com/meraki/api-v1/get-device-live-tools-mac-table/","get","/devices/{serial}/liveTools/macTable/{macTableId}","serial, macTableId","","entries, error, mac, macTableId, port, request, serial, status, url, vlanId","devices, liveTools, macTable","devices.getDeviceLiveToolsMacTable","dashboard:general:telemetry:read" +"beta","createDeviceLiveToolsMulticastRouting","Enqueue a job to perform a Multicast routing request for the device","https://developer.cisco.com/meraki/api-v1/create-device-live-tools-multicast-routing/","post","/devices/{serial}/liveTools/multicastRouting","serial","callback, httpServer, id, payloadTemplate, sharedSecret, url","callback, id, multicastRoutingId, request, serial, status, url","devices, liveTools, multicastRouting","devices.createDeviceLiveToolsMulticastRouting","" +"beta","getDeviceLiveToolsMulticastRouting","Return a Multicast routing live tool job.","https://developer.cisco.com/meraki/api-v1/get-device-live-tools-multicast-routing/","get","/devices/{serial}/liveTools/multicastRouting/{multicastRoutingId}","serial, multicastRoutingId","","error, flags, group, incomingInterfaceName, interfaces, ip, multicastRoutingId, name, neighbors, outgoingInterfaceNames, rendezvousPoint, request, routes, serial, source, status, subnet, url","devices, liveTools, multicastRouting","devices.getDeviceLiveToolsMulticastRouting","" +"beta","createDeviceLiveToolsOspfNeighbor","Enqueue a job to perform a OSPF neighbors request for the device","https://developer.cisco.com/meraki/api-v1/create-device-live-tools-ospf-neighbor/","post","/devices/{serial}/liveTools/ospfNeighbors","serial","callback, httpServer, id, payloadTemplate, sharedSecret, url","callback, id, ospfNeighborsId, request, serial, status, url","devices, liveTools, ospfNeighbors","devices.createDeviceLiveToolsOspfNeighbor","" +"beta","getDeviceLiveToolsOspfNeighbor","Return an OSPF neighbors live tool job.","https://developer.cisco.com/meraki/api-v1/get-device-live-tools-ospf-neighbor/","get","/devices/{serial}/liveTools/ospfNeighbors/{ospfNeighborsId}","serial, ospfNeighborsId","","error, id, ip, name, ospfNeighborsId, position, request, routers, serial, state, status, url, vlanId","devices, liveTools, ospfNeighbors","devices.getDeviceLiveToolsOspfNeighbor","" "GA","createDeviceLiveToolsPing","Enqueue a job to ping a target host from the device","https://developer.cisco.com/meraki/api-v1/create-device-live-tools-ping/","post","/devices/{serial}/liveTools/ping","serial","callback, count, httpServer, id, payloadTemplate, sharedSecret, target, url","callback, count, id, pingId, request, serial, status, target, url","devices, liveTools, ping","devices.createDeviceLiveToolsPing","dashboard:general:telemetry:write" "GA","getDeviceLiveToolsPing","Return a ping job","https://developer.cisco.com/meraki/api-v1/get-device-live-tools-ping/","get","/devices/{serial}/liveTools/ping/{id}","serial, id","","average, count, latencies, latency, loss, maximum, minimum, percentage, pingId, received, replies, request, results, sent, sequenceId, serial, size, status, target, url","devices, liveTools, ping","devices.getDeviceLiveToolsPing","dashboard:general:telemetry:read" "GA","createDeviceLiveToolsPingDevice","Enqueue a job to check connectivity status to the device","https://developer.cisco.com/meraki/api-v1/create-device-live-tools-ping-device/","post","/devices/{serial}/liveTools/pingDevice","serial","callback, count, httpServer, id, payloadTemplate, sharedSecret, url","callback, count, id, pingId, request, serial, status, url","devices, liveTools, pingDevice","devices.createDeviceLiveToolsPingDevice","dashboard:general:telemetry:write" @@ -82,17 +89,17 @@ "GA","getDeviceSensorCommand","Returns information about the command's execution, including the status","https://developer.cisco.com/meraki/api-v1/get-device-sensor-command/","get","/devices/{serial}/sensor/commands/{commandId}","serial, commandId","","adminId, commandId, completedAt, createdAt, createdBy, email, errors, name, operation, status","sensor, configure, commands","sensor.getDeviceSensorCommand","" "GA","getDeviceSensorRelationships","List the sensor roles for a given sensor or camera device.","https://developer.cisco.com/meraki/api-v1/get-device-sensor-relationships/","get","/devices/{serial}/sensor/relationships","serial","","livestream, productType, relatedDevices, serial","sensor, configure, relationships","sensor.getDeviceSensorRelationships","sensor:config:read" "GA","updateDeviceSensorRelationships","Assign one or more sensor roles to a given sensor or camera device.","https://developer.cisco.com/meraki/api-v1/update-device-sensor-relationships/","put","/devices/{serial}/sensor/relationships","serial","livestream, relatedDevices, serial","livestream, productType, relatedDevices, serial","sensor, configure, relationships","sensor.updateDeviceSensorRelationships","sensor:config:write" -"GA","getDeviceSwitchPorts","List the switch ports for a switch","https://developer.cisco.com/meraki/api-v1/get-device-switch-ports/","get","/devices/{serial}/switch/ports","serial","","accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, ports","switch.getDeviceSwitchPorts","switch:config:read" +"GA","getDeviceSwitchPorts","List the switch ports for a switch","https://developer.cisco.com/meraki/api-v1/get-device-switch-ports/","get","/devices/{serial}/switch/ports","serial","","accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, ports","switch.getDeviceSwitchPorts","switch:config:read" "GA","cycleDeviceSwitchPorts","Cycle a set of switch ports","https://developer.cisco.com/meraki/api-v1/cycle-device-switch-ports/","post","/devices/{serial}/switch/ports/cycle","serial","ports","ports","switch, liveTools, ports","switch.cycleDeviceSwitchPorts","switch:config:write" "beta","updateDeviceSwitchPortsMirror","Update a port mirror","https://developer.cisco.com/meraki/api-v1/update-device-switch-ports-mirror/","put","/devices/{serial}/switch/ports/mirror","serial","comment, destination, filter, hasTransitVlan, module, number, port, ports, role, serial, slot, source, tags, type, vlan, vlans","comment, destination, filter, hasTransitVlan, id, mirror, module, name, network, number, port, ports, role, serial, slot, source, tags, type, vlan, vlans, warnings","switch, configure, ports, mirror","switch.updateDeviceSwitchPortsMirror","" "GA","getDeviceSwitchPortsStatuses","Return the status for all the ports of a switch","https://developer.cisco.com/meraki/api-v1/get-device-switch-ports-statuses/","get","/devices/{serial}/switch/ports/statuses","serial, t0, timespan","","active, address, allowedVlans, authenticationStatus, capabilities, cdp, chassisId, clientCount, configOverrides, deviceId, duplex, enabled, errors, isAllocated, isUplink, lldp, managementAddress, managementVlan, nativeVlan, platform, poe, portDescription, portId, portVlan, powerUsageInWh, recv, securePort, sent, spanningTree, speed, status, statuses, systemCapabilities, systemDescription, systemName, total, trafficInKbps, type, usageInKb, version, vlan, voiceVlan, vtpManagementDomain, warnings","switch, monitor, ports, statuses","switch.getDeviceSwitchPortsStatuses","switch:telemetry:read" "GA","getDeviceSwitchPortsStatusesPackets","Return the packet counters for all the ports of a switch","https://developer.cisco.com/meraki/api-v1/get-device-switch-ports-statuses-packets/","get","/devices/{serial}/switch/ports/statuses/packets","serial, t0, timespan","","desc, packets, portId, ratePerSec, recv, sent, total","switch, monitor, ports, statuses, packets","switch.getDeviceSwitchPortsStatusesPackets","switch:telemetry:read" -"GA","getDeviceSwitchPort","Return a switch port","https://developer.cisco.com/meraki/api-v1/get-device-switch-port/","get","/devices/{serial}/switch/ports/{portId}","serial, portId","","accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, ports","switch.getDeviceSwitchPort","switch:config:read" -"GA","updateDeviceSwitchPort","Update a switch port","https://developer.cisco.com/meraki/api-v1/update-device-switch-port/","put","/devices/{serial}/switch/ports/{portId}","serial, portId","accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, name, peerSgtCapable, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, ports","switch.updateDeviceSwitchPort","switch:config:write" -"GA","getDeviceSwitchRoutingInterfaces","List layer 3 interfaces for a switch","https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interfaces/","get","/devices/{serial}/switch/routing/interfaces","serial, mode, protocol","","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId","switch, configure, routing, interfaces","switch.getDeviceSwitchRoutingInterfaces","switch:config:read" -"GA","createDeviceSwitchRoutingInterface","Create a layer 3 interface for a switch","https://developer.cisco.com/meraki/api-v1/create-device-switch-routing-interface/","post","/devices/{serial}/switch/routing/interfaces","serial","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId","switch, configure, routing, interfaces","switch.createDeviceSwitchRoutingInterface","switch:config:write" -"GA","getDeviceSwitchRoutingInterface","Return a layer 3 interface for a switch","https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interface/","get","/devices/{serial}/switch/routing/interfaces/{interfaceId}","serial, interfaceId","","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId","switch, configure, routing, interfaces","switch.getDeviceSwitchRoutingInterface","switch:config:read" -"GA","updateDeviceSwitchRoutingInterface","Update a layer 3 interface for a switch","https://developer.cisco.com/meraki/api-v1/update-device-switch-routing-interface/","put","/devices/{serial}/switch/routing/interfaces/{interfaceId}","serial, interfaceId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId","switch, configure, routing, interfaces","switch.updateDeviceSwitchRoutingInterface","switch:config:write" +"GA","getDeviceSwitchPort","Return a switch port","https://developer.cisco.com/meraki/api-v1/get-device-switch-port/","get","/devices/{serial}/switch/ports/{portId}","serial, portId","","accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, ports","switch.getDeviceSwitchPort","switch:config:read" +"GA","updateDeviceSwitchPort","Update a switch port","https://developer.cisco.com/meraki/api-v1/update-device-switch-port/","put","/devices/{serial}/switch/ports/{portId}","serial, portId","accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, macWhitelistLimit, name, peerSgtCapable, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, ports","switch.updateDeviceSwitchPort","switch:config:write" +"GA","getDeviceSwitchRoutingInterfaces","List layer 3 interfaces for a switch","https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interfaces/","get","/devices/{serial}/switch/routing/interfaces","serial, protocol","","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","switch, configure, routing, interfaces","switch.getDeviceSwitchRoutingInterfaces","switch:config:read" +"GA","createDeviceSwitchRoutingInterface","Create a layer 3 interface for a switch","https://developer.cisco.com/meraki/api-v1/create-device-switch-routing-interface/","post","/devices/{serial}/switch/routing/interfaces","serial","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","switch, configure, routing, interfaces","switch.createDeviceSwitchRoutingInterface","switch:config:write" +"GA","getDeviceSwitchRoutingInterface","Return a layer 3 interface for a switch","https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interface/","get","/devices/{serial}/switch/routing/interfaces/{interfaceId}","serial, interfaceId","","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","switch, configure, routing, interfaces","switch.getDeviceSwitchRoutingInterface","switch:config:read" +"GA","updateDeviceSwitchRoutingInterface","Update a layer 3 interface for a switch","https://developer.cisco.com/meraki/api-v1/update-device-switch-routing-interface/","put","/devices/{serial}/switch/routing/interfaces/{interfaceId}","serial, interfaceId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","switch, configure, routing, interfaces","switch.updateDeviceSwitchRoutingInterface","switch:config:write" "GA","deleteDeviceSwitchRoutingInterface","Delete a layer 3 interface from the switch","https://developer.cisco.com/meraki/api-v1/delete-device-switch-routing-interface/","delete","/devices/{serial}/switch/routing/interfaces/{interfaceId}","serial, interfaceId","","","switch, configure, routing, interfaces","switch.deleteDeviceSwitchRoutingInterface","switch:config:write" "GA","getDeviceSwitchRoutingInterfaceDhcp","Return a layer 3 interface DHCP configuration for a switch","https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interface-dhcp/","get","/devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp","serial, interfaceId","","bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value","switch, configure, routing, interfaces, dhcp","switch.getDeviceSwitchRoutingInterfaceDhcp","switch:config:read" "GA","updateDeviceSwitchRoutingInterfaceDhcp","Update a layer 3 interface DHCP configuration for a switch","https://developer.cisco.com/meraki/api-v1/update-device-switch-routing-interface-dhcp/","put","/devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp","serial, interfaceId","bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value","bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value","switch, configure, routing, interfaces, dhcp","switch.updateDeviceSwitchRoutingInterfaceDhcp","switch:config:write" @@ -114,8 +121,8 @@ "beta","getDeviceWirelessRadioAfcPosition","Return the position for a wireless device","https://developer.cisco.com/meraki/api-v1/get-device-wireless-radio-afc-position/","get","/devices/{serial}/wireless/radio/afc/position","serial","","antenna, cableLength, elevation, gps, height, id, name, network, serial, uncertainty","wireless, configure, radio, afc, position","wireless.getDeviceWirelessRadioAfcPosition","" "beta","updateDeviceWirelessRadioAfcPosition","Update the position attributes for this device","https://developer.cisco.com/meraki/api-v1/update-device-wireless-radio-afc-position/","put","/devices/{serial}/wireless/radio/afc/position","serial","antenna, cableLength, elevation, gps, height, uncertainty","antenna, cableLength, elevation, gps, height, id, name, network, serial, uncertainty","wireless, configure, radio, afc, position","wireless.updateDeviceWirelessRadioAfcPosition","" "beta","getDeviceWirelessRadioAfcPowerLimits","Return the AFC power limits for a wireless device","https://developer.cisco.com/meraki/api-v1/get-device-wireless-radio-afc-power-limits/","get","/devices/{serial}/wireless/radio/afc/powerLimits","serial","","byChannel, channel, channelWidth, expiresAt, id, lastSuccessAt, lastUpdatedAt, lat, limit, lng, location, name, network, serial, status, type, uncertainty","wireless, configure, radio, afc, powerLimits","wireless.getDeviceWirelessRadioAfcPowerLimits","" -"GA","getDeviceWirelessRadioSettings","Return the radio settings of a device","https://developer.cisco.com/meraki/api-v1/get-device-wireless-radio-settings/","get","/devices/{serial}/wireless/radio/settings","serial","","","wireless, configure, radio, settings","wireless.getDeviceWirelessRadioSettings","wireless:config:read" -"GA","updateDeviceWirelessRadioSettings","Update the radio settings of a device","https://developer.cisco.com/meraki/api-v1/update-device-wireless-radio-settings/","put","/devices/{serial}/wireless/radio/settings","serial","channel, channelWidth, fiveGhzSettings, rfProfileId, targetPower, twoFourGhzSettings","","wireless, configure, radio, settings","wireless.updateDeviceWirelessRadioSettings","wireless:config:write" +"GA","getDeviceWirelessRadioSettings","Return the manually configured radio settings overrides of a device, which take precedence over RF profiles.","https://developer.cisco.com/meraki/api-v1/get-device-wireless-radio-settings/","get","/devices/{serial}/wireless/radio/settings","serial","","","wireless, configure, radio, settings","wireless.getDeviceWirelessRadioSettings","wireless:config:read" +"GA","updateDeviceWirelessRadioSettings","Update the radio settings overrides of a device, which take precedence over RF profiles.","https://developer.cisco.com/meraki/api-v1/update-device-wireless-radio-settings/","put","/devices/{serial}/wireless/radio/settings","serial","channel, channelWidth, fiveGhzSettings, rfProfileId, targetPower, twoFourGhzSettings","","wireless, configure, radio, settings","wireless.updateDeviceWirelessRadioSettings","wireless:config:write" "GA","getDeviceWirelessStatus","Return the SSID statuses of an access point","https://developer.cisco.com/meraki/api-v1/get-device-wireless-status/","get","/devices/{serial}/wireless/status","serial","","band, basicServiceSets, broadcasting, bssid, channel, channelWidth, enabled, power, ssidName, ssidNumber, visible","wireless, monitor, status","wireless.getDeviceWirelessStatus","wireless:telemetry:read" "beta","createDeviceWirelessZigbeeEnrollment","Enqueue a job to start enrolling doorlocks on zigbee configured MRs","https://developer.cisco.com/meraki/api-v1/create-device-wireless-zigbee-enrollment/","post","/devices/{serial}/wireless/zigbee/enrollments","serial","","enrollmentId, request, serial, status, url","wireless, configure, zigbee, enrollments","wireless.createDeviceWirelessZigbeeEnrollment","" "beta","getDeviceWirelessZigbeeEnrollment","Return an enrollment job","https://developer.cisco.com/meraki/api-v1/get-device-wireless-zigbee-enrollment/","get","/devices/{serial}/wireless/zigbee/enrollments/{id}","serial, id","","doorLockId, doorLocks, enrolledAt, enrollmentId, enrollmentStartedAt, eui64, gateway, id, lastSeenAt, lqi, name, network, request, rssi, serial, shortId, status, url","wireless, configure, zigbee, enrollments","wireless.getDeviceWirelessZigbeeEnrollment","" @@ -199,6 +206,12 @@ "GA","getNetworkApplianceTrafficShapingUplinkSelection","Show uplink selection settings for an MX network","https://developer.cisco.com/meraki/api-v1/get-network-appliance-traffic-shaping-uplink-selection/","get","/networks/{networkId}/appliance/trafficShaping/uplinkSelection","networkId","","activeActiveAutoVpnEnabled, applications, builtinPerformanceClassName, cidr, customPerformanceClassId, defaultUplink, destination, enabled, failOverCriterion, failoverAndFailback, fqdn, host, id, immediate, loadBalancingEnabled, name, network, performanceClass, port, preferredUplink, protocol, source, trafficFilters, type, value, vlan, vpnTrafficUplinkPreferences, wanTrafficUplinkPreferences","appliance, configure, trafficShaping, uplinkSelection","appliance.getNetworkApplianceTrafficShapingUplinkSelection","sdwan:config:read" "GA","updateNetworkApplianceTrafficShapingUplinkSelection","Update uplink selection settings for an MX network","https://developer.cisco.com/meraki/api-v1/update-network-appliance-traffic-shaping-uplink-selection/","put","/networks/{networkId}/appliance/trafficShaping/uplinkSelection","networkId","activeActiveAutoVpnEnabled, builtinPerformanceClassName, cidr, customPerformanceClassId, defaultUplink, destination, enabled, failOverCriterion, failoverAndFailback, fqdn, host, id, immediate, loadBalancingEnabled, network, performanceClass, port, preferredUplink, protocol, source, trafficFilters, type, value, vlan, vpnTrafficUplinkPreferences, wanTrafficUplinkPreferences","activeActiveAutoVpnEnabled, applications, builtinPerformanceClassName, cidr, customPerformanceClassId, defaultUplink, destination, enabled, failOverCriterion, failoverAndFailback, fqdn, host, id, immediate, loadBalancingEnabled, name, network, performanceClass, port, preferredUplink, protocol, source, trafficFilters, type, value, vlan, vpnTrafficUplinkPreferences, wanTrafficUplinkPreferences","appliance, configure, trafficShaping, uplinkSelection","appliance.updateNetworkApplianceTrafficShapingUplinkSelection","sdwan:config:write" "GA","updateNetworkApplianceTrafficShapingVpnExclusions","Update VPN exclusion rules for an MX network.","https://developer.cisco.com/meraki/api-v1/update-network-appliance-traffic-shaping-vpn-exclusions/","put","/networks/{networkId}/appliance/trafficShaping/vpnExclusions","networkId","custom, destination, id, majorApplications, name, port, protocol","custom, destination, id, majorApplications, name, networkId, networkName, port, protocol","appliance, configure, trafficShaping, vpnExclusions","appliance.updateNetworkApplianceTrafficShapingVpnExclusions","sdwan:config:write" +"beta","connectNetworkApplianceUmbrellaAccount","Connect to Cisco Umbrella account to this network","https://developer.cisco.com/meraki/api-v1/connect-network-appliance-umbrella-account/","post","/networks/{networkId}/appliance/umbrella/account/connect","networkId","apiKey, apiSecret","umbrellaOrganizationId","appliance, configure, umbrella, account","appliance.connectNetworkApplianceUmbrellaAccount","" +"beta","disconnectNetworkApplianceUmbrellaAccount","Disconnect Umbrella account from this network","https://developer.cisco.com/meraki/api-v1/disconnect-network-appliance-umbrella-account/","delete","/networks/{networkId}/appliance/umbrella/account/disconnect","networkId","","message, success","appliance, configure, umbrella, account","appliance.disconnectNetworkApplianceUmbrellaAccount","" +"beta","disableNetworkApplianceUmbrellaProtection","Disable umbrella protection for an MX network","https://developer.cisco.com/meraki/api-v1/disable-network-appliance-umbrella-protection/","delete","/networks/{networkId}/appliance/umbrella/disableProtection","networkId","","message, success","appliance, configure, umbrella","appliance.disableNetworkApplianceUmbrellaProtection","" +"beta","enableNetworkApplianceUmbrellaProtection","Enable umbrella protection for an MX network","https://developer.cisco.com/meraki/api-v1/enable-network-appliance-umbrella-protection/","post","/networks/{networkId}/appliance/umbrella/enableProtection","networkId","","message, success","appliance, configure, umbrella","appliance.enableNetworkApplianceUmbrellaProtection","" +"beta","excludeNetworkApplianceUmbrellaDomains","Specify one or more domain names to be excluded from being routed to Cisco Umbrella.","https://developer.cisco.com/meraki/api-v1/exclude-network-appliance-umbrella-domains/","put","/networks/{networkId}/appliance/umbrella/excludeDomains","networkId","domains","message, success","appliance, configure, umbrella","appliance.excludeNetworkApplianceUmbrellaDomains","" +"beta","policiesNetworkApplianceUmbrella","Update umbrella policies applied to MX network.","https://developer.cisco.com/meraki/api-v1/policies-network-appliance-umbrella/","put","/networks/{networkId}/appliance/umbrella/policies","networkId","policyIds","message, success","appliance, configure, umbrella","appliance.policiesNetworkApplianceUmbrella","" "GA","getNetworkApplianceUplinksUsageHistory","Get the sent and received bytes for each uplink of a network.","https://developer.cisco.com/meraki/api-v1/get-network-appliance-uplinks-usage-history/","get","/networks/{networkId}/appliance/uplinks/usageHistory","networkId, t0, t1, timespan, resolution","","byInterface, endTime, interface, received, sent, startTime","appliance, monitor, uplinks, usageHistory","appliance.getNetworkApplianceUplinksUsageHistory","sdwan:telemetry:read" "GA","getNetworkApplianceVlans","List the VLANs for an MX network","https://developer.cisco.com/meraki/api-v1/get-network-appliance-vlans/","get","/networks/{networkId}/appliance/vlans","networkId","","applianceIp, autonomous, cidr, code, comment, dhcpBootFilename, dhcpBootNextServer, dhcpBootOptionsEnabled, dhcpHandling, dhcpLeaseTime, dhcpOptions, dhcpRelayServerIps, dnsNameservers, enabled, end, fixedIpAssignments, groupPolicyId, id, interfaceId, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, reservedIpRanges, start, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type, value, vpnNatSubnet","appliance, configure, vlans","appliance.getNetworkApplianceVlans","sdwan:config:read" "GA","createNetworkApplianceVlan","Add a VLAN","https://developer.cisco.com/meraki/api-v1/create-network-appliance-vlan/","post","/networks/{networkId}/appliance/vlans","networkId","adaptivePolicyGroupId, applianceIp, autonomous, cidr, code, dhcpBootOptionsEnabled, dhcpHandling, dhcpLeaseTime, dhcpOptions, enabled, groupPolicyId, id, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type, value","applianceIp, autonomous, cidr, enabled, groupPolicyId, id, interfaceId, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type","appliance, configure, vlans","appliance.createNetworkApplianceVlan","sdwan:config:write" @@ -218,9 +231,9 @@ "GA","getNetworkBluetoothClients","List the Bluetooth clients seen by APs in this network","https://developer.cisco.com/meraki/api-v1/get-network-bluetooth-clients/","get","/networks/{networkId}/bluetoothClients","networkId, t0, timespan, perPage, startingAfter, endingBefore, includeConnectivityHistory","","deviceName, id, inSightAlert, lastSeen, mac, manufacturer, name, networkId, outOfSightAlert, seenByDeviceMac, tags","networks, monitor, bluetoothClients","networks.getNetworkBluetoothClients","wireless:telemetry:read" "GA","getNetworkBluetoothClient","Return a Bluetooth client","https://developer.cisco.com/meraki/api-v1/get-network-bluetooth-client/","get","/networks/{networkId}/bluetoothClients/{bluetoothClientId}","networkId, bluetoothClientId, includeConnectivityHistory, connectivityHistoryTimespan","","deviceName, id, inSightAlert, lastSeen, mac, manufacturer, name, networkId, outOfSightAlert, seenByDeviceMac, tags","networks, monitor, bluetoothClients","networks.getNetworkBluetoothClient","wireless:telemetry:read" "GA","getNetworkCameraQualityRetentionProfiles","List the quality retention profiles for this network","https://developer.cisco.com/meraki/api-v1/get-network-camera-quality-retention-profiles/","get","/networks/{networkId}/camera/qualityRetentionProfiles","networkId","","","camera, configure, qualityRetentionProfiles","camera.getNetworkCameraQualityRetentionProfiles","camera:config:read" -"GA","createNetworkCameraQualityRetentionProfile","Creates new quality retention profile for this network.","https://developer.cisco.com/meraki/api-v1/create-network-camera-quality-retention-profile/","post","/networks/{networkId}/camera/qualityRetentionProfiles","networkId","MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings","","camera, configure, qualityRetentionProfiles","camera.createNetworkCameraQualityRetentionProfile","camera:config:write" +"GA","createNetworkCameraQualityRetentionProfile","Creates new quality retention profile for this network.","https://developer.cisco.com/meraki/api-v1/create-network-camera-quality-retention-profile/","post","/networks/{networkId}/camera/qualityRetentionProfiles","networkId","MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV84X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings","","camera, configure, qualityRetentionProfiles","camera.createNetworkCameraQualityRetentionProfile","camera:config:write" "GA","getNetworkCameraQualityRetentionProfile","Retrieve a single quality retention profile","https://developer.cisco.com/meraki/api-v1/get-network-camera-quality-retention-profile/","get","/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}","networkId, qualityRetentionProfileId","","","camera, configure, qualityRetentionProfiles","camera.getNetworkCameraQualityRetentionProfile","camera:config:read" -"GA","updateNetworkCameraQualityRetentionProfile","Update an existing quality retention profile for this network.","https://developer.cisco.com/meraki/api-v1/update-network-camera-quality-retention-profile/","put","/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}","networkId, qualityRetentionProfileId","MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings","","camera, configure, qualityRetentionProfiles","camera.updateNetworkCameraQualityRetentionProfile","camera:config:write" +"GA","updateNetworkCameraQualityRetentionProfile","Update an existing quality retention profile for this network.","https://developer.cisco.com/meraki/api-v1/update-network-camera-quality-retention-profile/","put","/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}","networkId, qualityRetentionProfileId","MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV84X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings","","camera, configure, qualityRetentionProfiles","camera.updateNetworkCameraQualityRetentionProfile","camera:config:write" "GA","deleteNetworkCameraQualityRetentionProfile","Delete an existing quality retention profile for this network.","https://developer.cisco.com/meraki/api-v1/delete-network-camera-quality-retention-profile/","delete","/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}","networkId, qualityRetentionProfileId","","","camera, configure, qualityRetentionProfiles","camera.deleteNetworkCameraQualityRetentionProfile","camera:config:write" "GA","getNetworkCameraSchedules","Returns a list of all camera recording schedules.","https://developer.cisco.com/meraki/api-v1/get-network-camera-schedules/","get","/networks/{networkId}/camera/schedules","networkId","","id, name","camera, configure, schedules","camera.getNetworkCameraSchedules","camera:config:read" "GA","createNetworkCameraWirelessProfile","Creates a new camera wireless profile for this network.","https://developer.cisco.com/meraki/api-v1/create-network-camera-wireless-profile/","post","/networks/{networkId}/camera/wirelessProfiles","networkId","authMode, encryptionMode, identity, name, password, psk, ssid, username","appliedDeviceCount, authMode, encryptionMode, id, identity, name, password, psk, ssid, username","camera, configure, wirelessProfiles","camera.createNetworkCameraWirelessProfile","camera:config:write" @@ -244,7 +257,7 @@ "GA","getNetworkClientsOverview","Return overview statistics for network clients","https://developer.cisco.com/meraki/api-v1/get-network-clients-overview/","get","/networks/{networkId}/clients/overview","networkId, t0, t1, timespan, resolution","","average, counts, total, usages, withHeavyUsage, withHeavyUsageAverage","networks, monitor, clients, overview","networks.getNetworkClientsOverview","dashboard:general:telemetry:read" "GA","provisionNetworkClients","Provisions a client with a name and policy","https://developer.cisco.com/meraki/api-v1/provision-network-clients/","post","/networks/{networkId}/clients/provision","networkId","0, 1, 10, 11, 12, 13, 14, 2, 3, 4, 5, 6, 7, 8, 9, clients, devicePolicy, groupPolicyId, mac, name, policiesBySecurityAppliance, policiesBySsid","clientId, clients, devicePolicy, groupPolicyId, mac, message, name","networks, configure, clients","networks.provisionNetworkClients","dashboard:general:config:write" "GA","getNetworkClientsUsageHistories","Return the usage histories for clients","https://developer.cisco.com/meraki/api-v1/get-network-clients-usage-histories/","get","/networks/{networkId}/clients/usageHistories","networkId, clients, ssidNumber, perPage, startingAfter, endingBefore, t0, t1, timespan","","","networks, monitor, clients, usageHistories","networks.getNetworkClientsUsageHistories","dashboard:general:telemetry:read" -"GA","getNetworkClient","Return the client associated with the given identifier","https://developer.cisco.com/meraki/api-v1/get-network-client/","get","/networks/{networkId}/clients/{clientId}","networkId, clientId","","cdp, clientVpnConnections, connectedAt, description, disconnectedAt, firstSeen, id, ip, ip6, lastSeen, lldp, mac, manufacturer, notes, os, recentDeviceConnection, recentDeviceMac, recentDeviceName, recentDeviceSerial, remoteIp, smInstalled, ssid, status, switchport, user, vlan, wirelessCapabilities","networks, monitor, clients","networks.getNetworkClient","dashboard:general:telemetry:read" +"GA","getNetworkClient","Return the client associated with the given identifier","https://developer.cisco.com/meraki/api-v1/get-network-client/","get","/networks/{networkId}/clients/{clientId}","networkId, clientId","","cdp, clientVpnConnections, connectedAt, description, deviceTypePrediction, disconnectedAt, firstSeen, id, ip, ip6, lastSeen, lldp, mac, manufacturer, namedVlan, notes, os, recentDeviceConnection, recentDeviceMac, recentDeviceName, recentDeviceSerial, remoteIp, smInstalled, ssid, status, switchport, user, vlan, wirelessCapabilities","networks, monitor, clients","networks.getNetworkClient","dashboard:general:telemetry:read" "GA","getNetworkClientPolicy","Return the policy assigned to a client on the network","https://developer.cisco.com/meraki/api-v1/get-network-client-policy/","get","/networks/{networkId}/clients/{clientId}/policy","networkId, clientId","","devicePolicy, groupPolicyId, mac","networks, configure, clients, policy","networks.getNetworkClientPolicy","dashboard:general:config:read" "GA","updateNetworkClientPolicy","Update the policy assigned to a client on the network","https://developer.cisco.com/meraki/api-v1/update-network-client-policy/","put","/networks/{networkId}/clients/{clientId}/policy","networkId, clientId","devicePolicy, groupPolicyId","devicePolicy, groupPolicyId, mac","networks, configure, clients, policy","networks.updateNetworkClientPolicy","dashboard:general:config:write" "GA","getNetworkClientSplashAuthorizationStatus","Return the splash authorization for a client, for each SSID they've associated with through splash","https://developer.cisco.com/meraki/api-v1/get-network-client-splash-authorization-status/","get","/networks/{networkId}/clients/{clientId}/splashAuthorizationStatus","networkId, clientId","","","networks, configure, clients, splashAuthorizationStatus","networks.getNetworkClientSplashAuthorizationStatus","dashboard:general:config:read" @@ -316,10 +329,10 @@ "GA","getNetworkPoliciesByClient","Get policies for all clients with policies","https://developer.cisco.com/meraki/api-v1/get-network-policies-by-client/","get","/networks/{networkId}/policies/byClient","networkId, perPage, startingAfter, endingBefore, t0, timespan","","assigned, clientId, groupPolicyId, name, ssid, ssidNumber, type","networks, configure, policies, byClient","networks.getNetworkPoliciesByClient","dashboard:general:config:read" "GA","getNetworkSensorAlertsCurrentOverviewByMetric","Return an overview of currently alerting sensors by metric","https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-current-overview-by-metric/","get","/networks/{networkId}/sensor/alerts/current/overview/byMetric","networkId","","ambient, apparentPower, co2, counts, current, door, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, supportedMetrics, temperature, tvoc, upstreamPower, voltage, water","sensor, monitor, alerts, current, overview, byMetric","sensor.getNetworkSensorAlertsCurrentOverviewByMetric","sensor:telemetry:read" "GA","getNetworkSensorAlertsOverviewByMetric","Return an overview of alert occurrences over a timespan, by metric","https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-overview-by-metric/","get","/networks/{networkId}/sensor/alerts/overview/byMetric","networkId, t0, t1, timespan, interval","","ambient, apparentPower, co2, counts, current, door, endTs, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, startTs, temperature, tvoc, upstreamPower, voltage, water","sensor, monitor, alerts, overview, byMetric","sensor.getNetworkSensorAlertsOverviewByMetric","sensor:telemetry:read" -"GA","getNetworkSensorAlertsProfiles","Lists all sensor alert profiles for a network.","https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-profiles/","get","/networks/{networkId}/sensor/alerts/profiles","networkId","","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","sensor, configure, alerts, profiles","sensor.getNetworkSensorAlertsProfiles","sensor:telemetry:read" -"GA","createNetworkSensorAlertsProfile","Creates a sensor alert profile for a network.","https://developer.cisco.com/meraki/api-v1/create-network-sensor-alerts-profile/","post","/networks/{networkId}/sensor/alerts/profiles","networkId","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","sensor, configure, alerts, profiles","sensor.createNetworkSensorAlertsProfile","sensor:telemetry:write" -"GA","getNetworkSensorAlertsProfile","Show details of a sensor alert profile for a network.","https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-profile/","get","/networks/{networkId}/sensor/alerts/profiles/{id}","networkId, id","","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","sensor, configure, alerts, profiles","sensor.getNetworkSensorAlertsProfile","sensor:telemetry:read" -"GA","updateNetworkSensorAlertsProfile","Updates a sensor alert profile for a network.","https://developer.cisco.com/meraki/api-v1/update-network-sensor-alerts-profile/","put","/networks/{networkId}/sensor/alerts/profiles/{id}","networkId, id","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","sensor, configure, alerts, profiles","sensor.updateNetworkSensorAlertsProfile","sensor:telemetry:write" +"GA","getNetworkSensorAlertsProfiles","Lists all sensor alert profiles for a network.","https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-profiles/","get","/networks/{networkId}/sensor/alerts/profiles","networkId","","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","sensor, configure, alerts, profiles","sensor.getNetworkSensorAlertsProfiles","sensor:telemetry:read" +"GA","createNetworkSensorAlertsProfile","Creates a sensor alert profile for a network.","https://developer.cisco.com/meraki/api-v1/create-network-sensor-alerts-profile/","post","/networks/{networkId}/sensor/alerts/profiles","networkId","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","sensor, configure, alerts, profiles","sensor.createNetworkSensorAlertsProfile","sensor:telemetry:write" +"GA","getNetworkSensorAlertsProfile","Show details of a sensor alert profile for a network.","https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-profile/","get","/networks/{networkId}/sensor/alerts/profiles/{id}","networkId, id","","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","sensor, configure, alerts, profiles","sensor.getNetworkSensorAlertsProfile","sensor:telemetry:read" +"GA","updateNetworkSensorAlertsProfile","Updates a sensor alert profile for a network.","https://developer.cisco.com/meraki/api-v1/update-network-sensor-alerts-profile/","put","/networks/{networkId}/sensor/alerts/profiles/{id}","networkId, id","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water","sensor, configure, alerts, profiles","sensor.updateNetworkSensorAlertsProfile","sensor:telemetry:write" "GA","deleteNetworkSensorAlertsProfile","Deletes a sensor alert profile from a network.","https://developer.cisco.com/meraki/api-v1/delete-network-sensor-alerts-profile/","delete","/networks/{networkId}/sensor/alerts/profiles/{id}","networkId, id","","","sensor, configure, alerts, profiles","sensor.deleteNetworkSensorAlertsProfile","sensor:telemetry:write" "GA","getNetworkSensorMqttBrokers","List the sensor settings of all MQTT brokers for this network","https://developer.cisco.com/meraki/api-v1/get-network-sensor-mqtt-brokers/","get","/networks/{networkId}/sensor/mqttBrokers","networkId","","enabled, mqttBrokerId","sensor, configure, mqttBrokers","sensor.getNetworkSensorMqttBrokers","sensor:telemetry:read" "GA","getNetworkSensorMqttBroker","Return the sensor settings of an MQTT broker","https://developer.cisco.com/meraki/api-v1/get-network-sensor-mqtt-broker/","get","/networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}","networkId, mqttBrokerId","","enabled, mqttBrokerId","sensor, configure, mqttBrokers","sensor.getNetworkSensorMqttBroker","sensor:telemetry:read" @@ -374,10 +387,10 @@ "GA","splitNetwork","Split a combined network into individual networks for each type of device","https://developer.cisco.com/meraki/api-v1/split-network/","post","/networks/{networkId}/split","networkId","","enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, resultingNetworks, tags, timeZone, url","networks, configure","networks.splitNetwork","dashboard:general:config:write" "GA","getNetworkSwitchAccessControlLists","Return the access control lists for a MS network","https://developer.cisco.com/meraki/api-v1/get-network-switch-access-control-lists/","get","/networks/{networkId}/switch/accessControlLists","networkId","","comment, dstCidr, dstPort, ipVersion, policy, protocol, rules, srcCidr, srcPort, vlan","switch, configure, accessControlLists","switch.getNetworkSwitchAccessControlLists","switch:config:read" "GA","updateNetworkSwitchAccessControlLists","Update the access control lists for a MS network","https://developer.cisco.com/meraki/api-v1/update-network-switch-access-control-lists/","put","/networks/{networkId}/switch/accessControlLists","networkId","comment, dstCidr, dstPort, ipVersion, policy, protocol, rules, srcCidr, srcPort, vlan","comment, dstCidr, dstPort, ipVersion, policy, protocol, rules, srcCidr, srcPort, vlan","switch, configure, accessControlLists","switch.updateNetworkSwitchAccessControlLists","switch:config:write" -"GA","getNetworkSwitchAccessPolicies","List the access policies for a switch network","https://developer.cisco.com/meraki/api-v1/get-network-switch-access-policies/","get","/networks/{networkId}/switch/accessPolicies","networkId","","accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy","switch, configure, accessPolicies","switch.getNetworkSwitchAccessPolicies","switch:config:read" -"GA","createNetworkSwitchAccessPolicy","Create an access policy for a switch network","https://developer.cisco.com/meraki/api-v1/create-network-switch-access-policy/","post","/networks/{networkId}/switch/accessPolicies","networkId","accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId","accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy","switch, configure, accessPolicies","switch.createNetworkSwitchAccessPolicy","switch:config:write" -"GA","getNetworkSwitchAccessPolicy","Return a specific access policy for a switch network","https://developer.cisco.com/meraki/api-v1/get-network-switch-access-policy/","get","/networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}","networkId, accessPolicyNumber","","accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy","switch, configure, accessPolicies","switch.getNetworkSwitchAccessPolicy","switch:config:read" -"GA","updateNetworkSwitchAccessPolicy","Update an access policy for a switch network","https://developer.cisco.com/meraki/api-v1/update-network-switch-access-policy/","put","/networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}","networkId, accessPolicyNumber","accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId","accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy","switch, configure, accessPolicies","switch.updateNetworkSwitchAccessPolicy","switch:config:write" +"GA","getNetworkSwitchAccessPolicies","List the access policies for a switch network","https://developer.cisco.com/meraki/api-v1/get-network-switch-access-policies/","get","/networks/{networkId}/switch/accessPolicies","networkId","","accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy","switch, configure, accessPolicies","switch.getNetworkSwitchAccessPolicies","switch:config:read" +"GA","createNetworkSwitchAccessPolicy","Create an access policy for a switch network","https://developer.cisco.com/meraki/api-v1/create-network-switch-access-policy/","post","/networks/{networkId}/switch/accessPolicies","networkId","accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId","accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy","switch, configure, accessPolicies","switch.createNetworkSwitchAccessPolicy","switch:config:write" +"GA","getNetworkSwitchAccessPolicy","Return a specific access policy for a switch network","https://developer.cisco.com/meraki/api-v1/get-network-switch-access-policy/","get","/networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}","networkId, accessPolicyNumber","","accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy","switch, configure, accessPolicies","switch.getNetworkSwitchAccessPolicy","switch:config:read" +"GA","updateNetworkSwitchAccessPolicy","Update an access policy for a switch network","https://developer.cisco.com/meraki/api-v1/update-network-switch-access-policy/","put","/networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}","networkId, accessPolicyNumber","accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId","accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy","switch, configure, accessPolicies","switch.updateNetworkSwitchAccessPolicy","switch:config:write" "GA","deleteNetworkSwitchAccessPolicy","Delete an access policy for a switch network","https://developer.cisco.com/meraki/api-v1/delete-network-switch-access-policy/","delete","/networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}","networkId, accessPolicyNumber","","","switch, configure, accessPolicies","switch.deleteNetworkSwitchAccessPolicy","switch:config:write" "GA","getNetworkSwitchAlternateManagementInterface","Return the switch alternate management interface for the network","https://developer.cisco.com/meraki/api-v1/get-network-switch-alternate-management-interface/","get","/networks/{networkId}/switch/alternateManagementInterface","networkId","","alternateManagementIp, enabled, gateway, protocols, serial, subnetMask, switches, vlanId","switch, configure, alternateManagementInterface","switch.getNetworkSwitchAlternateManagementInterface","switch:config:read" "GA","updateNetworkSwitchAlternateManagementInterface","Update the switch alternate management interface for the network","https://developer.cisco.com/meraki/api-v1/update-network-switch-alternate-management-interface/","put","/networks/{networkId}/switch/alternateManagementInterface","networkId","alternateManagementIp, enabled, gateway, protocols, serial, subnetMask, switches, vlanId","alternateManagementIp, enabled, gateway, protocols, serial, subnetMask, switches, vlanId","switch, configure, alternateManagementInterface","switch.updateNetworkSwitchAlternateManagementInterface","switch:config:write" @@ -430,10 +443,10 @@ "GA","addNetworkSwitchStack","Add a switch to a stack","https://developer.cisco.com/meraki/api-v1/add-network-switch-stack/","post","/networks/{networkId}/switch/stacks/{switchStackId}/add","networkId, switchStackId","serial","id, isMonitorOnly, mac, members, model, name, role, serial, serials","switch, configure, stacks","switch.addNetworkSwitchStack","switch:config:write" "beta","updateNetworkSwitchStackPortsMirror","Update switch port mirrors for switch stacks","https://developer.cisco.com/meraki/api-v1/update-network-switch-stack-ports-mirror/","put","/networks/{networkId}/switch/stacks/{switchStackId}/ports/mirror","networkId, switchStackId","comment, destination, filter, hasTransitVlan, module, number, port, ports, role, serial, slot, source, tags, type, vlan, vlans","comment, destination, filter, hasTransitVlan, id, mirror, module, name, network, number, port, ports, role, serial, slot, source, switchStackId, tags, type, vlan, vlans, warnings","switch, configure, stacks, ports, mirror","switch.updateNetworkSwitchStackPortsMirror","" "GA","removeNetworkSwitchStack","Remove a switch from a stack","https://developer.cisco.com/meraki/api-v1/remove-network-switch-stack/","post","/networks/{networkId}/switch/stacks/{switchStackId}/remove","networkId, switchStackId","serial","id, isMonitorOnly, mac, members, model, name, role, serial, serials","switch, configure, stacks","switch.removeNetworkSwitchStack","switch:config:write" -"GA","getNetworkSwitchStackRoutingInterfaces","List layer 3 interfaces for a switch stack","https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interfaces/","get","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces","networkId, switchStackId","","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId","switch, configure, stacks, routing, interfaces","switch.getNetworkSwitchStackRoutingInterfaces","switch:config:read" -"GA","createNetworkSwitchStackRoutingInterface","Create a layer 3 interface for a switch stack","https://developer.cisco.com/meraki/api-v1/create-network-switch-stack-routing-interface/","post","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces","networkId, switchStackId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId","switch, configure, stacks, routing, interfaces","switch.createNetworkSwitchStackRoutingInterface","switch:config:write" -"GA","getNetworkSwitchStackRoutingInterface","Return a layer 3 interface from a switch stack","https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interface/","get","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}","networkId, switchStackId, interfaceId","","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId","switch, configure, stacks, routing, interfaces","switch.getNetworkSwitchStackRoutingInterface","switch:config:read" -"GA","updateNetworkSwitchStackRoutingInterface","Update a layer 3 interface for a switch stack","https://developer.cisco.com/meraki/api-v1/update-network-switch-stack-routing-interface/","put","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}","networkId, switchStackId, interfaceId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","address, area, assignmentMode, cost, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId","switch, configure, stacks, routing, interfaces","switch.updateNetworkSwitchStackRoutingInterface","switch:config:write" +"GA","getNetworkSwitchStackRoutingInterfaces","List layer 3 interfaces for a switch stack","https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interfaces/","get","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces","networkId, switchStackId, protocol","","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","switch, configure, stacks, routing, interfaces","switch.getNetworkSwitchStackRoutingInterfaces","switch:config:read" +"GA","createNetworkSwitchStackRoutingInterface","Create a layer 3 interface for a switch stack","https://developer.cisco.com/meraki/api-v1/create-network-switch-stack-routing-interface/","post","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces","networkId, switchStackId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","switch, configure, stacks, routing, interfaces","switch.createNetworkSwitchStackRoutingInterface","switch:config:write" +"GA","getNetworkSwitchStackRoutingInterface","Return a layer 3 interface from a switch stack","https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interface/","get","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}","networkId, switchStackId, interfaceId","","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","switch, configure, stacks, routing, interfaces","switch.getNetworkSwitchStackRoutingInterface","switch:config:read" +"GA","updateNetworkSwitchStackRoutingInterface","Update a layer 3 interface for a switch stack","https://developer.cisco.com/meraki/api-v1/update-network-switch-stack-routing-interface/","put","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}","networkId, switchStackId, interfaceId","address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","address, area, assignmentMode, cost, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId","switch, configure, stacks, routing, interfaces","switch.updateNetworkSwitchStackRoutingInterface","switch:config:write" "GA","deleteNetworkSwitchStackRoutingInterface","Delete a layer 3 interface from a switch stack","https://developer.cisco.com/meraki/api-v1/delete-network-switch-stack-routing-interface/","delete","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}","networkId, switchStackId, interfaceId","","","switch, configure, stacks, routing, interfaces","switch.deleteNetworkSwitchStackRoutingInterface","switch:config:write" "GA","getNetworkSwitchStackRoutingInterfaceDhcp","Return a layer 3 interface DHCP configuration for a switch stack","https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interface-dhcp/","get","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp","networkId, switchStackId, interfaceId","","bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value","switch, configure, stacks, routing, interfaces, dhcp","switch.getNetworkSwitchStackRoutingInterfaceDhcp","switch:config:read" "GA","updateNetworkSwitchStackRoutingInterfaceDhcp","Update a layer 3 interface DHCP configuration for a switch stack","https://developer.cisco.com/meraki/api-v1/update-network-switch-stack-routing-interface-dhcp/","put","/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp","networkId, switchStackId, interfaceId","bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value","bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value","switch, configure, stacks, routing, interfaces, dhcp","switch.updateNetworkSwitchStackRoutingInterfaceDhcp","switch:config:write" @@ -514,7 +527,7 @@ "GA","getNetworkWirelessFailedConnections","List of all failed client connection events on this network in a given time range","https://developer.cisco.com/meraki/api-v1/get-network-wireless-failed-connections/","get","/networks/{networkId}/wireless/failedConnections","networkId, t0, t1, timespan, band, ssid, vlan, apTag, serial, clientId","","clientMac, failureStep, serial, ssidNumber, ts, type, vlan","wireless, monitor, failedConnections","wireless.getNetworkWirelessFailedConnections","wireless:telemetry:read" "GA","getNetworkWirelessLatencyHistory","Return average wireless latency over time for a network, device, or network client","https://developer.cisco.com/meraki/api-v1/get-network-wireless-latency-history/","get","/networks/{networkId}/wireless/latencyHistory","networkId, t0, t1, timespan, resolution, autoResolution, clientId, deviceSerial, apTag, band, ssid, accessCategory","","avgLatencyMs, endTs, startTs","wireless, monitor, latencyHistory","wireless.getNetworkWirelessLatencyHistory","wireless:telemetry:read" "GA","getNetworkWirelessLatencyStats","Aggregated latency info for this network","https://developer.cisco.com/meraki/api-v1/get-network-wireless-latency-stats/","get","/networks/{networkId}/wireless/latencyStats","networkId, t0, t1, timespan, band, ssid, vlan, apTag, fields","","","wireless, monitor, latencyStats","wireless.getNetworkWirelessLatencyStats","wireless:telemetry:read" -"beta","updateNetworkWirelessLocationScanning","Change scanning API settings","https://developer.cisco.com/meraki/api-v1/update-network-wireless-location-scanning/","put","/networks/{networkId}/wireless/location/scanning","networkId","api, enabled","api, enabled, string, validator","wireless, configure, location, scanning","wireless.updateNetworkWirelessLocationScanning","wireless:telemetry:write" +"GA","updateNetworkWirelessLocationScanning","Change scanning API settings","https://developer.cisco.com/meraki/api-v1/update-network-wireless-location-scanning/","put","/networks/{networkId}/wireless/location/scanning","networkId","api, enabled","api, enabled, string, validator","wireless, configure, location, scanning","wireless.updateNetworkWirelessLocationScanning","wireless:telemetry:write" "GA","getNetworkWirelessMeshStatuses","List wireless mesh statuses for repeaters","https://developer.cisco.com/meraki/api-v1/get-network-wireless-mesh-statuses/","get","/networks/{networkId}/wireless/meshStatuses","networkId, perPage, startingAfter, endingBefore","","latestMeshPerformance, mbps, meshRoute, metric, serial, usagePercentage","wireless, monitor, meshStatuses","wireless.getNetworkWirelessMeshStatuses","wireless:telemetry:read" "beta","updateNetworkWirelessOpportunisticPcap","Update the Opportunistic Pcap settings for a wireless network","https://developer.cisco.com/meraki/api-v1/update-network-wireless-opportunistic-pcap/","put","/networks/{networkId}/wireless/opportunisticPcap","networkId","enablement, networkWide, serials, tags","enablement, name, networkId, networkWide, serials, tags","wireless, configure, opportunisticPcap","wireless.updateNetworkWirelessOpportunisticPcap","" "beta","updateNetworkWirelessRadioAutoRf","Update the AutoRF settings for a wireless network","https://developer.cisco.com/meraki/api-v1/update-network-wireless-radio-auto-rf/","put","/networks/{networkId}/wireless/radio/autoRf","networkId","aiRrm, avoidance, busyHour, channel, enabled, end, fra, manual, minimizeChanges, mode, schedule, start","aiRrm, automatic, avoidance, busyHour, channel, enabled, enablementDate, end, fra, manual, minimizeChanges, mode, name, networkId, schedule, start, timeZone","wireless, configure, radio, autoRf","wireless.updateNetworkWirelessRadioAutoRf","" @@ -528,7 +541,7 @@ "GA","getNetworkWirelessSignalQualityHistory","Return signal quality (SNR/RSSI) over time for a device or network client","https://developer.cisco.com/meraki/api-v1/get-network-wireless-signal-quality-history/","get","/networks/{networkId}/wireless/signalQualityHistory","networkId, t0, t1, timespan, resolution, autoResolution, clientId, deviceSerial, apTag, band, ssid","","endTs, rssi, snr, startTs","wireless, monitor, signalQualityHistory","wireless.getNetworkWirelessSignalQualityHistory","wireless:telemetry:read" "GA","getNetworkWirelessSsids","List the MR SSIDs in a network","https://developer.cisco.com/meraki/api-v1/get-network-wireless-ssids/","get","/networks/{networkId}/wireless/ssids","networkId","","adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode","wireless, configure, ssids","wireless.getNetworkWirelessSsids","wireless:config:read" "GA","getNetworkWirelessSsid","Return a single MR SSID","https://developer.cisco.com/meraki/api-v1/get-network-wireless-ssid/","get","/networks/{networkId}/wireless/ssids/{number}","networkId, number","","adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode","wireless, configure, ssids","wireless.getNetworkWirelessSsid","wireless:config:read" -"GA","updateNetworkWirelessSsid","Update the attributes of an MR SSID","https://developer.cisco.com/meraki/api-v1/update-network-wireless-ssid/","put","/networks/{networkId}/wireless/ssids/{number}","networkId, number","activeDirectory, adaptive, adultContentFilteringEnabled, allowedDomains, apTagsAndVlanIds, authMode, availabilityTags, availableOnAllAps, bandSelection, baseDistinguishedName, byApTags, caCertificate, cacheTimeout, certificateAuthentication, clientRootCaCertificate, concentrator, concentratorNetworkId, contents, credentials, defaultVlanId, defaultVlanName, disassociateClientsOnVpnFailover, distinguishedName, dnsCustomNameservers, dnsRewrite, dot11r, dot11w, enabled, encryptionMode, enterpriseAdminAccess, gre, guestVlan, host, ipAssignmentMode, key, lanIsolationEnabled, ldap, localRadius, logonName, mandatoryDhcpEnabled, minBitrate, name, namedVlans, oauth, ocspResponderUrl, openRoamingCertificateId, password, passwordAuthentication, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, psk, radius, radiusAccountingEnabled, radiusAccountingInterimInterval, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusAuthenticationNasId, radiusCalledStationId, radiusCoaEnabled, radiusFailoverPolicy, radiusFallbackEnabled, radiusGuestVlanEnabled, radiusGuestVlanId, radiusLoadBalancingPolicy, radiusOverride, radiusProxyEnabled, radiusRadsec, radiusServerAttemptsLimit, radiusServerTimeout, radiusServers, radiusTestingEnabled, radsecEnabled, required, secondaryConcentratorNetworkId, secret, serverCaCertificate, servers, speedBurst, splashGuestSponsorDomains, splashPage, tagging, tags, timeout, tlsTunnel, useLdap, useOcsp, useVlanTagging, visible, vlanId, vlanName, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode","adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode","wireless, configure, ssids","wireless.updateNetworkWirelessSsid","wireless:config:write" +"GA","updateNetworkWirelessSsid","Update the attributes of an MR SSID","https://developer.cisco.com/meraki/api-v1/update-network-wireless-ssid/","put","/networks/{networkId}/wireless/ssids/{number}","networkId, number","activeDirectory, adaptive, adaptivePolicyGroupId, adultContentFilteringEnabled, allowedDomains, apTagsAndVlanIds, authMode, availabilityTags, availableOnAllAps, bandSelection, baseDistinguishedName, byApTags, caCertificate, cacheTimeout, certificateAuthentication, clientRootCaCertificate, concentrator, concentratorNetworkId, contents, credentials, defaultVlanId, defaultVlanName, disassociateClientsOnVpnFailover, distinguishedName, dnsCustomNameservers, dnsRewrite, dot11r, dot11w, enabled, encryptionMode, enterpriseAdminAccess, gre, guestVlan, host, ipAssignmentMode, key, lanIsolationEnabled, ldap, localRadius, logonName, mandatoryDhcpEnabled, minBitrate, name, namedVlans, oauth, ocspResponderUrl, openRoamingCertificateId, password, passwordAuthentication, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, psk, radius, radiusAccountingEnabled, radiusAccountingInterimInterval, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusAuthenticationNasId, radiusCalledStationId, radiusCoaEnabled, radiusFailoverPolicy, radiusFallbackEnabled, radiusGuestVlanEnabled, radiusGuestVlanId, radiusLoadBalancingPolicy, radiusOverride, radiusProxyEnabled, radiusRadsec, radiusServerAttemptsLimit, radiusServerTimeout, radiusServers, radiusTestingEnabled, radsecEnabled, required, secondaryConcentratorNetworkId, secret, serverCaCertificate, servers, speedBurst, splashGuestSponsorDomains, splashPage, tagging, tags, timeout, tlsTunnel, useLdap, useOcsp, useVlanTagging, visible, vlanId, vlanName, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode","adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode","wireless, configure, ssids","wireless.updateNetworkWirelessSsid","wireless:config:write" "GA","getNetworkWirelessSsidBonjourForwarding","List the Bonjour forwarding setting and rules for the SSID","https://developer.cisco.com/meraki/api-v1/get-network-wireless-ssid-bonjour-forwarding/","get","/networks/{networkId}/wireless/ssids/{number}/bonjourForwarding","networkId, number","","description, enabled, exception, rules, services, vlanId","wireless, configure, ssids, bonjourForwarding","wireless.getNetworkWirelessSsidBonjourForwarding","wireless:config:read" "GA","updateNetworkWirelessSsidBonjourForwarding","Update the bonjour forwarding setting and rules for the SSID","https://developer.cisco.com/meraki/api-v1/update-network-wireless-ssid-bonjour-forwarding/","put","/networks/{networkId}/wireless/ssids/{number}/bonjourForwarding","networkId, number","description, enabled, exception, rules, services, vlanId","description, enabled, exception, rules, services, vlanId","wireless, configure, ssids, bonjourForwarding","wireless.updateNetworkWirelessSsidBonjourForwarding","wireless:config:write" "GA","getNetworkWirelessSsidDeviceTypeGroupPolicies","List the device type group policies for the SSID","https://developer.cisco.com/meraki/api-v1/get-network-wireless-ssid-device-type-group-policies/","get","/networks/{networkId}/wireless/ssids/{number}/deviceTypeGroupPolicies","networkId, number","","","wireless, configure, ssids, deviceTypeGroupPolicies","wireless.getNetworkWirelessSsidDeviceTypeGroupPolicies","wireless:config:read" @@ -598,7 +611,7 @@ "GA","getOrganizationApplianceDnsLocalProfiles","Fetch the local DNS profiles used in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-dns-local-profiles/","get","/organizations/{organizationId}/appliance/dns/local/profiles","organizationId, profileIds","","name, profileId","appliance, configure, dns, local, profiles","appliance.getOrganizationApplianceDnsLocalProfiles","" "GA","createOrganizationApplianceDnsLocalProfile","Create a new local DNS profile","https://developer.cisco.com/meraki/api-v1/create-organization-appliance-dns-local-profile/","post","/organizations/{organizationId}/appliance/dns/local/profiles","organizationId","name","name, profileId","appliance, configure, dns, local, profiles","appliance.createOrganizationApplianceDnsLocalProfile","" "GA","getOrganizationApplianceDnsLocalProfilesAssignments","Fetch the local DNS profile assignments in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-dns-local-profiles-assignments/","get","/organizations/{organizationId}/appliance/dns/local/profiles/assignments","organizationId, profileIds, networkIds","","assignmentId, counts, id, items, meta, network, profile, remaining, total","appliance, configure, dns, local, profiles, assignments","appliance.getOrganizationApplianceDnsLocalProfilesAssignments","" -"GA","createOrganizationApplianceDnsLocalProfilesAssignmentsBulkCreate","Assign the local DNS profile to networks in the organization","https://developer.cisco.com/meraki/api-v1/create-organization-appliance-dns-local-profiles-assignments-bulk-create/","post","/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate","organizationId","id, items, network, profile","assignmentId, id, items, network, profile","appliance, configure, dns, local, profiles, assignments, bulkCreate","appliance.createOrganizationApplianceDnsLocalProfilesAssignmentsBulkCreate","" +"GA","bulkOrganizationApplianceDnsLocalProfilesAssignmentsCreate","Assign the local DNS profile to networks in the organization","https://developer.cisco.com/meraki/api-v1/bulk-organization-appliance-dns-local-profiles-assignments-create/","post","/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate","organizationId","id, items, network, profile","assignmentId, id, items, network, profile","appliance, configure, dns, local, profiles, assignments","appliance.bulkOrganizationApplianceDnsLocalProfilesAssignmentsCreate","" "GA","createOrganizationApplianceDnsLocalProfilesAssignmentsBulkDelete","Unassign the local DNS profile to networks in the organization","https://developer.cisco.com/meraki/api-v1/create-organization-appliance-dns-local-profiles-assignments-bulk-delete/","post","/organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkDelete","organizationId","assignmentId, items","assignmentId, id, items, network, profile","appliance, configure, dns, local, profiles, assignments, bulkDelete","appliance.createOrganizationApplianceDnsLocalProfilesAssignmentsBulkDelete","" "GA","updateOrganizationApplianceDnsLocalProfile","Update a local DNS profile","https://developer.cisco.com/meraki/api-v1/update-organization-appliance-dns-local-profile/","put","/organizations/{organizationId}/appliance/dns/local/profiles/{profileId}","organizationId, profileId","name","name, profileId","appliance, configure, dns, local, profiles","appliance.updateOrganizationApplianceDnsLocalProfile","" "GA","deleteOrganizationApplianceDnsLocalProfile","Deletes a local DNS profile","https://developer.cisco.com/meraki/api-v1/delete-organization-appliance-dns-local-profile/","delete","/organizations/{organizationId}/appliance/dns/local/profiles/{profileId}","organizationId, profileId","","","appliance, configure, dns, local, profiles","appliance.deleteOrganizationApplianceDnsLocalProfile","" @@ -622,20 +635,22 @@ "GA","getOrganizationApplianceUplinkStatuses","List the uplink status of every Meraki MX and Z series appliances in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-uplink-statuses/","get","/organizations/{organizationId}/appliance/uplink/statuses","organizationId, perPage, startingAfter, endingBefore, networkIds, serials, iccids","","enabled, gateway, highAvailability, interface, ip, ipAssignedBy, lastReportedAt, model, networkId, primaryDns, publicIp, role, secondaryDns, serial, status, uplinks","appliance, monitor, uplinks, statuses","appliance.getOrganizationApplianceUplinkStatuses","sdwan:telemetry:read" "GA","getOrganizationApplianceUplinksStatusesOverview","Returns an overview of uplink statuses","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-uplinks-statuses-overview/","get","/organizations/{organizationId}/appliance/uplinks/statuses/overview","organizationId","","active, byStatus, connecting, counts, failed, notConnected, ready","appliance, monitor, uplinks, statuses, overview","appliance.getOrganizationApplianceUplinksStatusesOverview","" "GA","getOrganizationApplianceUplinksUsageByNetwork","Get the sent and received bytes for each uplink of all MX and Z networks within an organization","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-uplinks-usage-by-network/","get","/organizations/{organizationId}/appliance/uplinks/usage/byNetwork","organizationId, t0, t1, timespan","","byUplink, interface, name, networkId, received, sent, serial","appliance, monitor, uplinks, usage, byNetwork","appliance.getOrganizationApplianceUplinksUsageByNetwork","sdwan:telemetry:read" +"beta","getOrganizationApplianceVlans","List the VLANs for an Organization","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vlans/","get","/organizations/{organizationId}/appliance/vlans","organizationId, perPage, startingAfter, endingBefore","","applianceIp, autonomous, cidr, code, comment, dhcpBootFilename, dhcpBootNextServer, dhcpBootOptionsEnabled, dhcpHandling, dhcpLeaseTime, dhcpOptions, dhcpRelayServerIps, dnsNameservers, enabled, end, fixedIpAssignments, groupPolicyId, id, interfaceId, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, reservedIpRanges, start, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type, value, vpnNatSubnet","appliance, configure, vlans","appliance.getOrganizationApplianceVlans","" "GA","getOrganizationApplianceVpnStats","Show VPN history stat for networks in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vpn-stats/","get","/organizations/{organizationId}/appliance/vpn/stats","organizationId, perPage, startingAfter, endingBefore, networkIds, t0, t1, timespan","","avgJitter, avgLatencyMs, avgLossPercentage, avgMos, jitterSummaries, latencySummaries, lossPercentageSummaries, maxJitter, maxLatencyMs, maxLossPercentage, maxMos, merakiVpnPeers, minJitter, minLatencyMs, minLossPercentage, minMos, mosSummaries, networkId, networkName, receivedInKilobytes, receiverUplink, senderUplink, sentInKilobytes, usageSummary","appliance, monitor, vpn, stats","appliance.getOrganizationApplianceVpnStats","sdwan:telemetry:read" "GA","getOrganizationApplianceVpnStatuses","Show VPN status for networks in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vpn-statuses/","get","/organizations/{organizationId}/appliance/vpn/statuses","organizationId, perPage, startingAfter, endingBefore, networkIds","","deviceSerial, deviceStatus, exportedSubnets, interface, merakiVpnPeers, name, networkId, networkName, publicIp, reachability, subnet, thirdPartyVpnPeers, uplinks, vpnMode, vpnstatusentities","appliance, monitor, vpn, statuses","appliance.getOrganizationApplianceVpnStatuses","sdwan:telemetry:read" "GA","getOrganizationApplianceVpnThirdPartyVPNPeers","Return the third party VPN peers for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vpn-third-party-vpnpeers/","get","/organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers","organizationId","","childAuthAlgo, childCipherAlgo, childLifetime, childPfsGroup, ikeAuthAlgo, ikeCipherAlgo, ikeDiffieHellmanGroup, ikeLifetime, ikePrfAlgo, ikeVersion, ipsecPolicies, ipsecPoliciesPreset, localId, name, networkTags, peers, privateSubnets, publicIp, remoteId, secret","appliance, configure, vpn, thirdPartyVPNPeers","appliance.getOrganizationApplianceVpnThirdPartyVPNPeers","sdwan:config:read" "GA","updateOrganizationApplianceVpnThirdPartyVPNPeers","Update the third party VPN peers for an organization","https://developer.cisco.com/meraki/api-v1/update-organization-appliance-vpn-third-party-vpnpeers/","put","/organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers","organizationId","childAuthAlgo, childCipherAlgo, childLifetime, childPfsGroup, ikeAuthAlgo, ikeCipherAlgo, ikeDiffieHellmanGroup, ikeLifetime, ikePrfAlgo, ikeVersion, ipsecPolicies, ipsecPoliciesPreset, localId, name, networkTags, peers, privateSubnets, publicHostname, publicIp, remoteId, secret","childAuthAlgo, childCipherAlgo, childLifetime, childPfsGroup, ikeAuthAlgo, ikeCipherAlgo, ikeDiffieHellmanGroup, ikeLifetime, ikePrfAlgo, ikeVersion, ipsecPolicies, ipsecPoliciesPreset, localId, name, networkTags, peers, privateSubnets, publicIp, remoteId, secret","appliance, configure, vpn, thirdPartyVPNPeers","appliance.updateOrganizationApplianceVpnThirdPartyVPNPeers","sdwan:config:write" "GA","getOrganizationApplianceVpnVpnFirewallRules","Return the firewall rules for an organization's site-to-site VPN","https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vpn-vpn-firewall-rules/","get","/organizations/{organizationId}/appliance/vpn/vpnFirewallRules","organizationId","","comment, destCidr, destPort, policy, protocol, rules, srcCidr, srcPort, syslogEnabled","appliance, configure, vpn, vpnFirewallRules","appliance.getOrganizationApplianceVpnVpnFirewallRules","sdwan:config:read" "GA","updateOrganizationApplianceVpnVpnFirewallRules","Update the firewall rules of an organization's site-to-site VPN","https://developer.cisco.com/meraki/api-v1/update-organization-appliance-vpn-vpn-firewall-rules/","put","/organizations/{organizationId}/appliance/vpn/vpnFirewallRules","organizationId","comment, destCidr, destPort, policy, protocol, rules, srcCidr, srcPort, syslogDefaultRule, syslogEnabled","comment, destCidr, destPort, policy, protocol, rules, srcCidr, srcPort, syslogEnabled","appliance, configure, vpn, vpnFirewallRules","appliance.updateOrganizationApplianceVpnVpnFirewallRules","sdwan:config:write" -"GA","getOrganizationAssuranceAlerts","Return all health alerts for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts/","get","/organizations/{organizationId}/assurance/alerts","organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, sortBy, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes","","applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url","organizations, monitor, alerts","organizations.getOrganizationAssuranceAlerts","" +"GA","getOrganizationAssuranceAlerts","Return all health alerts for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts/","get","/organizations/{organizationId}/assurance/alerts","organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, sortBy, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes","","applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, others, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url","organizations, monitor, alerts","organizations.getOrganizationAssuranceAlerts","" "GA","dismissOrganizationAssuranceAlerts","Dismiss health alerts","https://developer.cisco.com/meraki/api-v1/dismiss-organization-assurance-alerts/","post","/organizations/{organizationId}/assurance/alerts/dismiss","organizationId","alertIds","","organizations, monitor, alerts","organizations.dismissOrganizationAssuranceAlerts","" "GA","getOrganizationAssuranceAlertsOverview","Return overview of active health alerts for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts-overview/","get","/organizations/{organizationId}/assurance/alerts/overview","organizationId, networkId, severity, types, tsStart, tsEnd, category, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes","","bySeverity, count, counts, total, type","organizations, monitor, alerts, overview","organizations.getOrganizationAssuranceAlertsOverview","" "GA","getOrganizationAssuranceAlertsOverviewByNetwork","Return a Summary of Alerts grouped by network and severity","https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts-overview-by-network/","get","/organizations/{organizationId}/assurance/alerts/overview/byNetwork","organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes","","alertCount, count, counts, items, meta, networkId, networkName, severityCounts, type","organizations, monitor, alerts, overview, byNetwork","organizations.getOrganizationAssuranceAlertsOverviewByNetwork","dashboard:general:telemetry:read" "GA","getOrganizationAssuranceAlertsOverviewByType","Return a Summary of Alerts grouped by type and severity","https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts-overview-by-type/","get","/organizations/{organizationId}/assurance/alerts/overview/byType","organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, sortBy, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes","","count, counts, items, meta, type","organizations, monitor, alerts, overview, byType","organizations.getOrganizationAssuranceAlertsOverviewByType","" "GA","getOrganizationAssuranceAlertsOverviewHistorical","Returns historical health alert overviews","https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts-overview-historical/","get","/organizations/{organizationId}/assurance/alerts/overview/historical","organizationId, segmentDuration, networkId, severity, types, tsStart, tsEnd, category, serials, deviceTypes","","byAlertType, counts, critical, informational, items, meta, segmentStart, totals, type, warning","organizations, monitor, alerts, overview, historical","organizations.getOrganizationAssuranceAlertsOverviewHistorical","" "GA","restoreOrganizationAssuranceAlerts","Restore health alerts from dismissed","https://developer.cisco.com/meraki/api-v1/restore-organization-assurance-alerts/","post","/organizations/{organizationId}/assurance/alerts/restore","organizationId","alertIds","","organizations, monitor, alerts","organizations.restoreOrganizationAssuranceAlerts","" -"GA","getOrganizationAssuranceAlert","Return a singular Health Alert by its id","https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alert/","get","/organizations/{organizationId}/assurance/alerts/{id}","organizationId, id","","applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url","organizations, monitor, alerts","organizations.getOrganizationAssuranceAlert","" +"GA","getOrganizationAssuranceAlert","Return a singular Health Alert by its id","https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alert/","get","/organizations/{organizationId}/assurance/alerts/{id}","organizationId, id","","applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, others, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url","organizations, monitor, alerts","organizations.getOrganizationAssuranceAlert","" +"beta","getOrganizationAssuranceProductAnnouncements","Gets relevant product announcements for a user","https://developer.cisco.com/meraki/api-v1/get-organization-assurance-product-announcements/","get","/organizations/{organizationId}/assurance/productAnnouncements","organizationId, t0, timespan, onlyRelevant","","boardId, counts, editedAt, id, items, labels, meta, name, publishedAt, snippet, title, total, url","organizations, configure, productAnnouncements","organizations.getOrganizationAssuranceProductAnnouncements","" "beta","getOrganizationAuthRadiusServers","List the organization-wide RADIUS servers in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-auth-radius-servers/","get","/organizations/{organizationId}/auth/radius/servers","organizationId","","address, mode, modes, name, port, serverId","organizations, configure, auth, radius, servers","organizations.getOrganizationAuthRadiusServers","switch:config:read" "beta","createOrganizationAuthRadiusServer","Add an organization-wide RADIUS server","https://developer.cisco.com/meraki/api-v1/create-organization-auth-radius-server/","post","/organizations/{organizationId}/auth/radius/servers","organizationId","address, mode, modes, name, port, secret","address, mode, modes, name, port, serverId","organizations, configure, auth, radius, servers","organizations.createOrganizationAuthRadiusServer","switch:config:write" "beta","getOrganizationAuthRadiusServersAssignments","Return list of network and policies that organization-wide RADIUS servers are bing used","https://developer.cisco.com/meraki/api-v1/get-organization-auth-radius-servers-assignments/","get","/organizations/{organizationId}/auth/radius/servers/assignments","organizationId","","assignee, assignments, dashboardUrl, eid, id, name, network, serverId, tag, type","organizations, configure, auth, radius, servers, assignments","organizations.getOrganizationAuthRadiusServersAssignments","switch:config:read" @@ -666,6 +681,7 @@ "GA","deleteOrganizationCameraRole","Delete an existing role for this organization.","https://developer.cisco.com/meraki/api-v1/delete-organization-camera-role/","delete","/organizations/{organizationId}/camera/roles/{roleId}","organizationId, roleId","","","camera, configure, roles","camera.deleteOrganizationCameraRole","camera:config:write" "GA","updateOrganizationCameraRole","Update an existing role in this organization.","https://developer.cisco.com/meraki/api-v1/update-organization-camera-role/","put","/organizations/{organizationId}/camera/roles/{roleId}","organizationId, roleId","appliedOnDevices, appliedOnNetworks, appliedOrgWide, id, inNetworksWithId, inNetworksWithTag, name, permissionScopeId, tag","","camera, configure, roles","camera.updateOrganizationCameraRole","camera:config:write" "beta","getOrganizationCampusGatewayClusters","Get the details of campus gateway clusters","https://developer.cisco.com/meraki/api-v1/get-organization-campus-gateway-clusters/","get","/organizations/{organizationId}/campusGateway/clusters","organizationId, networkIds","","address, addresses, allowedVlans, assignmentMode, clusterId, devices, gateway, id, interface, memberId, name, nameservers, network, notes, portChannels, protocol, serial, subnetMask, tunnels, uplink, uplinks, url, vlan","campusGateway, configure, clusters","campusGateway.getOrganizationCampusGatewayClusters","" +"beta","getOrganizationCampusGatewayDevicesUplinksLocalOverridesByDevice","Uplink overrides configured locally on Campus Gateway devices in an organization.","https://developer.cisco.com/meraki/api-v1/get-organization-campus-gateway-devices-uplinks-local-overrides-by-device/","get","/organizations/{organizationId}/campusGateway/devices/uplinks/localOverrides/byDevice","organizationId, serials, perPage, startingAfter, endingBefore","","address, addresses, assignmentMode, counts, gateway, interface, items, meta, nameservers, protocol, remaining, serial, sgt, subnetMask, total, uplink, vlan","campusGateway, configure, devices, uplinks, localOverrides, byDevice","campusGateway.getOrganizationCampusGatewayDevicesUplinksLocalOverridesByDevice","" "GA","getOrganizationCellularGatewayEsimsInventory","The eSIM inventory of a given organization.","https://developer.cisco.com/meraki/api-v1/get-organization-cellular-gateway-esims-inventory/","get","/organizations/{organizationId}/cellularGateway/esims/inventory","organizationId, eids","","active, counts, customApns, device, eid, iccid, id, items, lastUpdatedAt, meta, model, name, network, plans, profiles, remaining, serial, serviceProvider, status, total, type, url","cellularGateway, configure, esims, inventory","cellularGateway.getOrganizationCellularGatewayEsimsInventory","" "GA","updateOrganizationCellularGatewayEsimsInventory","Toggle the status of an eSIM","https://developer.cisco.com/meraki/api-v1/update-organization-cellular-gateway-esims-inventory/","put","/organizations/{organizationId}/cellularGateway/esims/inventory/{id}","organizationId, id","status","active, customApns, device, eid, iccid, id, lastUpdatedAt, model, name, network, plans, profiles, serial, serviceProvider, status, type, url","cellularGateway, configure, esims, inventory","cellularGateway.updateOrganizationCellularGatewayEsimsInventory","" "GA","getOrganizationCellularGatewayEsimsServiceProviders","Service providers customers can add accounts for.","https://developer.cisco.com/meraki/api-v1/get-organization-cellular-gateway-esims-service-providers/","get","/organizations/{organizationId}/cellularGateway/esims/serviceProviders","organizationId","","content, counts, isBootstrap, items, logo, meta, name, remaining, terms, total, url","cellularGateway, configure, esims, serviceProviders","cellularGateway.getOrganizationCellularGatewayEsimsServiceProviders","" @@ -680,12 +696,6 @@ "GA","getOrganizationCellularGatewayUplinkStatuses","List the uplink status of every Meraki MG cellular gateway in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-cellular-gateway-uplink-statuses/","get","/organizations/{organizationId}/cellularGateway/uplink/statuses","organizationId, perPage, startingAfter, endingBefore, networkIds, serials, iccids","","apn, connectionType, dns1, dns2, gateway, iccid, imsi, interface, ip, lastReportedAt, mcc, mnc, model, msisdn, mtu, networkId, provider, publicIp, roaming, rsrp, rsrq, serial, signalStat, signalType, status, uplinks","cellularGateway, monitor, uplink, statuses","cellularGateway.getOrganizationCellularGatewayUplinkStatuses","sdwan:telemetry:read" "beta","getOrganizationCertificates","Gets all or specific certificates for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-certificates/","get","/organizations/{organizationId}/certificates","organizationId, certificateIds, certManagedBy","","algorithm, certificateId, commonName, country, data, description, end, fields, hash, hashes, isCritical, issuer, keyUsage, locality, organization, organizationalUnit, parentCertificateId, policy, publicKeyAlgorithm, serial, signatureAlgorithmId, source, start, state, subject, subjectAlternativeName, validity, version","organizations, configure, certificates","organizations.getOrganizationCertificates","dashboard:iam:config:read" "beta","createOrganizationCertificatesImport","Import certificate for this organization","https://developer.cisco.com/meraki/api-v1/create-organization-certificates-import/","post","/organizations/{organizationId}/certificates/import","organizationId","contents, description, managedBy","algorithm, certificateId, commonName, country, data, description, end, fields, hash, hashes, isCritical, issuer, keyUsage, locality, organization, organizationalUnit, parentCertificateId, policy, publicKeyAlgorithm, serial, signatureAlgorithmId, source, start, state, subject, subjectAlternativeName, validity, version","organizations, configure, certificates, import","organizations.createOrganizationCertificatesImport","dashboard:iam:config:write" -"beta","getOrganizationCertificatesRadSecDeviceCertificateAuthorities","Query for details on the organization's RADSEC device Certificate Authority certificates (CAs)","https://developer.cisco.com/meraki/api-v1/get-organization-certificates-rad-sec-device-certificate-authorities/","get","/organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities","organizationId","","authorityId, contents, status","organizations, configure, certificates, radSec, deviceCertificateAuthorities","organizations.getOrganizationCertificatesRadSecDeviceCertificateAuthorities","dashboard:iam:config:read" -"beta","createOrganizationCertificatesRadSecDeviceCertificateAuthority","Create an organization's RADSEC device Certificate Authority (CA)","https://developer.cisco.com/meraki/api-v1/create-organization-certificates-rad-sec-device-certificate-authority/","post","/organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities","organizationId","","authorityId, contents, status","organizations, configure, certificates, radSec, deviceCertificateAuthorities","organizations.createOrganizationCertificatesRadSecDeviceCertificateAuthority","dashboard:iam:config:write" -"beta","getOrganizationCertificatesRadSecDeviceCertificateAuthority","Query for details on an organization's RADSEC device Certificate Authority (CA) with the given id","https://developer.cisco.com/meraki/api-v1/get-organization-certificates-rad-sec-device-certificate-authority/","get","/organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}","organizationId, id","","authorityId, contents, status","organizations, configure, certificates, radSec, deviceCertificateAuthorities","organizations.getOrganizationCertificatesRadSecDeviceCertificateAuthority","" -"beta","updateOrganizationCertificatesRadSecDeviceCertificateAuthority","Update an organization's RADSEC device Certificate Authority (CA) state","https://developer.cisco.com/meraki/api-v1/update-organization-certificates-rad-sec-device-certificate-authority/","put","/organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}","organizationId, id","status","authorityId, contents, status","organizations, configure, certificates, radSec, deviceCertificateAuthorities","organizations.updateOrganizationCertificatesRadSecDeviceCertificateAuthority","dashboard:iam:config:write" -"beta","getOrganizationCertificatesRadSecDeviceCertificateAuthorityRevocationList","Query for certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id.","https://developer.cisco.com/meraki/api-v1/get-organization-certificates-rad-sec-device-certificate-authority-revocation-list/","get","/organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}/revocationList","organizationId, id","","crl","organizations, configure, certificates, radSec, deviceCertificateAuthorities, revocationList","organizations.getOrganizationCertificatesRadSecDeviceCertificateAuthorityRevocationList","dashboard:iam:config:read" -"beta","getOrganizationCertificatesRadSecDeviceCertificateAuthorityRevocationListDeltas","Query for all delta certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id.","https://developer.cisco.com/meraki/api-v1/get-organization-certificates-rad-sec-device-certificate-authority-revocation-list-deltas/","get","/organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}/revocationList/deltas","organizationId, id","","deltaCrls","organizations, configure, certificates, radSec, deviceCertificateAuthorities, revocationList, deltas","organizations.getOrganizationCertificatesRadSecDeviceCertificateAuthorityRevocationListDeltas","dashboard:iam:config:read" "beta","deleteOrganizationCertificate","Delete a certificate for an organization","https://developer.cisco.com/meraki/api-v1/delete-organization-certificate/","delete","/organizations/{organizationId}/certificates/{certificateId}","organizationId, certificateId","","","organizations, configure, certificates","organizations.deleteOrganizationCertificate","dashboard:iam:config:write" "beta","updateOrganizationCertificate","Update a certificate's description for an organization","https://developer.cisco.com/meraki/api-v1/update-organization-certificate/","put","/organizations/{organizationId}/certificates/{certificateId}","organizationId, certificateId","description","algorithm, certificateId, commonName, country, data, description, end, fields, hash, hashes, isCritical, issuer, keyUsage, locality, organization, organizationalUnit, parentCertificateId, policy, publicKeyAlgorithm, serial, signatureAlgorithmId, source, start, state, subject, subjectAlternativeName, validity, version","organizations, configure, certificates","organizations.updateOrganizationCertificate","dashboard:iam:config:write" "beta","getOrganizationCertificateContents","Download the trusted certificate by certificate id.","https://developer.cisco.com/meraki/api-v1/get-organization-certificate-contents/","get","/organizations/{organizationId}/certificates/{certificateId}/contents","organizationId, certificateId, chainId","","contents","organizations, configure, certificates, contents","organizations.getOrganizationCertificateContents","dashboard:iam:config:read" @@ -702,33 +712,39 @@ "GA","updateOrganizationConfigTemplate","Update a configuration template","https://developer.cisco.com/meraki/api-v1/update-organization-config-template/","put","/organizations/{organizationId}/configTemplates/{configTemplateId}","organizationId, configTemplateId","name, timeZone","id, name, productTypes, timeZone","organizations, configure, configTemplates","organizations.updateOrganizationConfigTemplate","dashboard:general:config:write" "GA","deleteOrganizationConfigTemplate","Remove a configuration template","https://developer.cisco.com/meraki/api-v1/delete-organization-config-template/","delete","/organizations/{organizationId}/configTemplates/{configTemplateId}","organizationId, configTemplateId","","","organizations, configure, configTemplates","organizations.deleteOrganizationConfigTemplate","dashboard:general:config:write" "GA","getOrganizationConfigTemplateSwitchProfiles","List the switch templates for your switch template configuration","https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profiles/","get","/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles","organizationId, configTemplateId","","model, name, switchProfileId","switch, configure, configTemplates, profiles","switch.getOrganizationConfigTemplateSwitchProfiles","switch:config:read" -"GA","getOrganizationConfigTemplateSwitchProfilePorts","Return all the ports of a switch template","https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profile-ports/","get","/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports","organizationId, configTemplateId, profileId","","accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, configTemplates, profiles, ports","switch.getOrganizationConfigTemplateSwitchProfilePorts","switch:config:read" +"GA","getOrganizationConfigTemplateSwitchProfilePorts","Return all the ports of a switch template","https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profile-ports/","get","/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports","organizationId, configTemplateId, profileId","","accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, configTemplates, profiles, ports","switch.getOrganizationConfigTemplateSwitchProfilePorts","switch:config:read" "beta","updateOrganizationConfigTemplateSwitchProfilePortsMirror","Update a port mirror","https://developer.cisco.com/meraki/api-v1/update-organization-config-template-switch-profile-ports-mirror/","put","/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/mirror","organizationId, configTemplateId, profileId","comment, destination, filter, hasTransitVlan, module, number, port, ports, role, slot, source, tags, type, vlan, vlans","comment, configTemplate, destination, filter, hasTransitVlan, id, mirror, module, name, number, port, ports, profileId, role, slot, source, tags, type, vlan, vlans, warnings","switch, configure, configTemplates, profiles, ports, mirror","switch.updateOrganizationConfigTemplateSwitchProfilePortsMirror","" -"GA","getOrganizationConfigTemplateSwitchProfilePort","Return a switch template port","https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profile-port/","get","/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}","organizationId, configTemplateId, profileId, portId","","accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, configTemplates, profiles, ports","switch.getOrganizationConfigTemplateSwitchProfilePort","switch:config:read" -"GA","updateOrganizationConfigTemplateSwitchProfilePort","Update a switch template port","https://developer.cisco.com/meraki/api-v1/update-organization-config-template-switch-profile-port/","put","/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}","organizationId, configTemplateId, profileId, portId","accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, name, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, configTemplates, profiles, ports","switch.updateOrganizationConfigTemplateSwitchProfilePort","switch:config:write" +"GA","getOrganizationConfigTemplateSwitchProfilePort","Return a switch template port","https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profile-port/","get","/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}","organizationId, configTemplateId, profileId, portId","","accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, configTemplates, profiles, ports","switch.getOrganizationConfigTemplateSwitchProfilePort","switch:config:read" +"GA","updateOrganizationConfigTemplateSwitchProfilePort","Update a switch template port","https://developer.cisco.com/meraki/api-v1/update-organization-config-template-switch-profile-port/","put","/organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}","organizationId, configTemplateId, profileId, portId","accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, macWhitelistLimit, name, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan","switch, configure, configTemplates, profiles, ports","switch.updateOrganizationConfigTemplateSwitchProfilePort","switch:config:write" "GA","getOrganizationConfigurationChanges","View the Change Log for your organization","https://developer.cisco.com/meraki/api-v1/get-organization-configuration-changes/","get","/organizations/{organizationId}/configurationChanges","organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, networkId, adminId","","adminEmail, adminId, adminName, client, id, label, networkId, networkName, networkUrl, newValue, oldValue, page, ssidName, ssidNumber, ts, type","organizations, monitor, configurationChanges","organizations.getOrganizationConfigurationChanges","dashboard:general:config:read" "GA","getOrganizationDevices","List the devices in an organization that have been assigned to a network.","https://developer.cisco.com/meraki/api-v1/get-organization-devices/","get","/organizations/{organizationId}/devices","organizationId, perPage, startingAfter, endingBefore, configurationUpdatedAfter, networkIds, productTypes, tags, tagsFilterType, name, mac, serial, model, macs, serials, sensorMetrics, sensorAlertProfileIds, models","","address, details, firmware, imei, lanIp, lat, lng, mac, model, name, networkId, notes, productType, serial, tags, value","organizations, configure, devices","organizations.getOrganizationDevices","dashboard:general:config:read" "GA","getOrganizationDevicesAvailabilities","List the availability information for devices in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-devices-availabilities/","get","/organizations/{organizationId}/devices/availabilities","organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, tags, tagsFilterType, statuses","","id, mac, name, network, productType, serial, status, tags","organizations, monitor, devices, availabilities","organizations.getOrganizationDevicesAvailabilities","dashboard:general:telemetry:read" "GA","getOrganizationDevicesAvailabilitiesChangeHistory","List the availability history information for devices in an organization.","https://developer.cisco.com/meraki/api-v1/get-organization-devices-availabilities-change-history/","get","/organizations/{organizationId}/devices/availabilities/changeHistory","organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, serials, productTypes, networkIds, statuses, categories, networkTags, networkTagsFilterType, deviceTags, deviceTagsFilterType","","category, details, device, id, model, name, network, new, old, productType, serial, tags, ts, url, value","organizations, monitor, devices, availabilities, changeHistory","organizations.getOrganizationDevicesAvailabilitiesChangeHistory","dashboard:general:telemetry:read" -"beta","getOrganizationDevicesBootsHistory","Returns the history of device boots in reverse chronological order (most recent first)","https://developer.cisco.com/meraki/api-v1/get-organization-devices-boots-history/","get","/organizations/{organizationId}/devices/boots/history","organizationId, t0, t1, timespan, serials, mostRecentPerDevice, perPage, startingAfter, endingBefore, sortOrder","","bootedAt, id, network, serial, start","organizations, configure, devices, boots, history","organizations.getOrganizationDevicesBootsHistory","" +"beta","getOrganizationDevicesBootsHistory","Returns the history of device boots in reverse chronological order (most recent first)","https://developer.cisco.com/meraki/api-v1/get-organization-devices-boots-history/","get","/organizations/{organizationId}/devices/boots/history","organizationId, t0, t1, timespan, serials, productTypes, mostRecentPerDevice, perPage, startingAfter, endingBefore, sortOrder","","bootedAt, id, network, serial, start","organizations, configure, devices, boots, history","organizations.getOrganizationDevicesBootsHistory","" "GA","createOrganizationDevicesControllerMigration","Migrate devices to another controller or management mode","https://developer.cisco.com/meraki/api-v1/create-organization-devices-controller-migration/","post","/organizations/{organizationId}/devices/controller/migrations","organizationId","serials, target","createdAt, migratedAt, serial, target","organizations, configure, devices, controller, migrations","organizations.createOrganizationDevicesControllerMigration","" "GA","getOrganizationDevicesControllerMigrations","Retrieve device migration statuses in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-devices-controller-migrations/","get","/organizations/{organizationId}/devices/controller/migrations","organizationId, serials, networkIds, target, perPage, startingAfter, endingBefore","","counts, createdAt, items, meta, migratedAt, remaining, serial, target, total","organizations, configure, devices, controller, migrations","organizations.getOrganizationDevicesControllerMigrations","" "GA","bulkUpdateOrganizationDevicesDetails","Updating device details (currently only used for Catalyst devices)","https://developer.cisco.com/meraki/api-v1/bulk-update-organization-devices-details/","post","/organizations/{organizationId}/devices/details/bulkUpdate","organizationId","details, name, serials, value","serials","organizations, configure, devices, details, bulkUpdate","organizations.bulkUpdateOrganizationDevicesDetails","" "GA","getOrganizationDevicesOverviewByModel","Lists the count for each device model","https://developer.cisco.com/meraki/api-v1/get-organization-devices-overview-by-model/","get","/organizations/{organizationId}/devices/overview/byModel","organizationId, models, networkIds, productTypes","","counts, model, total","organizations, configure, devices, overview, byModel","organizations.getOrganizationDevicesOverviewByModel","" -"beta","getOrganizationDevicesPacketCaptureCaptures","List Packet Captures","https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-captures/","get","/organizations/{organizationId}/devices/packetCapture/captures","organizationId, captureIds, networkIds, serials, captureSource, captureStatus, name, clientMac, captureReason, device, userName, perPage, startingAfter, endingBefore, sortOrder","","autopcapType, captureId, captureReason, captureSource, client, counts, device, devices, duration, errorMessage, fileSize, filterExpression, id, interfaces, items, mac, meta, name, network, outputType, packetCount, ports, remaining, serial, startTime, status, total, user","organizations, configure, devices, packetCapture, captures","organizations.getOrganizationDevicesPacketCaptureCaptures","" -"beta","createOrganizationDevicesPacketCaptureCapture","Perform a packet capture on a device and store in Meraki Cloud","https://developer.cisco.com/meraki/api-v1/create-organization-devices-packet-capture-capture/","post","/organizations/{organizationId}/devices/packetCapture/captures","organizationId","captureReason, duration, filterExpression, interface, name, outputType, ports, serials","autopcapType, captureId, captureReason, captureSource, client, device, devices, duration, errorMessage, fileSize, filterExpression, id, interfaces, mac, name, network, outputType, packetCount, ports, serial, startTime, status, user","organizations, configure, devices, packetCapture, captures","organizations.createOrganizationDevicesPacketCaptureCapture","" -"beta","deleteOrganizationDevicesPacketCaptureCaptures","Delete packet capture from cloud","https://developer.cisco.com/meraki/api-v1/delete-organization-devices-packet-capture-captures/","delete","/organizations/{organizationId}/devices/packetCapture/captures","organizationId","captureIds","","organizations, configure, devices, packetCapture, captures","organizations.deleteOrganizationDevicesPacketCaptureCaptures","" -"beta","downloadOrganizationDevicesPacketCaptureCaptureUrl","Get presigned download URL for given packet capture id","https://developer.cisco.com/meraki/api-v1/download-organization-devices-packet-capture-capture-url/","get","/organizations/{organizationId}/devices/packetCapture/captures/{id}/downloadUrl","organizationId, id","","captureId, downloadUrl","organizations, configure, devices, packetCapture, captures","organizations.downloadOrganizationDevicesPacketCaptureCaptureUrl","" -"beta","stopOrganizationDevicesPacketCaptureCapture","Stop a specific packet capture (not supported for Catalyst devices)","https://developer.cisco.com/meraki/api-v1/stop-organization-devices-packet-capture-capture/","post","/organizations/{organizationId}/devices/packetCapture/captures/{id}/stop","organizationId, id","serials","autopcapType, captureId, captureReason, captureSource, client, device, devices, duration, errorMessage, fileSize, filterExpression, id, interfaces, mac, name, network, outputType, packetCount, ports, serial, startTime, status, user","organizations, configure, devices, packetCapture, captures","organizations.stopOrganizationDevicesPacketCaptureCapture","" -"beta","getOrganizationDevicesPacketCaptureSchedules","List scheduled Packet Captures","https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-schedules/","get","/organizations/{organizationId}/devices/packetCapture/schedules","organizationId, pcapScheduleConfigurationIds, networkIds, deviceIds","","captureCount, captureReason, counts, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interfaces, items, lastCaptureId, meta, name, nextCaptureTs, pcapScheduleConfigurationId, priority, recurrence, schedule, serial, startTs, switchports, total, updatedAt, user, warnings, weekdays","organizations, configure, devices, packetCapture, schedules","organizations.getOrganizationDevicesPacketCaptureSchedules","" -"beta","createOrganizationDevicesPacketCaptureSchedule","Create a schedule for packet capture","https://developer.cisco.com/meraki/api-v1/create-organization-devices-packet-capture-schedule/","post","/organizations/{organizationId}/devices/packetCapture/schedules","organizationId","captureReason, devices, duration, enabled, endTs, filterExpression, frequency, interfaces, name, recurrence, schedule, serial, startTs, switchports, weekdays","captureCount, captureReason, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interfaces, lastCaptureId, name, nextCaptureTs, pcapScheduleConfigurationId, priority, recurrence, schedule, serial, startTs, switchports, updatedAt, user, warnings, weekdays","organizations, configure, devices, packetCapture, schedules","organizations.createOrganizationDevicesPacketCaptureSchedule","" -"beta","deleteOrganizationDevicesPacketCaptureSchedules","Delete schedule from cloud","https://developer.cisco.com/meraki/api-v1/delete-organization-devices-packet-capture-schedules/","delete","/organizations/{organizationId}/devices/packetCapture/schedules","organizationId","pcapScheduleConfigurationIds","","organizations, configure, devices, packetCapture, schedules","organizations.deleteOrganizationDevicesPacketCaptureSchedules","" -"beta","updateOrganizationDevicesPacketCaptureSchedulesPriority","Bulk update priorities of pcap schedules","https://developer.cisco.com/meraki/api-v1/update-organization-devices-packet-capture-schedules-priority/","put","/organizations/{organizationId}/devices/packetCapture/schedules/priority","organizationId","pcapScheduleConfigurationIds","pcapScheduleConfigurationId, priority, updatedPriorities","organizations, configure, devices, packetCapture, schedules, priority","organizations.updateOrganizationDevicesPacketCaptureSchedulesPriority","" -"beta","updateOrganizationDevicesPacketCaptureSchedule","Update a schedule for packet capture","https://developer.cisco.com/meraki/api-v1/update-organization-devices-packet-capture-schedule/","put","/organizations/{organizationId}/devices/packetCapture/schedules/{pcapScheduleConfigurationId}","organizationId, pcapScheduleConfigurationId","captureReason, devices, duration, enabled, endTs, filterExpression, frequency, name, recurrence, schedule, serial, startTs, switchports, weekdays","captureCount, captureReason, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interfaces, lastCaptureId, name, nextCaptureTs, pcapScheduleConfigurationId, priority, recurrence, schedule, serial, startTs, switchports, updatedAt, user, warnings, weekdays","organizations, configure, devices, packetCapture, schedules","organizations.updateOrganizationDevicesPacketCaptureSchedule","" +"GA","getOrganizationDevicesPacketCaptureCaptures","List Packet Captures","https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-captures/","get","/organizations/{organizationId}/devices/packetCapture/captures","organizationId, captureIds, networkIds, serials, process, captureStatus, name, clientMac, notes, deviceName, adminName, perPage, startingAfter, endingBefore, sortOrder","","admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, items, mac, meta, name, network, packets, ports, process, productType, remaining, serial, size, startTs, status, total, value","organizations, configure, devices, packetCapture, captures","organizations.getOrganizationDevicesPacketCaptureCaptures","" +"GA","createOrganizationDevicesPacketCaptureCapture","Perform a packet capture on a device and store in Meraki Cloud","https://developer.cisco.com/meraki/api-v1/create-organization-devices-packet-capture-capture/","post","/organizations/{organizationId}/devices/packetCapture/captures","organizationId","destination, duration, filterExpression, interface, name, notes, outputType, ports, serials","admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, mac, name, network, packets, ports, process, productType, serial, size, startTs, status, total, value","organizations, configure, devices, packetCapture, captures","organizations.createOrganizationDevicesPacketCaptureCapture","" +"GA","bulkOrganizationDevicesPacketCaptureCapturesCreate","Perform a packet capture on multiple devices and store in Meraki Cloud.","https://developer.cisco.com/meraki/api-v1/bulk-organization-devices-packet-capture-captures-create/","post","/organizations/{organizationId}/devices/packetCapture/captures/bulkCreate","organizationId","devices, duration, filterExpression, interface, name, notes, serial, switchports","admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, items, mac, name, network, packets, ports, process, productType, serial, size, startTs, status, total, value","organizations, configure, devices, packetCapture, captures","organizations.bulkOrganizationDevicesPacketCaptureCapturesCreate","" +"GA","bulkOrganizationDevicesPacketCaptureCapturesDelete","BulkDelete packet captures from cloud","https://developer.cisco.com/meraki/api-v1/bulk-organization-devices-packet-capture-captures-delete/","post","/organizations/{organizationId}/devices/packetCapture/captures/bulkDelete","organizationId","captureIds","","organizations, configure, devices, packetCapture, captures","organizations.bulkOrganizationDevicesPacketCaptureCapturesDelete","" +"GA","deleteOrganizationDevicesPacketCaptureCapture","Delete a single packet capture from cloud using captureId","https://developer.cisco.com/meraki/api-v1/delete-organization-devices-packet-capture-capture/","delete","/organizations/{organizationId}/devices/packetCapture/captures/{captureId}","organizationId, captureId","","","organizations, configure, devices, packetCapture, captures","organizations.deleteOrganizationDevicesPacketCaptureCapture","" +"GA","generateOrganizationDevicesPacketCaptureCaptureDownloadUrl","Get presigned download URL for given packet capture id","https://developer.cisco.com/meraki/api-v1/generate-organization-devices-packet-capture-capture-download-url/","post","/organizations/{organizationId}/devices/packetCapture/captures/{captureId}/downloadUrl/generate","organizationId, captureId","","captureId, downloadUrl, url","organizations, configure, devices, packetCapture, captures, downloadUrl","organizations.generateOrganizationDevicesPacketCaptureCaptureDownloadUrl","" +"GA","stopOrganizationDevicesPacketCaptureCapture","Stop a specific packet capture (not supported for Catalyst devices)","https://developer.cisco.com/meraki/api-v1/stop-organization-devices-packet-capture-capture/","post","/organizations/{organizationId}/devices/packetCapture/captures/{captureId}/stop","organizationId, captureId","serials","admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, mac, name, network, packets, ports, process, productType, serial, size, startTs, status, total, value","organizations, configure, devices, packetCapture, captures","organizations.stopOrganizationDevicesPacketCaptureCapture","" +"GA","getOrganizationDevicesPacketCaptureSchedules","List the Packet Capture Schedules","https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-schedules/","get","/organizations/{organizationId}/devices/packetCapture/schedules","organizationId, scheduleIds, networkIds, deviceIds","","admin, captureCount, counts, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interface, items, lastCaptureId, meta, name, nextCaptureTs, notes, priority, recurrence, schedule, scheduleId, serial, startTs, switchports, total, updatedAt, warnings, weekdays","organizations, configure, devices, packetCapture, schedules","organizations.getOrganizationDevicesPacketCaptureSchedules","" +"GA","createOrganizationDevicesPacketCaptureSchedule","Create a schedule for packet capture","https://developer.cisco.com/meraki/api-v1/create-organization-devices-packet-capture-schedule/","post","/organizations/{organizationId}/devices/packetCapture/schedules","organizationId","devices, duration, enabled, endTs, filterExpression, frequency, interface, name, notes, recurrence, schedule, serial, startTs, switchports, weekdays","admin, captureCount, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interface, lastCaptureId, name, nextCaptureTs, notes, priority, recurrence, schedule, scheduleId, serial, startTs, switchports, updatedAt, warnings, weekdays","organizations, configure, devices, packetCapture, schedules","organizations.createOrganizationDevicesPacketCaptureSchedule","" +"beta","bulkOrganizationDevicesPacketCaptureSchedulesDelete","Delete packet capture schedules","https://developer.cisco.com/meraki/api-v1/bulk-organization-devices-packet-capture-schedules-delete/","post","/organizations/{organizationId}/devices/packetCapture/schedules/bulkDelete","organizationId","scheduleIds","","organizations, configure, devices, packetCapture, schedules","organizations.bulkOrganizationDevicesPacketCaptureSchedulesDelete","" +"GA","reorderOrganizationDevicesPacketCaptureSchedules","Bulk update priorities of pcap schedules","https://developer.cisco.com/meraki/api-v1/reorder-organization-devices-packet-capture-schedules/","post","/organizations/{organizationId}/devices/packetCapture/schedules/reorder","organizationId","order, priority, scheduleId","pcapScheduleConfigurationId, priority, updatedPriorities","organizations, configure, devices, packetCapture, schedules","organizations.reorderOrganizationDevicesPacketCaptureSchedules","" +"GA","updateOrganizationDevicesPacketCaptureSchedule","Update a schedule for packet capture","https://developer.cisco.com/meraki/api-v1/update-organization-devices-packet-capture-schedule/","put","/organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}","organizationId, scheduleId","devices, duration, enabled, endTs, filterExpression, frequency, interface, name, notes, recurrence, schedule, serial, startTs, switchports, weekdays","admin, captureCount, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interface, lastCaptureId, name, nextCaptureTs, notes, priority, recurrence, schedule, scheduleId, serial, startTs, switchports, updatedAt, warnings, weekdays","organizations, configure, devices, packetCapture, schedules","organizations.updateOrganizationDevicesPacketCaptureSchedule","" +"GA","deleteOrganizationDevicesPacketCaptureSchedule","Delete schedule from cloud","https://developer.cisco.com/meraki/api-v1/delete-organization-devices-packet-capture-schedule/","delete","/organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}","organizationId, scheduleId","scheduleId","","organizations, configure, devices, packetCapture, schedules","organizations.deleteOrganizationDevicesPacketCaptureSchedule","" +"beta","tasksOrganizationDevicesPacketCapture","Enqueues a task for a specific packet capture","https://developer.cisco.com/meraki/api-v1/tasks-organization-devices-packet-capture/","post","/organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks","organizationId, packetId","networkId, task","status, task, taskId","organizations, configure, devices, packetCaptures","organizations.tasksOrganizationDevicesPacketCapture","dashboard:general:telemetry:packetcapture:read" +"beta","getOrganizationDevicesPacketCaptureTask","Retrieves packet capture analysis result for a specific packet capture task.","https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-task/","get","/organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks/{id}","organizationId, packetId, id, networkId","","analyzer, analyzers, counts, detailMessage, details, devices, failed, failureCount, failures, fileName, filePathUrl, ips, macs, name, packets, passed, present, result, status, subCategory, successes, summary, task, testCounts, testResults, total, url","organizations, configure, devices, packetCaptures, tasks","organizations.getOrganizationDevicesPacketCaptureTask","dashboard:general:telemetry:packetcapture:read" "GA","getOrganizationDevicesPowerModulesStatusesByDevice","List the most recent status information for power modules in rackmount MX and MS devices that support them","https://developer.cisco.com/meraki/api-v1/get-organization-devices-power-modules-statuses-by-device/","get","/organizations/{organizationId}/devices/powerModules/statuses/byDevice","organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, tags, tagsFilterType","","id, mac, model, name, network, number, productType, serial, slots, status, tags","organizations, monitor, devices, powerModules, statuses, byDevice","organizations.getOrganizationDevicesPowerModulesStatusesByDevice","dashboard:general:telemetry:read" "GA","getOrganizationDevicesProvisioningStatuses","List the provisioning statuses information for devices in an organization.","https://developer.cisco.com/meraki/api-v1/get-organization-devices-provisioning-statuses/","get","/organizations/{organizationId}/devices/provisioning/statuses","organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, status, tags, tagsFilterType","","id, mac, name, network, productType, serial, status, tags","organizations, monitor, devices, provisioning, statuses","organizations.getOrganizationDevicesProvisioningStatuses","dashboard:general:telemetry:read" "deprecated","getOrganizationDevicesStatuses","List the status of every Meraki device in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-devices-statuses/","get","/organizations/{organizationId}/devices/statuses","organizationId, perPage, startingAfter, endingBefore, networkIds, serials, statuses, productTypes, models, tags, tagsFilterType, configurationUpdatedAfter","","components, gateway, ipType, lanIp, lastReportedAt, mac, maximum, model, name, networkId, poe, powerSupplies, primaryDns, productType, publicIp, secondaryDns, serial, slot, status, tags, unit","organizations, monitor, devices, statuses","organizations.getOrganizationDevicesStatuses","dashboard:general:telemetry:read" "GA","getOrganizationDevicesStatusesOverview","Return an overview of current device statuses","https://developer.cisco.com/meraki/api-v1/get-organization-devices-statuses-overview/","get","/organizations/{organizationId}/devices/statuses/overview","organizationId, productTypes, networkIds","","alerting, byStatus, counts, dormant, offline, online","organizations, monitor, devices, statuses, overview","organizations.getOrganizationDevicesStatusesOverview","dashboard:general:telemetry:read" +"beta","getOrganizationDevicesSyslogServersRolesByNetwork","Returns roles that can be assigned to a syslog server for a given network.","https://developer.cisco.com/meraki/api-v1/get-organization-devices-syslog-servers-roles-by-network/","get","/organizations/{organizationId}/devices/syslog/servers/roles/byNetwork","organizationId, perPage, startingAfter, endingBefore, networkIds","","availableRoles, counts, id, items, meta, name, network, remaining, total, value","organizations, configure, devices, syslog, servers, roles, byNetwork","organizations.getOrganizationDevicesSyslogServersRolesByNetwork","" "GA","getOrganizationDevicesSystemMemoryUsageHistoryByInterval","Return the memory utilization history in kB for devices in the organization.","https://developer.cisco.com/meraki/api-v1/get-organization-devices-system-memory-usage-history-by-interval/","get","/organizations/{organizationId}/devices/system/memory/usage/history/byInterval","organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, interval, networkIds, serials, productTypes","","counts, endTs, free, id, intervals, items, mac, maximum, median, memory, meta, minimum, model, name, network, percentages, provisioned, remaining, serial, startTs, tags, total, used","organizations, monitor, devices, system, memory, usage, history, byInterval","organizations.getOrganizationDevicesSystemMemoryUsageHistoryByInterval","" "GA","getOrganizationDevicesUplinksAddressesByDevice","List the current uplink addresses for devices in an organization.","https://developer.cisco.com/meraki/api-v1/get-organization-devices-uplinks-addresses-by-device/","get","/organizations/{organizationId}/devices/uplinks/addresses/byDevice","organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, tags, tagsFilterType","","address, addresses, assignmentMode, gateway, id, interface, mac, name, nameservers, network, productType, protocol, public, serial, tags, uplinks, vlan","organizations, monitor, devices, uplinks, addresses, byDevice","organizations.getOrganizationDevicesUplinksAddressesByDevice","dashboard:general:telemetry:read" "GA","getOrganizationDevicesUplinksLossAndLatency","Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago","https://developer.cisco.com/meraki/api-v1/get-organization-devices-uplinks-loss-and-latency/","get","/organizations/{organizationId}/devices/uplinksLossAndLatency","organizationId, t0, t1, timespan, uplink, ip","","ip, latencyMs, lossPercent, networkId, serial, timeSeries, ts, uplink","organizations, monitor, devices, uplinks, uplinksLossAndLatency","organizations.getOrganizationDevicesUplinksLossAndLatency","dashboard:general:telemetry:read" @@ -738,7 +754,7 @@ "GA","getOrganizationEarlyAccessFeaturesOptIn","Show an early access feature opt-in for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-early-access-features-opt-in/","get","/organizations/{organizationId}/earlyAccess/features/optIns/{optInId}","organizationId, optInId","","createdAt, eligible, help, id, label, limitScopeToNetworks, name, optOutEligibility, reason, shortName, url","organizations, configure, earlyAccess, features, optIns","organizations.getOrganizationEarlyAccessFeaturesOptIn","dashboard:iam:config:read" "GA","updateOrganizationEarlyAccessFeaturesOptIn","Update an early access feature opt-in for an organization","https://developer.cisco.com/meraki/api-v1/update-organization-early-access-features-opt-in/","put","/organizations/{organizationId}/earlyAccess/features/optIns/{optInId}","organizationId, optInId","limitScopeToNetworks","createdAt, eligible, help, id, label, limitScopeToNetworks, name, optOutEligibility, reason, shortName, url","organizations, configure, earlyAccess, features, optIns","organizations.updateOrganizationEarlyAccessFeaturesOptIn","dashboard:iam:config:write" "GA","deleteOrganizationEarlyAccessFeaturesOptIn","Delete an early access feature opt-in","https://developer.cisco.com/meraki/api-v1/delete-organization-early-access-features-opt-in/","delete","/organizations/{organizationId}/earlyAccess/features/optIns/{optInId}","organizationId, optInId","","","organizations, configure, earlyAccess, features, optIns","organizations.deleteOrganizationEarlyAccessFeaturesOptIn","dashboard:iam:config:write" -"beta","updateOrganizationExtensionsJupiterInterconnect","Update name and status of an Interconnect","https://developer.cisco.com/meraki/api-v1/update-organization-extensions-jupiter-interconnect/","put","/organizations/{organizationId}/extensions/jupiter/interconnects/{interconnectId}","organizationId, interconnectId","name, status","asNum, createdAt, id, internalSubnets, name, networkId, networkLocaleId, status, tunnelCount, type, vpnCount, wiredId","organizations, configure, extensions, jupiter, interconnects","organizations.updateOrganizationExtensionsJupiterInterconnect","sdwan:config:write" +"beta","updateOrganizationExtensionsSdwanmanagerInterconnect","Update name and status of an Interconnect","https://developer.cisco.com/meraki/api-v1/update-organization-extensions-sdwanmanager-interconnect/","put","/organizations/{organizationId}/extensions/sdwanmanager/interconnects/{interconnectId}","organizationId, interconnectId","name, status","asNum, createdAt, id, internalSubnets, name, networkId, networkLocaleId, status, tunnelCount, type, vpnCount, wiredId","organizations, configure, extensions, sdwanmanager, interconnects","organizations.updateOrganizationExtensionsSdwanmanagerInterconnect","sdwan:config:write" "beta","getOrganizationExtensionsThousandEyesNetworks","List the ThousandEyes agent configurations under this organization","https://developer.cisco.com/meraki/api-v1/get-organization-extensions-thousand-eyes-networks/","get","/organizations/{organizationId}/extensions/thousandEyes/networks","organizationId","","agentId, enabled, networkId","organizations, configure, extensions, thousandEyes, networks","organizations.getOrganizationExtensionsThousandEyesNetworks","dashboard:general:config:read" "beta","createOrganizationExtensionsThousandEyesNetwork","Add a ThousandEyes agent for this network","https://developer.cisco.com/meraki/api-v1/create-organization-extensions-thousand-eyes-network/","post","/organizations/{organizationId}/extensions/thousandEyes/networks","organizationId","enabled, id, network, networkId, template, tenant, tests, userInputs","agentId, enabled, networkId","organizations, configure, extensions, thousandEyes, networks","organizations.createOrganizationExtensionsThousandEyesNetwork","dashboard:general:config:write" "beta","getOrganizationExtensionsThousandEyesNetworksSupported","List all the networks eligible for ThousandEyes agent activation under this organization.","https://developer.cisco.com/meraki/api-v1/get-organization-extensions-thousand-eyes-networks-supported/","get","/organizations/{organizationId}/extensions/thousandEyes/networks/supported","organizationId, perPage, startingAfter, endingBefore, agentInstalled","","agent, currentVersion, device, firmware, isInstalled, model, name, networkId, shortName, tags","organizations, configure, extensions, thousandEyes, networks, supported","organizations.getOrganizationExtensionsThousandEyesNetworksSupported","dashboard:general:config:read" @@ -764,19 +780,21 @@ "beta","createOrganizationInsightWebApp","Add a custom web application for Insight to be able to track","https://developer.cisco.com/meraki/api-v1/create-organization-insight-web-app/","post","/organizations/{organizationId}/insight/webApps","organizationId","hostname, name","category, counterSetRuleId, expression, goodput, host, name, responseDelay, signature, signatureType, thresholds","insight, configure, webApps","insight.createOrganizationInsightWebApp","" "beta","updateOrganizationInsightWebApp","Update a custom web application for Insight to be able to track","https://developer.cisco.com/meraki/api-v1/update-organization-insight-web-app/","put","/organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}","organizationId, customCounterSetRuleId","hostname, name","category, counterSetRuleId, expression, goodput, host, name, responseDelay, signature, signatureType, thresholds","insight, configure, webApps","insight.updateOrganizationInsightWebApp","" "beta","deleteOrganizationInsightWebApp","Delete a custom web application by counter set rule id.","https://developer.cisco.com/meraki/api-v1/delete-organization-insight-web-app/","delete","/organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}","organizationId, customCounterSetRuleId","","","insight, configure, webApps","insight.deleteOrganizationInsightWebApp","" -"beta","getOrganizationIntegrationsXdrNetworks","Returns the networks in the organization that have XDR enabled","https://developer.cisco.com/meraki/api-v1/get-organization-integrations-xdr-networks/","get","/organizations/{organizationId}/integrations/xdr/networks","organizationId, networkIds","","enabled, isEligible, name, networkId, productTypes","organizations, configure, integrations, xdr, networks","organizations.getOrganizationIntegrationsXdrNetworks","" -"beta","disableOrganizationIntegrationsXdrNetworks","Disable XDR on networks","https://developer.cisco.com/meraki/api-v1/disable-organization-integrations-xdr-networks/","post","/organizations/{organizationId}/integrations/xdr/networks/disable","organizationId","networkId, networks, productTypes","enabled, isEligible, name, networkId, productTypes","organizations, configure, integrations, xdr, networks","organizations.disableOrganizationIntegrationsXdrNetworks","" -"beta","enableOrganizationIntegrationsXdrNetworks","Enable XDR on networks","https://developer.cisco.com/meraki/api-v1/enable-organization-integrations-xdr-networks/","post","/organizations/{organizationId}/integrations/xdr/networks/enable","organizationId","networkId, networks, productTypes","enabled, isEligible, name, networkId, productTypes","organizations, configure, integrations, xdr, networks","organizations.enableOrganizationIntegrationsXdrNetworks","" +"GA","getOrganizationIntegrationsXdrNetworks","Returns the networks in the organization that have XDR enabled","https://developer.cisco.com/meraki/api-v1/get-organization-integrations-xdr-networks/","get","/organizations/{organizationId}/integrations/xdr/networks","organizationId, networkIds, perPage, startingAfter, endingBefore","","counts, enabled, isEligible, items, meta, name, networkId, productTypes, remaining, total","organizations, configure, integrations, xdr, networks","organizations.getOrganizationIntegrationsXdrNetworks","" +"GA","disableOrganizationIntegrationsXdrNetworks","Disable XDR on networks","https://developer.cisco.com/meraki/api-v1/disable-organization-integrations-xdr-networks/","post","/organizations/{organizationId}/integrations/xdr/networks/disable","organizationId","networkId, networks, productTypes","enabled, isEligible, name, networkId, networks, productTypes","organizations, configure, integrations, xdr, networks","organizations.disableOrganizationIntegrationsXdrNetworks","" +"GA","enableOrganizationIntegrationsXdrNetworks","Enable XDR on networks","https://developer.cisco.com/meraki/api-v1/enable-organization-integrations-xdr-networks/","post","/organizations/{organizationId}/integrations/xdr/networks/enable","organizationId","networkId, networks, productTypes","enabled, isEligible, name, networkId, networks, productTypes","organizations, configure, integrations, xdr, networks","organizations.enableOrganizationIntegrationsXdrNetworks","" "GA","claimIntoOrganizationInventory","Claim a list of devices, licenses, and/or orders into an organization inventory","https://developer.cisco.com/meraki/api-v1/claim-into-organization-inventory/","post","/organizations/{organizationId}/inventory/claim","organizationId","key, licenses, mode, orders, serials","key, licenses, mode, orders, serials","organizations, configure, inventory","organizations.claimIntoOrganizationInventory","dashboard:licensing:config:write" "GA","getOrganizationInventoryDevices","Return the device inventory for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-inventory-devices/","get","/organizations/{organizationId}/inventory/devices","organizationId, perPage, startingAfter, endingBefore, usedState, search, macs, networkIds, serials, models, orderNumbers, tags, tagsFilterType, productTypes","","claimedAt, countryCode, details, licenseExpirationDate, mac, model, name, networkId, orderNumber, productType, serial, tags, value","organizations, configure, inventory, devices","organizations.getOrganizationInventoryDevices","dashboard:general:config:read" "GA","createOrganizationInventoryDevicesSwapsBulk","Swap the devices identified by devices.old with a devices.new, then perform the :afterAction on the devices.old.","https://developer.cisco.com/meraki/api-v1/create-organization-inventory-devices-swaps-bulk/","post","/organizations/{organizationId}/inventory/devices/swaps/bulk","organizationId","afterAction, devices, new, old, swaps","afterAction, completedAt, createdAt, devices, errors, id, jobId, mac, model, name, new, old, serial, status, swaps","organizations, configure, inventory, devices, swaps, bulk","organizations.createOrganizationInventoryDevicesSwapsBulk","dashboard:general:config:write" "GA","getOrganizationInventoryDevicesSwapsBulk","List of device swaps for a given request ID ({id}).","https://developer.cisco.com/meraki/api-v1/get-organization-inventory-devices-swaps-bulk/","get","/organizations/{organizationId}/inventory/devices/swaps/bulk/{id}","organizationId, id","","afterAction, completedAt, createdAt, devices, errors, id, jobId, mac, model, name, new, old, serial, status, swaps","organizations, configure, inventory, devices, swaps, bulk","organizations.getOrganizationInventoryDevicesSwapsBulk","dashboard:general:config:read" "GA","getOrganizationInventoryDevice","Return a single device from the inventory of an organization","https://developer.cisco.com/meraki/api-v1/get-organization-inventory-device/","get","/organizations/{organizationId}/inventory/devices/{serial}","organizationId, serial","","claimedAt, countryCode, details, licenseExpirationDate, mac, model, name, networkId, orderNumber, productType, serial, tags, value","organizations, configure, inventory, devices","organizations.getOrganizationInventoryDevice","dashboard:general:config:read" -"GA","createOrganizationInventoryOnboardingCloudMonitoringExportEvent","Imports event logs related to the onboarding app into elastisearch","https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-export-event/","post","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents","organizationId","logEvent, request, targetOS, timestamp","","organizations, configure, inventory, onboarding, cloudMonitoring, exportEvents","organizations.createOrganizationInventoryOnboardingCloudMonitoringExportEvent","dashboard:general:config:write" -"GA","createOrganizationInventoryOnboardingCloudMonitoringImport","Commits the import operation to complete the onboarding of a device into Dashboard for monitoring.","https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-import/","post","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports","organizationId","deviceId, devices, networkId, udi","importId, message, status","organizations, configure, inventory, onboarding, cloudMonitoring, imports","organizations.createOrganizationInventoryOnboardingCloudMonitoringImport","dashboard:general:config:write" -"GA","getOrganizationInventoryOnboardingCloudMonitoringImports","Check the status of a committed Import operation","https://developer.cisco.com/meraki/api-v1/get-organization-inventory-onboarding-cloud-monitoring-imports/","get","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports","organizationId, importIds","","created, device, importId, status, url","organizations, configure, inventory, onboarding, cloudMonitoring, imports","organizations.getOrganizationInventoryOnboardingCloudMonitoringImports","dashboard:general:config:read" -"GA","getOrganizationInventoryOnboardingCloudMonitoringNetworks","Returns list of networks eligible for adding cloud monitored device","https://developer.cisco.com/meraki/api-v1/get-organization-inventory-onboarding-cloud-monitoring-networks/","get","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks","organizationId, deviceType, search, perPage, startingAfter, endingBefore","","enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url","organizations, configure, inventory, onboarding, cloudMonitoring, networks","organizations.getOrganizationInventoryOnboardingCloudMonitoringNetworks","dashboard:general:config:read" -"GA","createOrganizationInventoryOnboardingCloudMonitoringPrepare","Initiates or updates an import session","https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-prepare/","post","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare","organizationId","accessList, authentication, authorization, certificateName, devices, endLineNumber, group, localInterface, loopbackNumber, name, options, rotaryNumber, skipCommit, startLineNumber, sudi, tunnel, user, username, vty, vtyIn, vtyOut","cloudStaticIp, configParams, content, deviceId, hash, host, message, mode, name, port, publicKey, rootCertificate, secret, status, tunnel, udi, user, username","organizations, configure, inventory, onboarding, cloudMonitoring, prepare","organizations.createOrganizationInventoryOnboardingCloudMonitoringPrepare","dashboard:general:config:write" +"deprecated","createOrganizationInventoryOnboardingCloudMonitoringExportEvent","Imports event logs related to the onboarding app into elastisearch","https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-export-event/","post","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents","organizationId","logEvent, request, targetOS, timestamp","","organizations, configure, inventory, onboarding, cloudMonitoring, exportEvents","organizations.createOrganizationInventoryOnboardingCloudMonitoringExportEvent","dashboard:general:config:write" +"deprecated","createOrganizationInventoryOnboardingCloudMonitoringImport","Commits the import operation to complete the onboarding of a device into Dashboard for monitoring.","https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-import/","post","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports","organizationId","deviceId, devices, networkId, udi","importId, message, status","organizations, configure, inventory, onboarding, cloudMonitoring, imports","organizations.createOrganizationInventoryOnboardingCloudMonitoringImport","dashboard:general:config:write" +"deprecated","getOrganizationInventoryOnboardingCloudMonitoringImports","Check the status of a committed Import operation","https://developer.cisco.com/meraki/api-v1/get-organization-inventory-onboarding-cloud-monitoring-imports/","get","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports","organizationId, importIds","","created, device, importId, status, url","organizations, configure, inventory, onboarding, cloudMonitoring, imports","organizations.getOrganizationInventoryOnboardingCloudMonitoringImports","dashboard:general:config:read" +"deprecated","getOrganizationInventoryOnboardingCloudMonitoringNetworks","Returns list of networks eligible for adding cloud monitored device","https://developer.cisco.com/meraki/api-v1/get-organization-inventory-onboarding-cloud-monitoring-networks/","get","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks","organizationId, deviceType, search, perPage, startingAfter, endingBefore","","enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url","organizations, configure, inventory, onboarding, cloudMonitoring, networks","organizations.getOrganizationInventoryOnboardingCloudMonitoringNetworks","dashboard:general:config:read" +"deprecated","createOrganizationInventoryOnboardingCloudMonitoringPrepare","Initiates or updates an import session","https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-prepare/","post","/organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare","organizationId","accessList, authentication, authorization, certificateName, devices, endLineNumber, group, localInterface, loopbackNumber, name, options, rotaryNumber, skipCommit, startLineNumber, sudi, tunnel, user, username, vty, vtyIn, vtyOut","cloudStaticIp, configParams, content, deviceId, hash, host, message, mode, name, port, publicKey, rootCertificate, secret, status, tunnel, udi, user, username","organizations, configure, inventory, onboarding, cloudMonitoring, prepare","organizations.createOrganizationInventoryOnboardingCloudMonitoringPrepare","dashboard:general:config:write" +"beta","claimOrganizationInventoryOrders","Claim an order by the secure unique order claim number, the order claim id","https://developer.cisco.com/meraki/api-v1/claim-organization-inventory-orders/","post","/organizations/{organizationId}/inventory/orders/claim","organizationId","claimId, description, name, subscriptionId, subscriptions","claimId, counts, description, endDate, isClaimed, limit, name, number, seats, serials, startDate, subscriptionId, subscriptions","organizations, configure, inventory, orders","organizations.claimOrganizationInventoryOrders","" +"beta","previewOrganizationInventoryOrders","Preview the results and status of an order claim by the secure order id","https://developer.cisco.com/meraki/api-v1/preview-organization-inventory-orders/","post","/organizations/{organizationId}/inventory/orders/preview","organizationId","claimId","claimId, counts, description, devices, endDate, isClaimed, limit, name, number, pending, quantity, seats, shipments, shippedAt, shipping, sku, startDate, subscriptionId, subscriptions","organizations, configure, inventory, orders","organizations.previewOrganizationInventoryOrders","" "GA","releaseFromOrganizationInventory","Release a list of claimed devices from an organization.","https://developer.cisco.com/meraki/api-v1/release-from-organization-inventory/","post","/organizations/{organizationId}/inventory/release","organizationId","serials","serials","organizations, configure, inventory","organizations.releaseFromOrganizationInventory","dashboard:general:config:write" "GA","getOrganizationLicenses","List the licenses for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-licenses/","get","/organizations/{organizationId}/licenses","organizationId, perPage, startingAfter, endingBefore, deviceSerial, networkId, state","","activationDate, claimDate, deviceSerial, durationInDays, expirationDate, headLicenseId, id, licenseKey, licenseType, networkId, orderNumber, permanentlyQueuedLicenses, seatCount, state, totalDurationInDays","organizations, configure, licenses","organizations.getOrganizationLicenses","dashboard:licensing:config:read" "GA","assignOrganizationLicensesSeats","Assign SM seats to a network","https://developer.cisco.com/meraki/api-v1/assign-organization-licenses-seats/","post","/organizations/{organizationId}/licenses/assignSeats","organizationId","licenseId, networkId, seatCount","activationDate, claimDate, deviceSerial, durationInDays, expirationDate, headLicenseId, id, licenseKey, licenseType, networkId, orderNumber, permanentlyQueuedLicenses, resultingLicenses, seatCount, state, totalDurationInDays","organizations, configure, licenses","organizations.assignOrganizationLicensesSeats","dashboard:licensing:config:write" @@ -788,10 +806,8 @@ "GA","updateOrganizationLicense","Update a license","https://developer.cisco.com/meraki/api-v1/update-organization-license/","put","/organizations/{organizationId}/licenses/{licenseId}","organizationId, licenseId","deviceSerial","activationDate, claimDate, deviceSerial, durationInDays, expirationDate, headLicenseId, id, licenseKey, licenseType, networkId, orderNumber, permanentlyQueuedLicenses, seatCount, state, totalDurationInDays","organizations, configure, licenses","organizations.updateOrganizationLicense","dashboard:licensing:config:write" "GA","getOrganizationLicensingCotermLicenses","List the licenses in a coterm organization","https://developer.cisco.com/meraki/api-v1/get-organization-licensing-coterm-licenses/","get","/organizations/{organizationId}/licensing/coterm/licenses","organizationId, perPage, startingAfter, endingBefore, invalidated, expired","","claimedAt, count, counts, duration, edition, editions, expired, invalidated, invalidatedAt, key, mode, model, organizationId, productType, startedAt","licensing, configure, coterm, licenses","licensing.getOrganizationLicensingCotermLicenses","dashboard:licensing:config:read" "GA","moveOrganizationLicensingCotermLicenses","Moves a license to a different organization (coterm only)","https://developer.cisco.com/meraki/api-v1/move-organization-licensing-coterm-licenses/","post","/organizations/{organizationId}/licensing/coterm/licenses/move","organizationId","count, counts, destination, key, licenses, mode, model, organizationId","claimedAt, count, counts, duration, edition, editions, expired, invalidated, invalidatedAt, key, mode, model, movedLicenses, organizationId, productType, remainderLicenses, startedAt","licensing, configure, coterm, licenses","licensing.moveOrganizationLicensingCotermLicenses","dashboard:licensing:config:write" -"beta","claimOrganizationLicensingOrders","Claim an order by the secure unique order claim number, the order claim id","https://developer.cisco.com/meraki/api-v1/claim-organization-licensing-orders/","post","/organizations/{organizationId}/licensing/orders/claim","organizationId","claimId, description, name, subscriptionId, subscriptions","assigned, available, claimId, counts, description, endDate, isClaimed, limit, name, networks, number, organizations, seats, serials, startDate, subscriptionId, subscriptions","licensing, configure, orders","licensing.claimOrganizationLicensingOrders","" -"beta","previewOrganizationLicensingOrders","Preview the results and status of an order claim by the secure order id","https://developer.cisco.com/meraki/api-v1/preview-organization-licensing-orders/","post","/organizations/{organizationId}/licensing/orders/preview","organizationId","claimId","assigned, available, claimId, counts, description, devices, endDate, isClaimed, limit, networks, number, organizations, pending, quantity, seats, shipments, shippedAt, shipping, sku, startDate, subscriptionId, subscriptions","licensing, configure, orders","licensing.previewOrganizationLicensingOrders","" -"GA","getOrganizationLoginSecurity","Returns the login security settings for an organization.","https://developer.cisco.com/meraki/api-v1/get-organization-login-security/","get","/organizations/{organizationId}/loginSecurity","organizationId","","accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, numDifferentPasswords, passwordExpirationDays, ranges","organizations, configure, loginSecurity","organizations.getOrganizationLoginSecurity","dashboard:iam:config:read" -"GA","updateOrganizationLoginSecurity","Update the login security settings for an organization","https://developer.cisco.com/meraki/api-v1/update-organization-login-security/","put","/organizations/{organizationId}/loginSecurity","organizationId","accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, numDifferentPasswords, passwordExpirationDays, ranges","accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, numDifferentPasswords, passwordExpirationDays, ranges","organizations, configure, loginSecurity","organizations.updateOrganizationLoginSecurity","dashboard:iam:config:write" +"GA","getOrganizationLoginSecurity","Returns the login security settings for an organization.","https://developer.cisco.com/meraki/api-v1/get-organization-login-security/","get","/organizations/{organizationId}/loginSecurity","organizationId","","accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, minimumPasswordLength, numDifferentPasswords, passwordExpirationDays, ranges","organizations, configure, loginSecurity","organizations.getOrganizationLoginSecurity","dashboard:iam:config:read" +"GA","updateOrganizationLoginSecurity","Update the login security settings for an organization","https://developer.cisco.com/meraki/api-v1/update-organization-login-security/","put","/organizations/{organizationId}/loginSecurity","organizationId","accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, minimumPasswordLength, numDifferentPasswords, passwordExpirationDays, ranges","accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, minimumPasswordLength, numDifferentPasswords, passwordExpirationDays, ranges","organizations, configure, loginSecurity","organizations.updateOrganizationLoginSecurity","dashboard:iam:config:write" "GA","getOrganizationNetworks","List the networks that the user has privileges on in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-networks/","get","/organizations/{organizationId}/networks","organizationId, configTemplateId, isBoundToConfigTemplate, tags, tagsFilterType, productTypes, perPage, startingAfter, endingBefore","","enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url","organizations, configure, networks","organizations.getOrganizationNetworks","dashboard:general:config:read" "GA","createOrganizationNetwork","Create a network","https://developer.cisco.com/meraki/api-v1/create-organization-network/","post","/organizations/{organizationId}/networks","organizationId","copyFromNetworkId, name, notes, productTypes, tags, timeZone","enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url","organizations, configure, networks","organizations.createOrganizationNetwork","dashboard:general:config:write" "GA","combineOrganizationNetworks","Combine multiple networks into a single network","https://developer.cisco.com/meraki/api-v1/combine-organization-networks/","post","/organizations/{organizationId}/networks/combine","organizationId","enrollmentString, name, networkIds","enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, resultingNetwork, tags, timeZone, url","organizations, configure, networks","organizations.combineOrganizationNetworks","dashboard:general:config:write" @@ -822,6 +838,10 @@ "GA","getOrganizationSamlRole","Return a SAML role","https://developer.cisco.com/meraki/api-v1/get-organization-saml-role/","get","/organizations/{organizationId}/samlRoles/{samlRoleId}","organizationId, samlRoleId","","access, camera, id, networks, orgAccess, orgWide, role, tag, tags","organizations, configure, samlRoles","organizations.getOrganizationSamlRole","dashboard:iam:config:read" "GA","updateOrganizationSamlRole","Update a SAML role","https://developer.cisco.com/meraki/api-v1/update-organization-saml-role/","put","/organizations/{organizationId}/samlRoles/{samlRoleId}","organizationId, samlRoleId","access, id, networks, orgAccess, role, tag, tags","access, camera, id, networks, orgAccess, orgWide, role, tag, tags","organizations, configure, samlRoles","organizations.updateOrganizationSamlRole","dashboard:iam:config:write" "GA","deleteOrganizationSamlRole","Remove a SAML role","https://developer.cisco.com/meraki/api-v1/delete-organization-saml-role/","delete","/organizations/{organizationId}/samlRoles/{samlRoleId}","organizationId, samlRoleId","","","organizations, configure, samlRoles","organizations.deleteOrganizationSamlRole","dashboard:iam:config:write" +"beta","getOrganizationSaseConnectivityEnrollableNetworks","List of MX networks or templates that can be enrolled into Secure Access","https://developer.cisco.com/meraki/api-v1/get-organization-sase-connectivity-enrollable-networks/","get","/organizations/{organizationId}/sase/connectivity/enrollableNetworks","organizationId, perPage, startingAfter, endingBefore","","address, counts, defaultRoute, enabled, items, meta, model, name, networkId, region, remaining, routing, street, total, type, vpn","organizations, configure, sase, connectivity, enrollableNetworks","organizations.getOrganizationSaseConnectivityEnrollableNetworks","" +"beta","deleteOrganizationSaseConnectivitySitesBulkDetach","Detach sites in this organization from Secure Access","https://developer.cisco.com/meraki/api-v1/delete-organization-sase-connectivity-sites-bulk-detach/","delete","/organizations/{organizationId}/sase/connectivity/sites/bulkDetach","organizationId","callback, httpServer, id, merakiEnrollments, network, payloadTemplate, sharedSecret, siteId, url","action, callback, id, message, request, siteId, status, url","organizations, configure, sase, connectivity, sites, bulkDetach","organizations.deleteOrganizationSaseConnectivitySitesBulkDetach","" +"beta","createOrganizationSaseConnectivitySitesBulkEnroll","Enroll sites in this organization to Secure Access","https://developer.cisco.com/meraki/api-v1/create-organization-sase-connectivity-sites-bulk-enroll/","post","/organizations/{organizationId}/sase/connectivity/sites/bulkEnroll","organizationId","callback, httpServer, id, merakiEnrollments, network, payloadTemplate, region, sharedSecret, url","action, callback, id, message, regionId, request, siteId, status, url","organizations, configure, sase, connectivity, sites, bulkEnroll","organizations.createOrganizationSaseConnectivitySitesBulkEnroll","" +"beta","getOrganizationSaseConnectivitySite","Get details of a site in this organization","https://developer.cisco.com/meraki/api-v1/get-organization-sase-connectivity-site/","get","/organizations/{organizationId}/sase/connectivity/sites/{id}","organizationId, id, id","","address, defaultRoute, enabled, id, model, name, networkId, region, routing, street, type, vpn","organizations, configure, sase, connectivity, sites","organizations.getOrganizationSaseConnectivitySite","" "beta","getOrganizationSecureConnectPrivateApplicationGroups","Provides a list of private application groups for an Organization","https://developer.cisco.com/meraki/api-v1/get-organization-secure-connect-private-application-groups/","get","/organizations/{organizationId}/secureConnect/privateApplicationGroups","organizationId, perPage, startingAfter, endingBefore, nameIncludes, applicationGroupIds, sortBy, sortOrder","","applicationGroupId, applicationIds, createdAt, data, description, meta, modifiedAt, name, total","secureConnect, configure, privateApplicationGroups","secureConnect.getOrganizationSecureConnectPrivateApplicationGroups","" "beta","createOrganizationSecureConnectPrivateApplicationGroup","Creates a group of private applications to apply to policy","https://developer.cisco.com/meraki/api-v1/create-organization-secure-connect-private-application-group/","post","/organizations/{organizationId}/secureConnect/privateApplicationGroups","organizationId","applicationIds, description, name","applicationGroupId, applicationIds, createdAt, description, modifiedAt, name","secureConnect, configure, privateApplicationGroups","secureConnect.createOrganizationSecureConnectPrivateApplicationGroup","" "beta","updateOrganizationSecureConnectPrivateApplicationGroup","Update an application group in an Organization","https://developer.cisco.com/meraki/api-v1/update-organization-secure-connect-private-application-group/","put","/organizations/{organizationId}/secureConnect/privateApplicationGroups/{id}","organizationId, id","applicationIds, description, name","applicationGroupId, applicationIds, createdAt, description, modifiedAt, name","secureConnect, configure, privateApplicationGroups","secureConnect.updateOrganizationSecureConnectPrivateApplicationGroup","" @@ -875,6 +895,7 @@ "GA","updateOrganizationSnmp","Update the SNMP settings for an organization","https://developer.cisco.com/meraki/api-v1/update-organization-snmp/","put","/organizations/{organizationId}/snmp","organizationId","peerIps, v2cEnabled, v3AuthMode, v3AuthPass, v3Enabled, v3PrivMode, v3PrivPass","hostname, peerIps, port, v2CommunityString, v2cEnabled, v3AuthMode, v3Enabled, v3PrivMode, v3User","organizations, configure, snmp","organizations.updateOrganizationSnmp","dashboard:general:telemetry:write" "beta","getOrganizationSnmpTrapsByNetwork","Retrieve the SNMP trap configuration for the networks in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-snmp-traps-by-network/","get","/organizations/{organizationId}/snmp/traps/byNetwork","organizationId, networkIds","","address, community, id, mode, name, network, port, receiver, users, v2, v3","organizations, configure, snmp, traps, byNetwork","organizations.getOrganizationSnmpTrapsByNetwork","" "beta","deleteOrganizationSpacesIntegrationRemove","Remove the Spaces integration from Meraki","https://developer.cisco.com/meraki/api-v1/delete-organization-spaces-integration-remove/","delete","/organizations/{organizationId}/spaces/integration/remove","organizationId","","message, status","organizations, configure, spaces, integration, remove","organizations.deleteOrganizationSpacesIntegrationRemove","dashboard:general:config:write" +"beta","createOrganizationSpacesIntegrationRemove","Remove the Spaces integration from Meraki","https://developer.cisco.com/meraki/api-v1/create-organization-spaces-integration-remove/","post","/organizations/{organizationId}/spaces/integration/remove","organizationId","","message, status","organizations, configure, spaces, integration, remove","organizations.createOrganizationSpacesIntegrationRemove","dashboard:general:config:write" "GA","getOrganizationSplashAsset","Get a Splash Theme Asset","https://developer.cisco.com/meraki/api-v1/get-organization-splash-asset/","get","/organizations/{organizationId}/splash/assets/{id}","organizationId, id","","fileData, id, name","organizations, configure, splash, assets","organizations.getOrganizationSplashAsset","" "GA","deleteOrganizationSplashAsset","Delete a Splash Theme Asset","https://developer.cisco.com/meraki/api-v1/delete-organization-splash-asset/","delete","/organizations/{organizationId}/splash/assets/{id}","organizationId, id","","","organizations, configure, splash, assets","organizations.deleteOrganizationSplashAsset","" "GA","getOrganizationSplashThemes","List Splash Themes","https://developer.cisco.com/meraki/api-v1/get-organization-splash-themes/","get","/organizations/{organizationId}/splash/themes","organizationId","","id, name, themeAssets","organizations, configure, splash, themes","organizations.getOrganizationSplashThemes","" @@ -905,6 +926,11 @@ "beta","createOrganizationSwitchPortsProfilesAutomation","Create a port profile automation for an organization","https://developer.cisco.com/meraki/api-v1/create-organization-switch-ports-profiles-automation/","post","/organizations/{organizationId}/switch/ports/profiles/automations","organizationId","assignedSwitchPorts, attribute, conditions, description, fallbackProfile, id, name, portIds, priority, profile, rules, serial, switch, values","assigned, assignedSwitchPorts, attribute, conditions, counts, description, devices, fallbackProfile, id, isOrganizationWide, name, networks, portIds, ports, priority, profile, rules, serial, switch, types, values","switch, configure, ports, profiles, automations","switch.createOrganizationSwitchPortsProfilesAutomation","" "beta","updateOrganizationSwitchPortsProfilesAutomation","Update a port profile automation in an organization","https://developer.cisco.com/meraki/api-v1/update-organization-switch-ports-profiles-automation/","put","/organizations/{organizationId}/switch/ports/profiles/automations/{id}","organizationId, id","assignedSwitchPorts, attribute, conditions, description, fallbackProfile, id, name, portIds, priority, profile, rules, serial, switch, values","assigned, assignedSwitchPorts, attribute, conditions, counts, description, devices, fallbackProfile, id, isOrganizationWide, name, networks, portIds, ports, priority, profile, rules, serial, switch, types, values","switch, configure, ports, profiles, automations","switch.updateOrganizationSwitchPortsProfilesAutomation","" "beta","deleteOrganizationSwitchPortsProfilesAutomation","Delete an automation port profile from an organization","https://developer.cisco.com/meraki/api-v1/delete-organization-switch-ports-profiles-automation/","delete","/organizations/{organizationId}/switch/ports/profiles/automations/{id}","organizationId, id","","","switch, configure, ports, profiles, automations","switch.deleteOrganizationSwitchPortsProfilesAutomation","" +"beta","getOrganizationSwitchPortsProfilesNetworksAssignments","Fetch all Network - Smart Port Profile associations for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-switch-ports-profiles-networks-assignments/","get","/organizations/{organizationId}/switch/ports/profiles/networks/assignments","organizationId, perPage, page","","assignmentId, counts, id, items, meta, network, profile, remaining, total, type","switch, configure, ports, profiles, networks, assignments","switch.getOrganizationSwitchPortsProfilesNetworksAssignments","" +"beta","createOrganizationSwitchPortsProfilesNetworksAssignment","Create Network and Smart Ports Profile association for a specific profile","https://developer.cisco.com/meraki/api-v1/create-organization-switch-ports-profiles-networks-assignment/","post","/organizations/{organizationId}/switch/ports/profiles/networks/assignments","organizationId","id, network, profile, type","assignmentId, id, network, profile, type","switch, configure, ports, profiles, networks, assignments","switch.createOrganizationSwitchPortsProfilesNetworksAssignment","" +"beta","batchOrganizationSwitchPortsProfilesNetworksAssignmentsCreate","Batch Create Network and Smart Ports Profile associations for a specific profile","https://developer.cisco.com/meraki/api-v1/batch-organization-switch-ports-profiles-networks-assignments-create/","post","/organizations/{organizationId}/switch/ports/profiles/networks/assignments/batchCreate","organizationId","id, items, network, profile, type","assignmentId, id, items, network, profile, type","switch, configure, ports, profiles, networks, assignments","switch.batchOrganizationSwitchPortsProfilesNetworksAssignmentsCreate","" +"beta","bulkOrganizationSwitchPortsProfilesNetworksAssignmentsDelete","Bulk delete Network and Smart Port Profile associations","https://developer.cisco.com/meraki/api-v1/bulk-organization-switch-ports-profiles-networks-assignments-delete/","post","/organizations/{organizationId}/switch/ports/profiles/networks/assignments/bulkDelete","organizationId","assignmentId, items","","switch, configure, ports, profiles, networks, assignments","switch.bulkOrganizationSwitchPortsProfilesNetworksAssignmentsDelete","" +"beta","deleteOrganizationSwitchPortsProfilesNetworksAssignment","Delete Network and Smart Port profile association for a specific profile","https://developer.cisco.com/meraki/api-v1/delete-organization-switch-ports-profiles-networks-assignment/","delete","/organizations/{organizationId}/switch/ports/profiles/networks/assignments/{assignmentId}","organizationId, assignmentId","","","switch, configure, ports, profiles, networks, assignments","switch.deleteOrganizationSwitchPortsProfilesNetworksAssignment","" "beta","getOrganizationSwitchPortsProfilesOverviewByProfile","List the port profiles in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-switch-ports-profiles-overview-by-profile/","get","/organizations/{organizationId}/switch/ports/profiles/overview/byProfile","organizationId, networkIds, formattedStaticAssignments, searchQuery, perPage, startingAfter, endingBefore","","access, assigned, automations, counts, createdAt, description, excluded, id, included, isOrganizationWide, items, meta, name, network, networks, networksCount, ports, profileId, switches, total, type, updatedAt, values","switch, configure, ports, profiles, overview, byProfile","switch.getOrganizationSwitchPortsProfilesOverviewByProfile","" "beta","getOrganizationSwitchPortsProfile","Get detailed information about a port profile","https://developer.cisco.com/meraki/api-v1/get-organization-switch-ports-profile/","get","/organizations/{organizationId}/switch/ports/profiles/{id}","organizationId, id","","access, accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, assignedSwitchports, associatedPorts, associatedSwitches, automations, createdAt, daiTrusted, description, enabled, id, isOrganizationWide, isolationEnabled, mac, macAllowList, model, name, networkId, networks, peerSgtCapable, poeEnabled, port, portId, portIds, portName, portNum, profile, profileId, rstpEnabled, serial, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, switch, switchId, tags, template, type, udld, updatedAt, values, vlan, voiceVlan","switch, configure, ports, profiles","switch.getOrganizationSwitchPortsProfile","" "beta","updateOrganizationSwitchPortsProfile","Update a port profile in an organization","https://developer.cisco.com/meraki/api-v1/update-organization-switch-ports-profile/","put","/organizations/{organizationId}/switch/ports/profiles/{id}","organizationId, id","accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, daiTrusted, description, id, isOrganizationWide, isolationEnabled, macAllowList, name, networkId, networks, peerSgtCapable, poeEnabled, port, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, values, vlan, voiceVlan","access, accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, assignedSwitchports, associatedPorts, associatedSwitches, automations, createdAt, daiTrusted, description, enabled, id, isOrganizationWide, isolationEnabled, mac, macAllowList, model, name, networkId, networks, peerSgtCapable, poeEnabled, port, portId, portIds, portName, portNum, profile, profileId, rstpEnabled, serial, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, switch, switchId, tags, template, type, udld, updatedAt, values, vlan, voiceVlan","switch, configure, ports, profiles","switch.updateOrganizationSwitchPortsProfile","" @@ -932,19 +958,35 @@ "beta","getOrganizationWebhooksWebhookTest","Return the status of a webhook test for an organization","https://developer.cisco.com/meraki/api-v1/get-organization-webhooks-webhook-test/","get","/organizations/{organizationId}/webhooks/webhookTests/{webhookTestId}","organizationId, webhookTestId","","id, status, url","organizations, configure, webhooks, webhookTests","organizations.getOrganizationWebhooksWebhookTest","" "GA","getOrganizationWirelessAirMarshalRules","Returns the current Air Marshal rules for this organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-air-marshal-rules/","get","/organizations/{organizationId}/wireless/airMarshal/rules","organizationId, networkIds, perPage, startingAfter, endingBefore","","counts, createdAt, id, items, match, meta, name, network, ruleId, string, total, type, updatedAt","wireless, configure, airMarshal, rules","wireless.getOrganizationWirelessAirMarshalRules","" "GA","getOrganizationWirelessAirMarshalSettingsByNetwork","Returns the current Air Marshal settings for this network","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-air-marshal-settings-by-network/","get","/organizations/{organizationId}/wireless/airMarshal/settings/byNetwork","organizationId, networkIds, perPage, startingAfter, endingBefore","","counts, defaultPolicy, items, meta, networkId, remaining, total","wireless, configure, airMarshal, settings, byNetwork","wireless.getOrganizationWirelessAirMarshalSettingsByNetwork","" +"beta","getOrganizationWirelessCertificatesOpenRoamingCertificateAuthority","Query for details on the organization's OpenRoaming Certificate Authority certificate (CAs).","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-certificates-open-roaming-certificate-authority/","get","/organizations/{organizationId}/wireless/certificates/openRoaming/certificateAuthority","organizationId","","contents, status","wireless, configure, certificates, openRoaming, certificateAuthority","wireless.getOrganizationWirelessCertificatesOpenRoamingCertificateAuthority","wireless:config:read" "GA","getOrganizationWirelessClientsOverviewByDevice","List access point client count at the moment in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-clients-overview-by-device/","get","/organizations/{organizationId}/wireless/clients/overview/byDevice","organizationId, networkIds, serials, campusGatewayClusterIds, perPage, startingAfter, endingBefore","","byStatus, counts, id, items, meta, network, online, remaining, serial, total","wireless, monitor, clients, overview, byDevice","wireless.getOrganizationWirelessClientsOverviewByDevice","" "GA","getOrganizationWirelessDevicesChannelUtilizationByDevice","Get average channel utilization for all bands in a network, split by AP","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-channel-utilization-by-device/","get","/organizations/{organizationId}/wireless/devices/channelUtilization/byDevice","organizationId, networkIds, serials, perPage, startingAfter, endingBefore, t0, t1, timespan, interval","","band, byBand, id, mac, network, nonWifi, percentage, serial, total, wifi","wireless, monitor, devices, channelUtilization, byDevice","wireless.getOrganizationWirelessDevicesChannelUtilizationByDevice","wireless:telemetry:read" "GA","getOrganizationWirelessDevicesChannelUtilizationByNetwork","Get average channel utilization across all bands for all networks in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-channel-utilization-by-network/","get","/organizations/{organizationId}/wireless/devices/channelUtilization/byNetwork","organizationId, networkIds, serials, perPage, startingAfter, endingBefore, t0, t1, timespan, interval","","band, byBand, id, network, nonWifi, percentage, total, wifi","wireless, monitor, devices, channelUtilization, byNetwork","wireless.getOrganizationWirelessDevicesChannelUtilizationByNetwork","wireless:telemetry:read" "GA","getOrganizationWirelessDevicesChannelUtilizationHistoryByDeviceByInterval","Get a time-series of average channel utilization for all bands, segmented by device.","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-channel-utilization-history-by-device-by-interval/","get","/organizations/{organizationId}/wireless/devices/channelUtilization/history/byDevice/byInterval","organizationId, networkIds, serials, perPage, startingAfter, endingBefore, t0, t1, timespan, interval","","band, byBand, endTs, id, mac, network, nonWifi, percentage, serial, startTs, total, wifi","wireless, monitor, devices, channelUtilization, history, byDevice, byInterval","wireless.getOrganizationWirelessDevicesChannelUtilizationHistoryByDeviceByInterval","wireless:telemetry:read" "GA","getOrganizationWirelessDevicesChannelUtilizationHistoryByNetworkByInterval","Get a time-series of average channel utilization for all bands","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-channel-utilization-history-by-network-by-interval/","get","/organizations/{organizationId}/wireless/devices/channelUtilization/history/byNetwork/byInterval","organizationId, networkIds, serials, perPage, startingAfter, endingBefore, t0, t1, timespan, interval","","band, byBand, endTs, id, network, nonWifi, percentage, startTs, total, wifi","wireless, monitor, devices, channelUtilization, history, byNetwork, byInterval","wireless.getOrganizationWirelessDevicesChannelUtilizationHistoryByNetworkByInterval","wireless:telemetry:read" "GA","getOrganizationWirelessDevicesEthernetStatuses","List the most recent Ethernet link speed, duplex, aggregation and power mode and status information for wireless devices.","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-ethernet-statuses/","get","/organizations/{organizationId}/wireless/devices/ethernet/statuses","organizationId, perPage, startingAfter, endingBefore, networkIds","","ac, aggregation, duplex, enabled, id, isConnected, linkNegotiation, mode, name, network, poe, ports, power, serial, speed, standard","wireless, monitor, devices, ethernet, statuses","wireless.getOrganizationWirelessDevicesEthernetStatuses","wireless:telemetry:read" +"beta","getOrganizationWirelessDevicesLatencyByClient","Get latency summaries for all wireless devices in an organization.","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-latency-by-client/","get","/organizations/{organizationId}/wireless/devices/latency/byClient","organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, networkIds, bands, ssids, macs","","average, device, frames, id, mac, name, network, overall, serial","wireless, configure, devices, latency, byClient","wireless.getOrganizationWirelessDevicesLatencyByClient","" +"beta","getOrganizationWirelessDevicesLatencyByDevice","Get latency summaries for all wireless devices in an organization.","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-latency-by-device/","get","/organizations/{organizationId}/wireless/devices/latency/byDevice","organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, networkIds, serials, bands, ssids","","average, device, frames, id, mac, name, network, overall, serial","wireless, configure, devices, latency, byDevice","wireless.getOrganizationWirelessDevicesLatencyByDevice","" +"beta","getOrganizationWirelessDevicesLatencyByNetwork","Get per-network latency summaries for all wireless networks in an organization.","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-latency-by-network/","get","/organizations/{organizationId}/wireless/devices/latency/byNetwork","organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, networkIds, serials, bands, ssids","","average, frames, id, name, network, overall","wireless, configure, devices, latency, byNetwork","wireless.getOrganizationWirelessDevicesLatencyByNetwork","" "GA","getOrganizationWirelessDevicesPacketLossByClient","Get average packet loss for the given timespan for all clients in the organization.","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-packet-loss-by-client/","get","/organizations/{organizationId}/wireless/devices/packetLoss/byClient","organizationId, networkIds, ssids, bands, macs, perPage, startingAfter, endingBefore, t0, t1, timespan","","client, downstream, id, lossPercentage, lost, mac, name, network, total, upstream","wireless, monitor, devices, packetLoss, byClient","wireless.getOrganizationWirelessDevicesPacketLossByClient","" "GA","getOrganizationWirelessDevicesPacketLossByDevice","Get average packet loss for the given timespan for all devices in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-packet-loss-by-device/","get","/organizations/{organizationId}/wireless/devices/packetLoss/byDevice","organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan","","device, downstream, id, lossPercentage, lost, mac, name, network, serial, total, upstream","wireless, monitor, devices, packetLoss, byDevice","wireless.getOrganizationWirelessDevicesPacketLossByDevice","" "GA","getOrganizationWirelessDevicesPacketLossByNetwork","Get average packet loss for the given timespan for all networks in the organization.","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-packet-loss-by-network/","get","/organizations/{organizationId}/wireless/devices/packetLoss/byNetwork","organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan","","downstream, id, lossPercentage, lost, name, network, total, upstream","wireless, monitor, devices, packetLoss, byNetwork","wireless.getOrganizationWirelessDevicesPacketLossByNetwork","" "GA","getOrganizationWirelessDevicesPowerModeHistory","Return a record of power mode changes for wireless devices in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-power-mode-history/","get","/organizations/{organizationId}/wireless/devices/power/mode/history","organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, networkIds, serials","","events, id, items, mac, model, name, network, powerMode, serial, tags, ts","wireless, monitor, devices, power, mode, history","wireless.getOrganizationWirelessDevicesPowerModeHistory","" +"GA","getOrganizationWirelessDevicesRadsecCertificatesAuthorities","Query for details on the organization's RADSEC device Certificate Authority certificates (CAs)","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-radsec-certificates-authorities/","get","/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities","organizationId, certificateAuthorityIds","","certificateAuthorityId, contents, counts, items, meta, remaining, status, total","wireless, configure, devices, radsec, certificates, authorities","wireless.getOrganizationWirelessDevicesRadsecCertificatesAuthorities","dashboard:iam:config:read" +"GA","updateOrganizationWirelessDevicesRadsecCertificatesAuthorities","Update an organization's RADSEC device Certificate Authority (CA) state","https://developer.cisco.com/meraki/api-v1/update-organization-wireless-devices-radsec-certificates-authorities/","put","/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities","organizationId","certificateAuthorityId, status","certificateAuthorityId, contents, status","wireless, configure, devices, radsec, certificates, authorities","wireless.updateOrganizationWirelessDevicesRadsecCertificatesAuthorities","dashboard:iam:config:write" +"GA","createOrganizationWirelessDevicesRadsecCertificatesAuthority","Create an organization's RADSEC device Certificate Authority (CA)","https://developer.cisco.com/meraki/api-v1/create-organization-wireless-devices-radsec-certificates-authority/","post","/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities","organizationId","","certificateAuthorityId, contents, status","wireless, configure, devices, radsec, certificates, authorities","wireless.createOrganizationWirelessDevicesRadsecCertificatesAuthority","dashboard:iam:config:write" +"GA","getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrls","Query for certificate revocation list (CRL) for the organization's RADSEC device Certificate Authorities (CAs).","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-radsec-certificates-authorities-crls/","get","/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls","organizationId, certificateAuthorityIds","","certificateAuthorityId, counts, crl, items, meta, remaining, total","wireless, configure, devices, radsec, certificates, authorities, crls","wireless.getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrls","dashboard:iam:config:read" +"GA","getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrlsDeltas","Query for all delta certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id.","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-radsec-certificates-authorities-crls-deltas/","get","/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls/deltas","organizationId, certificateAuthorityIds","","certificateAuthorityId, counts, crl, items, meta, remaining, total","wireless, configure, devices, radsec, certificates, authorities, crls, deltas","wireless.getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrlsDeltas","dashboard:iam:config:read" +"beta","getOrganizationWirelessDevicesSignalQualityByClient","Get average signal quality for all clients in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-signal-quality-by-client/","get","/organizations/{organizationId}/wireless/devices/signalQuality/byClient","organizationId, networkIds, serials, ssids, bands, macs, perPage, startingAfter, endingBefore, t0, t1, timespan","","client, id, mac, name, network, rssi, snr","wireless, monitor, devices, signalQuality, byClient","wireless.getOrganizationWirelessDevicesSignalQualityByClient","" +"beta","getOrganizationWirelessDevicesSignalQualityByDevice","Get average signal quality for all devices in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-signal-quality-by-device/","get","/organizations/{organizationId}/wireless/devices/signalQuality/byDevice","organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan","","id, name, network, rssi, snr","wireless, monitor, devices, signalQuality, byDevice","wireless.getOrganizationWirelessDevicesSignalQualityByDevice","" +"beta","getOrganizationWirelessDevicesSignalQualityByNetwork","Get average signal quality for all networks in the organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-signal-quality-by-network/","get","/organizations/{organizationId}/wireless/devices/signalQuality/byNetwork","organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan","","id, name, network, rssi, snr","wireless, monitor, devices, signalQuality, byNetwork","wireless.getOrganizationWirelessDevicesSignalQualityByNetwork","" "GA","getOrganizationWirelessDevicesSystemCpuLoadHistory","Return the CPU Load history for a list of wireless devices in the organization.","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-system-cpu-load-history/","get","/organizations/{organizationId}/wireless/devices/system/cpu/load/history","organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, networkIds, serials","","cpuCount, cpuLoad5, id, items, mac, model, name, network, serial, series, tags, ts","wireless, monitor, devices, system, cpu, load, history","wireless.getOrganizationWirelessDevicesSystemCpuLoadHistory","" "GA","getOrganizationWirelessDevicesWirelessControllersByDevice","List of Catalyst access points information","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-wireless-controllers-by-device/","get","/organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice","organizationId, networkIds, serials, controllerSerials, perPage, startingAfter, endingBefore","","controller, countryCode, counts, details, id, items, joinedAt, meta, mode, model, name, network, policy, remaining, rf, serial, site, tags, total, value","wireless, monitor, devices, wirelessControllers, byDevice","wireless.getOrganizationWirelessDevicesWirelessControllersByDevice","" -"beta","getOrganizationWirelessLocationScanningByNetwork","Return scanning API settings","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-location-scanning-by-network/","get","/organizations/{organizationId}/wireless/location/scanning/byNetwork","organizationId, perPage, startingAfter, endingBefore, networkIds","","api, counts, enabled, items, meta, name, networkId, remaining, string, total, validator","wireless, configure, location, scanning, byNetwork","wireless.getOrganizationWirelessLocationScanningByNetwork","wireless:telemetry:read" +"GA","getOrganizationWirelessLocationScanningByNetwork","Return scanning API settings","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-location-scanning-by-network/","get","/organizations/{organizationId}/wireless/location/scanning/byNetwork","organizationId, perPage, startingAfter, endingBefore, networkIds","","api, counts, enabled, items, meta, name, networkId, remaining, string, total, validator","wireless, configure, location, scanning, byNetwork","wireless.getOrganizationWirelessLocationScanningByNetwork","wireless:telemetry:read" +"GA","getOrganizationWirelessLocationScanningReceivers","Return scanning API receivers","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-location-scanning-receivers/","get","/organizations/{organizationId}/wireless/location/scanning/receivers","organizationId, perPage, startingAfter, endingBefore, networkIds","","counts, id, items, meta, name, network, radio, receiverId, remaining, total, type, url, version","wireless, configure, location, scanning, receivers","wireless.getOrganizationWirelessLocationScanningReceivers","wireless:telemetry:read" +"GA","createOrganizationWirelessLocationScanningReceiver","Add new receiver for scanning API","https://developer.cisco.com/meraki/api-v1/create-organization-wireless-location-scanning-receiver/","post","/organizations/{organizationId}/wireless/location/scanning/receivers","organizationId","id, network, radio, sharedSecret, type, url, version","id, name, network, radio, receiverId, type, url, version","wireless, configure, location, scanning, receivers","wireless.createOrganizationWirelessLocationScanningReceiver","wireless:telemetry:write" +"GA","updateOrganizationWirelessLocationScanningReceiver","Change scanning API receiver settings","https://developer.cisco.com/meraki/api-v1/update-organization-wireless-location-scanning-receiver/","put","/organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId}","organizationId, receiverId","radio, type, url, version","id, name, network, radio, receiverId, type, url, version","wireless, configure, location, scanning, receivers","wireless.updateOrganizationWirelessLocationScanningReceiver","wireless:telemetry:write" +"GA","deleteOrganizationWirelessLocationScanningReceiver","Delete a scanning API receiver","https://developer.cisco.com/meraki/api-v1/delete-organization-wireless-location-scanning-receiver/","delete","/organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId}","organizationId, receiverId","","","wireless, configure, location, scanning, receivers","wireless.deleteOrganizationWirelessLocationScanningReceiver","wireless:telemetry:write" "beta","getOrganizationWirelessOpportunisticPcapByNetwork","List the Opportunistic Pcap settings of an organization by network","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-opportunistic-pcap-by-network/","get","/organizations/{organizationId}/wireless/opportunisticPcap/byNetwork","organizationId, networkIds","","enablement, name, networkId, networkWide, serials, tags","wireless, configure, opportunisticPcap, byNetwork","wireless.getOrganizationWirelessOpportunisticPcapByNetwork","" "beta","byOrganizationWirelessOpportunisticPcapLicenseNetwork","Check the Opportunistic Pcap license status of an organization by network","https://developer.cisco.com/meraki/api-v1/by-organization-wireless-opportunistic-pcap-license-network/","get","/organizations/{organizationId}/wireless/opportunisticPcap/license/byNetwork","organizationId, networkIds","","licensed, name, networkId","wireless, configure, opportunisticPcap, license","wireless.byOrganizationWirelessOpportunisticPcapLicenseNetwork","" "beta","getOrganizationWirelessRadioAfcPositionByDevice","List the AFC power limits of an organization by device","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-radio-afc-position-by-device/","get","/organizations/{organizationId}/wireless/radio/afc/position/byDevice","organizationId, perPage, startingAfter, endingBefore, networkIds, serials","","antenna, cableLength, elevation, gps, height, id, name, network, serial, uncertainty","wireless, configure, radio, afc, position, byDevice","wireless.getOrganizationWirelessRadioAfcPositionByDevice","" @@ -953,14 +995,14 @@ "beta","getOrganizationWirelessRadioAutoRfChannelsPlanningActivities","List the channel planning activities of an organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-radio-auto-rf-channels-planning-activities/","get","/organizations/{organizationId}/wireless/radio/autoRf/channels/planning/activities","organizationId, networkIds, deviceSerials, bands, channels, serials, gFloorplanId, tags, models, rfProfiles, minimumRfHealthScore, maximumRfHealthScore","","band, channel, device, endsAt, id, mac, name, network, reason, serial, severity, startedAt, tags, type","wireless, configure, radio, autoRf, channels, planning, activities","wireless.getOrganizationWirelessRadioAutoRfChannelsPlanningActivities","" "GA","recalculateOrganizationWirelessRadioAutoRfChannels","Recalculates automatically assigned channels for every AP within specified the specified network(s)","https://developer.cisco.com/meraki/api-v1/recalculate-organization-wireless-radio-auto-rf-channels/","post","/organizations/{organizationId}/wireless/radio/autoRf/channels/recalculate","organizationId","networkIds","estimatedCompletedAt","wireless, configure, radio, autoRf, channels","wireless.recalculateOrganizationWirelessRadioAutoRfChannels","" "GA","getOrganizationWirelessRfProfilesAssignmentsByDevice","List the RF profiles of an organization by device","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-rf-profiles-assignments-by-device/","get","/organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice","organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, name, mac, serial, model, macs, serials, models","","counts, id, isIndoorDefault, isOutdoorDefault, items, meta, model, name, network, remaining, rfProfile, serial, total","wireless, configure, rfProfiles, assignments, byDevice","wireless.getOrganizationWirelessRfProfilesAssignmentsByDevice","" -"beta","getOrganizationWirelessSsidsFirewallIsolationAllowlistEntries","List the L2 isolation allow list MAC entry in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-ssids-firewall-isolation-allowlist-entries/","get","/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries","organizationId, perPage, startingAfter, endingBefore, networkIds, ssids","","client, counts, createdAt, description, entryId, id, items, mac, meta, name, network, number, remaining, ssid, total, updatedAt","wireless, configure, ssids, firewall, isolation, allowlist, entries","wireless.getOrganizationWirelessSsidsFirewallIsolationAllowlistEntries","" -"beta","createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","Create isolation allow list MAC entry for this organization","https://developer.cisco.com/meraki/api-v1/create-organization-wireless-ssids-firewall-isolation-allowlist-entry/","post","/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries","organizationId","client, description, id, mac, network, number, ssid","client, createdAt, description, entryId, id, mac, name, network, number, ssid, updatedAt","wireless, configure, ssids, firewall, isolation, allowlist, entries","wireless.createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","" -"beta","deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","Destroy isolation allow list MAC entry for this organization","https://developer.cisco.com/meraki/api-v1/delete-organization-wireless-ssids-firewall-isolation-allowlist-entry/","delete","/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{id}","organizationId, id","","","wireless, configure, ssids, firewall, isolation, allowlist, entries","wireless.deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","" -"beta","updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","Update isolation allow list MAC entry info","https://developer.cisco.com/meraki/api-v1/update-organization-wireless-ssids-firewall-isolation-allowlist-entry/","put","/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{id}","organizationId, id","client, description, mac","client, createdAt, description, entryId, id, mac, name, network, number, ssid, updatedAt","wireless, configure, ssids, firewall, isolation, allowlist, entries","wireless.updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","" +"GA","getOrganizationWirelessSsidsFirewallIsolationAllowlistEntries","List the L2 isolation allow list MAC entry in an organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-ssids-firewall-isolation-allowlist-entries/","get","/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries","organizationId, perPage, startingAfter, endingBefore, networkIds, ssids","","client, counts, createdAt, description, entryId, id, items, lastUpdatedAt, mac, meta, name, network, number, remaining, ssid, total","wireless, configure, ssids, firewall, isolation, allowlist, entries","wireless.getOrganizationWirelessSsidsFirewallIsolationAllowlistEntries","" +"GA","createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","Create isolation allow list MAC entry for this organization","https://developer.cisco.com/meraki/api-v1/create-organization-wireless-ssids-firewall-isolation-allowlist-entry/","post","/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries","organizationId","client, description, id, mac, network, number, ssid","client, createdAt, description, entryId, id, lastUpdatedAt, mac, name, network, number, ssid","wireless, configure, ssids, firewall, isolation, allowlist, entries","wireless.createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","" +"GA","deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","Destroy isolation allow list MAC entry for this organization","https://developer.cisco.com/meraki/api-v1/delete-organization-wireless-ssids-firewall-isolation-allowlist-entry/","delete","/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId}","organizationId, entryId","","","wireless, configure, ssids, firewall, isolation, allowlist, entries","wireless.deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","" +"GA","updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","Update isolation allow list MAC entry info","https://developer.cisco.com/meraki/api-v1/update-organization-wireless-ssids-firewall-isolation-allowlist-entry/","put","/organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId}","organizationId, entryId","client, description, mac","client, createdAt, description, entryId, id, lastUpdatedAt, mac, name, network, number, ssid","wireless, configure, ssids, firewall, isolation, allowlist, entries","wireless.updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry","" "GA","getOrganizationWirelessSsidsStatusesByDevice","List status information of all BSSIDs in your organization","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-ssids-statuses-by-device/","get","/organizations/{organizationId}/wireless/ssids/statuses/byDevice","organizationId, networkIds, serials, bssids, hideDisabled, perPage, startingAfter, endingBefore","","advertised, band, basicServiceSets, bssid, channel, channelWidth, counts, enabled, id, index, isBroadcasting, items, meta, name, network, number, power, radio, remaining, serial, ssid, total","wireless, monitor, ssids, statuses, byDevice","wireless.getOrganizationWirelessSsidsStatusesByDevice","wireless:telemetry:read" "beta","getOrganizationWirelessZigbeeByNetwork","Return list of Zigbee configs","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-zigbee-by-network/","get","/organizations/{organizationId}/wireless/zigbee/byNetwork","organizationId, perPage, startingAfter, endingBefore, networkIds","","address, channel, defaults, enabled, id, iotController, lockManagement, mac, name, network, serial, status, transmitPowerLevel, username","wireless, configure, zigbee, byNetwork","wireless.getOrganizationWirelessZigbeeByNetwork","" "beta","getOrganizationWirelessZigbeeDevices","List the Zigbee MR Nodes for and organization or the supplied network(s)","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-zigbee-devices/","get","/organizations/{organizationId}/wireless/zigbee/devices","organizationId, perPage, startingAfter, endingBefore, networkIds, isEnrolled, search","","byStatus, channel, counts, doorLocks, dormant, enrolled, gateway, id, mac, name, network, offline, online, panId, serial, status, tags, transmitPowerLevel","wireless, configure, zigbee, devices","wireless.getOrganizationWirelessZigbeeDevices","" -"beta","updateOrganizationWirelessZigbeeDevice","Endpoint to update zigbee gateways","https://developer.cisco.com/meraki/api-v1/update-organization-wireless-zigbee-device/","put","/organizations/{organizationId}/wireless/zigbee/devices/{id}","organizationId, id","enrolled","byStatus, channel, counts, doorLocks, dormant, enrolled, gateway, id, mac, name, network, offline, online, panId, serial, status, tags, transmitPowerLevel","wireless, configure, zigbee, devices","wireless.updateOrganizationWirelessZigbeeDevice","" +"beta","updateOrganizationWirelessZigbeeDevice","Endpoint to update zigbee gateways","https://developer.cisco.com/meraki/api-v1/update-organization-wireless-zigbee-device/","put","/organizations/{organizationId}/wireless/zigbee/devices/{id}","organizationId, id","channel, enrolled","byStatus, channel, counts, doorLocks, dormant, enrolled, gateway, id, mac, name, network, offline, online, panId, serial, status, tags, transmitPowerLevel","wireless, configure, zigbee, devices","wireless.updateOrganizationWirelessZigbeeDevice","" "beta","createOrganizationWirelessZigbeeDisenrollment","Enqueue a job to start disenrolling doorlocks on zigbee configured MRs","https://developer.cisco.com/meraki/api-v1/create-organization-wireless-zigbee-disenrollment/","post","/organizations/{organizationId}/wireless/zigbee/disenrollments","organizationId","doorLockIds","disenrollmentId, doorLockIds, request, status, url","wireless, configure, zigbee, disenrollments","wireless.createOrganizationWirelessZigbeeDisenrollment","" "beta","getOrganizationWirelessZigbeeDisenrollment","Return a disenrollment job","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-zigbee-disenrollment/","get","/organizations/{organizationId}/wireless/zigbee/disenrollments/{id}","organizationId, id","","disenrollmentId, doorLockId, doorLockIds, doorLocks, request, status, url","wireless, configure, zigbee, disenrollments","wireless.getOrganizationWirelessZigbeeDisenrollment","" "beta","getOrganizationWirelessZigbeeDoorLocks","Return the list of doorlocks for a network","https://developer.cisco.com/meraki/api-v1/get-organization-wireless-zigbee-door-locks/","get","/organizations/{organizationId}/wireless/zigbee/doorLocks","organizationId, networkIds, serial, perPage, startingAfter, endingBefore","","doorLockId, enrolledAt, eui64, gateway, id, lastSeenAt, lqi, name, network, rssi, serial, shortId, status","wireless, configure, zigbee, doorLocks","wireless.getOrganizationWirelessZigbeeDoorLocks","" diff --git a/docs/api-index/meraki-api-index.html b/docs/api-index/meraki-api-index.html index da9612a..0db6cb9 100644 --- a/docs/api-index/meraki-api-index.html +++ b/docs/api-index/meraki-api-index.html @@ -54,7 +54,9 @@ GET /administered/licensing/subscription/entitlements
Retrieve the list of purchasable entitlements
> getAdministeredLicensingSubscriptionEntitlements
skus `` featureTier, isAddOn, name, productClass, productType, sku `` - GET /administered/licensing/subscription/subscriptions
List available subscriptions
> getAdministeredLicensingSubscriptionSubscriptions
perPage, startingAfter, endingBefore, subscriptionIds, organizationIds, statuses, productTypes, name, startDate, endDate `` account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId `` + POST /administered/licensing/subscription/networks/featureTiers/batchUpdate
Batch change networks to their desired feature tier for specified product types (BETA)
> batchAdministeredLicensingSubscriptionNetworksFeatureTiersUpdate
`` featureTier, id, isAtomic, items, network, productType, productTypes error, errors, featureTier, id, items, network, productType, productTypes `` + + GET /administered/licensing/subscription/subscriptions
List available subscriptions
> getAdministeredLicensingSubscriptionSubscriptions
perPage, startingAfter, endingBefore, subscriptionIds, organizationIds, statuses, productTypes, skus, name, startDate, endDate `` account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId `` POST /administered/licensing/subscription/subscriptions/claim
Claim a subscription into an organization.
> claimAdministeredLicensingSubscriptionSubscriptions
validate claimKey, description, name, organizationId account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId `` @@ -94,7 +96,7 @@ GET /devices/{serial}/camera/analytics/recent
Returns most recent record for analytics zones (DEPRECATED)
> getDeviceCameraAnalyticsRecent
serial, objectType `` averageCount, endTs, entrances, startTs, zoneId `` - GET /devices/{serial}/camera/analytics/zones
Returns all configured analytic zones for this camera (DEPRECATED)
> getDeviceCameraAnalyticsZones
serial `` id, label, regionOfInterest, type, x0, x1, y0, y1 `` + GET /devices/{serial}/camera/analytics/zones
Returns all configured analytic zones for this camera (DEPRECATED)
> getDeviceCameraAnalyticsZones
serial `` id, label, regionOfInterest, type, x0, x1, y0, y1 camera:config:read GET /devices/{serial}/camera/analytics/zones/{zoneId}/history
Return historical records for analytic zones (DEPRECATED)
> getDeviceCameraAnalyticsZoneHistory
serial, zoneId, t0, t1, timespan, resolution, objectType `` averageCount, endTs, entrances, startTs `` @@ -102,7 +104,7 @@ PUT /devices/{serial}/camera/customAnalytics
Update custom analytics settings for a camera
> updateDeviceCameraCustomAnalytics
serial artifactId, enabled, name, parameters, value artifactId, enabled, name, parameters, value camera:config:write - POST /devices/{serial}/camera/generateSnapshot
Generate a snapshot of what the camera sees at the specified time and return a link to that image.
> generateDeviceCameraSnapshot
serial fullframe, timestamp expiry, url camera:config:write + POST /devices/{serial}/camera/generateSnapshot
Generate a snapshot of what the camera sees at the specified time and return a link to that image.
> generateDeviceCameraSnapshot
serial fullframe, timestamp expiry, url camera:telemetry:write GET /devices/{serial}/camera/qualityAndRetention
Returns quality and retention settings for the given camera
> getDeviceCameraQualityAndRetention
serial `` `` camera:config:read @@ -154,13 +156,25 @@ GET /devices/{serial}/liveTools/cyclePort/{id}
Return a cycle port live tool job. (BETA)
> getDeviceLiveToolsCyclePort
serial, id `` cyclePortId, error, ports, request, serial, status, url dashboard:general:config:read + POST /devices/{serial}/liveTools/dhcpLeases
Enqueue a job to perform a DHCP leases request for the device (BETA)
> createDeviceLiveToolsDhcpLease
serial callback, httpServer, id, payloadTemplate, sharedSecret, url callback, dhcpLeasesId, id, request, serial, status, url `` + + GET /devices/{serial}/liveTools/dhcpLeases/{dhcpLeasesId}
Return a DHCP leases live tool job. (BETA)
> getDeviceLiveToolsDhcpLease
serial, dhcpLeasesId `` dhcpLeases, dhcpLeasesId, error, expiresAt, ip, mac, request, serial, status, url `` + POST /devices/{serial}/liveTools/leds/blink
Enqueue a job to blink LEDs on a device
> createDeviceLiveToolsLedsBlink
serial callback, duration, httpServer, id, payloadTemplate, sharedSecret, url callback, duration, error, id, ledsBlinkId, request, serial, status, url dashboard:general:config:write GET /devices/{serial}/liveTools/leds/blink/{ledsBlinkId}
Return a blink LEDs job
> getDeviceLiveToolsLedsBlink
serial, ledsBlinkId `` duration, error, ledsBlinkId, request, serial, status, url dashboard:general:config:read - POST /devices/{serial}/liveTools/macTable
Enqueue a job to request the MAC table from the device (BETA)
> createDeviceLiveToolsMacTable
serial callback, httpServer, id, payloadTemplate, sharedSecret, url callback, id, macTableId, request, serial, status, url dashboard:general:telemetry:write + POST /devices/{serial}/liveTools/macTable
Enqueue a job to request the MAC table from the device
> createDeviceLiveToolsMacTable
serial callback, httpServer, id, payloadTemplate, sharedSecret, url callback, id, macTableId, request, serial, status, url dashboard:general:telemetry:write + + GET /devices/{serial}/liveTools/macTable/{macTableId}
Return a MAC table live tool job.
> getDeviceLiveToolsMacTable
serial, macTableId `` entries, error, mac, macTableId, port, request, serial, status, url, vlanId dashboard:general:telemetry:read - GET /devices/{serial}/liveTools/macTable/{macTableId}
Return a MAC table live tool job. (BETA)
> getDeviceLiveToolsMacTable
serial, macTableId `` entries, error, mac, macTableId, port, request, serial, status, url, vlanId dashboard:general:telemetry:read + POST /devices/{serial}/liveTools/multicastRouting
Enqueue a job to perform a Multicast routing request for the device (BETA)
> createDeviceLiveToolsMulticastRouting
serial callback, httpServer, id, payloadTemplate, sharedSecret, url callback, id, multicastRoutingId, request, serial, status, url `` + + GET /devices/{serial}/liveTools/multicastRouting/{multicastRoutingId}
Return a Multicast routing live tool job. (BETA)
> getDeviceLiveToolsMulticastRouting
serial, multicastRoutingId `` error, flags, group, incomingInterfaceName, interfaces, ip, multicastRoutingId, name, neighbors, outgoingInterfaceNames, rendezvousPoint, request, routes, serial, source, status, subnet, url `` + + POST /devices/{serial}/liveTools/ospfNeighbors
Enqueue a job to perform a OSPF neighbors request for the device (BETA)
> createDeviceLiveToolsOspfNeighbor
serial callback, httpServer, id, payloadTemplate, sharedSecret, url callback, id, ospfNeighborsId, request, serial, status, url `` + + GET /devices/{serial}/liveTools/ospfNeighbors/{ospfNeighborsId}
Return an OSPF neighbors live tool job. (BETA)
> getDeviceLiveToolsOspfNeighbor
serial, ospfNeighborsId `` error, id, ip, name, ospfNeighborsId, position, request, routers, serial, state, status, url, vlanId `` POST /devices/{serial}/liveTools/ping
Enqueue a job to ping a target host from the device
> createDeviceLiveToolsPing
serial callback, count, httpServer, id, payloadTemplate, sharedSecret, target, url callback, count, id, pingId, request, serial, status, target, url dashboard:general:telemetry:write @@ -210,7 +224,7 @@ PUT /devices/{serial}/sensor/relationships
Assign one or more sensor roles to a given sensor or camera device.
> updateDeviceSensorRelationships
serial livestream, relatedDevices, serial livestream, productType, relatedDevices, serial sensor:config:write - GET /devices/{serial}/switch/ports
List the switch ports for a switch
> getDeviceSwitchPorts
serial `` accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:read + GET /devices/{serial}/switch/ports
List the switch ports for a switch
> getDeviceSwitchPorts
serial `` accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:read POST /devices/{serial}/switch/ports/cycle
Cycle a set of switch ports
> cycleDeviceSwitchPorts
serial ports ports switch:config:write @@ -220,17 +234,17 @@ GET /devices/{serial}/switch/ports/statuses/packets
Return the packet counters for all the ports of a switch
> getDeviceSwitchPortsStatusesPackets
serial, t0, timespan `` desc, packets, portId, ratePerSec, recv, sent, total switch:telemetry:read - GET /devices/{serial}/switch/ports/{portId}
Return a switch port
> getDeviceSwitchPort
serial, portId `` accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:read + GET /devices/{serial}/switch/ports/{portId}
Return a switch port
> getDeviceSwitchPort
serial, portId `` accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:read - PUT /devices/{serial}/switch/ports/{portId}
Update a switch port
> updateDeviceSwitchPort
serial, portId accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, name, peerSgtCapable, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:write + PUT /devices/{serial}/switch/ports/{portId}
Update a switch port
> updateDeviceSwitchPort
serial, portId accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, macWhitelistLimit, name, peerSgtCapable, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:write - GET /devices/{serial}/switch/routing/interfaces
List layer 3 interfaces for a switch
> getDeviceSwitchRoutingInterfaces
serial, mode, protocol `` address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId switch:config:read + GET /devices/{serial}/switch/routing/interfaces
List layer 3 interfaces for a switch
> getDeviceSwitchRoutingInterfaces
serial, protocol `` address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId switch:config:read - POST /devices/{serial}/switch/routing/interfaces
Create a layer 3 interface for a switch
> createDeviceSwitchRoutingInterface
serial address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId switch:config:write + POST /devices/{serial}/switch/routing/interfaces
Create a layer 3 interface for a switch
> createDeviceSwitchRoutingInterface
serial address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId switch:config:write - GET /devices/{serial}/switch/routing/interfaces/{interfaceId}
Return a layer 3 interface for a switch
> getDeviceSwitchRoutingInterface
serial, interfaceId `` address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId switch:config:read + GET /devices/{serial}/switch/routing/interfaces/{interfaceId}
Return a layer 3 interface for a switch
> getDeviceSwitchRoutingInterface
serial, interfaceId `` address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId switch:config:read - PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}
Update a layer 3 interface for a switch
> updateDeviceSwitchRoutingInterface
serial, interfaceId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId switch:config:write + PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}
Update a layer 3 interface for a switch
> updateDeviceSwitchRoutingInterface
serial, interfaceId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId switch:config:write DELETE /devices/{serial}/switch/routing/interfaces/{interfaceId}
Delete a layer 3 interface from the switch
> deleteDeviceSwitchRoutingInterface
serial, interfaceId `` `` switch:config:write @@ -274,9 +288,9 @@ GET /devices/{serial}/wireless/radio/afc/powerLimits
Return the AFC power limits for a wireless device (BETA)
> getDeviceWirelessRadioAfcPowerLimits
serial `` byChannel, channel, channelWidth, expiresAt, id, lastSuccessAt, lastUpdatedAt, lat, limit, lng, location, name, network, serial, status, type, uncertainty `` - GET /devices/{serial}/wireless/radio/settings
Return the radio settings of a device
> getDeviceWirelessRadioSettings
serial `` `` wireless:config:read + GET /devices/{serial}/wireless/radio/settings
Return the manually configured radio settings overrides of a device, which take precedence over RF profiles.
> getDeviceWirelessRadioSettings
serial `` `` wireless:config:read - PUT /devices/{serial}/wireless/radio/settings
Update the radio settings of a device
> updateDeviceWirelessRadioSettings
serial channel, channelWidth, fiveGhzSettings, rfProfileId, targetPower, twoFourGhzSettings `` wireless:config:write + PUT /devices/{serial}/wireless/radio/settings
Update the radio settings overrides of a device, which take precedence over RF profiles.
> updateDeviceWirelessRadioSettings
serial channel, channelWidth, fiveGhzSettings, rfProfileId, targetPower, twoFourGhzSettings `` wireless:config:write GET /devices/{serial}/wireless/status
Return the SSID statuses of an access point
> getDeviceWirelessStatus
serial `` band, basicServiceSets, broadcasting, bssid, channel, channelWidth, enabled, power, ssidName, ssidNumber, visible wireless:telemetry:read @@ -444,6 +458,18 @@ PUT /networks/{networkId}/appliance/trafficShaping/vpnExclusions
Update VPN exclusion rules for an MX network.
> updateNetworkApplianceTrafficShapingVpnExclusions
networkId custom, destination, id, majorApplications, name, port, protocol custom, destination, id, majorApplications, name, networkId, networkName, port, protocol sdwan:config:write + POST /networks/{networkId}/appliance/umbrella/account/connect
Connect to Cisco Umbrella account to this network (BETA)
> connectNetworkApplianceUmbrellaAccount
networkId apiKey, apiSecret umbrellaOrganizationId `` + + DELETE /networks/{networkId}/appliance/umbrella/account/disconnect
Disconnect Umbrella account from this network (BETA)
> disconnectNetworkApplianceUmbrellaAccount
networkId `` message, success `` + + DELETE /networks/{networkId}/appliance/umbrella/disableProtection
Disable umbrella protection for an MX network (BETA)
> disableNetworkApplianceUmbrellaProtection
networkId `` message, success `` + + POST /networks/{networkId}/appliance/umbrella/enableProtection
Enable umbrella protection for an MX network (BETA)
> enableNetworkApplianceUmbrellaProtection
networkId `` message, success `` + + PUT /networks/{networkId}/appliance/umbrella/excludeDomains
Specify one or more domain names to be excluded from being routed to Cisco Umbrella. (BETA)
> excludeNetworkApplianceUmbrellaDomains
networkId domains message, success `` + + PUT /networks/{networkId}/appliance/umbrella/policies
Update umbrella policies applied to MX network. (BETA)
> policiesNetworkApplianceUmbrella
networkId policyIds message, success `` + GET /networks/{networkId}/appliance/uplinks/usageHistory
Get the sent and received bytes for each uplink of a network.
> getNetworkApplianceUplinksUsageHistory
networkId, t0, t1, timespan, resolution `` byInterface, endTime, interface, received, sent, startTime sdwan:telemetry:read GET /networks/{networkId}/appliance/vlans
List the VLANs for an MX network
> getNetworkApplianceVlans
networkId `` applianceIp, autonomous, cidr, code, comment, dhcpBootFilename, dhcpBootNextServer, dhcpBootOptionsEnabled, dhcpHandling, dhcpLeaseTime, dhcpOptions, dhcpRelayServerIps, dnsNameservers, enabled, end, fixedIpAssignments, groupPolicyId, id, interfaceId, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, reservedIpRanges, start, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type, value, vpnNatSubnet sdwan:config:read @@ -482,11 +508,11 @@ GET /networks/{networkId}/camera/qualityRetentionProfiles
List the quality retention profiles for this network
> getNetworkCameraQualityRetentionProfiles
networkId `` `` camera:config:read - POST /networks/{networkId}/camera/qualityRetentionProfiles
Creates new quality retention profile for this network.
> createNetworkCameraQualityRetentionProfile
networkId MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings `` camera:config:write + POST /networks/{networkId}/camera/qualityRetentionProfiles
Creates new quality retention profile for this network.
> createNetworkCameraQualityRetentionProfile
networkId MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV84X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings `` camera:config:write GET /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
Retrieve a single quality retention profile
> getNetworkCameraQualityRetentionProfile
networkId, qualityRetentionProfileId `` `` camera:config:read - PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
Update an existing quality retention profile for this network.
> updateNetworkCameraQualityRetentionProfile
networkId, qualityRetentionProfileId MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings `` camera:config:write + PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
Update an existing quality retention profile for this network.
> updateNetworkCameraQualityRetentionProfile
networkId, qualityRetentionProfileId MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV84X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings `` camera:config:write DELETE /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
Delete an existing quality retention profile for this network.
> deleteNetworkCameraQualityRetentionProfile
networkId, qualityRetentionProfileId `` `` camera:config:write @@ -534,7 +560,7 @@ GET /networks/{networkId}/clients/usageHistories
Return the usage histories for clients
> getNetworkClientsUsageHistories
networkId, clients, ssidNumber, perPage, startingAfter, endingBefore, t0, t1, timespan `` `` dashboard:general:telemetry:read - GET /networks/{networkId}/clients/{clientId}
Return the client associated with the given identifier
> getNetworkClient
networkId, clientId `` cdp, clientVpnConnections, connectedAt, description, disconnectedAt, firstSeen, id, ip, ip6, lastSeen, lldp, mac, manufacturer, notes, os, recentDeviceConnection, recentDeviceMac, recentDeviceName, recentDeviceSerial, remoteIp, smInstalled, ssid, status, switchport, user, vlan, wirelessCapabilities dashboard:general:telemetry:read + GET /networks/{networkId}/clients/{clientId}
Return the client associated with the given identifier
> getNetworkClient
networkId, clientId `` cdp, clientVpnConnections, connectedAt, description, deviceTypePrediction, disconnectedAt, firstSeen, id, ip, ip6, lastSeen, lldp, mac, manufacturer, namedVlan, notes, os, recentDeviceConnection, recentDeviceMac, recentDeviceName, recentDeviceSerial, remoteIp, smInstalled, ssid, status, switchport, user, vlan, wirelessCapabilities dashboard:general:telemetry:read GET /networks/{networkId}/clients/{clientId}/policy
Return the policy assigned to a client on the network
> getNetworkClientPolicy
networkId, clientId `` devicePolicy, groupPolicyId, mac dashboard:general:config:read @@ -678,13 +704,13 @@ GET /networks/{networkId}/sensor/alerts/overview/byMetric
Return an overview of alert occurrences over a timespan, by metric
> getNetworkSensorAlertsOverviewByMetric
networkId, t0, t1, timespan, interval `` ambient, apparentPower, co2, counts, current, door, endTs, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, startTs, temperature, tvoc, upstreamPower, voltage, water sensor:telemetry:read - GET /networks/{networkId}/sensor/alerts/profiles
Lists all sensor alert profiles for a network.
> getNetworkSensorAlertsProfiles
networkId `` ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water sensor:telemetry:read + GET /networks/{networkId}/sensor/alerts/profiles
Lists all sensor alert profiles for a network.
> getNetworkSensorAlertsProfiles
networkId `` ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water sensor:telemetry:read - POST /networks/{networkId}/sensor/alerts/profiles
Creates a sensor alert profile for a network.
> createNetworkSensorAlertsProfile
networkId ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water sensor:telemetry:write + POST /networks/{networkId}/sensor/alerts/profiles
Creates a sensor alert profile for a network.
> createNetworkSensorAlertsProfile
networkId ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water sensor:telemetry:write - GET /networks/{networkId}/sensor/alerts/profiles/{id}
Show details of a sensor alert profile for a network.
> getNetworkSensorAlertsProfile
networkId, id `` ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water sensor:telemetry:read + GET /networks/{networkId}/sensor/alerts/profiles/{id}
Show details of a sensor alert profile for a network.
> getNetworkSensorAlertsProfile
networkId, id `` ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water sensor:telemetry:read - PUT /networks/{networkId}/sensor/alerts/profiles/{id}
Updates a sensor alert profile for a network.
> updateNetworkSensorAlertsProfile
networkId, id ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water sensor:telemetry:write + PUT /networks/{networkId}/sensor/alerts/profiles/{id}
Updates a sensor alert profile for a network.
> updateNetworkSensorAlertsProfile
networkId, id ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water sensor:telemetry:write DELETE /networks/{networkId}/sensor/alerts/profiles/{id}
Deletes a sensor alert profile from a network.
> deleteNetworkSensorAlertsProfile
networkId, id `` `` sensor:telemetry:write @@ -794,13 +820,13 @@ PUT /networks/{networkId}/switch/accessControlLists
Update the access control lists for a MS network
> updateNetworkSwitchAccessControlLists
networkId comment, dstCidr, dstPort, ipVersion, policy, protocol, rules, srcCidr, srcPort, vlan comment, dstCidr, dstPort, ipVersion, policy, protocol, rules, srcCidr, srcPort, vlan switch:config:write - GET /networks/{networkId}/switch/accessPolicies
List the access policies for a switch network
> getNetworkSwitchAccessPolicies
networkId `` accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy switch:config:read + GET /networks/{networkId}/switch/accessPolicies
List the access policies for a switch network
> getNetworkSwitchAccessPolicies
networkId `` accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy switch:config:read - POST /networks/{networkId}/switch/accessPolicies
Create an access policy for a switch network
> createNetworkSwitchAccessPolicy
networkId accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy switch:config:write + POST /networks/{networkId}/switch/accessPolicies
Create an access policy for a switch network
> createNetworkSwitchAccessPolicy
networkId accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy switch:config:write - GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
Return a specific access policy for a switch network
> getNetworkSwitchAccessPolicy
networkId, accessPolicyNumber `` accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy switch:config:read + GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
Return a specific access policy for a switch network
> getNetworkSwitchAccessPolicy
networkId, accessPolicyNumber `` accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy switch:config:read - PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
Update an access policy for a switch network
> updateNetworkSwitchAccessPolicy
networkId, accessPolicyNumber accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy switch:config:write + PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
Update an access policy for a switch network
> updateNetworkSwitchAccessPolicy
networkId, accessPolicyNumber accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy switch:config:write DELETE /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
Delete an access policy for a switch network
> deleteNetworkSwitchAccessPolicy
networkId, accessPolicyNumber `` `` switch:config:write @@ -906,13 +932,13 @@ POST /networks/{networkId}/switch/stacks/{switchStackId}/remove
Remove a switch from a stack
> removeNetworkSwitchStack
networkId, switchStackId serial id, isMonitorOnly, mac, members, model, name, role, serial, serials switch:config:write - GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
List layer 3 interfaces for a switch stack
> getNetworkSwitchStackRoutingInterfaces
networkId, switchStackId `` address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId switch:config:read + GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
List layer 3 interfaces for a switch stack
> getNetworkSwitchStackRoutingInterfaces
networkId, switchStackId, protocol `` address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId switch:config:read - POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
Create a layer 3 interface for a switch stack
> createNetworkSwitchStackRoutingInterface
networkId, switchStackId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId switch:config:write + POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
Create a layer 3 interface for a switch stack
> createNetworkSwitchStackRoutingInterface
networkId, switchStackId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId switch:config:write - GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
Return a layer 3 interface from a switch stack
> getNetworkSwitchStackRoutingInterface
networkId, switchStackId, interfaceId `` address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId switch:config:read + GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
Return a layer 3 interface from a switch stack
> getNetworkSwitchStackRoutingInterface
networkId, switchStackId, interfaceId `` address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId switch:config:read - PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
Update a layer 3 interface for a switch stack
> updateNetworkSwitchStackRoutingInterface
networkId, switchStackId, interfaceId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId address, area, assignmentMode, cost, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId switch:config:write + PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
Update a layer 3 interface for a switch stack
> updateNetworkSwitchStackRoutingInterface
networkId, switchStackId, interfaceId address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId address, area, assignmentMode, cost, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId switch:config:write DELETE /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
Delete a layer 3 interface from a switch stack
> deleteNetworkSwitchStackRoutingInterface
networkId, switchStackId, interfaceId `` `` switch:config:write @@ -1074,7 +1100,7 @@ GET /networks/{networkId}/wireless/latencyStats
Aggregated latency info for this network
> getNetworkWirelessLatencyStats
networkId, t0, t1, timespan, band, ssid, vlan, apTag, fields `` `` wireless:telemetry:read - PUT /networks/{networkId}/wireless/location/scanning
Change scanning API settings (BETA)
> updateNetworkWirelessLocationScanning
networkId api, enabled api, enabled, string, validator wireless:telemetry:write + PUT /networks/{networkId}/wireless/location/scanning
Change scanning API settings
> updateNetworkWirelessLocationScanning
networkId api, enabled api, enabled, string, validator wireless:telemetry:write GET /networks/{networkId}/wireless/meshStatuses
List wireless mesh statuses for repeaters
> getNetworkWirelessMeshStatuses
networkId, perPage, startingAfter, endingBefore `` latestMeshPerformance, mbps, meshRoute, metric, serial, usagePercentage wireless:telemetry:read @@ -1102,7 +1128,7 @@ GET /networks/{networkId}/wireless/ssids/{number}
Return a single MR SSID
> getNetworkWirelessSsid
networkId, number `` adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode wireless:config:read - PUT /networks/{networkId}/wireless/ssids/{number}
Update the attributes of an MR SSID
> updateNetworkWirelessSsid
networkId, number activeDirectory, adaptive, adultContentFilteringEnabled, allowedDomains, apTagsAndVlanIds, authMode, availabilityTags, availableOnAllAps, bandSelection, baseDistinguishedName, byApTags, caCertificate, cacheTimeout, certificateAuthentication, clientRootCaCertificate, concentrator, concentratorNetworkId, contents, credentials, defaultVlanId, defaultVlanName, disassociateClientsOnVpnFailover, distinguishedName, dnsCustomNameservers, dnsRewrite, dot11r, dot11w, enabled, encryptionMode, enterpriseAdminAccess, gre, guestVlan, host, ipAssignmentMode, key, lanIsolationEnabled, ldap, localRadius, logonName, mandatoryDhcpEnabled, minBitrate, name, namedVlans, oauth, ocspResponderUrl, openRoamingCertificateId, password, passwordAuthentication, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, psk, radius, radiusAccountingEnabled, radiusAccountingInterimInterval, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusAuthenticationNasId, radiusCalledStationId, radiusCoaEnabled, radiusFailoverPolicy, radiusFallbackEnabled, radiusGuestVlanEnabled, radiusGuestVlanId, radiusLoadBalancingPolicy, radiusOverride, radiusProxyEnabled, radiusRadsec, radiusServerAttemptsLimit, radiusServerTimeout, radiusServers, radiusTestingEnabled, radsecEnabled, required, secondaryConcentratorNetworkId, secret, serverCaCertificate, servers, speedBurst, splashGuestSponsorDomains, splashPage, tagging, tags, timeout, tlsTunnel, useLdap, useOcsp, useVlanTagging, visible, vlanId, vlanName, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode wireless:config:write + PUT /networks/{networkId}/wireless/ssids/{number}
Update the attributes of an MR SSID
> updateNetworkWirelessSsid
networkId, number activeDirectory, adaptive, adaptivePolicyGroupId, adultContentFilteringEnabled, allowedDomains, apTagsAndVlanIds, authMode, availabilityTags, availableOnAllAps, bandSelection, baseDistinguishedName, byApTags, caCertificate, cacheTimeout, certificateAuthentication, clientRootCaCertificate, concentrator, concentratorNetworkId, contents, credentials, defaultVlanId, defaultVlanName, disassociateClientsOnVpnFailover, distinguishedName, dnsCustomNameservers, dnsRewrite, dot11r, dot11w, enabled, encryptionMode, enterpriseAdminAccess, gre, guestVlan, host, ipAssignmentMode, key, lanIsolationEnabled, ldap, localRadius, logonName, mandatoryDhcpEnabled, minBitrate, name, namedVlans, oauth, ocspResponderUrl, openRoamingCertificateId, password, passwordAuthentication, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, psk, radius, radiusAccountingEnabled, radiusAccountingInterimInterval, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusAuthenticationNasId, radiusCalledStationId, radiusCoaEnabled, radiusFailoverPolicy, radiusFallbackEnabled, radiusGuestVlanEnabled, radiusGuestVlanId, radiusLoadBalancingPolicy, radiusOverride, radiusProxyEnabled, radiusRadsec, radiusServerAttemptsLimit, radiusServerTimeout, radiusServers, radiusTestingEnabled, radsecEnabled, required, secondaryConcentratorNetworkId, secret, serverCaCertificate, servers, speedBurst, splashGuestSponsorDomains, splashPage, tagging, tags, timeout, tlsTunnel, useLdap, useOcsp, useVlanTagging, visible, vlanId, vlanName, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode wireless:config:write GET /networks/{networkId}/wireless/ssids/{number}/bonjourForwarding
List the Bonjour forwarding setting and rules for the SSID
> getNetworkWirelessSsidBonjourForwarding
networkId, number `` description, enabled, exception, rules, services, vlanId wireless:config:read @@ -1242,7 +1268,7 @@ GET /organizations/{organizationId}/appliance/dns/local/profiles/assignments
Fetch the local DNS profile assignments in the organization
> getOrganizationApplianceDnsLocalProfilesAssignments
organizationId, profileIds, networkIds `` assignmentId, counts, id, items, meta, network, profile, remaining, total `` - POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate
Assign the local DNS profile to networks in the organization
> createOrganizationApplianceDnsLocalProfilesAssignmentsBulkCreate
organizationId id, items, network, profile assignmentId, id, items, network, profile `` + POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate
Assign the local DNS profile to networks in the organization
> bulkOrganizationApplianceDnsLocalProfilesAssignmentsCreate
organizationId id, items, network, profile assignmentId, id, items, network, profile `` POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkDelete
Unassign the local DNS profile to networks in the organization
> createOrganizationApplianceDnsLocalProfilesAssignmentsBulkDelete
organizationId assignmentId, items assignmentId, id, items, network, profile `` @@ -1290,6 +1316,8 @@ GET /organizations/{organizationId}/appliance/uplinks/usage/byNetwork
Get the sent and received bytes for each uplink of all MX and Z networks within an organization
> getOrganizationApplianceUplinksUsageByNetwork
organizationId, t0, t1, timespan `` byUplink, interface, name, networkId, received, sent, serial sdwan:telemetry:read + GET /organizations/{organizationId}/appliance/vlans
List the VLANs for an Organization (BETA)
> getOrganizationApplianceVlans
organizationId, perPage, startingAfter, endingBefore `` applianceIp, autonomous, cidr, code, comment, dhcpBootFilename, dhcpBootNextServer, dhcpBootOptionsEnabled, dhcpHandling, dhcpLeaseTime, dhcpOptions, dhcpRelayServerIps, dnsNameservers, enabled, end, fixedIpAssignments, groupPolicyId, id, interfaceId, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, reservedIpRanges, start, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type, value, vpnNatSubnet `` + GET /organizations/{organizationId}/appliance/vpn/stats
Show VPN history stat for networks in an organization
> getOrganizationApplianceVpnStats
organizationId, perPage, startingAfter, endingBefore, networkIds, t0, t1, timespan `` avgJitter, avgLatencyMs, avgLossPercentage, avgMos, jitterSummaries, latencySummaries, lossPercentageSummaries, maxJitter, maxLatencyMs, maxLossPercentage, maxMos, merakiVpnPeers, minJitter, minLatencyMs, minLossPercentage, minMos, mosSummaries, networkId, networkName, receivedInKilobytes, receiverUplink, senderUplink, sentInKilobytes, usageSummary sdwan:telemetry:read GET /organizations/{organizationId}/appliance/vpn/statuses
Show VPN status for networks in an organization
> getOrganizationApplianceVpnStatuses
organizationId, perPage, startingAfter, endingBefore, networkIds `` deviceSerial, deviceStatus, exportedSubnets, interface, merakiVpnPeers, name, networkId, networkName, publicIp, reachability, subnet, thirdPartyVpnPeers, uplinks, vpnMode, vpnstatusentities sdwan:telemetry:read @@ -1302,7 +1330,7 @@ PUT /organizations/{organizationId}/appliance/vpn/vpnFirewallRules
Update the firewall rules of an organization's site-to-site VPN
> updateOrganizationApplianceVpnVpnFirewallRules
organizationId comment, destCidr, destPort, policy, protocol, rules, srcCidr, srcPort, syslogDefaultRule, syslogEnabled comment, destCidr, destPort, policy, protocol, rules, srcCidr, srcPort, syslogEnabled sdwan:config:write - GET /organizations/{organizationId}/assurance/alerts
Return all health alerts for an organization
> getOrganizationAssuranceAlerts
organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, sortBy, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes `` applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url `` + GET /organizations/{organizationId}/assurance/alerts
Return all health alerts for an organization
> getOrganizationAssuranceAlerts
organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, sortBy, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes `` applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, others, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url `` POST /organizations/{organizationId}/assurance/alerts/dismiss
Dismiss health alerts
> dismissOrganizationAssuranceAlerts
organizationId alertIds `` `` @@ -1316,7 +1344,9 @@ POST /organizations/{organizationId}/assurance/alerts/restore
Restore health alerts from dismissed
> restoreOrganizationAssuranceAlerts
organizationId alertIds `` `` - GET /organizations/{organizationId}/assurance/alerts/{id}
Return a singular Health Alert by its id
> getOrganizationAssuranceAlert
organizationId, id `` applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url `` + GET /organizations/{organizationId}/assurance/alerts/{id}
Return a singular Health Alert by its id
> getOrganizationAssuranceAlert
organizationId, id `` applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, others, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url `` + + GET /organizations/{organizationId}/assurance/productAnnouncements
Gets relevant product announcements for a user (BETA)
> getOrganizationAssuranceProductAnnouncements
organizationId, t0, timespan, onlyRelevant `` boardId, counts, editedAt, id, items, labels, meta, name, publishedAt, snippet, title, total, url `` GET /organizations/{organizationId}/auth/radius/servers
List the organization-wide RADIUS servers in the organization (BETA)
> getOrganizationAuthRadiusServers
organizationId `` address, mode, modes, name, port, serverId switch:config:read @@ -1378,6 +1408,8 @@ GET /organizations/{organizationId}/campusGateway/clusters
Get the details of campus gateway clusters (BETA)
> getOrganizationCampusGatewayClusters
organizationId, networkIds `` address, addresses, allowedVlans, assignmentMode, clusterId, devices, gateway, id, interface, memberId, name, nameservers, network, notes, portChannels, protocol, serial, subnetMask, tunnels, uplink, uplinks, url, vlan `` + GET /organizations/{organizationId}/campusGateway/devices/uplinks/localOverrides/byDevice
Uplink overrides configured locally on Campus Gateway devices in an organization. (BETA)
> getOrganizationCampusGatewayDevicesUplinksLocalOverridesByDevice
organizationId, serials, perPage, startingAfter, endingBefore `` address, addresses, assignmentMode, counts, gateway, interface, items, meta, nameservers, protocol, remaining, serial, sgt, subnetMask, total, uplink, vlan `` + GET /organizations/{organizationId}/cellularGateway/esims/inventory
The eSIM inventory of a given organization.
> getOrganizationCellularGatewayEsimsInventory
organizationId, eids `` active, counts, customApns, device, eid, iccid, id, items, lastUpdatedAt, meta, model, name, network, plans, profiles, remaining, serial, serviceProvider, status, total, type, url `` PUT /organizations/{organizationId}/cellularGateway/esims/inventory/{id}
Toggle the status of an eSIM
> updateOrganizationCellularGatewayEsimsInventory
organizationId, id status active, customApns, device, eid, iccid, id, lastUpdatedAt, model, name, network, plans, profiles, serial, serviceProvider, status, type, url `` @@ -1406,18 +1438,6 @@ POST /organizations/{organizationId}/certificates/import
Import certificate for this organization (BETA)
> createOrganizationCertificatesImport
organizationId contents, description, managedBy algorithm, certificateId, commonName, country, data, description, end, fields, hash, hashes, isCritical, issuer, keyUsage, locality, organization, organizationalUnit, parentCertificateId, policy, publicKeyAlgorithm, serial, signatureAlgorithmId, source, start, state, subject, subjectAlternativeName, validity, version dashboard:iam:config:write - GET /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities
Query for details on the organization's RADSEC device Certificate Authority certificates (CAs) (BETA)
> getOrganizationCertificatesRadSecDeviceCertificateAuthorities
organizationId `` authorityId, contents, status dashboard:iam:config:read - - POST /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities
Create an organization's RADSEC device Certificate Authority (CA) (BETA)
> createOrganizationCertificatesRadSecDeviceCertificateAuthority
organizationId `` authorityId, contents, status dashboard:iam:config:write - - GET /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}
Query for details on an organization's RADSEC device Certificate Authority (CA) with the given id (BETA)
> getOrganizationCertificatesRadSecDeviceCertificateAuthority
organizationId, id `` authorityId, contents, status `` - - PUT /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}
Update an organization's RADSEC device Certificate Authority (CA) state (BETA)
> updateOrganizationCertificatesRadSecDeviceCertificateAuthority
organizationId, id status authorityId, contents, status dashboard:iam:config:write - - GET /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}/revocationList
Query for certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id. (BETA)
> getOrganizationCertificatesRadSecDeviceCertificateAuthorityRevocationList
organizationId, id `` crl dashboard:iam:config:read - - GET /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}/revocationList/deltas
Query for all delta certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id. (BETA)
> getOrganizationCertificatesRadSecDeviceCertificateAuthorityRevocationListDeltas
organizationId, id `` deltaCrls dashboard:iam:config:read - DELETE /organizations/{organizationId}/certificates/{certificateId}
Delete a certificate for an organization (BETA)
> deleteOrganizationCertificate
organizationId, certificateId `` `` dashboard:iam:config:write PUT /organizations/{organizationId}/certificates/{certificateId}
Update a certificate's description for an organization (BETA)
> updateOrganizationCertificate
organizationId, certificateId description algorithm, certificateId, commonName, country, data, description, end, fields, hash, hashes, isCritical, issuer, keyUsage, locality, organization, organizationalUnit, parentCertificateId, policy, publicKeyAlgorithm, serial, signatureAlgorithmId, source, start, state, subject, subjectAlternativeName, validity, version dashboard:iam:config:write @@ -1450,13 +1470,13 @@ GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles
List the switch templates for your switch template configuration
> getOrganizationConfigTemplateSwitchProfiles
organizationId, configTemplateId `` model, name, switchProfileId switch:config:read - GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports
Return all the ports of a switch template
> getOrganizationConfigTemplateSwitchProfilePorts
organizationId, configTemplateId, profileId `` accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:read + GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports
Return all the ports of a switch template
> getOrganizationConfigTemplateSwitchProfilePorts
organizationId, configTemplateId, profileId `` accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:read PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/mirror
Update a port mirror (BETA)
> updateOrganizationConfigTemplateSwitchProfilePortsMirror
organizationId, configTemplateId, profileId comment, destination, filter, hasTransitVlan, module, number, port, ports, role, slot, source, tags, type, vlan, vlans comment, configTemplate, destination, filter, hasTransitVlan, id, mirror, module, name, number, port, ports, profileId, role, slot, source, tags, type, vlan, vlans, warnings `` - GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
Return a switch template port
> getOrganizationConfigTemplateSwitchProfilePort
organizationId, configTemplateId, profileId, portId `` accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:read + GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
Return a switch template port
> getOrganizationConfigTemplateSwitchProfilePort
organizationId, configTemplateId, profileId, portId `` accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:read - PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
Update a switch template port
> updateOrganizationConfigTemplateSwitchProfilePort
organizationId, configTemplateId, profileId, portId accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, name, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:write + PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
Update a switch template port
> updateOrganizationConfigTemplateSwitchProfilePort
organizationId, configTemplateId, profileId, portId accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, macWhitelistLimit, name, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan switch:config:write GET /organizations/{organizationId}/configurationChanges
View the Change Log for your organization
> getOrganizationConfigurationChanges
organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, networkId, adminId `` adminEmail, adminId, adminName, client, id, label, networkId, networkName, networkUrl, newValue, oldValue, page, ssidName, ssidNumber, ts, type dashboard:general:config:read @@ -1466,7 +1486,7 @@ GET /organizations/{organizationId}/devices/availabilities/changeHistory
List the availability history information for devices in an organization.
> getOrganizationDevicesAvailabilitiesChangeHistory
organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, serials, productTypes, networkIds, statuses, categories, networkTags, networkTagsFilterType, deviceTags, deviceTagsFilterType `` category, details, device, id, model, name, network, new, old, productType, serial, tags, ts, url, value dashboard:general:telemetry:read - GET /organizations/{organizationId}/devices/boots/history
Returns the history of device boots in reverse chronological order (most recent first) (BETA)
> getOrganizationDevicesBootsHistory
organizationId, t0, t1, timespan, serials, mostRecentPerDevice, perPage, startingAfter, endingBefore, sortOrder `` bootedAt, id, network, serial, start `` + GET /organizations/{organizationId}/devices/boots/history
Returns the history of device boots in reverse chronological order (most recent first) (BETA)
> getOrganizationDevicesBootsHistory
organizationId, t0, t1, timespan, serials, productTypes, mostRecentPerDevice, perPage, startingAfter, endingBefore, sortOrder `` bootedAt, id, network, serial, start `` POST /organizations/{organizationId}/devices/controller/migrations
Migrate devices to another controller or management mode
> createOrganizationDevicesControllerMigration
organizationId serials, target createdAt, migratedAt, serial, target `` @@ -1476,25 +1496,35 @@ GET /organizations/{organizationId}/devices/overview/byModel
Lists the count for each device model
> getOrganizationDevicesOverviewByModel
organizationId, models, networkIds, productTypes `` counts, model, total `` - GET /organizations/{organizationId}/devices/packetCapture/captures
List Packet Captures (BETA)
> getOrganizationDevicesPacketCaptureCaptures
organizationId, captureIds, networkIds, serials, captureSource, captureStatus, name, clientMac, captureReason, device, userName, perPage, startingAfter, endingBefore, sortOrder `` autopcapType, captureId, captureReason, captureSource, client, counts, device, devices, duration, errorMessage, fileSize, filterExpression, id, interfaces, items, mac, meta, name, network, outputType, packetCount, ports, remaining, serial, startTime, status, total, user `` + GET /organizations/{organizationId}/devices/packetCapture/captures
List Packet Captures
> getOrganizationDevicesPacketCaptureCaptures
organizationId, captureIds, networkIds, serials, process, captureStatus, name, clientMac, notes, deviceName, adminName, perPage, startingAfter, endingBefore, sortOrder `` admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, items, mac, meta, name, network, packets, ports, process, productType, remaining, serial, size, startTs, status, total, value `` - POST /organizations/{organizationId}/devices/packetCapture/captures
Perform a packet capture on a device and store in Meraki Cloud (BETA)
> createOrganizationDevicesPacketCaptureCapture
organizationId captureReason, duration, filterExpression, interface, name, outputType, ports, serials autopcapType, captureId, captureReason, captureSource, client, device, devices, duration, errorMessage, fileSize, filterExpression, id, interfaces, mac, name, network, outputType, packetCount, ports, serial, startTime, status, user `` + POST /organizations/{organizationId}/devices/packetCapture/captures
Perform a packet capture on a device and store in Meraki Cloud
> createOrganizationDevicesPacketCaptureCapture
organizationId destination, duration, filterExpression, interface, name, notes, outputType, ports, serials admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, mac, name, network, packets, ports, process, productType, serial, size, startTs, status, total, value `` - DELETE /organizations/{organizationId}/devices/packetCapture/captures
Delete packet capture from cloud (BETA)
> deleteOrganizationDevicesPacketCaptureCaptures
organizationId captureIds `` `` + POST /organizations/{organizationId}/devices/packetCapture/captures/bulkCreate
Perform a packet capture on multiple devices and store in Meraki Cloud.
> bulkOrganizationDevicesPacketCaptureCapturesCreate
organizationId devices, duration, filterExpression, interface, name, notes, serial, switchports admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, items, mac, name, network, packets, ports, process, productType, serial, size, startTs, status, total, value `` - GET /organizations/{organizationId}/devices/packetCapture/captures/{id}/downloadUrl
Get presigned download URL for given packet capture id (BETA)
> downloadOrganizationDevicesPacketCaptureCaptureUrl
organizationId, id `` captureId, downloadUrl `` + POST /organizations/{organizationId}/devices/packetCapture/captures/bulkDelete
BulkDelete packet captures from cloud
> bulkOrganizationDevicesPacketCaptureCapturesDelete
organizationId captureIds `` `` - POST /organizations/{organizationId}/devices/packetCapture/captures/{id}/stop
Stop a specific packet capture (not supported for Catalyst devices) (BETA)
> stopOrganizationDevicesPacketCaptureCapture
organizationId, id serials autopcapType, captureId, captureReason, captureSource, client, device, devices, duration, errorMessage, fileSize, filterExpression, id, interfaces, mac, name, network, outputType, packetCount, ports, serial, startTime, status, user `` + DELETE /organizations/{organizationId}/devices/packetCapture/captures/{captureId}
Delete a single packet capture from cloud using captureId
> deleteOrganizationDevicesPacketCaptureCapture
organizationId, captureId `` `` `` - GET /organizations/{organizationId}/devices/packetCapture/schedules
List scheduled Packet Captures (BETA)
> getOrganizationDevicesPacketCaptureSchedules
organizationId, pcapScheduleConfigurationIds, networkIds, deviceIds `` captureCount, captureReason, counts, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interfaces, items, lastCaptureId, meta, name, nextCaptureTs, pcapScheduleConfigurationId, priority, recurrence, schedule, serial, startTs, switchports, total, updatedAt, user, warnings, weekdays `` + POST /organizations/{organizationId}/devices/packetCapture/captures/{captureId}/downloadUrl/generate
Get presigned download URL for given packet capture id
> generateOrganizationDevicesPacketCaptureCaptureDownloadUrl
organizationId, captureId `` captureId, downloadUrl, url `` - POST /organizations/{organizationId}/devices/packetCapture/schedules
Create a schedule for packet capture (BETA)
> createOrganizationDevicesPacketCaptureSchedule
organizationId captureReason, devices, duration, enabled, endTs, filterExpression, frequency, interfaces, name, recurrence, schedule, serial, startTs, switchports, weekdays captureCount, captureReason, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interfaces, lastCaptureId, name, nextCaptureTs, pcapScheduleConfigurationId, priority, recurrence, schedule, serial, startTs, switchports, updatedAt, user, warnings, weekdays `` + POST /organizations/{organizationId}/devices/packetCapture/captures/{captureId}/stop
Stop a specific packet capture (not supported for Catalyst devices)
> stopOrganizationDevicesPacketCaptureCapture
organizationId, captureId serials admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, mac, name, network, packets, ports, process, productType, serial, size, startTs, status, total, value `` - DELETE /organizations/{organizationId}/devices/packetCapture/schedules
Delete schedule from cloud (BETA)
> deleteOrganizationDevicesPacketCaptureSchedules
organizationId pcapScheduleConfigurationIds `` `` + GET /organizations/{organizationId}/devices/packetCapture/schedules
List the Packet Capture Schedules
> getOrganizationDevicesPacketCaptureSchedules
organizationId, scheduleIds, networkIds, deviceIds `` admin, captureCount, counts, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interface, items, lastCaptureId, meta, name, nextCaptureTs, notes, priority, recurrence, schedule, scheduleId, serial, startTs, switchports, total, updatedAt, warnings, weekdays `` - PUT /organizations/{organizationId}/devices/packetCapture/schedules/priority
Bulk update priorities of pcap schedules (BETA)
> updateOrganizationDevicesPacketCaptureSchedulesPriority
organizationId pcapScheduleConfigurationIds pcapScheduleConfigurationId, priority, updatedPriorities `` + POST /organizations/{organizationId}/devices/packetCapture/schedules
Create a schedule for packet capture
> createOrganizationDevicesPacketCaptureSchedule
organizationId devices, duration, enabled, endTs, filterExpression, frequency, interface, name, notes, recurrence, schedule, serial, startTs, switchports, weekdays admin, captureCount, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interface, lastCaptureId, name, nextCaptureTs, notes, priority, recurrence, schedule, scheduleId, serial, startTs, switchports, updatedAt, warnings, weekdays `` - PUT /organizations/{organizationId}/devices/packetCapture/schedules/{pcapScheduleConfigurationId}
Update a schedule for packet capture (BETA)
> updateOrganizationDevicesPacketCaptureSchedule
organizationId, pcapScheduleConfigurationId captureReason, devices, duration, enabled, endTs, filterExpression, frequency, name, recurrence, schedule, serial, startTs, switchports, weekdays captureCount, captureReason, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interfaces, lastCaptureId, name, nextCaptureTs, pcapScheduleConfigurationId, priority, recurrence, schedule, serial, startTs, switchports, updatedAt, user, warnings, weekdays `` + POST /organizations/{organizationId}/devices/packetCapture/schedules/bulkDelete
Delete packet capture schedules (BETA)
> bulkOrganizationDevicesPacketCaptureSchedulesDelete
organizationId scheduleIds `` `` + + POST /organizations/{organizationId}/devices/packetCapture/schedules/reorder
Bulk update priorities of pcap schedules
> reorderOrganizationDevicesPacketCaptureSchedules
organizationId order, priority, scheduleId pcapScheduleConfigurationId, priority, updatedPriorities `` + + PUT /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}
Update a schedule for packet capture
> updateOrganizationDevicesPacketCaptureSchedule
organizationId, scheduleId devices, duration, enabled, endTs, filterExpression, frequency, interface, name, notes, recurrence, schedule, serial, startTs, switchports, weekdays admin, captureCount, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interface, lastCaptureId, name, nextCaptureTs, notes, priority, recurrence, schedule, scheduleId, serial, startTs, switchports, updatedAt, warnings, weekdays `` + + DELETE /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}
Delete schedule from cloud
> deleteOrganizationDevicesPacketCaptureSchedule
organizationId, scheduleId scheduleId `` `` + + POST /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks
Enqueues a task for a specific packet capture (BETA)
> tasksOrganizationDevicesPacketCapture
organizationId, packetId networkId, task status, task, taskId dashboard:general:telemetry:packetcapture:read + + GET /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks/{id}
Retrieves packet capture analysis result for a specific packet capture task. (BETA)
> getOrganizationDevicesPacketCaptureTask
organizationId, packetId, id, networkId `` analyzer, analyzers, counts, detailMessage, details, devices, failed, failureCount, failures, fileName, filePathUrl, ips, macs, name, packets, passed, present, result, status, subCategory, successes, summary, task, testCounts, testResults, total, url dashboard:general:telemetry:packetcapture:read GET /organizations/{organizationId}/devices/powerModules/statuses/byDevice
List the most recent status information for power modules in rackmount MX and MS devices that support them
> getOrganizationDevicesPowerModulesStatusesByDevice
organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, tags, tagsFilterType `` id, mac, model, name, network, number, productType, serial, slots, status, tags dashboard:general:telemetry:read @@ -1504,6 +1534,8 @@ GET /organizations/{organizationId}/devices/statuses/overview
Return an overview of current device statuses
> getOrganizationDevicesStatusesOverview
organizationId, productTypes, networkIds `` alerting, byStatus, counts, dormant, offline, online dashboard:general:telemetry:read + GET /organizations/{organizationId}/devices/syslog/servers/roles/byNetwork
Returns roles that can be assigned to a syslog server for a given network. (BETA)
> getOrganizationDevicesSyslogServersRolesByNetwork
organizationId, perPage, startingAfter, endingBefore, networkIds `` availableRoles, counts, id, items, meta, name, network, remaining, total, value `` + GET /organizations/{organizationId}/devices/system/memory/usage/history/byInterval
Return the memory utilization history in kB for devices in the organization.
> getOrganizationDevicesSystemMemoryUsageHistoryByInterval
organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, interval, networkIds, serials, productTypes `` counts, endTs, free, id, intervals, items, mac, maximum, median, memory, meta, minimum, model, name, network, percentages, provisioned, remaining, serial, startTs, tags, total, used `` GET /organizations/{organizationId}/devices/uplinks/addresses/byDevice
List the current uplink addresses for devices in an organization.
> getOrganizationDevicesUplinksAddressesByDevice
organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, tags, tagsFilterType `` address, addresses, assignmentMode, gateway, id, interface, mac, name, nameservers, network, productType, protocol, public, serial, tags, uplinks, vlan dashboard:general:telemetry:read @@ -1522,7 +1554,7 @@ DELETE /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
Delete an early access feature opt-in
> deleteOrganizationEarlyAccessFeaturesOptIn
organizationId, optInId `` `` dashboard:iam:config:write - PUT /organizations/{organizationId}/extensions/jupiter/interconnects/{interconnectId}
Update name and status of an Interconnect (BETA)
> updateOrganizationExtensionsJupiterInterconnect
organizationId, interconnectId name, status asNum, createdAt, id, internalSubnets, name, networkId, networkLocaleId, status, tunnelCount, type, vpnCount, wiredId sdwan:config:write + PUT /organizations/{organizationId}/extensions/sdwanmanager/interconnects/{interconnectId}
Update name and status of an Interconnect (BETA)
> updateOrganizationExtensionsSdwanmanagerInterconnect
organizationId, interconnectId name, status asNum, createdAt, id, internalSubnets, name, networkId, networkLocaleId, status, tunnelCount, type, vpnCount, wiredId sdwan:config:write GET /organizations/{organizationId}/extensions/thousandEyes/networks
List the ThousandEyes agent configurations under this organization (BETA)
> getOrganizationExtensionsThousandEyesNetworks
organizationId `` agentId, enabled, networkId dashboard:general:config:read @@ -1574,11 +1606,11 @@ DELETE /organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}
Delete a custom web application by counter set rule id. (BETA)
> deleteOrganizationInsightWebApp
organizationId, customCounterSetRuleId `` `` `` - GET /organizations/{organizationId}/integrations/xdr/networks
Returns the networks in the organization that have XDR enabled (BETA)
> getOrganizationIntegrationsXdrNetworks
organizationId, networkIds `` enabled, isEligible, name, networkId, productTypes `` + GET /organizations/{organizationId}/integrations/xdr/networks
Returns the networks in the organization that have XDR enabled
> getOrganizationIntegrationsXdrNetworks
organizationId, networkIds, perPage, startingAfter, endingBefore `` counts, enabled, isEligible, items, meta, name, networkId, productTypes, remaining, total `` - POST /organizations/{organizationId}/integrations/xdr/networks/disable
Disable XDR on networks (BETA)
> disableOrganizationIntegrationsXdrNetworks
organizationId networkId, networks, productTypes enabled, isEligible, name, networkId, productTypes `` + POST /organizations/{organizationId}/integrations/xdr/networks/disable
Disable XDR on networks
> disableOrganizationIntegrationsXdrNetworks
organizationId networkId, networks, productTypes enabled, isEligible, name, networkId, networks, productTypes `` - POST /organizations/{organizationId}/integrations/xdr/networks/enable
Enable XDR on networks (BETA)
> enableOrganizationIntegrationsXdrNetworks
organizationId networkId, networks, productTypes enabled, isEligible, name, networkId, productTypes `` + POST /organizations/{organizationId}/integrations/xdr/networks/enable
Enable XDR on networks
> enableOrganizationIntegrationsXdrNetworks
organizationId networkId, networks, productTypes enabled, isEligible, name, networkId, networks, productTypes `` POST /organizations/{organizationId}/inventory/claim
Claim a list of devices, licenses, and/or orders into an organization inventory
> claimIntoOrganizationInventory
organizationId key, licenses, mode, orders, serials key, licenses, mode, orders, serials dashboard:licensing:config:write @@ -1590,15 +1622,19 @@ GET /organizations/{organizationId}/inventory/devices/{serial}
Return a single device from the inventory of an organization
> getOrganizationInventoryDevice
organizationId, serial `` claimedAt, countryCode, details, licenseExpirationDate, mac, model, name, networkId, orderNumber, productType, serial, tags, value dashboard:general:config:read - POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents
Imports event logs related to the onboarding app into elastisearch
> createOrganizationInventoryOnboardingCloudMonitoringExportEvent
organizationId logEvent, request, targetOS, timestamp `` dashboard:general:config:write + POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents
Imports event logs related to the onboarding app into elastisearch (DEPRECATED)
> createOrganizationInventoryOnboardingCloudMonitoringExportEvent
organizationId logEvent, request, targetOS, timestamp `` dashboard:general:config:write + + POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
Commits the import operation to complete the onboarding of a device into Dashboard for monitoring. (DEPRECATED)
> createOrganizationInventoryOnboardingCloudMonitoringImport
organizationId deviceId, devices, networkId, udi importId, message, status dashboard:general:config:write - POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
Commits the import operation to complete the onboarding of a device into Dashboard for monitoring.
> createOrganizationInventoryOnboardingCloudMonitoringImport
organizationId deviceId, devices, networkId, udi importId, message, status dashboard:general:config:write + GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
Check the status of a committed Import operation (DEPRECATED)
> getOrganizationInventoryOnboardingCloudMonitoringImports
organizationId, importIds `` created, device, importId, status, url dashboard:general:config:read - GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
Check the status of a committed Import operation
> getOrganizationInventoryOnboardingCloudMonitoringImports
organizationId, importIds `` created, device, importId, status, url dashboard:general:config:read + GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks
Returns list of networks eligible for adding cloud monitored device (DEPRECATED)
> getOrganizationInventoryOnboardingCloudMonitoringNetworks
organizationId, deviceType, search, perPage, startingAfter, endingBefore `` enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url dashboard:general:config:read - GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks
Returns list of networks eligible for adding cloud monitored device
> getOrganizationInventoryOnboardingCloudMonitoringNetworks
organizationId, deviceType, search, perPage, startingAfter, endingBefore `` enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url dashboard:general:config:read + POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare
Initiates or updates an import session (DEPRECATED)
> createOrganizationInventoryOnboardingCloudMonitoringPrepare
organizationId accessList, authentication, authorization, certificateName, devices, endLineNumber, group, localInterface, loopbackNumber, name, options, rotaryNumber, skipCommit, startLineNumber, sudi, tunnel, user, username, vty, vtyIn, vtyOut cloudStaticIp, configParams, content, deviceId, hash, host, message, mode, name, port, publicKey, rootCertificate, secret, status, tunnel, udi, user, username dashboard:general:config:write - POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare
Initiates or updates an import session
> createOrganizationInventoryOnboardingCloudMonitoringPrepare
organizationId accessList, authentication, authorization, certificateName, devices, endLineNumber, group, localInterface, loopbackNumber, name, options, rotaryNumber, skipCommit, startLineNumber, sudi, tunnel, user, username, vty, vtyIn, vtyOut cloudStaticIp, configParams, content, deviceId, hash, host, message, mode, name, port, publicKey, rootCertificate, secret, status, tunnel, udi, user, username dashboard:general:config:write + POST /organizations/{organizationId}/inventory/orders/claim
Claim an order by the secure unique order claim number, the order claim id (BETA)
> claimOrganizationInventoryOrders
organizationId claimId, description, name, subscriptionId, subscriptions claimId, counts, description, endDate, isClaimed, limit, name, number, seats, serials, startDate, subscriptionId, subscriptions `` + + POST /organizations/{organizationId}/inventory/orders/preview
Preview the results and status of an order claim by the secure order id (BETA)
> previewOrganizationInventoryOrders
organizationId claimId claimId, counts, description, devices, endDate, isClaimed, limit, name, number, pending, quantity, seats, shipments, shippedAt, shipping, sku, startDate, subscriptionId, subscriptions `` POST /organizations/{organizationId}/inventory/release
Release a list of claimed devices from an organization.
> releaseFromOrganizationInventory
organizationId serials serials dashboard:general:config:write @@ -1622,13 +1658,9 @@ POST /organizations/{organizationId}/licensing/coterm/licenses/move
Moves a license to a different organization (coterm only)
> moveOrganizationLicensingCotermLicenses
organizationId count, counts, destination, key, licenses, mode, model, organizationId claimedAt, count, counts, duration, edition, editions, expired, invalidated, invalidatedAt, key, mode, model, movedLicenses, organizationId, productType, remainderLicenses, startedAt dashboard:licensing:config:write - POST /organizations/{organizationId}/licensing/orders/claim
Claim an order by the secure unique order claim number, the order claim id (BETA)
> claimOrganizationLicensingOrders
organizationId claimId, description, name, subscriptionId, subscriptions assigned, available, claimId, counts, description, endDate, isClaimed, limit, name, networks, number, organizations, seats, serials, startDate, subscriptionId, subscriptions `` - - POST /organizations/{organizationId}/licensing/orders/preview
Preview the results and status of an order claim by the secure order id (BETA)
> previewOrganizationLicensingOrders
organizationId claimId assigned, available, claimId, counts, description, devices, endDate, isClaimed, limit, networks, number, organizations, pending, quantity, seats, shipments, shippedAt, shipping, sku, startDate, subscriptionId, subscriptions `` + GET /organizations/{organizationId}/loginSecurity
Returns the login security settings for an organization.
> getOrganizationLoginSecurity
organizationId `` accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, minimumPasswordLength, numDifferentPasswords, passwordExpirationDays, ranges dashboard:iam:config:read - GET /organizations/{organizationId}/loginSecurity
Returns the login security settings for an organization.
> getOrganizationLoginSecurity
organizationId `` accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, numDifferentPasswords, passwordExpirationDays, ranges dashboard:iam:config:read - - PUT /organizations/{organizationId}/loginSecurity
Update the login security settings for an organization
> updateOrganizationLoginSecurity
organizationId accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, numDifferentPasswords, passwordExpirationDays, ranges accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, numDifferentPasswords, passwordExpirationDays, ranges dashboard:iam:config:write + PUT /organizations/{organizationId}/loginSecurity
Update the login security settings for an organization
> updateOrganizationLoginSecurity
organizationId accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, minimumPasswordLength, numDifferentPasswords, passwordExpirationDays, ranges accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, minimumPasswordLength, numDifferentPasswords, passwordExpirationDays, ranges dashboard:iam:config:write GET /organizations/{organizationId}/networks
List the networks that the user has privileges on in an organization
> getOrganizationNetworks
organizationId, configTemplateId, isBoundToConfigTemplate, tags, tagsFilterType, productTypes, perPage, startingAfter, endingBefore `` enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url dashboard:general:config:read @@ -1690,6 +1722,14 @@ DELETE /organizations/{organizationId}/samlRoles/{samlRoleId}
Remove a SAML role
> deleteOrganizationSamlRole
organizationId, samlRoleId `` `` dashboard:iam:config:write + GET /organizations/{organizationId}/sase/connectivity/enrollableNetworks
List of MX networks or templates that can be enrolled into Secure Access (BETA)
> getOrganizationSaseConnectivityEnrollableNetworks
organizationId, perPage, startingAfter, endingBefore `` address, counts, defaultRoute, enabled, items, meta, model, name, networkId, region, remaining, routing, street, total, type, vpn `` + + DELETE /organizations/{organizationId}/sase/connectivity/sites/bulkDetach
Detach sites in this organization from Secure Access (BETA)
> deleteOrganizationSaseConnectivitySitesBulkDetach
organizationId callback, httpServer, id, merakiEnrollments, network, payloadTemplate, sharedSecret, siteId, url action, callback, id, message, request, siteId, status, url `` + + POST /organizations/{organizationId}/sase/connectivity/sites/bulkEnroll
Enroll sites in this organization to Secure Access (BETA)
> createOrganizationSaseConnectivitySitesBulkEnroll
organizationId callback, httpServer, id, merakiEnrollments, network, payloadTemplate, region, sharedSecret, url action, callback, id, message, regionId, request, siteId, status, url `` + + GET /organizations/{organizationId}/sase/connectivity/sites/{id}
Get details of a site in this organization (BETA)
> getOrganizationSaseConnectivitySite
organizationId, id, id `` address, defaultRoute, enabled, id, model, name, networkId, region, routing, street, type, vpn `` + GET /organizations/{organizationId}/secureConnect/privateApplicationGroups
Provides a list of private application groups for an Organization (BETA)
> getOrganizationSecureConnectPrivateApplicationGroups
organizationId, perPage, startingAfter, endingBefore, nameIncludes, applicationGroupIds, sortBy, sortOrder `` applicationGroupId, applicationIds, createdAt, data, description, meta, modifiedAt, name, total `` POST /organizations/{organizationId}/secureConnect/privateApplicationGroups
Creates a group of private applications to apply to policy (BETA)
> createOrganizationSecureConnectPrivateApplicationGroup
organizationId applicationIds, description, name applicationGroupId, applicationIds, createdAt, description, modifiedAt, name `` @@ -1796,6 +1836,8 @@ DELETE /organizations/{organizationId}/spaces/integration/remove
Remove the Spaces integration from Meraki (BETA)
> deleteOrganizationSpacesIntegrationRemove
organizationId `` message, status dashboard:general:config:write + POST /organizations/{organizationId}/spaces/integration/remove
Remove the Spaces integration from Meraki (BETA)
> createOrganizationSpacesIntegrationRemove
organizationId `` message, status dashboard:general:config:write + GET /organizations/{organizationId}/splash/assets/{id}
Get a Splash Theme Asset
> getOrganizationSplashAsset
organizationId, id `` fileData, id, name `` DELETE /organizations/{organizationId}/splash/assets/{id}
Delete a Splash Theme Asset
> deleteOrganizationSplashAsset
organizationId, id `` `` `` @@ -1856,6 +1898,16 @@ DELETE /organizations/{organizationId}/switch/ports/profiles/automations/{id}
Delete an automation port profile from an organization (BETA)
> deleteOrganizationSwitchPortsProfilesAutomation
organizationId, id `` `` `` + GET /organizations/{organizationId}/switch/ports/profiles/networks/assignments
Fetch all Network - Smart Port Profile associations for an organization (BETA)
> getOrganizationSwitchPortsProfilesNetworksAssignments
organizationId, perPage, page `` assignmentId, counts, id, items, meta, network, profile, remaining, total, type `` + + POST /organizations/{organizationId}/switch/ports/profiles/networks/assignments
Create Network and Smart Ports Profile association for a specific profile (BETA)
> createOrganizationSwitchPortsProfilesNetworksAssignment
organizationId id, network, profile, type assignmentId, id, network, profile, type `` + + POST /organizations/{organizationId}/switch/ports/profiles/networks/assignments/batchCreate
Batch Create Network and Smart Ports Profile associations for a specific profile (BETA)
> batchOrganizationSwitchPortsProfilesNetworksAssignmentsCreate
organizationId id, items, network, profile, type assignmentId, id, items, network, profile, type `` + + POST /organizations/{organizationId}/switch/ports/profiles/networks/assignments/bulkDelete
Bulk delete Network and Smart Port Profile associations (BETA)
> bulkOrganizationSwitchPortsProfilesNetworksAssignmentsDelete
organizationId assignmentId, items `` `` + + DELETE /organizations/{organizationId}/switch/ports/profiles/networks/assignments/{assignmentId}
Delete Network and Smart Port profile association for a specific profile (BETA)
> deleteOrganizationSwitchPortsProfilesNetworksAssignment
organizationId, assignmentId `` `` `` + GET /organizations/{organizationId}/switch/ports/profiles/overview/byProfile
List the port profiles in an organization (BETA)
> getOrganizationSwitchPortsProfilesOverviewByProfile
organizationId, networkIds, formattedStaticAssignments, searchQuery, perPage, startingAfter, endingBefore `` access, assigned, automations, counts, createdAt, description, excluded, id, included, isOrganizationWide, items, meta, name, network, networks, networksCount, ports, profileId, switches, total, type, updatedAt, values `` GET /organizations/{organizationId}/switch/ports/profiles/{id}
Get detailed information about a port profile (BETA)
> getOrganizationSwitchPortsProfile
organizationId, id `` access, accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, assignedSwitchports, associatedPorts, associatedSwitches, automations, createdAt, daiTrusted, description, enabled, id, isOrganizationWide, isolationEnabled, mac, macAllowList, model, name, networkId, networks, peerSgtCapable, poeEnabled, port, portId, portIds, portName, portNum, profile, profileId, rstpEnabled, serial, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, switch, switchId, tags, template, type, udld, updatedAt, values, vlan, voiceVlan `` @@ -1910,6 +1962,8 @@ GET /organizations/{organizationId}/wireless/airMarshal/settings/byNetwork
Returns the current Air Marshal settings for this network
> getOrganizationWirelessAirMarshalSettingsByNetwork
organizationId, networkIds, perPage, startingAfter, endingBefore `` counts, defaultPolicy, items, meta, networkId, remaining, total `` + GET /organizations/{organizationId}/wireless/certificates/openRoaming/certificateAuthority
Query for details on the organization's OpenRoaming Certificate Authority certificate (CAs). (BETA)
> getOrganizationWirelessCertificatesOpenRoamingCertificateAuthority
organizationId `` contents, status wireless:config:read + GET /organizations/{organizationId}/wireless/clients/overview/byDevice
List access point client count at the moment in an organization
> getOrganizationWirelessClientsOverviewByDevice
organizationId, networkIds, serials, campusGatewayClusterIds, perPage, startingAfter, endingBefore `` byStatus, counts, id, items, meta, network, online, remaining, serial, total `` GET /organizations/{organizationId}/wireless/devices/channelUtilization/byDevice
Get average channel utilization for all bands in a network, split by AP
> getOrganizationWirelessDevicesChannelUtilizationByDevice
organizationId, networkIds, serials, perPage, startingAfter, endingBefore, t0, t1, timespan, interval `` band, byBand, id, mac, network, nonWifi, percentage, serial, total, wifi wireless:telemetry:read @@ -1922,6 +1976,12 @@ GET /organizations/{organizationId}/wireless/devices/ethernet/statuses
List the most recent Ethernet link speed, duplex, aggregation and power mode and status information for wireless devices.
> getOrganizationWirelessDevicesEthernetStatuses
organizationId, perPage, startingAfter, endingBefore, networkIds `` ac, aggregation, duplex, enabled, id, isConnected, linkNegotiation, mode, name, network, poe, ports, power, serial, speed, standard wireless:telemetry:read + GET /organizations/{organizationId}/wireless/devices/latency/byClient
Get latency summaries for all wireless devices in an organization. (BETA)
> getOrganizationWirelessDevicesLatencyByClient
organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, networkIds, bands, ssids, macs `` average, device, frames, id, mac, name, network, overall, serial `` + + GET /organizations/{organizationId}/wireless/devices/latency/byDevice
Get latency summaries for all wireless devices in an organization. (BETA)
> getOrganizationWirelessDevicesLatencyByDevice
organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, networkIds, serials, bands, ssids `` average, device, frames, id, mac, name, network, overall, serial `` + + GET /organizations/{organizationId}/wireless/devices/latency/byNetwork
Get per-network latency summaries for all wireless networks in an organization. (BETA)
> getOrganizationWirelessDevicesLatencyByNetwork
organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, networkIds, serials, bands, ssids `` average, frames, id, name, network, overall `` + GET /organizations/{organizationId}/wireless/devices/packetLoss/byClient
Get average packet loss for the given timespan for all clients in the organization.
> getOrganizationWirelessDevicesPacketLossByClient
organizationId, networkIds, ssids, bands, macs, perPage, startingAfter, endingBefore, t0, t1, timespan `` client, downstream, id, lossPercentage, lost, mac, name, network, total, upstream `` GET /organizations/{organizationId}/wireless/devices/packetLoss/byDevice
Get average packet loss for the given timespan for all devices in the organization
> getOrganizationWirelessDevicesPacketLossByDevice
organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan `` device, downstream, id, lossPercentage, lost, mac, name, network, serial, total, upstream `` @@ -1930,11 +1990,35 @@ GET /organizations/{organizationId}/wireless/devices/power/mode/history
Return a record of power mode changes for wireless devices in the organization
> getOrganizationWirelessDevicesPowerModeHistory
organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, networkIds, serials `` events, id, items, mac, model, name, network, powerMode, serial, tags, ts `` + GET /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
Query for details on the organization's RADSEC device Certificate Authority certificates (CAs)
> getOrganizationWirelessDevicesRadsecCertificatesAuthorities
organizationId, certificateAuthorityIds `` certificateAuthorityId, contents, counts, items, meta, remaining, status, total dashboard:iam:config:read + + PUT /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
Update an organization's RADSEC device Certificate Authority (CA) state
> updateOrganizationWirelessDevicesRadsecCertificatesAuthorities
organizationId certificateAuthorityId, status certificateAuthorityId, contents, status dashboard:iam:config:write + + POST /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
Create an organization's RADSEC device Certificate Authority (CA)
> createOrganizationWirelessDevicesRadsecCertificatesAuthority
organizationId `` certificateAuthorityId, contents, status dashboard:iam:config:write + + GET /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls
Query for certificate revocation list (CRL) for the organization's RADSEC device Certificate Authorities (CAs).
> getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrls
organizationId, certificateAuthorityIds `` certificateAuthorityId, counts, crl, items, meta, remaining, total dashboard:iam:config:read + + GET /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls/deltas
Query for all delta certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id.
> getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrlsDeltas
organizationId, certificateAuthorityIds `` certificateAuthorityId, counts, crl, items, meta, remaining, total dashboard:iam:config:read + + GET /organizations/{organizationId}/wireless/devices/signalQuality/byClient
Get average signal quality for all clients in the organization (BETA)
> getOrganizationWirelessDevicesSignalQualityByClient
organizationId, networkIds, serials, ssids, bands, macs, perPage, startingAfter, endingBefore, t0, t1, timespan `` client, id, mac, name, network, rssi, snr `` + + GET /organizations/{organizationId}/wireless/devices/signalQuality/byDevice
Get average signal quality for all devices in the organization (BETA)
> getOrganizationWirelessDevicesSignalQualityByDevice
organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan `` id, name, network, rssi, snr `` + + GET /organizations/{organizationId}/wireless/devices/signalQuality/byNetwork
Get average signal quality for all networks in the organization (BETA)
> getOrganizationWirelessDevicesSignalQualityByNetwork
organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan `` id, name, network, rssi, snr `` + GET /organizations/{organizationId}/wireless/devices/system/cpu/load/history
Return the CPU Load history for a list of wireless devices in the organization.
> getOrganizationWirelessDevicesSystemCpuLoadHistory
organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, networkIds, serials `` cpuCount, cpuLoad5, id, items, mac, model, name, network, serial, series, tags, ts `` GET /organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice
List of Catalyst access points information
> getOrganizationWirelessDevicesWirelessControllersByDevice
organizationId, networkIds, serials, controllerSerials, perPage, startingAfter, endingBefore `` controller, countryCode, counts, details, id, items, joinedAt, meta, mode, model, name, network, policy, remaining, rf, serial, site, tags, total, value `` - GET /organizations/{organizationId}/wireless/location/scanning/byNetwork
Return scanning API settings (BETA)
> getOrganizationWirelessLocationScanningByNetwork
organizationId, perPage, startingAfter, endingBefore, networkIds `` api, counts, enabled, items, meta, name, networkId, remaining, string, total, validator wireless:telemetry:read + GET /organizations/{organizationId}/wireless/location/scanning/byNetwork
Return scanning API settings
> getOrganizationWirelessLocationScanningByNetwork
organizationId, perPage, startingAfter, endingBefore, networkIds `` api, counts, enabled, items, meta, name, networkId, remaining, string, total, validator wireless:telemetry:read + + GET /organizations/{organizationId}/wireless/location/scanning/receivers
Return scanning API receivers
> getOrganizationWirelessLocationScanningReceivers
organizationId, perPage, startingAfter, endingBefore, networkIds `` counts, id, items, meta, name, network, radio, receiverId, remaining, total, type, url, version wireless:telemetry:read + + POST /organizations/{organizationId}/wireless/location/scanning/receivers
Add new receiver for scanning API
> createOrganizationWirelessLocationScanningReceiver
organizationId id, network, radio, sharedSecret, type, url, version id, name, network, radio, receiverId, type, url, version wireless:telemetry:write + + PUT /organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId}
Change scanning API receiver settings
> updateOrganizationWirelessLocationScanningReceiver
organizationId, receiverId radio, type, url, version id, name, network, radio, receiverId, type, url, version wireless:telemetry:write + + DELETE /organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId}
Delete a scanning API receiver
> deleteOrganizationWirelessLocationScanningReceiver
organizationId, receiverId `` `` wireless:telemetry:write GET /organizations/{organizationId}/wireless/opportunisticPcap/byNetwork
List the Opportunistic Pcap settings of an organization by network (BETA)
> getOrganizationWirelessOpportunisticPcapByNetwork
organizationId, networkIds `` enablement, name, networkId, networkWide, serials, tags `` @@ -1952,13 +2036,13 @@ GET /organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice
List the RF profiles of an organization by device
> getOrganizationWirelessRfProfilesAssignmentsByDevice
organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, name, mac, serial, model, macs, serials, models `` counts, id, isIndoorDefault, isOutdoorDefault, items, meta, model, name, network, remaining, rfProfile, serial, total `` - GET /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries
List the L2 isolation allow list MAC entry in an organization (BETA)
> getOrganizationWirelessSsidsFirewallIsolationAllowlistEntries
organizationId, perPage, startingAfter, endingBefore, networkIds, ssids `` client, counts, createdAt, description, entryId, id, items, mac, meta, name, network, number, remaining, ssid, total, updatedAt `` + GET /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries
List the L2 isolation allow list MAC entry in an organization
> getOrganizationWirelessSsidsFirewallIsolationAllowlistEntries
organizationId, perPage, startingAfter, endingBefore, networkIds, ssids `` client, counts, createdAt, description, entryId, id, items, lastUpdatedAt, mac, meta, name, network, number, remaining, ssid, total `` - POST /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries
Create isolation allow list MAC entry for this organization (BETA)
> createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry
organizationId client, description, id, mac, network, number, ssid client, createdAt, description, entryId, id, mac, name, network, number, ssid, updatedAt `` + POST /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries
Create isolation allow list MAC entry for this organization
> createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry
organizationId client, description, id, mac, network, number, ssid client, createdAt, description, entryId, id, lastUpdatedAt, mac, name, network, number, ssid `` - DELETE /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{id}
Destroy isolation allow list MAC entry for this organization (BETA)
> deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry
organizationId, id `` `` `` + DELETE /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId}
Destroy isolation allow list MAC entry for this organization
> deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry
organizationId, entryId `` `` `` - PUT /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{id}
Update isolation allow list MAC entry info (BETA)
> updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry
organizationId, id client, description, mac client, createdAt, description, entryId, id, mac, name, network, number, ssid, updatedAt `` + PUT /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId}
Update isolation allow list MAC entry info
> updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry
organizationId, entryId client, description, mac client, createdAt, description, entryId, id, lastUpdatedAt, mac, name, network, number, ssid `` GET /organizations/{organizationId}/wireless/ssids/statuses/byDevice
List status information of all BSSIDs in your organization
> getOrganizationWirelessSsidsStatusesByDevice
organizationId, networkIds, serials, bssids, hideDisabled, perPage, startingAfter, endingBefore `` advertised, band, basicServiceSets, bssid, channel, channelWidth, counts, enabled, id, index, isBroadcasting, items, meta, name, network, number, power, radio, remaining, serial, ssid, total wireless:telemetry:read @@ -1966,7 +2050,7 @@ GET /organizations/{organizationId}/wireless/zigbee/devices
List the Zigbee MR Nodes for and organization or the supplied network(s) (BETA)
> getOrganizationWirelessZigbeeDevices
organizationId, perPage, startingAfter, endingBefore, networkIds, isEnrolled, search `` byStatus, channel, counts, doorLocks, dormant, enrolled, gateway, id, mac, name, network, offline, online, panId, serial, status, tags, transmitPowerLevel `` - PUT /organizations/{organizationId}/wireless/zigbee/devices/{id}
Endpoint to update zigbee gateways (BETA)
> updateOrganizationWirelessZigbeeDevice
organizationId, id enrolled byStatus, channel, counts, doorLocks, dormant, enrolled, gateway, id, mac, name, network, offline, online, panId, serial, status, tags, transmitPowerLevel `` + PUT /organizations/{organizationId}/wireless/zigbee/devices/{id}
Endpoint to update zigbee gateways (BETA)
> updateOrganizationWirelessZigbeeDevice
organizationId, id channel, enrolled byStatus, channel, counts, doorLocks, dormant, enrolled, gateway, id, mac, name, network, offline, online, panId, serial, status, tags, transmitPowerLevel `` POST /organizations/{organizationId}/wireless/zigbee/disenrollments
Enqueue a job to start disenrolling doorlocks on zigbee configured MRs (BETA)
> createOrganizationWirelessZigbeeDisenrollment
organizationId doorLockIds disenrollmentId, doorLockIds, request, status, url `` @@ -2010,7 +2094,7 @@ -

API v1.56.0-beta.0

+

API v1.58.0-beta.1

diff --git a/docs/api-index/meraki-api-index.md b/docs/api-index/meraki-api-index.md index 55b7e97..efafed3 100644 --- a/docs/api-index/meraki-api-index.md +++ b/docs/api-index/meraki-api-index.md @@ -1,4 +1,4 @@ -## Meraki API Specification - Version 1.56.0-beta.0 +## Meraki API Specification - Version 1.58.0-beta.1 [Download CSV](meraki-api-index.csv) @@ -9,7 +9,8 @@ GET /administered/identities/me/api/keys
[List the non-sensitive metadata POST /administered/identities/me/api/keys/generate
[Generates an API key for an identity](https://developer.cisco.com/meraki/api-v1/generate-administered-identities-me-api-keys/)
> `generateAdministeredIdentitiesMeApiKeys`
| `` | `` | `key` | `` POST /administered/identities/me/api/keys/{suffix}/revoke
[Revokes an identity's API key, using the last four characters of the key](https://developer.cisco.com/meraki/api-v1/revoke-administered-identities-me-api-keys/)
> `revokeAdministeredIdentitiesMeApiKeys`
| `suffix` | `` | `` | `` GET /administered/licensing/subscription/entitlements
[Retrieve the list of purchasable entitlements](https://developer.cisco.com/meraki/api-v1/get-administered-licensing-subscription-entitlements/)
> `getAdministeredLicensingSubscriptionEntitlements`
| `skus` | `` | `featureTier, isAddOn, name, productClass, productType, sku` | `` -GET /administered/licensing/subscription/subscriptions
[List available subscriptions](https://developer.cisco.com/meraki/api-v1/get-administered-licensing-subscription-subscriptions/)
> `getAdministeredLicensingSubscriptionSubscriptions`
| `perPage, startingAfter, endingBefore, subscriptionIds, organizationIds, statuses, productTypes, name, startDate, endDate` | `` | `account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId` | `` +POST /administered/licensing/subscription/networks/featureTiers/batchUpdate
[Batch change networks to their desired feature tier for specified product types (BETA)](https://developer.cisco.com/meraki/api-v1/batch-administered-licensing-subscription-networks-feature-tiers-update/)
> `batchAdministeredLicensingSubscriptionNetworksFeatureTiersUpdate`
| `` | `featureTier, id, isAtomic, items, network, productType, productTypes` | `error, errors, featureTier, id, items, network, productType, productTypes` | `` +GET /administered/licensing/subscription/subscriptions
[List available subscriptions](https://developer.cisco.com/meraki/api-v1/get-administered-licensing-subscription-subscriptions/)
> `getAdministeredLicensingSubscriptionSubscriptions`
| `perPage, startingAfter, endingBefore, subscriptionIds, organizationIds, statuses, productTypes, skus, name, startDate, endDate` | `` | `account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId` | `` POST /administered/licensing/subscription/subscriptions/claim
[Claim a subscription into an organization.](https://developer.cisco.com/meraki/api-v1/claim-administered-licensing-subscription-subscriptions/)
> `claimAdministeredLicensingSubscriptionSubscriptions`
| `validate` | `claimKey, description, name, organizationId` | `account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId` | `` POST /administered/licensing/subscription/subscriptions/claimKey/validate
[Find a subscription by claim key](https://developer.cisco.com/meraki/api-v1/validate-administered-licensing-subscription-subscriptions-claim-key/)
> `validateAdministeredLicensingSubscriptionSubscriptionsClaimKey`
| `` | `claimKey` | `account, assigned, available, counts, description, domain, endDate, enterpriseAgreement, entitlements, id, lastUpdatedAt, limit, name, networks, organizations, productTypes, renewalRequested, seats, sku, smartAccount, startDate, status, subscriptionId, suites, type, webOrderId, webOrderLineId` | `` GET /administered/licensing/subscription/subscriptions/compliance/statuses
[Get compliance status for requested subscriptions](https://developer.cisco.com/meraki/api-v1/get-administered-licensing-subscription-subscriptions-compliance-statuses/)
> `getAdministeredLicensingSubscriptionSubscriptionsComplianceStatuses`
| `organizationIds, subscriptionIds` | `` | `byProductClass, entitlements, gracePeriodEndsAt, id, missing, name, productClass, quantity, sku, status, subscription, violations` | `` @@ -29,11 +30,11 @@ POST /devices/{serial}/blinkLeds
[Blink the LEDs on a device (DEPRECATED) GET /devices/{serial}/camera/analytics/live
[Returns live state from camera analytics zones (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-live/)
> `getDeviceCameraAnalyticsLive`
| `serial` | `` | `person, ts, zoneId, zones` | `` GET /devices/{serial}/camera/analytics/overview
[Returns an overview of aggregate analytics data for a timespan (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-overview/)
> `getDeviceCameraAnalyticsOverview`
| `serial, t0, t1, timespan, objectType` | `` | `averageCount, endTs, entrances, startTs, zoneId` | `` GET /devices/{serial}/camera/analytics/recent
[Returns most recent record for analytics zones (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-recent/)
> `getDeviceCameraAnalyticsRecent`
| `serial, objectType` | `` | `averageCount, endTs, entrances, startTs, zoneId` | `` -GET /devices/{serial}/camera/analytics/zones
[Returns all configured analytic zones for this camera (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-zones/)
> `getDeviceCameraAnalyticsZones`
| `serial` | `` | `id, label, regionOfInterest, type, x0, x1, y0, y1` | `` +GET /devices/{serial}/camera/analytics/zones
[Returns all configured analytic zones for this camera (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-zones/)
> `getDeviceCameraAnalyticsZones`
| `serial` | `` | `id, label, regionOfInterest, type, x0, x1, y0, y1` | `camera:config:read` GET /devices/{serial}/camera/analytics/zones/{zoneId}/history
[Return historical records for analytic zones (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/get-device-camera-analytics-zone-history/)
> `getDeviceCameraAnalyticsZoneHistory`
| `serial, zoneId, t0, t1, timespan, resolution, objectType` | `` | `averageCount, endTs, entrances, startTs` | `` GET /devices/{serial}/camera/customAnalytics
[Return custom analytics settings for a camera](https://developer.cisco.com/meraki/api-v1/get-device-camera-custom-analytics/)
> `getDeviceCameraCustomAnalytics`
| `serial` | `` | `artifactId, enabled, name, parameters, value` | `camera:config:read` PUT /devices/{serial}/camera/customAnalytics
[Update custom analytics settings for a camera](https://developer.cisco.com/meraki/api-v1/update-device-camera-custom-analytics/)
> `updateDeviceCameraCustomAnalytics`
| `serial` | `artifactId, enabled, name, parameters, value` | `artifactId, enabled, name, parameters, value` | `camera:config:write` -POST /devices/{serial}/camera/generateSnapshot
[Generate a snapshot of what the camera sees at the specified time and return a link to that image.](https://developer.cisco.com/meraki/api-v1/generate-device-camera-snapshot/)
> `generateDeviceCameraSnapshot`
| `serial` | `fullframe, timestamp` | `expiry, url` | `camera:config:write` +POST /devices/{serial}/camera/generateSnapshot
[Generate a snapshot of what the camera sees at the specified time and return a link to that image.](https://developer.cisco.com/meraki/api-v1/generate-device-camera-snapshot/)
> `generateDeviceCameraSnapshot`
| `serial` | `fullframe, timestamp` | `expiry, url` | `camera:telemetry:write` GET /devices/{serial}/camera/qualityAndRetention
[Returns quality and retention settings for the given camera](https://developer.cisco.com/meraki/api-v1/get-device-camera-quality-and-retention/)
> `getDeviceCameraQualityAndRetention`
| `serial` | `` | `` | `camera:config:read` PUT /devices/{serial}/camera/qualityAndRetention
[Update quality and retention settings for the given camera](https://developer.cisco.com/meraki/api-v1/update-device-camera-quality-and-retention/)
> `updateDeviceCameraQualityAndRetention`
| `serial` | `audioRecordingEnabled, motionBasedRetentionEnabled, motionDetectorVersion, profileId, quality, resolution, restrictedBandwidthModeEnabled` | `` | `camera:config:write` GET /devices/{serial}/camera/sense
[Returns sense settings for a given camera](https://developer.cisco.com/meraki/api-v1/get-device-camera-sense/)
> `getDeviceCameraSense`
| `serial` | `` | `` | `camera:config:read` @@ -59,10 +60,16 @@ POST /devices/{serial}/liveTools/cableTest
[Enqueue a job to perform a ca GET /devices/{serial}/liveTools/cableTest/{id}
[Return a cable test live tool job.](https://developer.cisco.com/meraki/api-v1/get-device-live-tools-cable-test/)
> `getDeviceLiveToolsCableTest`
| `serial, id` | `` | `cableTestId, error, index, lengthMeters, pairs, port, ports, request, results, serial, speedMbps, status, url` | `dashboard:general:config:read` POST /devices/{serial}/liveTools/cyclePort
[Enqueue a job to perform a cycle port for the device on the specified ports (BETA)](https://developer.cisco.com/meraki/api-v1/create-device-live-tools-cycle-port/)
> `createDeviceLiveToolsCyclePort`
| `serial` | `callback, httpServer, id, payloadTemplate, ports, sharedSecret, url` | `callback, cyclePortId, id, ports, request, serial, status, url` | `dashboard:general:config:write` GET /devices/{serial}/liveTools/cyclePort/{id}
[Return a cycle port live tool job. (BETA)](https://developer.cisco.com/meraki/api-v1/get-device-live-tools-cycle-port/)
> `getDeviceLiveToolsCyclePort`
| `serial, id` | `` | `cyclePortId, error, ports, request, serial, status, url` | `dashboard:general:config:read` +POST /devices/{serial}/liveTools/dhcpLeases
[Enqueue a job to perform a DHCP leases request for the device (BETA)](https://developer.cisco.com/meraki/api-v1/create-device-live-tools-dhcp-lease/)
> `createDeviceLiveToolsDhcpLease`
| `serial` | `callback, httpServer, id, payloadTemplate, sharedSecret, url` | `callback, dhcpLeasesId, id, request, serial, status, url` | `` +GET /devices/{serial}/liveTools/dhcpLeases/{dhcpLeasesId}
[Return a DHCP leases live tool job. (BETA)](https://developer.cisco.com/meraki/api-v1/get-device-live-tools-dhcp-lease/)
> `getDeviceLiveToolsDhcpLease`
| `serial, dhcpLeasesId` | `` | `dhcpLeases, dhcpLeasesId, error, expiresAt, ip, mac, request, serial, status, url` | `` POST /devices/{serial}/liveTools/leds/blink
[Enqueue a job to blink LEDs on a device](https://developer.cisco.com/meraki/api-v1/create-device-live-tools-leds-blink/)
> `createDeviceLiveToolsLedsBlink`
| `serial` | `callback, duration, httpServer, id, payloadTemplate, sharedSecret, url` | `callback, duration, error, id, ledsBlinkId, request, serial, status, url` | `dashboard:general:config:write` GET /devices/{serial}/liveTools/leds/blink/{ledsBlinkId}
[Return a blink LEDs job](https://developer.cisco.com/meraki/api-v1/get-device-live-tools-leds-blink/)
> `getDeviceLiveToolsLedsBlink`
| `serial, ledsBlinkId` | `` | `duration, error, ledsBlinkId, request, serial, status, url` | `dashboard:general:config:read` -POST /devices/{serial}/liveTools/macTable
[Enqueue a job to request the MAC table from the device (BETA)](https://developer.cisco.com/meraki/api-v1/create-device-live-tools-mac-table/)
> `createDeviceLiveToolsMacTable`
| `serial` | `callback, httpServer, id, payloadTemplate, sharedSecret, url` | `callback, id, macTableId, request, serial, status, url` | `dashboard:general:telemetry:write` -GET /devices/{serial}/liveTools/macTable/{macTableId}
[Return a MAC table live tool job. (BETA)](https://developer.cisco.com/meraki/api-v1/get-device-live-tools-mac-table/)
> `getDeviceLiveToolsMacTable`
| `serial, macTableId` | `` | `entries, error, mac, macTableId, port, request, serial, status, url, vlanId` | `dashboard:general:telemetry:read` +POST /devices/{serial}/liveTools/macTable
[Enqueue a job to request the MAC table from the device](https://developer.cisco.com/meraki/api-v1/create-device-live-tools-mac-table/)
> `createDeviceLiveToolsMacTable`
| `serial` | `callback, httpServer, id, payloadTemplate, sharedSecret, url` | `callback, id, macTableId, request, serial, status, url` | `dashboard:general:telemetry:write` +GET /devices/{serial}/liveTools/macTable/{macTableId}
[Return a MAC table live tool job.](https://developer.cisco.com/meraki/api-v1/get-device-live-tools-mac-table/)
> `getDeviceLiveToolsMacTable`
| `serial, macTableId` | `` | `entries, error, mac, macTableId, port, request, serial, status, url, vlanId` | `dashboard:general:telemetry:read` +POST /devices/{serial}/liveTools/multicastRouting
[Enqueue a job to perform a Multicast routing request for the device (BETA)](https://developer.cisco.com/meraki/api-v1/create-device-live-tools-multicast-routing/)
> `createDeviceLiveToolsMulticastRouting`
| `serial` | `callback, httpServer, id, payloadTemplate, sharedSecret, url` | `callback, id, multicastRoutingId, request, serial, status, url` | `` +GET /devices/{serial}/liveTools/multicastRouting/{multicastRoutingId}
[Return a Multicast routing live tool job. (BETA)](https://developer.cisco.com/meraki/api-v1/get-device-live-tools-multicast-routing/)
> `getDeviceLiveToolsMulticastRouting`
| `serial, multicastRoutingId` | `` | `error, flags, group, incomingInterfaceName, interfaces, ip, multicastRoutingId, name, neighbors, outgoingInterfaceNames, rendezvousPoint, request, routes, serial, source, status, subnet, url` | `` +POST /devices/{serial}/liveTools/ospfNeighbors
[Enqueue a job to perform a OSPF neighbors request for the device (BETA)](https://developer.cisco.com/meraki/api-v1/create-device-live-tools-ospf-neighbor/)
> `createDeviceLiveToolsOspfNeighbor`
| `serial` | `callback, httpServer, id, payloadTemplate, sharedSecret, url` | `callback, id, ospfNeighborsId, request, serial, status, url` | `` +GET /devices/{serial}/liveTools/ospfNeighbors/{ospfNeighborsId}
[Return an OSPF neighbors live tool job. (BETA)](https://developer.cisco.com/meraki/api-v1/get-device-live-tools-ospf-neighbor/)
> `getDeviceLiveToolsOspfNeighbor`
| `serial, ospfNeighborsId` | `` | `error, id, ip, name, ospfNeighborsId, position, request, routers, serial, state, status, url, vlanId` | `` POST /devices/{serial}/liveTools/ping
[Enqueue a job to ping a target host from the device](https://developer.cisco.com/meraki/api-v1/create-device-live-tools-ping/)
> `createDeviceLiveToolsPing`
| `serial` | `callback, count, httpServer, id, payloadTemplate, sharedSecret, target, url` | `callback, count, id, pingId, request, serial, status, target, url` | `dashboard:general:telemetry:write` GET /devices/{serial}/liveTools/ping/{id}
[Return a ping job](https://developer.cisco.com/meraki/api-v1/get-device-live-tools-ping/)
> `getDeviceLiveToolsPing`
| `serial, id` | `` | `average, count, latencies, latency, loss, maximum, minimum, percentage, pingId, received, replies, request, results, sent, sequenceId, serial, size, status, target, url` | `dashboard:general:telemetry:read` POST /devices/{serial}/liveTools/pingDevice
[Enqueue a job to check connectivity status to the device](https://developer.cisco.com/meraki/api-v1/create-device-live-tools-ping-device/)
> `createDeviceLiveToolsPingDevice`
| `serial` | `callback, count, httpServer, id, payloadTemplate, sharedSecret, url` | `callback, count, id, pingId, request, serial, status, url` | `dashboard:general:telemetry:write` @@ -87,17 +94,17 @@ POST /devices/{serial}/sensor/commands
[Sends a command to a sensor](http GET /devices/{serial}/sensor/commands/{commandId}
[Returns information about the command's execution, including the status](https://developer.cisco.com/meraki/api-v1/get-device-sensor-command/)
> `getDeviceSensorCommand`
| `serial, commandId` | `` | `adminId, commandId, completedAt, createdAt, createdBy, email, errors, name, operation, status` | `` GET /devices/{serial}/sensor/relationships
[List the sensor roles for a given sensor or camera device.](https://developer.cisco.com/meraki/api-v1/get-device-sensor-relationships/)
> `getDeviceSensorRelationships`
| `serial` | `` | `livestream, productType, relatedDevices, serial` | `sensor:config:read` PUT /devices/{serial}/sensor/relationships
[Assign one or more sensor roles to a given sensor or camera device.](https://developer.cisco.com/meraki/api-v1/update-device-sensor-relationships/)
> `updateDeviceSensorRelationships`
| `serial` | `livestream, relatedDevices, serial` | `livestream, productType, relatedDevices, serial` | `sensor:config:write` -GET /devices/{serial}/switch/ports
[List the switch ports for a switch](https://developer.cisco.com/meraki/api-v1/get-device-switch-ports/)
> `getDeviceSwitchPorts`
| `serial` | `` | `accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:read` +GET /devices/{serial}/switch/ports
[List the switch ports for a switch](https://developer.cisco.com/meraki/api-v1/get-device-switch-ports/)
> `getDeviceSwitchPorts`
| `serial` | `` | `accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:read` POST /devices/{serial}/switch/ports/cycle
[Cycle a set of switch ports](https://developer.cisco.com/meraki/api-v1/cycle-device-switch-ports/)
> `cycleDeviceSwitchPorts`
| `serial` | `ports` | `ports` | `switch:config:write` PUT /devices/{serial}/switch/ports/mirror
[Update a port mirror (BETA)](https://developer.cisco.com/meraki/api-v1/update-device-switch-ports-mirror/)
> `updateDeviceSwitchPortsMirror`
| `serial` | `comment, destination, filter, hasTransitVlan, module, number, port, ports, role, serial, slot, source, tags, type, vlan, vlans` | `comment, destination, filter, hasTransitVlan, id, mirror, module, name, network, number, port, ports, role, serial, slot, source, tags, type, vlan, vlans, warnings` | `` GET /devices/{serial}/switch/ports/statuses
[Return the status for all the ports of a switch](https://developer.cisco.com/meraki/api-v1/get-device-switch-ports-statuses/)
> `getDeviceSwitchPortsStatuses`
| `serial, t0, timespan` | `` | `active, address, allowedVlans, authenticationStatus, capabilities, cdp, chassisId, clientCount, configOverrides, deviceId, duplex, enabled, errors, isAllocated, isUplink, lldp, managementAddress, managementVlan, nativeVlan, platform, poe, portDescription, portId, portVlan, powerUsageInWh, recv, securePort, sent, spanningTree, speed, status, statuses, systemCapabilities, systemDescription, systemName, total, trafficInKbps, type, usageInKb, version, vlan, voiceVlan, vtpManagementDomain, warnings` | `switch:telemetry:read` GET /devices/{serial}/switch/ports/statuses/packets
[Return the packet counters for all the ports of a switch](https://developer.cisco.com/meraki/api-v1/get-device-switch-ports-statuses-packets/)
> `getDeviceSwitchPortsStatusesPackets`
| `serial, t0, timespan` | `` | `desc, packets, portId, ratePerSec, recv, sent, total` | `switch:telemetry:read` -GET /devices/{serial}/switch/ports/{portId}
[Return a switch port](https://developer.cisco.com/meraki/api-v1/get-device-switch-port/)
> `getDeviceSwitchPort`
| `serial, portId` | `` | `accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:read` -PUT /devices/{serial}/switch/ports/{portId}
[Update a switch port](https://developer.cisco.com/meraki/api-v1/update-device-switch-port/)
> `updateDeviceSwitchPort`
| `serial, portId` | `accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, name, peerSgtCapable, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:write` -GET /devices/{serial}/switch/routing/interfaces
[List layer 3 interfaces for a switch](https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interfaces/)
> `getDeviceSwitchRoutingInterfaces`
| `serial, mode, protocol` | `` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId` | `switch:config:read` -POST /devices/{serial}/switch/routing/interfaces
[Create a layer 3 interface for a switch](https://developer.cisco.com/meraki/api-v1/create-device-switch-routing-interface/)
> `createDeviceSwitchRoutingInterface`
| `serial` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId` | `switch:config:write` -GET /devices/{serial}/switch/routing/interfaces/{interfaceId}
[Return a layer 3 interface for a switch](https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interface/)
> `getDeviceSwitchRoutingInterface`
| `serial, interfaceId` | `` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId` | `switch:config:read` -PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}
[Update a layer 3 interface for a switch](https://developer.cisco.com/meraki/api-v1/update-device-switch-routing-interface/)
> `updateDeviceSwitchRoutingInterface`
| `serial, interfaceId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId` | `switch:config:write` +GET /devices/{serial}/switch/ports/{portId}
[Return a switch port](https://developer.cisco.com/meraki/api-v1/get-device-switch-port/)
> `getDeviceSwitchPort`
| `serial, portId` | `` | `accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:read` +PUT /devices/{serial}/switch/ports/{portId}
[Update a switch port](https://developer.cisco.com/meraki/api-v1/update-device-switch-port/)
> `updateDeviceSwitchPort`
| `serial, portId` | `accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, macWhitelistLimit, name, peerSgtCapable, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `accessPolicyNumber, accessPolicyType, adaptivePolicyGroup, adaptivePolicyGroupId, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, peerSgtCapable, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:write` +GET /devices/{serial}/switch/routing/interfaces
[List layer 3 interfaces for a switch](https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interfaces/)
> `getDeviceSwitchRoutingInterfaces`
| `serial, protocol` | `` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `switch:config:read` +POST /devices/{serial}/switch/routing/interfaces
[Create a layer 3 interface for a switch](https://developer.cisco.com/meraki/api-v1/create-device-switch-routing-interface/)
> `createDeviceSwitchRoutingInterface`
| `serial` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `switch:config:write` +GET /devices/{serial}/switch/routing/interfaces/{interfaceId}
[Return a layer 3 interface for a switch](https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interface/)
> `getDeviceSwitchRoutingInterface`
| `serial, interfaceId` | `` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `switch:config:read` +PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}
[Update a layer 3 interface for a switch](https://developer.cisco.com/meraki/api-v1/update-device-switch-routing-interface/)
> `updateDeviceSwitchRoutingInterface`
| `serial, interfaceId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `switch:config:write` DELETE /devices/{serial}/switch/routing/interfaces/{interfaceId}
[Delete a layer 3 interface from the switch](https://developer.cisco.com/meraki/api-v1/delete-device-switch-routing-interface/)
> `deleteDeviceSwitchRoutingInterface`
| `serial, interfaceId` | `` | `` | `switch:config:write` GET /devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp
[Return a layer 3 interface DHCP configuration for a switch](https://developer.cisco.com/meraki/api-v1/get-device-switch-routing-interface-dhcp/)
> `getDeviceSwitchRoutingInterfaceDhcp`
| `serial, interfaceId` | `` | `bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value` | `switch:config:read` PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp
[Update a layer 3 interface DHCP configuration for a switch](https://developer.cisco.com/meraki/api-v1/update-device-switch-routing-interface-dhcp/)
> `updateDeviceSwitchRoutingInterfaceDhcp`
| `serial, interfaceId` | `bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value` | `bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value` | `switch:config:write` @@ -119,8 +126,8 @@ GET /devices/{serial}/wireless/latencyStats
[Aggregated latency info for GET /devices/{serial}/wireless/radio/afc/position
[Return the position for a wireless device (BETA)](https://developer.cisco.com/meraki/api-v1/get-device-wireless-radio-afc-position/)
> `getDeviceWirelessRadioAfcPosition`
| `serial` | `` | `antenna, cableLength, elevation, gps, height, id, name, network, serial, uncertainty` | `` PUT /devices/{serial}/wireless/radio/afc/position
[Update the position attributes for this device (BETA)](https://developer.cisco.com/meraki/api-v1/update-device-wireless-radio-afc-position/)
> `updateDeviceWirelessRadioAfcPosition`
| `serial` | `antenna, cableLength, elevation, gps, height, uncertainty` | `antenna, cableLength, elevation, gps, height, id, name, network, serial, uncertainty` | `` GET /devices/{serial}/wireless/radio/afc/powerLimits
[Return the AFC power limits for a wireless device (BETA)](https://developer.cisco.com/meraki/api-v1/get-device-wireless-radio-afc-power-limits/)
> `getDeviceWirelessRadioAfcPowerLimits`
| `serial` | `` | `byChannel, channel, channelWidth, expiresAt, id, lastSuccessAt, lastUpdatedAt, lat, limit, lng, location, name, network, serial, status, type, uncertainty` | `` -GET /devices/{serial}/wireless/radio/settings
[Return the radio settings of a device](https://developer.cisco.com/meraki/api-v1/get-device-wireless-radio-settings/)
> `getDeviceWirelessRadioSettings`
| `serial` | `` | `` | `wireless:config:read` -PUT /devices/{serial}/wireless/radio/settings
[Update the radio settings of a device](https://developer.cisco.com/meraki/api-v1/update-device-wireless-radio-settings/)
> `updateDeviceWirelessRadioSettings`
| `serial` | `channel, channelWidth, fiveGhzSettings, rfProfileId, targetPower, twoFourGhzSettings` | `` | `wireless:config:write` +GET /devices/{serial}/wireless/radio/settings
[Return the manually configured radio settings overrides of a device, which take precedence over RF profiles.](https://developer.cisco.com/meraki/api-v1/get-device-wireless-radio-settings/)
> `getDeviceWirelessRadioSettings`
| `serial` | `` | `` | `wireless:config:read` +PUT /devices/{serial}/wireless/radio/settings
[Update the radio settings overrides of a device, which take precedence over RF profiles.](https://developer.cisco.com/meraki/api-v1/update-device-wireless-radio-settings/)
> `updateDeviceWirelessRadioSettings`
| `serial` | `channel, channelWidth, fiveGhzSettings, rfProfileId, targetPower, twoFourGhzSettings` | `` | `wireless:config:write` GET /devices/{serial}/wireless/status
[Return the SSID statuses of an access point](https://developer.cisco.com/meraki/api-v1/get-device-wireless-status/)
> `getDeviceWirelessStatus`
| `serial` | `` | `band, basicServiceSets, broadcasting, bssid, channel, channelWidth, enabled, power, ssidName, ssidNumber, visible` | `wireless:telemetry:read` POST /devices/{serial}/wireless/zigbee/enrollments
[Enqueue a job to start enrolling doorlocks on zigbee configured MRs (BETA)](https://developer.cisco.com/meraki/api-v1/create-device-wireless-zigbee-enrollment/)
> `createDeviceWirelessZigbeeEnrollment`
| `serial` | `` | `enrollmentId, request, serial, status, url` | `` GET /devices/{serial}/wireless/zigbee/enrollments/{id}
[Return an enrollment job (BETA)](https://developer.cisco.com/meraki/api-v1/get-device-wireless-zigbee-enrollment/)
> `getDeviceWirelessZigbeeEnrollment`
| `serial, id` | `` | `doorLockId, doorLocks, enrolledAt, enrollmentId, enrollmentStartedAt, eui64, gateway, id, lastSeenAt, lqi, name, network, request, rssi, serial, shortId, status, url` | `` @@ -204,6 +211,12 @@ PUT /networks/{networkId}/appliance/trafficShaping/uplinkBandwidth
[Updat GET /networks/{networkId}/appliance/trafficShaping/uplinkSelection
[Show uplink selection settings for an MX network](https://developer.cisco.com/meraki/api-v1/get-network-appliance-traffic-shaping-uplink-selection/)
> `getNetworkApplianceTrafficShapingUplinkSelection`
| `networkId` | `` | `activeActiveAutoVpnEnabled, applications, builtinPerformanceClassName, cidr, customPerformanceClassId, defaultUplink, destination, enabled, failOverCriterion, failoverAndFailback, fqdn, host, id, immediate, loadBalancingEnabled, name, network, performanceClass, port, preferredUplink, protocol, source, trafficFilters, type, value, vlan, vpnTrafficUplinkPreferences, wanTrafficUplinkPreferences` | `sdwan:config:read` PUT /networks/{networkId}/appliance/trafficShaping/uplinkSelection
[Update uplink selection settings for an MX network](https://developer.cisco.com/meraki/api-v1/update-network-appliance-traffic-shaping-uplink-selection/)
> `updateNetworkApplianceTrafficShapingUplinkSelection`
| `networkId` | `activeActiveAutoVpnEnabled, builtinPerformanceClassName, cidr, customPerformanceClassId, defaultUplink, destination, enabled, failOverCriterion, failoverAndFailback, fqdn, host, id, immediate, loadBalancingEnabled, network, performanceClass, port, preferredUplink, protocol, source, trafficFilters, type, value, vlan, vpnTrafficUplinkPreferences, wanTrafficUplinkPreferences` | `activeActiveAutoVpnEnabled, applications, builtinPerformanceClassName, cidr, customPerformanceClassId, defaultUplink, destination, enabled, failOverCriterion, failoverAndFailback, fqdn, host, id, immediate, loadBalancingEnabled, name, network, performanceClass, port, preferredUplink, protocol, source, trafficFilters, type, value, vlan, vpnTrafficUplinkPreferences, wanTrafficUplinkPreferences` | `sdwan:config:write` PUT /networks/{networkId}/appliance/trafficShaping/vpnExclusions
[Update VPN exclusion rules for an MX network.](https://developer.cisco.com/meraki/api-v1/update-network-appliance-traffic-shaping-vpn-exclusions/)
> `updateNetworkApplianceTrafficShapingVpnExclusions`
| `networkId` | `custom, destination, id, majorApplications, name, port, protocol` | `custom, destination, id, majorApplications, name, networkId, networkName, port, protocol` | `sdwan:config:write` +POST /networks/{networkId}/appliance/umbrella/account/connect
[Connect to Cisco Umbrella account to this network (BETA)](https://developer.cisco.com/meraki/api-v1/connect-network-appliance-umbrella-account/)
> `connectNetworkApplianceUmbrellaAccount`
| `networkId` | `apiKey, apiSecret` | `umbrellaOrganizationId` | `` +DELETE /networks/{networkId}/appliance/umbrella/account/disconnect
[Disconnect Umbrella account from this network (BETA)](https://developer.cisco.com/meraki/api-v1/disconnect-network-appliance-umbrella-account/)
> `disconnectNetworkApplianceUmbrellaAccount`
| `networkId` | `` | `message, success` | `` +DELETE /networks/{networkId}/appliance/umbrella/disableProtection
[Disable umbrella protection for an MX network (BETA)](https://developer.cisco.com/meraki/api-v1/disable-network-appliance-umbrella-protection/)
> `disableNetworkApplianceUmbrellaProtection`
| `networkId` | `` | `message, success` | `` +POST /networks/{networkId}/appliance/umbrella/enableProtection
[Enable umbrella protection for an MX network (BETA)](https://developer.cisco.com/meraki/api-v1/enable-network-appliance-umbrella-protection/)
> `enableNetworkApplianceUmbrellaProtection`
| `networkId` | `` | `message, success` | `` +PUT /networks/{networkId}/appliance/umbrella/excludeDomains
[Specify one or more domain names to be excluded from being routed to Cisco Umbrella. (BETA)](https://developer.cisco.com/meraki/api-v1/exclude-network-appliance-umbrella-domains/)
> `excludeNetworkApplianceUmbrellaDomains`
| `networkId` | `domains` | `message, success` | `` +PUT /networks/{networkId}/appliance/umbrella/policies
[Update umbrella policies applied to MX network. (BETA)](https://developer.cisco.com/meraki/api-v1/policies-network-appliance-umbrella/)
> `policiesNetworkApplianceUmbrella`
| `networkId` | `policyIds` | `message, success` | `` GET /networks/{networkId}/appliance/uplinks/usageHistory
[Get the sent and received bytes for each uplink of a network.](https://developer.cisco.com/meraki/api-v1/get-network-appliance-uplinks-usage-history/)
> `getNetworkApplianceUplinksUsageHistory`
| `networkId, t0, t1, timespan, resolution` | `` | `byInterface, endTime, interface, received, sent, startTime` | `sdwan:telemetry:read` GET /networks/{networkId}/appliance/vlans
[List the VLANs for an MX network](https://developer.cisco.com/meraki/api-v1/get-network-appliance-vlans/)
> `getNetworkApplianceVlans`
| `networkId` | `` | `applianceIp, autonomous, cidr, code, comment, dhcpBootFilename, dhcpBootNextServer, dhcpBootOptionsEnabled, dhcpHandling, dhcpLeaseTime, dhcpOptions, dhcpRelayServerIps, dnsNameservers, enabled, end, fixedIpAssignments, groupPolicyId, id, interfaceId, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, reservedIpRanges, start, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type, value, vpnNatSubnet` | `sdwan:config:read` POST /networks/{networkId}/appliance/vlans
[Add a VLAN](https://developer.cisco.com/meraki/api-v1/create-network-appliance-vlan/)
> `createNetworkApplianceVlan`
| `networkId` | `adaptivePolicyGroupId, applianceIp, autonomous, cidr, code, dhcpBootOptionsEnabled, dhcpHandling, dhcpLeaseTime, dhcpOptions, enabled, groupPolicyId, id, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type, value` | `applianceIp, autonomous, cidr, enabled, groupPolicyId, id, interfaceId, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type` | `sdwan:config:write` @@ -223,9 +236,9 @@ POST /networks/{networkId}/bind
[Bind a network to a template.](https://d GET /networks/{networkId}/bluetoothClients
[List the Bluetooth clients seen by APs in this network](https://developer.cisco.com/meraki/api-v1/get-network-bluetooth-clients/)
> `getNetworkBluetoothClients`
| `networkId, t0, timespan, perPage, startingAfter, endingBefore, includeConnectivityHistory` | `` | `deviceName, id, inSightAlert, lastSeen, mac, manufacturer, name, networkId, outOfSightAlert, seenByDeviceMac, tags` | `wireless:telemetry:read` GET /networks/{networkId}/bluetoothClients/{bluetoothClientId}
[Return a Bluetooth client](https://developer.cisco.com/meraki/api-v1/get-network-bluetooth-client/)
> `getNetworkBluetoothClient`
| `networkId, bluetoothClientId, includeConnectivityHistory, connectivityHistoryTimespan` | `` | `deviceName, id, inSightAlert, lastSeen, mac, manufacturer, name, networkId, outOfSightAlert, seenByDeviceMac, tags` | `wireless:telemetry:read` GET /networks/{networkId}/camera/qualityRetentionProfiles
[List the quality retention profiles for this network](https://developer.cisco.com/meraki/api-v1/get-network-camera-quality-retention-profiles/)
> `getNetworkCameraQualityRetentionProfiles`
| `networkId` | `` | `` | `camera:config:read` -POST /networks/{networkId}/camera/qualityRetentionProfiles
[Creates new quality retention profile for this network.](https://developer.cisco.com/meraki/api-v1/create-network-camera-quality-retention-profile/)
> `createNetworkCameraQualityRetentionProfile`
| `networkId` | `MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings` | `` | `camera:config:write` +POST /networks/{networkId}/camera/qualityRetentionProfiles
[Creates new quality retention profile for this network.](https://developer.cisco.com/meraki/api-v1/create-network-camera-quality-retention-profile/)
> `createNetworkCameraQualityRetentionProfile`
| `networkId` | `MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV84X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings` | `` | `camera:config:write` GET /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
[Retrieve a single quality retention profile](https://developer.cisco.com/meraki/api-v1/get-network-camera-quality-retention-profile/)
> `getNetworkCameraQualityRetentionProfile`
| `networkId, qualityRetentionProfileId` | `` | `` | `camera:config:read` -PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
[Update an existing quality retention profile for this network.](https://developer.cisco.com/meraki/api-v1/update-network-camera-quality-retention-profile/)
> `updateNetworkCameraQualityRetentionProfile`
| `networkId, qualityRetentionProfileId` | `MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings` | `` | `camera:config:write` +PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
[Update an existing quality retention profile for this network.](https://developer.cisco.com/meraki/api-v1/update-network-camera-quality-retention-profile/)
> `updateNetworkCameraQualityRetentionProfile`
| `networkId, qualityRetentionProfileId` | `MV12/MV22/MV72, MV12WE, MV13, MV13M, MV21/MV71, MV22X/MV72X, MV23, MV23M, MV23X, MV32, MV33, MV33M, MV52, MV53X, MV63, MV63M, MV63X, MV73, MV73M, MV73X, MV84X, MV93, MV93M, MV93X, audioRecordingEnabled, cloudArchiveEnabled, enabled, maxRetentionDays, motionBasedRetentionEnabled, motionDetectorVersion, name, quality, resolution, restrictedBandwidthModeEnabled, scheduleId, smartRetention, videoSettings` | `` | `camera:config:write` DELETE /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
[Delete an existing quality retention profile for this network.](https://developer.cisco.com/meraki/api-v1/delete-network-camera-quality-retention-profile/)
> `deleteNetworkCameraQualityRetentionProfile`
| `networkId, qualityRetentionProfileId` | `` | `` | `camera:config:write` GET /networks/{networkId}/camera/schedules
[Returns a list of all camera recording schedules.](https://developer.cisco.com/meraki/api-v1/get-network-camera-schedules/)
> `getNetworkCameraSchedules`
| `networkId` | `` | `id, name` | `camera:config:read` POST /networks/{networkId}/camera/wirelessProfiles
[Creates a new camera wireless profile for this network.](https://developer.cisco.com/meraki/api-v1/create-network-camera-wireless-profile/)
> `createNetworkCameraWirelessProfile`
| `networkId` | `authMode, encryptionMode, identity, name, password, psk, ssid, username` | `appliedDeviceCount, authMode, encryptionMode, id, identity, name, password, psk, ssid, username` | `camera:config:write` @@ -249,7 +262,7 @@ GET /networks/{networkId}/clients/bandwidthUsageHistory
[Returns a timese GET /networks/{networkId}/clients/overview
[Return overview statistics for network clients](https://developer.cisco.com/meraki/api-v1/get-network-clients-overview/)
> `getNetworkClientsOverview`
| `networkId, t0, t1, timespan, resolution` | `` | `average, counts, total, usages, withHeavyUsage, withHeavyUsageAverage` | `dashboard:general:telemetry:read` POST /networks/{networkId}/clients/provision
[Provisions a client with a name and policy](https://developer.cisco.com/meraki/api-v1/provision-network-clients/)
> `provisionNetworkClients`
| `networkId` | `0, 1, 10, 11, 12, 13, 14, 2, 3, 4, 5, 6, 7, 8, 9, clients, devicePolicy, groupPolicyId, mac, name, policiesBySecurityAppliance, policiesBySsid` | `clientId, clients, devicePolicy, groupPolicyId, mac, message, name` | `dashboard:general:config:write` GET /networks/{networkId}/clients/usageHistories
[Return the usage histories for clients](https://developer.cisco.com/meraki/api-v1/get-network-clients-usage-histories/)
> `getNetworkClientsUsageHistories`
| `networkId, clients, ssidNumber, perPage, startingAfter, endingBefore, t0, t1, timespan` | `` | `` | `dashboard:general:telemetry:read` -GET /networks/{networkId}/clients/{clientId}
[Return the client associated with the given identifier](https://developer.cisco.com/meraki/api-v1/get-network-client/)
> `getNetworkClient`
| `networkId, clientId` | `` | `cdp, clientVpnConnections, connectedAt, description, disconnectedAt, firstSeen, id, ip, ip6, lastSeen, lldp, mac, manufacturer, notes, os, recentDeviceConnection, recentDeviceMac, recentDeviceName, recentDeviceSerial, remoteIp, smInstalled, ssid, status, switchport, user, vlan, wirelessCapabilities` | `dashboard:general:telemetry:read` +GET /networks/{networkId}/clients/{clientId}
[Return the client associated with the given identifier](https://developer.cisco.com/meraki/api-v1/get-network-client/)
> `getNetworkClient`
| `networkId, clientId` | `` | `cdp, clientVpnConnections, connectedAt, description, deviceTypePrediction, disconnectedAt, firstSeen, id, ip, ip6, lastSeen, lldp, mac, manufacturer, namedVlan, notes, os, recentDeviceConnection, recentDeviceMac, recentDeviceName, recentDeviceSerial, remoteIp, smInstalled, ssid, status, switchport, user, vlan, wirelessCapabilities` | `dashboard:general:telemetry:read` GET /networks/{networkId}/clients/{clientId}/policy
[Return the policy assigned to a client on the network](https://developer.cisco.com/meraki/api-v1/get-network-client-policy/)
> `getNetworkClientPolicy`
| `networkId, clientId` | `` | `devicePolicy, groupPolicyId, mac` | `dashboard:general:config:read` PUT /networks/{networkId}/clients/{clientId}/policy
[Update the policy assigned to a client on the network](https://developer.cisco.com/meraki/api-v1/update-network-client-policy/)
> `updateNetworkClientPolicy`
| `networkId, clientId` | `devicePolicy, groupPolicyId` | `devicePolicy, groupPolicyId, mac` | `dashboard:general:config:write` GET /networks/{networkId}/clients/{clientId}/splashAuthorizationStatus
[Return the splash authorization for a client, for each SSID they've associated with through splash](https://developer.cisco.com/meraki/api-v1/get-network-client-splash-authorization-status/)
> `getNetworkClientSplashAuthorizationStatus`
| `networkId, clientId` | `` | `` | `dashboard:general:config:read` @@ -321,10 +334,10 @@ GET /networks/{networkId}/pii/smOwnersForKey
[Given a piece of Personally GET /networks/{networkId}/policies/byClient
[Get policies for all clients with policies](https://developer.cisco.com/meraki/api-v1/get-network-policies-by-client/)
> `getNetworkPoliciesByClient`
| `networkId, perPage, startingAfter, endingBefore, t0, timespan` | `` | `assigned, clientId, groupPolicyId, name, ssid, ssidNumber, type` | `dashboard:general:config:read` GET /networks/{networkId}/sensor/alerts/current/overview/byMetric
[Return an overview of currently alerting sensors by metric](https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-current-overview-by-metric/)
> `getNetworkSensorAlertsCurrentOverviewByMetric`
| `networkId` | `` | `ambient, apparentPower, co2, counts, current, door, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, supportedMetrics, temperature, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:read` GET /networks/{networkId}/sensor/alerts/overview/byMetric
[Return an overview of alert occurrences over a timespan, by metric](https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-overview-by-metric/)
> `getNetworkSensorAlertsOverviewByMetric`
| `networkId, t0, t1, timespan, interval` | `` | `ambient, apparentPower, co2, counts, current, door, endTs, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, startTs, temperature, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:read` -GET /networks/{networkId}/sensor/alerts/profiles
[Lists all sensor alert profiles for a network.](https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-profiles/)
> `getNetworkSensorAlertsProfiles`
| `networkId` | `` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:read` -POST /networks/{networkId}/sensor/alerts/profiles
[Creates a sensor alert profile for a network.](https://developer.cisco.com/meraki/api-v1/create-network-sensor-alerts-profile/)
> `createNetworkSensorAlertsProfile`
| `networkId` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:write` -GET /networks/{networkId}/sensor/alerts/profiles/{id}
[Show details of a sensor alert profile for a network.](https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-profile/)
> `getNetworkSensorAlertsProfile`
| `networkId, id` | `` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:read` -PUT /networks/{networkId}/sensor/alerts/profiles/{id}
[Updates a sensor alert profile for a network.](https://developer.cisco.com/meraki/api-v1/update-network-sensor-alerts-profile/)
> `updateNetworkSensorAlertsProfile`
| `networkId, id` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, indoorAirQuality, level, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:write` +GET /networks/{networkId}/sensor/alerts/profiles
[Lists all sensor alert profiles for a network.](https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-profiles/)
> `getNetworkSensorAlertsProfiles`
| `networkId` | `` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:read` +POST /networks/{networkId}/sensor/alerts/profiles
[Creates a sensor alert profile for a network.](https://developer.cisco.com/meraki/api-v1/create-network-sensor-alerts-profile/)
> `createNetworkSensorAlertsProfile`
| `networkId` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:write` +GET /networks/{networkId}/sensor/alerts/profiles/{id}
[Show details of a sensor alert profile for a network.](https://developer.cisco.com/meraki/api-v1/get-network-sensor-alerts-profile/)
> `getNetworkSensorAlertsProfile`
| `networkId, id` | `` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:read` +PUT /networks/{networkId}/sensor/alerts/profiles/{id}
[Updates a sensor alert profile for a network.](https://developer.cisco.com/meraki/api-v1/update-network-sensor-alerts-profile/)
> `updateNetworkSensorAlertsProfile`
| `networkId, id` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `ambient, apparentPower, celsius, co2, concentration, conditions, current, direction, door, draw, duration, emails, fahrenheit, frequency, httpServerIds, humidity, id, includeSensorUrl, indoorAirQuality, level, message, metric, name, noise, open, outageDetected, percentage, pm25, powerFactor, present, profileId, quality, realPower, recipients, relativePercentage, schedule, score, serials, smsNumbers, temperature, threshold, tvoc, upstreamPower, voltage, water` | `sensor:telemetry:write` DELETE /networks/{networkId}/sensor/alerts/profiles/{id}
[Deletes a sensor alert profile from a network.](https://developer.cisco.com/meraki/api-v1/delete-network-sensor-alerts-profile/)
> `deleteNetworkSensorAlertsProfile`
| `networkId, id` | `` | `` | `sensor:telemetry:write` GET /networks/{networkId}/sensor/mqttBrokers
[List the sensor settings of all MQTT brokers for this network](https://developer.cisco.com/meraki/api-v1/get-network-sensor-mqtt-brokers/)
> `getNetworkSensorMqttBrokers`
| `networkId` | `` | `enabled, mqttBrokerId` | `sensor:telemetry:read` GET /networks/{networkId}/sensor/mqttBrokers/{mqttBrokerId}
[Return the sensor settings of an MQTT broker](https://developer.cisco.com/meraki/api-v1/get-network-sensor-mqtt-broker/)
> `getNetworkSensorMqttBroker`
| `networkId, mqttBrokerId` | `` | `enabled, mqttBrokerId` | `sensor:telemetry:read` @@ -379,10 +392,10 @@ GET /networks/{networkId}/splashLoginAttempts
[List the splash login atte POST /networks/{networkId}/split
[Split a combined network into individual networks for each type of device](https://developer.cisco.com/meraki/api-v1/split-network/)
> `splitNetwork`
| `networkId` | `` | `enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, resultingNetworks, tags, timeZone, url` | `dashboard:general:config:write` GET /networks/{networkId}/switch/accessControlLists
[Return the access control lists for a MS network](https://developer.cisco.com/meraki/api-v1/get-network-switch-access-control-lists/)
> `getNetworkSwitchAccessControlLists`
| `networkId` | `` | `comment, dstCidr, dstPort, ipVersion, policy, protocol, rules, srcCidr, srcPort, vlan` | `switch:config:read` PUT /networks/{networkId}/switch/accessControlLists
[Update the access control lists for a MS network](https://developer.cisco.com/meraki/api-v1/update-network-switch-access-control-lists/)
> `updateNetworkSwitchAccessControlLists`
| `networkId` | `comment, dstCidr, dstPort, ipVersion, policy, protocol, rules, srcCidr, srcPort, vlan` | `comment, dstCidr, dstPort, ipVersion, policy, protocol, rules, srcCidr, srcPort, vlan` | `switch:config:write` -GET /networks/{networkId}/switch/accessPolicies
[List the access policies for a switch network](https://developer.cisco.com/meraki/api-v1/get-network-switch-access-policies/)
> `getNetworkSwitchAccessPolicies`
| `networkId` | `` | `accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy` | `switch:config:read` -POST /networks/{networkId}/switch/accessPolicies
[Create an access policy for a switch network](https://developer.cisco.com/meraki/api-v1/create-network-switch-access-policy/)
> `createNetworkSwitchAccessPolicy`
| `networkId` | `accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId` | `accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy` | `switch:config:write` -GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
[Return a specific access policy for a switch network](https://developer.cisco.com/meraki/api-v1/get-network-switch-access-policy/)
> `getNetworkSwitchAccessPolicy`
| `networkId, accessPolicyNumber` | `` | `accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy` | `switch:config:read` -PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
[Update an access policy for a switch network](https://developer.cisco.com/meraki/api-v1/update-network-switch-access-policy/)
> `updateNetworkSwitchAccessPolicy`
| `networkId, accessPolicyNumber` | `accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId` | `accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy` | `switch:config:write` +GET /networks/{networkId}/switch/accessPolicies
[List the access policies for a switch network](https://developer.cisco.com/meraki/api-v1/get-network-switch-access-policies/)
> `getNetworkSwitchAccessPolicies`
| `networkId` | `` | `accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy` | `switch:config:read` +POST /networks/{networkId}/switch/accessPolicies
[Create an access policy for a switch network](https://developer.cisco.com/meraki/api-v1/create-network-switch-access-policy/)
> `createNetworkSwitchAccessPolicy`
| `networkId` | `accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId` | `accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy` | `switch:config:write` +GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
[Return a specific access policy for a switch network](https://developer.cisco.com/meraki/api-v1/get-network-switch-access-policy/)
> `getNetworkSwitchAccessPolicy`
| `networkId, accessPolicyNumber` | `` | `accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy` | `switch:config:read` +PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
[Update an access policy for a switch network](https://developer.cisco.com/meraki/api-v1/update-network-switch-access-policy/)
> `updateNetworkSwitchAccessPolicy`
| `networkId, accessPolicyNumber` | `accessPolicyType, cache, controlDirection, criticalAuth, dataVlanId, dot1x, enabled, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, secret, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId` | `accessPolicyType, cache, controlDirection, counts, criticalAuth, dataVlanId, dot1x, enabled, enforceRadiusMonitoring, failedAuthVlanId, guestPortBouncing, guestVlanId, host, hostMode, increaseAccessSpeed, name, organizationRadiusServerId, port, ports, radius, radiusAccountingEnabled, radiusAccountingServers, radiusCoaSupportEnabled, radiusGroupAttribute, radiusServers, radiusTestingEnabled, reAuthenticationInterval, serverId, suspendPortBounce, timeout, urlRedirectWalledGardenEnabled, urlRedirectWalledGardenRanges, voiceVlanClients, voiceVlanId, withThisPolicy` | `switch:config:write` DELETE /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
[Delete an access policy for a switch network](https://developer.cisco.com/meraki/api-v1/delete-network-switch-access-policy/)
> `deleteNetworkSwitchAccessPolicy`
| `networkId, accessPolicyNumber` | `` | `` | `switch:config:write` GET /networks/{networkId}/switch/alternateManagementInterface
[Return the switch alternate management interface for the network](https://developer.cisco.com/meraki/api-v1/get-network-switch-alternate-management-interface/)
> `getNetworkSwitchAlternateManagementInterface`
| `networkId` | `` | `alternateManagementIp, enabled, gateway, protocols, serial, subnetMask, switches, vlanId` | `switch:config:read` PUT /networks/{networkId}/switch/alternateManagementInterface
[Update the switch alternate management interface for the network](https://developer.cisco.com/meraki/api-v1/update-network-switch-alternate-management-interface/)
> `updateNetworkSwitchAlternateManagementInterface`
| `networkId` | `alternateManagementIp, enabled, gateway, protocols, serial, subnetMask, switches, vlanId` | `alternateManagementIp, enabled, gateway, protocols, serial, subnetMask, switches, vlanId` | `switch:config:write` @@ -435,10 +448,10 @@ DELETE /networks/{networkId}/switch/stacks/{switchStackId}
[Delete a stac POST /networks/{networkId}/switch/stacks/{switchStackId}/add
[Add a switch to a stack](https://developer.cisco.com/meraki/api-v1/add-network-switch-stack/)
> `addNetworkSwitchStack`
| `networkId, switchStackId` | `serial` | `id, isMonitorOnly, mac, members, model, name, role, serial, serials` | `switch:config:write` PUT /networks/{networkId}/switch/stacks/{switchStackId}/ports/mirror
[Update switch port mirrors for switch stacks (BETA)](https://developer.cisco.com/meraki/api-v1/update-network-switch-stack-ports-mirror/)
> `updateNetworkSwitchStackPortsMirror`
| `networkId, switchStackId` | `comment, destination, filter, hasTransitVlan, module, number, port, ports, role, serial, slot, source, tags, type, vlan, vlans` | `comment, destination, filter, hasTransitVlan, id, mirror, module, name, network, number, port, ports, role, serial, slot, source, switchStackId, tags, type, vlan, vlans, warnings` | `` POST /networks/{networkId}/switch/stacks/{switchStackId}/remove
[Remove a switch from a stack](https://developer.cisco.com/meraki/api-v1/remove-network-switch-stack/)
> `removeNetworkSwitchStack`
| `networkId, switchStackId` | `serial` | `id, isMonitorOnly, mac, members, model, name, role, serial, serials` | `switch:config:write` -GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
[List layer 3 interfaces for a switch stack](https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interfaces/)
> `getNetworkSwitchStackRoutingInterfaces`
| `networkId, switchStackId` | `` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId` | `switch:config:read` -POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
[Create a layer 3 interface for a switch stack](https://developer.cisco.com/meraki/api-v1/create-network-switch-stack-routing-interface/)
> `createNetworkSwitchStackRoutingInterface`
| `networkId, switchStackId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId` | `switch:config:write` -GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
[Return a layer 3 interface from a switch stack](https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interface/)
> `getNetworkSwitchStackRoutingInterface`
| `networkId, switchStackId, interfaceId` | `` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId` | `switch:config:read` -PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
[Update a layer 3 interface for a switch stack](https://developer.cisco.com/meraki/api-v1/update-network-switch-stack-routing-interface/)
> `updateNetworkSwitchStackRoutingInterface`
| `networkId, switchStackId, interfaceId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `address, area, assignmentMode, cost, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, mode, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, switchPortId, uplinkV4, uplinkV6, vlanId` | `switch:config:write` +GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
[List layer 3 interfaces for a switch stack](https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interfaces/)
> `getNetworkSwitchStackRoutingInterfaces`
| `networkId, switchStackId, protocol` | `` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `switch:config:read` +POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
[Create a layer 3 interface for a switch stack](https://developer.cisco.com/meraki/api-v1/create-network-switch-stack-routing-interface/)
> `createNetworkSwitchStackRoutingInterface`
| `networkId, switchStackId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `switch:config:write` +GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
[Return a layer 3 interface from a switch stack](https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interface/)
> `getNetworkSwitchStackRoutingInterface`
| `networkId, switchStackId, interfaceId` | `` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `switch:config:read` +PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
[Update a layer 3 interface for a switch stack](https://developer.cisco.com/meraki/api-v1/update-network-switch-stack-routing-interface/)
> `updateNetworkSwitchStackRoutingInterface`
| `networkId, switchStackId, interfaceId` | `address, area, assignmentMode, cost, defaultGateway, gateway, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `address, area, assignmentMode, cost, gateway, interfaceId, interfaceIp, ipv6, isPassiveEnabled, multicastRouting, name, ospfSettings, ospfV3, prefix, staticV4Dns1, staticV4Dns2, staticV6Dns1, staticV6Dns2, subnet, uplinkV4, uplinkV6, vlanId` | `switch:config:write` DELETE /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
[Delete a layer 3 interface from a switch stack](https://developer.cisco.com/meraki/api-v1/delete-network-switch-stack-routing-interface/)
> `deleteNetworkSwitchStackRoutingInterface`
| `networkId, switchStackId, interfaceId` | `` | `` | `switch:config:write` GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp
[Return a layer 3 interface DHCP configuration for a switch stack](https://developer.cisco.com/meraki/api-v1/get-network-switch-stack-routing-interface-dhcp/)
> `getNetworkSwitchStackRoutingInterfaceDhcp`
| `networkId, switchStackId, interfaceId` | `` | `bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value` | `switch:config:read` PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp
[Update a layer 3 interface DHCP configuration for a switch stack](https://developer.cisco.com/meraki/api-v1/update-network-switch-stack-routing-interface-dhcp/)
> `updateNetworkSwitchStackRoutingInterfaceDhcp`
| `networkId, switchStackId, interfaceId` | `bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value` | `bootFileName, bootNextServer, bootOptionsEnabled, code, comment, dhcpLeaseTime, dhcpMode, dhcpOptions, dhcpRelayServerIps, dnsCustomNameservers, dnsNameserversOption, end, fixedIpAssignments, ip, mac, name, reservedIpRanges, start, type, value` | `switch:config:write` @@ -519,7 +532,7 @@ DELETE /networks/{networkId}/wireless/ethernet/ports/profiles/{profileId}
GET /networks/{networkId}/wireless/failedConnections
[List of all failed client connection events on this network in a given time range](https://developer.cisco.com/meraki/api-v1/get-network-wireless-failed-connections/)
> `getNetworkWirelessFailedConnections`
| `networkId, t0, t1, timespan, band, ssid, vlan, apTag, serial, clientId` | `` | `clientMac, failureStep, serial, ssidNumber, ts, type, vlan` | `wireless:telemetry:read` GET /networks/{networkId}/wireless/latencyHistory
[Return average wireless latency over time for a network, device, or network client](https://developer.cisco.com/meraki/api-v1/get-network-wireless-latency-history/)
> `getNetworkWirelessLatencyHistory`
| `networkId, t0, t1, timespan, resolution, autoResolution, clientId, deviceSerial, apTag, band, ssid, accessCategory` | `` | `avgLatencyMs, endTs, startTs` | `wireless:telemetry:read` GET /networks/{networkId}/wireless/latencyStats
[Aggregated latency info for this network](https://developer.cisco.com/meraki/api-v1/get-network-wireless-latency-stats/)
> `getNetworkWirelessLatencyStats`
| `networkId, t0, t1, timespan, band, ssid, vlan, apTag, fields` | `` | `` | `wireless:telemetry:read` -PUT /networks/{networkId}/wireless/location/scanning
[Change scanning API settings (BETA)](https://developer.cisco.com/meraki/api-v1/update-network-wireless-location-scanning/)
> `updateNetworkWirelessLocationScanning`
| `networkId` | `api, enabled` | `api, enabled, string, validator` | `wireless:telemetry:write` +PUT /networks/{networkId}/wireless/location/scanning
[Change scanning API settings](https://developer.cisco.com/meraki/api-v1/update-network-wireless-location-scanning/)
> `updateNetworkWirelessLocationScanning`
| `networkId` | `api, enabled` | `api, enabled, string, validator` | `wireless:telemetry:write` GET /networks/{networkId}/wireless/meshStatuses
[List wireless mesh statuses for repeaters](https://developer.cisco.com/meraki/api-v1/get-network-wireless-mesh-statuses/)
> `getNetworkWirelessMeshStatuses`
| `networkId, perPage, startingAfter, endingBefore` | `` | `latestMeshPerformance, mbps, meshRoute, metric, serial, usagePercentage` | `wireless:telemetry:read` PUT /networks/{networkId}/wireless/opportunisticPcap
[Update the Opportunistic Pcap settings for a wireless network (BETA)](https://developer.cisco.com/meraki/api-v1/update-network-wireless-opportunistic-pcap/)
> `updateNetworkWirelessOpportunisticPcap`
| `networkId` | `enablement, networkWide, serials, tags` | `enablement, name, networkId, networkWide, serials, tags` | `` PUT /networks/{networkId}/wireless/radio/autoRf
[Update the AutoRF settings for a wireless network (BETA)](https://developer.cisco.com/meraki/api-v1/update-network-wireless-radio-auto-rf/)
> `updateNetworkWirelessRadioAutoRf`
| `networkId` | `aiRrm, avoidance, busyHour, channel, enabled, end, fra, manual, minimizeChanges, mode, schedule, start` | `aiRrm, automatic, avoidance, busyHour, channel, enabled, enablementDate, end, fra, manual, minimizeChanges, mode, name, networkId, schedule, start, timeZone` | `` @@ -533,7 +546,7 @@ PUT /networks/{networkId}/wireless/settings
[Update the wireless settings GET /networks/{networkId}/wireless/signalQualityHistory
[Return signal quality (SNR/RSSI) over time for a device or network client](https://developer.cisco.com/meraki/api-v1/get-network-wireless-signal-quality-history/)
> `getNetworkWirelessSignalQualityHistory`
| `networkId, t0, t1, timespan, resolution, autoResolution, clientId, deviceSerial, apTag, band, ssid` | `` | `endTs, rssi, snr, startTs` | `wireless:telemetry:read` GET /networks/{networkId}/wireless/ssids
[List the MR SSIDs in a network](https://developer.cisco.com/meraki/api-v1/get-network-wireless-ssids/)
> `getNetworkWirelessSsids`
| `networkId` | `` | `adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode` | `wireless:config:read` GET /networks/{networkId}/wireless/ssids/{number}
[Return a single MR SSID](https://developer.cisco.com/meraki/api-v1/get-network-wireless-ssid/)
> `getNetworkWirelessSsid`
| `networkId, number` | `` | `adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode` | `wireless:config:read` -PUT /networks/{networkId}/wireless/ssids/{number}
[Update the attributes of an MR SSID](https://developer.cisco.com/meraki/api-v1/update-network-wireless-ssid/)
> `updateNetworkWirelessSsid`
| `networkId, number` | `activeDirectory, adaptive, adultContentFilteringEnabled, allowedDomains, apTagsAndVlanIds, authMode, availabilityTags, availableOnAllAps, bandSelection, baseDistinguishedName, byApTags, caCertificate, cacheTimeout, certificateAuthentication, clientRootCaCertificate, concentrator, concentratorNetworkId, contents, credentials, defaultVlanId, defaultVlanName, disassociateClientsOnVpnFailover, distinguishedName, dnsCustomNameservers, dnsRewrite, dot11r, dot11w, enabled, encryptionMode, enterpriseAdminAccess, gre, guestVlan, host, ipAssignmentMode, key, lanIsolationEnabled, ldap, localRadius, logonName, mandatoryDhcpEnabled, minBitrate, name, namedVlans, oauth, ocspResponderUrl, openRoamingCertificateId, password, passwordAuthentication, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, psk, radius, radiusAccountingEnabled, radiusAccountingInterimInterval, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusAuthenticationNasId, radiusCalledStationId, radiusCoaEnabled, radiusFailoverPolicy, radiusFallbackEnabled, radiusGuestVlanEnabled, radiusGuestVlanId, radiusLoadBalancingPolicy, radiusOverride, radiusProxyEnabled, radiusRadsec, radiusServerAttemptsLimit, radiusServerTimeout, radiusServers, radiusTestingEnabled, radsecEnabled, required, secondaryConcentratorNetworkId, secret, serverCaCertificate, servers, speedBurst, splashGuestSponsorDomains, splashPage, tagging, tags, timeout, tlsTunnel, useLdap, useOcsp, useVlanTagging, visible, vlanId, vlanName, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode` | `adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode` | `wireless:config:write` +PUT /networks/{networkId}/wireless/ssids/{number}
[Update the attributes of an MR SSID](https://developer.cisco.com/meraki/api-v1/update-network-wireless-ssid/)
> `updateNetworkWirelessSsid`
| `networkId, number` | `activeDirectory, adaptive, adaptivePolicyGroupId, adultContentFilteringEnabled, allowedDomains, apTagsAndVlanIds, authMode, availabilityTags, availableOnAllAps, bandSelection, baseDistinguishedName, byApTags, caCertificate, cacheTimeout, certificateAuthentication, clientRootCaCertificate, concentrator, concentratorNetworkId, contents, credentials, defaultVlanId, defaultVlanName, disassociateClientsOnVpnFailover, distinguishedName, dnsCustomNameservers, dnsRewrite, dot11r, dot11w, enabled, encryptionMode, enterpriseAdminAccess, gre, guestVlan, host, ipAssignmentMode, key, lanIsolationEnabled, ldap, localRadius, logonName, mandatoryDhcpEnabled, minBitrate, name, namedVlans, oauth, ocspResponderUrl, openRoamingCertificateId, password, passwordAuthentication, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, psk, radius, radiusAccountingEnabled, radiusAccountingInterimInterval, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusAuthenticationNasId, radiusCalledStationId, radiusCoaEnabled, radiusFailoverPolicy, radiusFallbackEnabled, radiusGuestVlanEnabled, radiusGuestVlanId, radiusLoadBalancingPolicy, radiusOverride, radiusProxyEnabled, radiusRadsec, radiusServerAttemptsLimit, radiusServerTimeout, radiusServers, radiusTestingEnabled, radsecEnabled, required, secondaryConcentratorNetworkId, secret, serverCaCertificate, servers, speedBurst, splashGuestSponsorDomains, splashPage, tagging, tags, timeout, tlsTunnel, useLdap, useOcsp, useVlanTagging, visible, vlanId, vlanName, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode` | `adminSplashUrl, authMode, availabilityTags, availableOnAllAps, bandSelection, caCertificate, enabled, encryptionMode, host, ipAssignmentMode, localAuth, mandatoryDhcpEnabled, minBitrate, name, number, openRoamingCertificateId, perClientBandwidthLimitDown, perClientBandwidthLimitUp, perSsidBandwidthLimitDown, perSsidBandwidthLimitUp, port, radiusAccountingEnabled, radiusAccountingServers, radiusAttributeForGroupPolicies, radiusEnabled, radiusFailoverPolicy, radiusLoadBalancingPolicy, radiusServers, splashPage, splashTimeout, ssidAdminAccessible, visible, walledGardenEnabled, walledGardenRanges, wpaEncryptionMode` | `wireless:config:write` GET /networks/{networkId}/wireless/ssids/{number}/bonjourForwarding
[List the Bonjour forwarding setting and rules for the SSID](https://developer.cisco.com/meraki/api-v1/get-network-wireless-ssid-bonjour-forwarding/)
> `getNetworkWirelessSsidBonjourForwarding`
| `networkId, number` | `` | `description, enabled, exception, rules, services, vlanId` | `wireless:config:read` PUT /networks/{networkId}/wireless/ssids/{number}/bonjourForwarding
[Update the bonjour forwarding setting and rules for the SSID](https://developer.cisco.com/meraki/api-v1/update-network-wireless-ssid-bonjour-forwarding/)
> `updateNetworkWirelessSsidBonjourForwarding`
| `networkId, number` | `description, enabled, exception, rules, services, vlanId` | `description, enabled, exception, rules, services, vlanId` | `wireless:config:write` GET /networks/{networkId}/wireless/ssids/{number}/deviceTypeGroupPolicies
[List the device type group policies for the SSID](https://developer.cisco.com/meraki/api-v1/get-network-wireless-ssid-device-type-group-policies/)
> `getNetworkWirelessSsidDeviceTypeGroupPolicies`
| `networkId, number` | `` | `` | `wireless:config:read` @@ -603,7 +616,7 @@ GET /organizations/{organizationId}/apiRequests/overview/responseCodes/byInterva GET /organizations/{organizationId}/appliance/dns/local/profiles
[Fetch the local DNS profiles used in the organization](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-dns-local-profiles/)
> `getOrganizationApplianceDnsLocalProfiles`
| `organizationId, profileIds` | `` | `name, profileId` | `` POST /organizations/{organizationId}/appliance/dns/local/profiles
[Create a new local DNS profile](https://developer.cisco.com/meraki/api-v1/create-organization-appliance-dns-local-profile/)
> `createOrganizationApplianceDnsLocalProfile`
| `organizationId` | `name` | `name, profileId` | `` GET /organizations/{organizationId}/appliance/dns/local/profiles/assignments
[Fetch the local DNS profile assignments in the organization](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-dns-local-profiles-assignments/)
> `getOrganizationApplianceDnsLocalProfilesAssignments`
| `organizationId, profileIds, networkIds` | `` | `assignmentId, counts, id, items, meta, network, profile, remaining, total` | `` -POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate
[Assign the local DNS profile to networks in the organization](https://developer.cisco.com/meraki/api-v1/create-organization-appliance-dns-local-profiles-assignments-bulk-create/)
> `createOrganizationApplianceDnsLocalProfilesAssignmentsBulkCreate`
| `organizationId` | `id, items, network, profile` | `assignmentId, id, items, network, profile` | `` +POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate
[Assign the local DNS profile to networks in the organization](https://developer.cisco.com/meraki/api-v1/bulk-organization-appliance-dns-local-profiles-assignments-create/)
> `bulkOrganizationApplianceDnsLocalProfilesAssignmentsCreate`
| `organizationId` | `id, items, network, profile` | `assignmentId, id, items, network, profile` | `` POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkDelete
[Unassign the local DNS profile to networks in the organization](https://developer.cisco.com/meraki/api-v1/create-organization-appliance-dns-local-profiles-assignments-bulk-delete/)
> `createOrganizationApplianceDnsLocalProfilesAssignmentsBulkDelete`
| `organizationId` | `assignmentId, items` | `assignmentId, id, items, network, profile` | `` PUT /organizations/{organizationId}/appliance/dns/local/profiles/{profileId}
[Update a local DNS profile](https://developer.cisco.com/meraki/api-v1/update-organization-appliance-dns-local-profile/)
> `updateOrganizationApplianceDnsLocalProfile`
| `organizationId, profileId` | `name` | `name, profileId` | `` DELETE /organizations/{organizationId}/appliance/dns/local/profiles/{profileId}
[Deletes a local DNS profile](https://developer.cisco.com/meraki/api-v1/delete-organization-appliance-dns-local-profile/)
> `deleteOrganizationApplianceDnsLocalProfile`
| `organizationId, profileId` | `` | `` | `` @@ -627,20 +640,22 @@ GET /organizations/{organizationId}/appliance/trafficShaping/vpnExclusions/byNet GET /organizations/{organizationId}/appliance/uplink/statuses
[List the uplink status of every Meraki MX and Z series appliances in the organization](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-uplink-statuses/)
> `getOrganizationApplianceUplinkStatuses`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, serials, iccids` | `` | `enabled, gateway, highAvailability, interface, ip, ipAssignedBy, lastReportedAt, model, networkId, primaryDns, publicIp, role, secondaryDns, serial, status, uplinks` | `sdwan:telemetry:read` GET /organizations/{organizationId}/appliance/uplinks/statuses/overview
[Returns an overview of uplink statuses](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-uplinks-statuses-overview/)
> `getOrganizationApplianceUplinksStatusesOverview`
| `organizationId` | `` | `active, byStatus, connecting, counts, failed, notConnected, ready` | `` GET /organizations/{organizationId}/appliance/uplinks/usage/byNetwork
[Get the sent and received bytes for each uplink of all MX and Z networks within an organization](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-uplinks-usage-by-network/)
> `getOrganizationApplianceUplinksUsageByNetwork`
| `organizationId, t0, t1, timespan` | `` | `byUplink, interface, name, networkId, received, sent, serial` | `sdwan:telemetry:read` +GET /organizations/{organizationId}/appliance/vlans
[List the VLANs for an Organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vlans/)
> `getOrganizationApplianceVlans`
| `organizationId, perPage, startingAfter, endingBefore` | `` | `applianceIp, autonomous, cidr, code, comment, dhcpBootFilename, dhcpBootNextServer, dhcpBootOptionsEnabled, dhcpHandling, dhcpLeaseTime, dhcpOptions, dhcpRelayServerIps, dnsNameservers, enabled, end, fixedIpAssignments, groupPolicyId, id, interfaceId, interfaces, ipv6, mandatoryDhcp, mask, name, origin, prefixAssignments, reservedIpRanges, start, staticApplianceIp6, staticPrefix, subnet, templateVlanType, type, value, vpnNatSubnet` | `` GET /organizations/{organizationId}/appliance/vpn/stats
[Show VPN history stat for networks in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vpn-stats/)
> `getOrganizationApplianceVpnStats`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, t0, t1, timespan` | `` | `avgJitter, avgLatencyMs, avgLossPercentage, avgMos, jitterSummaries, latencySummaries, lossPercentageSummaries, maxJitter, maxLatencyMs, maxLossPercentage, maxMos, merakiVpnPeers, minJitter, minLatencyMs, minLossPercentage, minMos, mosSummaries, networkId, networkName, receivedInKilobytes, receiverUplink, senderUplink, sentInKilobytes, usageSummary` | `sdwan:telemetry:read` GET /organizations/{organizationId}/appliance/vpn/statuses
[Show VPN status for networks in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vpn-statuses/)
> `getOrganizationApplianceVpnStatuses`
| `organizationId, perPage, startingAfter, endingBefore, networkIds` | `` | `deviceSerial, deviceStatus, exportedSubnets, interface, merakiVpnPeers, name, networkId, networkName, publicIp, reachability, subnet, thirdPartyVpnPeers, uplinks, vpnMode, vpnstatusentities` | `sdwan:telemetry:read` GET /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers
[Return the third party VPN peers for an organization](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vpn-third-party-vpnpeers/)
> `getOrganizationApplianceVpnThirdPartyVPNPeers`
| `organizationId` | `` | `childAuthAlgo, childCipherAlgo, childLifetime, childPfsGroup, ikeAuthAlgo, ikeCipherAlgo, ikeDiffieHellmanGroup, ikeLifetime, ikePrfAlgo, ikeVersion, ipsecPolicies, ipsecPoliciesPreset, localId, name, networkTags, peers, privateSubnets, publicIp, remoteId, secret` | `sdwan:config:read` PUT /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers
[Update the third party VPN peers for an organization](https://developer.cisco.com/meraki/api-v1/update-organization-appliance-vpn-third-party-vpnpeers/)
> `updateOrganizationApplianceVpnThirdPartyVPNPeers`
| `organizationId` | `childAuthAlgo, childCipherAlgo, childLifetime, childPfsGroup, ikeAuthAlgo, ikeCipherAlgo, ikeDiffieHellmanGroup, ikeLifetime, ikePrfAlgo, ikeVersion, ipsecPolicies, ipsecPoliciesPreset, localId, name, networkTags, peers, privateSubnets, publicHostname, publicIp, remoteId, secret` | `childAuthAlgo, childCipherAlgo, childLifetime, childPfsGroup, ikeAuthAlgo, ikeCipherAlgo, ikeDiffieHellmanGroup, ikeLifetime, ikePrfAlgo, ikeVersion, ipsecPolicies, ipsecPoliciesPreset, localId, name, networkTags, peers, privateSubnets, publicIp, remoteId, secret` | `sdwan:config:write` GET /organizations/{organizationId}/appliance/vpn/vpnFirewallRules
[Return the firewall rules for an organization's site-to-site VPN](https://developer.cisco.com/meraki/api-v1/get-organization-appliance-vpn-vpn-firewall-rules/)
> `getOrganizationApplianceVpnVpnFirewallRules`
| `organizationId` | `` | `comment, destCidr, destPort, policy, protocol, rules, srcCidr, srcPort, syslogEnabled` | `sdwan:config:read` PUT /organizations/{organizationId}/appliance/vpn/vpnFirewallRules
[Update the firewall rules of an organization's site-to-site VPN](https://developer.cisco.com/meraki/api-v1/update-organization-appliance-vpn-vpn-firewall-rules/)
> `updateOrganizationApplianceVpnVpnFirewallRules`
| `organizationId` | `comment, destCidr, destPort, policy, protocol, rules, srcCidr, srcPort, syslogDefaultRule, syslogEnabled` | `comment, destCidr, destPort, policy, protocol, rules, srcCidr, srcPort, syslogEnabled` | `sdwan:config:write` -GET /organizations/{organizationId}/assurance/alerts
[Return all health alerts for an organization](https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts/)
> `getOrganizationAssuranceAlerts`
| `organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, sortBy, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes` | `` | `applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url` | `` +GET /organizations/{organizationId}/assurance/alerts
[Return all health alerts for an organization](https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts/)
> `getOrganizationAssuranceAlerts`
| `organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, sortBy, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes` | `` | `applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, others, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url` | `` POST /organizations/{organizationId}/assurance/alerts/dismiss
[Dismiss health alerts](https://developer.cisco.com/meraki/api-v1/dismiss-organization-assurance-alerts/)
> `dismissOrganizationAssuranceAlerts`
| `organizationId` | `alertIds` | `` | `` GET /organizations/{organizationId}/assurance/alerts/overview
[Return overview of active health alerts for an organization](https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts-overview/)
> `getOrganizationAssuranceAlertsOverview`
| `organizationId, networkId, severity, types, tsStart, tsEnd, category, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes` | `` | `bySeverity, count, counts, total, type` | `` GET /organizations/{organizationId}/assurance/alerts/overview/byNetwork
[Return a Summary of Alerts grouped by network and severity](https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts-overview-by-network/)
> `getOrganizationAssuranceAlertsOverviewByNetwork`
| `organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes` | `` | `alertCount, count, counts, items, meta, networkId, networkName, severityCounts, type` | `dashboard:general:telemetry:read` GET /organizations/{organizationId}/assurance/alerts/overview/byType
[Return a Summary of Alerts grouped by type and severity](https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts-overview-by-type/)
> `getOrganizationAssuranceAlertsOverviewByType`
| `organizationId, perPage, startingAfter, endingBefore, sortOrder, networkId, severity, types, tsStart, tsEnd, category, sortBy, serials, deviceTypes, deviceTags, active, dismissed, resolved, suppressAlertsForOfflineNodes` | `` | `count, counts, items, meta, type` | `` GET /organizations/{organizationId}/assurance/alerts/overview/historical
[Returns historical health alert overviews](https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alerts-overview-historical/)
> `getOrganizationAssuranceAlertsOverviewHistorical`
| `organizationId, segmentDuration, networkId, severity, types, tsStart, tsEnd, category, serials, deviceTypes` | `` | `byAlertType, counts, critical, informational, items, meta, segmentStart, totals, type, warning` | `` POST /organizations/{organizationId}/assurance/alerts/restore
[Restore health alerts from dismissed](https://developer.cisco.com/meraki/api-v1/restore-organization-assurance-alerts/)
> `restoreOrganizationAssuranceAlerts`
| `organizationId` | `alertIds` | `` | `` -GET /organizations/{organizationId}/assurance/alerts/{id}
[Return a singular Health Alert by its id](https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alert/)
> `getOrganizationAssuranceAlert`
| `organizationId, id` | `` | `applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url` | `` +GET /organizations/{organizationId}/assurance/alerts/{id}
[Return a singular Health Alert by its id](https://developer.cisco.com/meraki/api-v1/get-organization-assurance-alert/)
> `getOrganizationAssuranceAlert`
| `organizationId, id` | `` | `applications, categoryType, description, deviceType, devices, dismissedAt, id, imei, lldp, mac, name, network, order, others, peers, port, productType, resolvedAt, scope, serial, severity, startedAt, title, type, url` | `` +GET /organizations/{organizationId}/assurance/productAnnouncements
[Gets relevant product announcements for a user (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-assurance-product-announcements/)
> `getOrganizationAssuranceProductAnnouncements`
| `organizationId, t0, timespan, onlyRelevant` | `` | `boardId, counts, editedAt, id, items, labels, meta, name, publishedAt, snippet, title, total, url` | `` GET /organizations/{organizationId}/auth/radius/servers
[List the organization-wide RADIUS servers in the organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-auth-radius-servers/)
> `getOrganizationAuthRadiusServers`
| `organizationId` | `` | `address, mode, modes, name, port, serverId` | `switch:config:read` POST /organizations/{organizationId}/auth/radius/servers
[Add an organization-wide RADIUS server (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-auth-radius-server/)
> `createOrganizationAuthRadiusServer`
| `organizationId` | `address, mode, modes, name, port, secret` | `address, mode, modes, name, port, serverId` | `switch:config:write` GET /organizations/{organizationId}/auth/radius/servers/assignments
[Return list of network and policies that organization-wide RADIUS servers are bing used (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-auth-radius-servers-assignments/)
> `getOrganizationAuthRadiusServersAssignments`
| `organizationId` | `` | `assignee, assignments, dashboardUrl, eid, id, name, network, serverId, tag, type` | `switch:config:read` @@ -671,6 +686,7 @@ GET /organizations/{organizationId}/camera/roles/{roleId}
[Retrieve a sin DELETE /organizations/{organizationId}/camera/roles/{roleId}
[Delete an existing role for this organization.](https://developer.cisco.com/meraki/api-v1/delete-organization-camera-role/)
> `deleteOrganizationCameraRole`
| `organizationId, roleId` | `` | `` | `camera:config:write` PUT /organizations/{organizationId}/camera/roles/{roleId}
[Update an existing role in this organization.](https://developer.cisco.com/meraki/api-v1/update-organization-camera-role/)
> `updateOrganizationCameraRole`
| `organizationId, roleId` | `appliedOnDevices, appliedOnNetworks, appliedOrgWide, id, inNetworksWithId, inNetworksWithTag, name, permissionScopeId, tag` | `` | `camera:config:write` GET /organizations/{organizationId}/campusGateway/clusters
[Get the details of campus gateway clusters (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-campus-gateway-clusters/)
> `getOrganizationCampusGatewayClusters`
| `organizationId, networkIds` | `` | `address, addresses, allowedVlans, assignmentMode, clusterId, devices, gateway, id, interface, memberId, name, nameservers, network, notes, portChannels, protocol, serial, subnetMask, tunnels, uplink, uplinks, url, vlan` | `` +GET /organizations/{organizationId}/campusGateway/devices/uplinks/localOverrides/byDevice
[Uplink overrides configured locally on Campus Gateway devices in an organization. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-campus-gateway-devices-uplinks-local-overrides-by-device/)
> `getOrganizationCampusGatewayDevicesUplinksLocalOverridesByDevice`
| `organizationId, serials, perPage, startingAfter, endingBefore` | `` | `address, addresses, assignmentMode, counts, gateway, interface, items, meta, nameservers, protocol, remaining, serial, sgt, subnetMask, total, uplink, vlan` | `` GET /organizations/{organizationId}/cellularGateway/esims/inventory
[The eSIM inventory of a given organization.](https://developer.cisco.com/meraki/api-v1/get-organization-cellular-gateway-esims-inventory/)
> `getOrganizationCellularGatewayEsimsInventory`
| `organizationId, eids` | `` | `active, counts, customApns, device, eid, iccid, id, items, lastUpdatedAt, meta, model, name, network, plans, profiles, remaining, serial, serviceProvider, status, total, type, url` | `` PUT /organizations/{organizationId}/cellularGateway/esims/inventory/{id}
[Toggle the status of an eSIM](https://developer.cisco.com/meraki/api-v1/update-organization-cellular-gateway-esims-inventory/)
> `updateOrganizationCellularGatewayEsimsInventory`
| `organizationId, id` | `status` | `active, customApns, device, eid, iccid, id, lastUpdatedAt, model, name, network, plans, profiles, serial, serviceProvider, status, type, url` | `` GET /organizations/{organizationId}/cellularGateway/esims/serviceProviders
[Service providers customers can add accounts for.](https://developer.cisco.com/meraki/api-v1/get-organization-cellular-gateway-esims-service-providers/)
> `getOrganizationCellularGatewayEsimsServiceProviders`
| `organizationId` | `` | `content, counts, isBootstrap, items, logo, meta, name, remaining, terms, total, url` | `` @@ -685,12 +701,6 @@ PUT /organizations/{organizationId}/cellularGateway/esims/swap/{id}
[Get GET /organizations/{organizationId}/cellularGateway/uplink/statuses
[List the uplink status of every Meraki MG cellular gateway in the organization](https://developer.cisco.com/meraki/api-v1/get-organization-cellular-gateway-uplink-statuses/)
> `getOrganizationCellularGatewayUplinkStatuses`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, serials, iccids` | `` | `apn, connectionType, dns1, dns2, gateway, iccid, imsi, interface, ip, lastReportedAt, mcc, mnc, model, msisdn, mtu, networkId, provider, publicIp, roaming, rsrp, rsrq, serial, signalStat, signalType, status, uplinks` | `sdwan:telemetry:read` GET /organizations/{organizationId}/certificates
[Gets all or specific certificates for an organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-certificates/)
> `getOrganizationCertificates`
| `organizationId, certificateIds, certManagedBy` | `` | `algorithm, certificateId, commonName, country, data, description, end, fields, hash, hashes, isCritical, issuer, keyUsage, locality, organization, organizationalUnit, parentCertificateId, policy, publicKeyAlgorithm, serial, signatureAlgorithmId, source, start, state, subject, subjectAlternativeName, validity, version` | `dashboard:iam:config:read` POST /organizations/{organizationId}/certificates/import
[Import certificate for this organization (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-certificates-import/)
> `createOrganizationCertificatesImport`
| `organizationId` | `contents, description, managedBy` | `algorithm, certificateId, commonName, country, data, description, end, fields, hash, hashes, isCritical, issuer, keyUsage, locality, organization, organizationalUnit, parentCertificateId, policy, publicKeyAlgorithm, serial, signatureAlgorithmId, source, start, state, subject, subjectAlternativeName, validity, version` | `dashboard:iam:config:write` -GET /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities
[Query for details on the organization's RADSEC device Certificate Authority certificates (CAs) (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-certificates-rad-sec-device-certificate-authorities/)
> `getOrganizationCertificatesRadSecDeviceCertificateAuthorities`
| `organizationId` | `` | `authorityId, contents, status` | `dashboard:iam:config:read` -POST /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities
[Create an organization's RADSEC device Certificate Authority (CA) (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-certificates-rad-sec-device-certificate-authority/)
> `createOrganizationCertificatesRadSecDeviceCertificateAuthority`
| `organizationId` | `` | `authorityId, contents, status` | `dashboard:iam:config:write` -GET /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}
[Query for details on an organization's RADSEC device Certificate Authority (CA) with the given id (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-certificates-rad-sec-device-certificate-authority/)
> `getOrganizationCertificatesRadSecDeviceCertificateAuthority`
| `organizationId, id` | `` | `authorityId, contents, status` | `` -PUT /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}
[Update an organization's RADSEC device Certificate Authority (CA) state (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-certificates-rad-sec-device-certificate-authority/)
> `updateOrganizationCertificatesRadSecDeviceCertificateAuthority`
| `organizationId, id` | `status` | `authorityId, contents, status` | `dashboard:iam:config:write` -GET /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}/revocationList
[Query for certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-certificates-rad-sec-device-certificate-authority-revocation-list/)
> `getOrganizationCertificatesRadSecDeviceCertificateAuthorityRevocationList`
| `organizationId, id` | `` | `crl` | `dashboard:iam:config:read` -GET /organizations/{organizationId}/certificates/radSec/deviceCertificateAuthorities/{id}/revocationList/deltas
[Query for all delta certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-certificates-rad-sec-device-certificate-authority-revocation-list-deltas/)
> `getOrganizationCertificatesRadSecDeviceCertificateAuthorityRevocationListDeltas`
| `organizationId, id` | `` | `deltaCrls` | `dashboard:iam:config:read` DELETE /organizations/{organizationId}/certificates/{certificateId}
[Delete a certificate for an organization (BETA)](https://developer.cisco.com/meraki/api-v1/delete-organization-certificate/)
> `deleteOrganizationCertificate`
| `organizationId, certificateId` | `` | `` | `dashboard:iam:config:write` PUT /organizations/{organizationId}/certificates/{certificateId}
[Update a certificate's description for an organization (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-certificate/)
> `updateOrganizationCertificate`
| `organizationId, certificateId` | `description` | `algorithm, certificateId, commonName, country, data, description, end, fields, hash, hashes, isCritical, issuer, keyUsage, locality, organization, organizationalUnit, parentCertificateId, policy, publicKeyAlgorithm, serial, signatureAlgorithmId, source, start, state, subject, subjectAlternativeName, validity, version` | `dashboard:iam:config:write` GET /organizations/{organizationId}/certificates/{certificateId}/contents
[Download the trusted certificate by certificate id. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-certificate-contents/)
> `getOrganizationCertificateContents`
| `organizationId, certificateId, chainId` | `` | `contents` | `dashboard:iam:config:read` @@ -707,33 +717,39 @@ GET /organizations/{organizationId}/configTemplates/{configTemplateId}
[R PUT /organizations/{organizationId}/configTemplates/{configTemplateId}
[Update a configuration template](https://developer.cisco.com/meraki/api-v1/update-organization-config-template/)
> `updateOrganizationConfigTemplate`
| `organizationId, configTemplateId` | `name, timeZone` | `id, name, productTypes, timeZone` | `dashboard:general:config:write` DELETE /organizations/{organizationId}/configTemplates/{configTemplateId}
[Remove a configuration template](https://developer.cisco.com/meraki/api-v1/delete-organization-config-template/)
> `deleteOrganizationConfigTemplate`
| `organizationId, configTemplateId` | `` | `` | `dashboard:general:config:write` GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles
[List the switch templates for your switch template configuration](https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profiles/)
> `getOrganizationConfigTemplateSwitchProfiles`
| `organizationId, configTemplateId` | `` | `model, name, switchProfileId` | `switch:config:read` -GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports
[Return all the ports of a switch template](https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profile-ports/)
> `getOrganizationConfigTemplateSwitchProfilePorts`
| `organizationId, configTemplateId, profileId` | `` | `accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:read` +GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports
[Return all the ports of a switch template](https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profile-ports/)
> `getOrganizationConfigTemplateSwitchProfilePorts`
| `organizationId, configTemplateId, profileId` | `` | `accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:read` PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/mirror
[Update a port mirror (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-config-template-switch-profile-ports-mirror/)
> `updateOrganizationConfigTemplateSwitchProfilePortsMirror`
| `organizationId, configTemplateId, profileId` | `comment, destination, filter, hasTransitVlan, module, number, port, ports, role, slot, source, tags, type, vlan, vlans` | `comment, configTemplate, destination, filter, hasTransitVlan, id, mirror, module, name, number, port, ports, profileId, role, slot, source, tags, type, vlan, vlans, warnings` | `` -GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
[Return a switch template port](https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profile-port/)
> `getOrganizationConfigTemplateSwitchProfilePort`
| `organizationId, configTemplateId, profileId, portId` | `` | `accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:read` -PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
[Update a switch template port](https://developer.cisco.com/meraki/api-v1/update-organization-config-template-switch-profile-port/)
> `updateOrganizationConfigTemplateSwitchProfilePort`
| `organizationId, configTemplateId, profileId, portId` | `accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, name, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:write` +GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
[Return a switch template port](https://developer.cisco.com/meraki/api-v1/get-organization-config-template-switch-profile-port/)
> `getOrganizationConfigTemplateSwitchProfilePort`
| `organizationId, configTemplateId, profileId, portId` | `` | `accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:read` +PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}
[Update a switch template port](https://developer.cisco.com/meraki/api-v1/update-organization-config-template-switch-profile-port/)
> `updateOrganizationConfigTemplateSwitchProfilePort`
| `organizationId, configTemplateId, profileId, portId` | `accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isolationEnabled, linkNegotiation, macAllowList, macWhitelistLimit, name, poeEnabled, portScheduleId, profile, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `accessPolicyNumber, accessPolicyType, allowedVlans, daiTrusted, dot3az, enabled, flexibleStackingEnabled, id, iname, isDualActiveDetector, isStackWiseVirtualLink, isolationEnabled, linkNegotiation, linkNegotiationCapabilities, macAllowList, macWhitelistLimit, mirror, mode, model, module, name, poeEnabled, portId, portScheduleId, profile, rstpEnabled, schedule, stackwiseVirtual, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, vlan, voiceVlan` | `switch:config:write` GET /organizations/{organizationId}/configurationChanges
[View the Change Log for your organization](https://developer.cisco.com/meraki/api-v1/get-organization-configuration-changes/)
> `getOrganizationConfigurationChanges`
| `organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, networkId, adminId` | `` | `adminEmail, adminId, adminName, client, id, label, networkId, networkName, networkUrl, newValue, oldValue, page, ssidName, ssidNumber, ts, type` | `dashboard:general:config:read` GET /organizations/{organizationId}/devices
[List the devices in an organization that have been assigned to a network.](https://developer.cisco.com/meraki/api-v1/get-organization-devices/)
> `getOrganizationDevices`
| `organizationId, perPage, startingAfter, endingBefore, configurationUpdatedAfter, networkIds, productTypes, tags, tagsFilterType, name, mac, serial, model, macs, serials, sensorMetrics, sensorAlertProfileIds, models` | `` | `address, details, firmware, imei, lanIp, lat, lng, mac, model, name, networkId, notes, productType, serial, tags, value` | `dashboard:general:config:read` GET /organizations/{organizationId}/devices/availabilities
[List the availability information for devices in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-devices-availabilities/)
> `getOrganizationDevicesAvailabilities`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, tags, tagsFilterType, statuses` | `` | `id, mac, name, network, productType, serial, status, tags` | `dashboard:general:telemetry:read` GET /organizations/{organizationId}/devices/availabilities/changeHistory
[List the availability history information for devices in an organization.](https://developer.cisco.com/meraki/api-v1/get-organization-devices-availabilities-change-history/)
> `getOrganizationDevicesAvailabilitiesChangeHistory`
| `organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, serials, productTypes, networkIds, statuses, categories, networkTags, networkTagsFilterType, deviceTags, deviceTagsFilterType` | `` | `category, details, device, id, model, name, network, new, old, productType, serial, tags, ts, url, value` | `dashboard:general:telemetry:read` -GET /organizations/{organizationId}/devices/boots/history
[Returns the history of device boots in reverse chronological order (most recent first) (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-devices-boots-history/)
> `getOrganizationDevicesBootsHistory`
| `organizationId, t0, t1, timespan, serials, mostRecentPerDevice, perPage, startingAfter, endingBefore, sortOrder` | `` | `bootedAt, id, network, serial, start` | `` +GET /organizations/{organizationId}/devices/boots/history
[Returns the history of device boots in reverse chronological order (most recent first) (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-devices-boots-history/)
> `getOrganizationDevicesBootsHistory`
| `organizationId, t0, t1, timespan, serials, productTypes, mostRecentPerDevice, perPage, startingAfter, endingBefore, sortOrder` | `` | `bootedAt, id, network, serial, start` | `` POST /organizations/{organizationId}/devices/controller/migrations
[Migrate devices to another controller or management mode](https://developer.cisco.com/meraki/api-v1/create-organization-devices-controller-migration/)
> `createOrganizationDevicesControllerMigration`
| `organizationId` | `serials, target` | `createdAt, migratedAt, serial, target` | `` GET /organizations/{organizationId}/devices/controller/migrations
[Retrieve device migration statuses in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-devices-controller-migrations/)
> `getOrganizationDevicesControllerMigrations`
| `organizationId, serials, networkIds, target, perPage, startingAfter, endingBefore` | `` | `counts, createdAt, items, meta, migratedAt, remaining, serial, target, total` | `` POST /organizations/{organizationId}/devices/details/bulkUpdate
[Updating device details (currently only used for Catalyst devices)](https://developer.cisco.com/meraki/api-v1/bulk-update-organization-devices-details/)
> `bulkUpdateOrganizationDevicesDetails`
| `organizationId` | `details, name, serials, value` | `serials` | `` GET /organizations/{organizationId}/devices/overview/byModel
[Lists the count for each device model](https://developer.cisco.com/meraki/api-v1/get-organization-devices-overview-by-model/)
> `getOrganizationDevicesOverviewByModel`
| `organizationId, models, networkIds, productTypes` | `` | `counts, model, total` | `` -GET /organizations/{organizationId}/devices/packetCapture/captures
[List Packet Captures (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-captures/)
> `getOrganizationDevicesPacketCaptureCaptures`
| `organizationId, captureIds, networkIds, serials, captureSource, captureStatus, name, clientMac, captureReason, device, userName, perPage, startingAfter, endingBefore, sortOrder` | `` | `autopcapType, captureId, captureReason, captureSource, client, counts, device, devices, duration, errorMessage, fileSize, filterExpression, id, interfaces, items, mac, meta, name, network, outputType, packetCount, ports, remaining, serial, startTime, status, total, user` | `` -POST /organizations/{organizationId}/devices/packetCapture/captures
[Perform a packet capture on a device and store in Meraki Cloud (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-devices-packet-capture-capture/)
> `createOrganizationDevicesPacketCaptureCapture`
| `organizationId` | `captureReason, duration, filterExpression, interface, name, outputType, ports, serials` | `autopcapType, captureId, captureReason, captureSource, client, device, devices, duration, errorMessage, fileSize, filterExpression, id, interfaces, mac, name, network, outputType, packetCount, ports, serial, startTime, status, user` | `` -DELETE /organizations/{organizationId}/devices/packetCapture/captures
[Delete packet capture from cloud (BETA)](https://developer.cisco.com/meraki/api-v1/delete-organization-devices-packet-capture-captures/)
> `deleteOrganizationDevicesPacketCaptureCaptures`
| `organizationId` | `captureIds` | `` | `` -GET /organizations/{organizationId}/devices/packetCapture/captures/{id}/downloadUrl
[Get presigned download URL for given packet capture id (BETA)](https://developer.cisco.com/meraki/api-v1/download-organization-devices-packet-capture-capture-url/)
> `downloadOrganizationDevicesPacketCaptureCaptureUrl`
| `organizationId, id` | `` | `captureId, downloadUrl` | `` -POST /organizations/{organizationId}/devices/packetCapture/captures/{id}/stop
[Stop a specific packet capture (not supported for Catalyst devices) (BETA)](https://developer.cisco.com/meraki/api-v1/stop-organization-devices-packet-capture-capture/)
> `stopOrganizationDevicesPacketCaptureCapture`
| `organizationId, id` | `serials` | `autopcapType, captureId, captureReason, captureSource, client, device, devices, duration, errorMessage, fileSize, filterExpression, id, interfaces, mac, name, network, outputType, packetCount, ports, serial, startTime, status, user` | `` -GET /organizations/{organizationId}/devices/packetCapture/schedules
[List scheduled Packet Captures (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-schedules/)
> `getOrganizationDevicesPacketCaptureSchedules`
| `organizationId, pcapScheduleConfigurationIds, networkIds, deviceIds` | `` | `captureCount, captureReason, counts, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interfaces, items, lastCaptureId, meta, name, nextCaptureTs, pcapScheduleConfigurationId, priority, recurrence, schedule, serial, startTs, switchports, total, updatedAt, user, warnings, weekdays` | `` -POST /organizations/{organizationId}/devices/packetCapture/schedules
[Create a schedule for packet capture (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-devices-packet-capture-schedule/)
> `createOrganizationDevicesPacketCaptureSchedule`
| `organizationId` | `captureReason, devices, duration, enabled, endTs, filterExpression, frequency, interfaces, name, recurrence, schedule, serial, startTs, switchports, weekdays` | `captureCount, captureReason, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interfaces, lastCaptureId, name, nextCaptureTs, pcapScheduleConfigurationId, priority, recurrence, schedule, serial, startTs, switchports, updatedAt, user, warnings, weekdays` | `` -DELETE /organizations/{organizationId}/devices/packetCapture/schedules
[Delete schedule from cloud (BETA)](https://developer.cisco.com/meraki/api-v1/delete-organization-devices-packet-capture-schedules/)
> `deleteOrganizationDevicesPacketCaptureSchedules`
| `organizationId` | `pcapScheduleConfigurationIds` | `` | `` -PUT /organizations/{organizationId}/devices/packetCapture/schedules/priority
[Bulk update priorities of pcap schedules (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-devices-packet-capture-schedules-priority/)
> `updateOrganizationDevicesPacketCaptureSchedulesPriority`
| `organizationId` | `pcapScheduleConfigurationIds` | `pcapScheduleConfigurationId, priority, updatedPriorities` | `` -PUT /organizations/{organizationId}/devices/packetCapture/schedules/{pcapScheduleConfigurationId}
[Update a schedule for packet capture (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-devices-packet-capture-schedule/)
> `updateOrganizationDevicesPacketCaptureSchedule`
| `organizationId, pcapScheduleConfigurationId` | `captureReason, devices, duration, enabled, endTs, filterExpression, frequency, name, recurrence, schedule, serial, startTs, switchports, weekdays` | `captureCount, captureReason, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interfaces, lastCaptureId, name, nextCaptureTs, pcapScheduleConfigurationId, priority, recurrence, schedule, serial, startTs, switchports, updatedAt, user, warnings, weekdays` | `` +GET /organizations/{organizationId}/devices/packetCapture/captures
[List Packet Captures](https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-captures/)
> `getOrganizationDevicesPacketCaptureCaptures`
| `organizationId, captureIds, networkIds, serials, process, captureStatus, name, clientMac, notes, deviceName, adminName, perPage, startingAfter, endingBefore, sortOrder` | `` | `admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, items, mac, meta, name, network, packets, ports, process, productType, remaining, serial, size, startTs, status, total, value` | `` +POST /organizations/{organizationId}/devices/packetCapture/captures
[Perform a packet capture on a device and store in Meraki Cloud](https://developer.cisco.com/meraki/api-v1/create-organization-devices-packet-capture-capture/)
> `createOrganizationDevicesPacketCaptureCapture`
| `organizationId` | `destination, duration, filterExpression, interface, name, notes, outputType, ports, serials` | `admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, mac, name, network, packets, ports, process, productType, serial, size, startTs, status, total, value` | `` +POST /organizations/{organizationId}/devices/packetCapture/captures/bulkCreate
[Perform a packet capture on multiple devices and store in Meraki Cloud.](https://developer.cisco.com/meraki/api-v1/bulk-organization-devices-packet-capture-captures-create/)
> `bulkOrganizationDevicesPacketCaptureCapturesCreate`
| `organizationId` | `devices, duration, filterExpression, interface, name, notes, serial, switchports` | `admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, items, mac, name, network, packets, ports, process, productType, serial, size, startTs, status, total, value` | `` +POST /organizations/{organizationId}/devices/packetCapture/captures/bulkDelete
[BulkDelete packet captures from cloud](https://developer.cisco.com/meraki/api-v1/bulk-organization-devices-packet-capture-captures-delete/)
> `bulkOrganizationDevicesPacketCaptureCapturesDelete`
| `organizationId` | `captureIds` | `` | `` +DELETE /organizations/{organizationId}/devices/packetCapture/captures/{captureId}
[Delete a single packet capture from cloud using captureId](https://developer.cisco.com/meraki/api-v1/delete-organization-devices-packet-capture-capture/)
> `deleteOrganizationDevicesPacketCaptureCapture`
| `organizationId, captureId` | `` | `` | `` +POST /organizations/{organizationId}/devices/packetCapture/captures/{captureId}/downloadUrl/generate
[Get presigned download URL for given packet capture id](https://developer.cisco.com/meraki/api-v1/generate-organization-devices-packet-capture-capture-download-url/)
> `generateOrganizationDevicesPacketCaptureCaptureDownloadUrl`
| `organizationId, captureId` | `` | `captureId, downloadUrl, url` | `` +POST /organizations/{organizationId}/devices/packetCapture/captures/{captureId}/stop
[Stop a specific packet capture (not supported for Catalyst devices)](https://developer.cisco.com/meraki/api-v1/stop-organization-devices-packet-capture-capture/)
> `stopOrganizationDevicesPacketCaptureCapture`
| `organizationId, captureId` | `serials` | `admin, captureId, client, counts, destination, details, device, devices, duration, errorMessage, file, filterExpression, id, interface, mac, name, network, packets, ports, process, productType, serial, size, startTs, status, total, value` | `` +GET /organizations/{organizationId}/devices/packetCapture/schedules
[List the Packet Capture Schedules](https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-schedules/)
> `getOrganizationDevicesPacketCaptureSchedules`
| `organizationId, scheduleIds, networkIds, deviceIds` | `` | `admin, captureCount, counts, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interface, items, lastCaptureId, meta, name, nextCaptureTs, notes, priority, recurrence, schedule, scheduleId, serial, startTs, switchports, total, updatedAt, warnings, weekdays` | `` +POST /organizations/{organizationId}/devices/packetCapture/schedules
[Create a schedule for packet capture](https://developer.cisco.com/meraki/api-v1/create-organization-devices-packet-capture-schedule/)
> `createOrganizationDevicesPacketCaptureSchedule`
| `organizationId` | `devices, duration, enabled, endTs, filterExpression, frequency, interface, name, notes, recurrence, schedule, serial, startTs, switchports, weekdays` | `admin, captureCount, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interface, lastCaptureId, name, nextCaptureTs, notes, priority, recurrence, schedule, scheduleId, serial, startTs, switchports, updatedAt, warnings, weekdays` | `` +POST /organizations/{organizationId}/devices/packetCapture/schedules/bulkDelete
[Delete packet capture schedules (BETA)](https://developer.cisco.com/meraki/api-v1/bulk-organization-devices-packet-capture-schedules-delete/)
> `bulkOrganizationDevicesPacketCaptureSchedulesDelete`
| `organizationId` | `scheduleIds` | `` | `` +POST /organizations/{organizationId}/devices/packetCapture/schedules/reorder
[Bulk update priorities of pcap schedules](https://developer.cisco.com/meraki/api-v1/reorder-organization-devices-packet-capture-schedules/)
> `reorderOrganizationDevicesPacketCaptureSchedules`
| `organizationId` | `order, priority, scheduleId` | `pcapScheduleConfigurationId, priority, updatedPriorities` | `` +PUT /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}
[Update a schedule for packet capture](https://developer.cisco.com/meraki/api-v1/update-organization-devices-packet-capture-schedule/)
> `updateOrganizationDevicesPacketCaptureSchedule`
| `organizationId, scheduleId` | `devices, duration, enabled, endTs, filterExpression, frequency, interface, name, notes, recurrence, schedule, serial, startTs, switchports, weekdays` | `admin, captureCount, createdAt, device, devices, duration, enabled, endTs, filterExpression, frequency, id, interface, lastCaptureId, name, nextCaptureTs, notes, priority, recurrence, schedule, scheduleId, serial, startTs, switchports, updatedAt, warnings, weekdays` | `` +DELETE /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}
[Delete schedule from cloud](https://developer.cisco.com/meraki/api-v1/delete-organization-devices-packet-capture-schedule/)
> `deleteOrganizationDevicesPacketCaptureSchedule`
| `organizationId, scheduleId` | `scheduleId` | `` | `` +POST /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks
[Enqueues a task for a specific packet capture (BETA)](https://developer.cisco.com/meraki/api-v1/tasks-organization-devices-packet-capture/)
> `tasksOrganizationDevicesPacketCapture`
| `organizationId, packetId` | `networkId, task` | `status, task, taskId` | `dashboard:general:telemetry:packetcapture:read` +GET /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks/{id}
[Retrieves packet capture analysis result for a specific packet capture task. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-devices-packet-capture-task/)
> `getOrganizationDevicesPacketCaptureTask`
| `organizationId, packetId, id, networkId` | `` | `analyzer, analyzers, counts, detailMessage, details, devices, failed, failureCount, failures, fileName, filePathUrl, ips, macs, name, packets, passed, present, result, status, subCategory, successes, summary, task, testCounts, testResults, total, url` | `dashboard:general:telemetry:packetcapture:read` GET /organizations/{organizationId}/devices/powerModules/statuses/byDevice
[List the most recent status information for power modules in rackmount MX and MS devices that support them](https://developer.cisco.com/meraki/api-v1/get-organization-devices-power-modules-statuses-by-device/)
> `getOrganizationDevicesPowerModulesStatusesByDevice`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, tags, tagsFilterType` | `` | `id, mac, model, name, network, number, productType, serial, slots, status, tags` | `dashboard:general:telemetry:read` GET /organizations/{organizationId}/devices/provisioning/statuses
[List the provisioning statuses information for devices in an organization.](https://developer.cisco.com/meraki/api-v1/get-organization-devices-provisioning-statuses/)
> `getOrganizationDevicesProvisioningStatuses`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, status, tags, tagsFilterType` | `` | `id, mac, name, network, productType, serial, status, tags` | `dashboard:general:telemetry:read` GET /organizations/{organizationId}/devices/statuses
[List the status of every Meraki device in the organization (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/get-organization-devices-statuses/)
> `getOrganizationDevicesStatuses`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, serials, statuses, productTypes, models, tags, tagsFilterType, configurationUpdatedAfter` | `` | `components, gateway, ipType, lanIp, lastReportedAt, mac, maximum, model, name, networkId, poe, powerSupplies, primaryDns, productType, publicIp, secondaryDns, serial, slot, status, tags, unit` | `dashboard:general:telemetry:read` GET /organizations/{organizationId}/devices/statuses/overview
[Return an overview of current device statuses](https://developer.cisco.com/meraki/api-v1/get-organization-devices-statuses-overview/)
> `getOrganizationDevicesStatusesOverview`
| `organizationId, productTypes, networkIds` | `` | `alerting, byStatus, counts, dormant, offline, online` | `dashboard:general:telemetry:read` +GET /organizations/{organizationId}/devices/syslog/servers/roles/byNetwork
[Returns roles that can be assigned to a syslog server for a given network. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-devices-syslog-servers-roles-by-network/)
> `getOrganizationDevicesSyslogServersRolesByNetwork`
| `organizationId, perPage, startingAfter, endingBefore, networkIds` | `` | `availableRoles, counts, id, items, meta, name, network, remaining, total, value` | `` GET /organizations/{organizationId}/devices/system/memory/usage/history/byInterval
[Return the memory utilization history in kB for devices in the organization.](https://developer.cisco.com/meraki/api-v1/get-organization-devices-system-memory-usage-history-by-interval/)
> `getOrganizationDevicesSystemMemoryUsageHistoryByInterval`
| `organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, interval, networkIds, serials, productTypes` | `` | `counts, endTs, free, id, intervals, items, mac, maximum, median, memory, meta, minimum, model, name, network, percentages, provisioned, remaining, serial, startTs, tags, total, used` | `` GET /organizations/{organizationId}/devices/uplinks/addresses/byDevice
[List the current uplink addresses for devices in an organization.](https://developer.cisco.com/meraki/api-v1/get-organization-devices-uplinks-addresses-by-device/)
> `getOrganizationDevicesUplinksAddressesByDevice`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, serials, tags, tagsFilterType` | `` | `address, addresses, assignmentMode, gateway, id, interface, mac, name, nameservers, network, productType, protocol, public, serial, tags, uplinks, vlan` | `dashboard:general:telemetry:read` GET /organizations/{organizationId}/devices/uplinksLossAndLatency
[Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago](https://developer.cisco.com/meraki/api-v1/get-organization-devices-uplinks-loss-and-latency/)
> `getOrganizationDevicesUplinksLossAndLatency`
| `organizationId, t0, t1, timespan, uplink, ip` | `` | `ip, latencyMs, lossPercent, networkId, serial, timeSeries, ts, uplink` | `dashboard:general:telemetry:read` @@ -743,7 +759,7 @@ POST /organizations/{organizationId}/earlyAccess/features/optIns
[Create GET /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
[Show an early access feature opt-in for an organization](https://developer.cisco.com/meraki/api-v1/get-organization-early-access-features-opt-in/)
> `getOrganizationEarlyAccessFeaturesOptIn`
| `organizationId, optInId` | `` | `createdAt, eligible, help, id, label, limitScopeToNetworks, name, optOutEligibility, reason, shortName, url` | `dashboard:iam:config:read` PUT /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
[Update an early access feature opt-in for an organization](https://developer.cisco.com/meraki/api-v1/update-organization-early-access-features-opt-in/)
> `updateOrganizationEarlyAccessFeaturesOptIn`
| `organizationId, optInId` | `limitScopeToNetworks` | `createdAt, eligible, help, id, label, limitScopeToNetworks, name, optOutEligibility, reason, shortName, url` | `dashboard:iam:config:write` DELETE /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
[Delete an early access feature opt-in](https://developer.cisco.com/meraki/api-v1/delete-organization-early-access-features-opt-in/)
> `deleteOrganizationEarlyAccessFeaturesOptIn`
| `organizationId, optInId` | `` | `` | `dashboard:iam:config:write` -PUT /organizations/{organizationId}/extensions/jupiter/interconnects/{interconnectId}
[Update name and status of an Interconnect (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-extensions-jupiter-interconnect/)
> `updateOrganizationExtensionsJupiterInterconnect`
| `organizationId, interconnectId` | `name, status` | `asNum, createdAt, id, internalSubnets, name, networkId, networkLocaleId, status, tunnelCount, type, vpnCount, wiredId` | `sdwan:config:write` +PUT /organizations/{organizationId}/extensions/sdwanmanager/interconnects/{interconnectId}
[Update name and status of an Interconnect (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-extensions-sdwanmanager-interconnect/)
> `updateOrganizationExtensionsSdwanmanagerInterconnect`
| `organizationId, interconnectId` | `name, status` | `asNum, createdAt, id, internalSubnets, name, networkId, networkLocaleId, status, tunnelCount, type, vpnCount, wiredId` | `sdwan:config:write` GET /organizations/{organizationId}/extensions/thousandEyes/networks
[List the ThousandEyes agent configurations under this organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-extensions-thousand-eyes-networks/)
> `getOrganizationExtensionsThousandEyesNetworks`
| `organizationId` | `` | `agentId, enabled, networkId` | `dashboard:general:config:read` POST /organizations/{organizationId}/extensions/thousandEyes/networks
[Add a ThousandEyes agent for this network (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-extensions-thousand-eyes-network/)
> `createOrganizationExtensionsThousandEyesNetwork`
| `organizationId` | `enabled, id, network, networkId, template, tenant, tests, userInputs` | `agentId, enabled, networkId` | `dashboard:general:config:write` GET /organizations/{organizationId}/extensions/thousandEyes/networks/supported
[List all the networks eligible for ThousandEyes agent activation under this organization. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-extensions-thousand-eyes-networks-supported/)
> `getOrganizationExtensionsThousandEyesNetworksSupported`
| `organizationId, perPage, startingAfter, endingBefore, agentInstalled` | `` | `agent, currentVersion, device, firmware, isInstalled, model, name, networkId, shortName, tags` | `dashboard:general:config:read` @@ -769,19 +785,21 @@ GET /organizations/{organizationId}/insight/webApps
[Lists all default we POST /organizations/{organizationId}/insight/webApps
[Add a custom web application for Insight to be able to track (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-insight-web-app/)
> `createOrganizationInsightWebApp`
| `organizationId` | `hostname, name` | `category, counterSetRuleId, expression, goodput, host, name, responseDelay, signature, signatureType, thresholds` | `` PUT /organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}
[Update a custom web application for Insight to be able to track (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-insight-web-app/)
> `updateOrganizationInsightWebApp`
| `organizationId, customCounterSetRuleId` | `hostname, name` | `category, counterSetRuleId, expression, goodput, host, name, responseDelay, signature, signatureType, thresholds` | `` DELETE /organizations/{organizationId}/insight/webApps/{customCounterSetRuleId}
[Delete a custom web application by counter set rule id. (BETA)](https://developer.cisco.com/meraki/api-v1/delete-organization-insight-web-app/)
> `deleteOrganizationInsightWebApp`
| `organizationId, customCounterSetRuleId` | `` | `` | `` -GET /organizations/{organizationId}/integrations/xdr/networks
[Returns the networks in the organization that have XDR enabled (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-integrations-xdr-networks/)
> `getOrganizationIntegrationsXdrNetworks`
| `organizationId, networkIds` | `` | `enabled, isEligible, name, networkId, productTypes` | `` -POST /organizations/{organizationId}/integrations/xdr/networks/disable
[Disable XDR on networks (BETA)](https://developer.cisco.com/meraki/api-v1/disable-organization-integrations-xdr-networks/)
> `disableOrganizationIntegrationsXdrNetworks`
| `organizationId` | `networkId, networks, productTypes` | `enabled, isEligible, name, networkId, productTypes` | `` -POST /organizations/{organizationId}/integrations/xdr/networks/enable
[Enable XDR on networks (BETA)](https://developer.cisco.com/meraki/api-v1/enable-organization-integrations-xdr-networks/)
> `enableOrganizationIntegrationsXdrNetworks`
| `organizationId` | `networkId, networks, productTypes` | `enabled, isEligible, name, networkId, productTypes` | `` +GET /organizations/{organizationId}/integrations/xdr/networks
[Returns the networks in the organization that have XDR enabled](https://developer.cisco.com/meraki/api-v1/get-organization-integrations-xdr-networks/)
> `getOrganizationIntegrationsXdrNetworks`
| `organizationId, networkIds, perPage, startingAfter, endingBefore` | `` | `counts, enabled, isEligible, items, meta, name, networkId, productTypes, remaining, total` | `` +POST /organizations/{organizationId}/integrations/xdr/networks/disable
[Disable XDR on networks](https://developer.cisco.com/meraki/api-v1/disable-organization-integrations-xdr-networks/)
> `disableOrganizationIntegrationsXdrNetworks`
| `organizationId` | `networkId, networks, productTypes` | `enabled, isEligible, name, networkId, networks, productTypes` | `` +POST /organizations/{organizationId}/integrations/xdr/networks/enable
[Enable XDR on networks](https://developer.cisco.com/meraki/api-v1/enable-organization-integrations-xdr-networks/)
> `enableOrganizationIntegrationsXdrNetworks`
| `organizationId` | `networkId, networks, productTypes` | `enabled, isEligible, name, networkId, networks, productTypes` | `` POST /organizations/{organizationId}/inventory/claim
[Claim a list of devices, licenses, and/or orders into an organization inventory](https://developer.cisco.com/meraki/api-v1/claim-into-organization-inventory/)
> `claimIntoOrganizationInventory`
| `organizationId` | `key, licenses, mode, orders, serials` | `key, licenses, mode, orders, serials` | `dashboard:licensing:config:write` GET /organizations/{organizationId}/inventory/devices
[Return the device inventory for an organization](https://developer.cisco.com/meraki/api-v1/get-organization-inventory-devices/)
> `getOrganizationInventoryDevices`
| `organizationId, perPage, startingAfter, endingBefore, usedState, search, macs, networkIds, serials, models, orderNumbers, tags, tagsFilterType, productTypes` | `` | `claimedAt, countryCode, details, licenseExpirationDate, mac, model, name, networkId, orderNumber, productType, serial, tags, value` | `dashboard:general:config:read` POST /organizations/{organizationId}/inventory/devices/swaps/bulk
[Swap the devices identified by devices.old with a devices.new, then perform the :afterAction on the devices.old.](https://developer.cisco.com/meraki/api-v1/create-organization-inventory-devices-swaps-bulk/)
> `createOrganizationInventoryDevicesSwapsBulk`
| `organizationId` | `afterAction, devices, new, old, swaps` | `afterAction, completedAt, createdAt, devices, errors, id, jobId, mac, model, name, new, old, serial, status, swaps` | `dashboard:general:config:write` GET /organizations/{organizationId}/inventory/devices/swaps/bulk/{id}
[List of device swaps for a given request ID ({id}).](https://developer.cisco.com/meraki/api-v1/get-organization-inventory-devices-swaps-bulk/)
> `getOrganizationInventoryDevicesSwapsBulk`
| `organizationId, id` | `` | `afterAction, completedAt, createdAt, devices, errors, id, jobId, mac, model, name, new, old, serial, status, swaps` | `dashboard:general:config:read` GET /organizations/{organizationId}/inventory/devices/{serial}
[Return a single device from the inventory of an organization](https://developer.cisco.com/meraki/api-v1/get-organization-inventory-device/)
> `getOrganizationInventoryDevice`
| `organizationId, serial` | `` | `claimedAt, countryCode, details, licenseExpirationDate, mac, model, name, networkId, orderNumber, productType, serial, tags, value` | `dashboard:general:config:read` -POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents
[Imports event logs related to the onboarding app into elastisearch](https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-export-event/)
> `createOrganizationInventoryOnboardingCloudMonitoringExportEvent`
| `organizationId` | `logEvent, request, targetOS, timestamp` | `` | `dashboard:general:config:write` -POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
[Commits the import operation to complete the onboarding of a device into Dashboard for monitoring.](https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-import/)
> `createOrganizationInventoryOnboardingCloudMonitoringImport`
| `organizationId` | `deviceId, devices, networkId, udi` | `importId, message, status` | `dashboard:general:config:write` -GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
[Check the status of a committed Import operation](https://developer.cisco.com/meraki/api-v1/get-organization-inventory-onboarding-cloud-monitoring-imports/)
> `getOrganizationInventoryOnboardingCloudMonitoringImports`
| `organizationId, importIds` | `` | `created, device, importId, status, url` | `dashboard:general:config:read` -GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks
[Returns list of networks eligible for adding cloud monitored device](https://developer.cisco.com/meraki/api-v1/get-organization-inventory-onboarding-cloud-monitoring-networks/)
> `getOrganizationInventoryOnboardingCloudMonitoringNetworks`
| `organizationId, deviceType, search, perPage, startingAfter, endingBefore` | `` | `enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url` | `dashboard:general:config:read` -POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare
[Initiates or updates an import session](https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-prepare/)
> `createOrganizationInventoryOnboardingCloudMonitoringPrepare`
| `organizationId` | `accessList, authentication, authorization, certificateName, devices, endLineNumber, group, localInterface, loopbackNumber, name, options, rotaryNumber, skipCommit, startLineNumber, sudi, tunnel, user, username, vty, vtyIn, vtyOut` | `cloudStaticIp, configParams, content, deviceId, hash, host, message, mode, name, port, publicKey, rootCertificate, secret, status, tunnel, udi, user, username` | `dashboard:general:config:write` +POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents
[Imports event logs related to the onboarding app into elastisearch (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-export-event/)
> `createOrganizationInventoryOnboardingCloudMonitoringExportEvent`
| `organizationId` | `logEvent, request, targetOS, timestamp` | `` | `dashboard:general:config:write` +POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
[Commits the import operation to complete the onboarding of a device into Dashboard for monitoring. (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-import/)
> `createOrganizationInventoryOnboardingCloudMonitoringImport`
| `organizationId` | `deviceId, devices, networkId, udi` | `importId, message, status` | `dashboard:general:config:write` +GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports
[Check the status of a committed Import operation (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/get-organization-inventory-onboarding-cloud-monitoring-imports/)
> `getOrganizationInventoryOnboardingCloudMonitoringImports`
| `organizationId, importIds` | `` | `created, device, importId, status, url` | `dashboard:general:config:read` +GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks
[Returns list of networks eligible for adding cloud monitored device (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/get-organization-inventory-onboarding-cloud-monitoring-networks/)
> `getOrganizationInventoryOnboardingCloudMonitoringNetworks`
| `organizationId, deviceType, search, perPage, startingAfter, endingBefore` | `` | `enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url` | `dashboard:general:config:read` +POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare
[Initiates or updates an import session (DEPRECATED)](https://developer.cisco.com/meraki/api-v1/create-organization-inventory-onboarding-cloud-monitoring-prepare/)
> `createOrganizationInventoryOnboardingCloudMonitoringPrepare`
| `organizationId` | `accessList, authentication, authorization, certificateName, devices, endLineNumber, group, localInterface, loopbackNumber, name, options, rotaryNumber, skipCommit, startLineNumber, sudi, tunnel, user, username, vty, vtyIn, vtyOut` | `cloudStaticIp, configParams, content, deviceId, hash, host, message, mode, name, port, publicKey, rootCertificate, secret, status, tunnel, udi, user, username` | `dashboard:general:config:write` +POST /organizations/{organizationId}/inventory/orders/claim
[Claim an order by the secure unique order claim number, the order claim id (BETA)](https://developer.cisco.com/meraki/api-v1/claim-organization-inventory-orders/)
> `claimOrganizationInventoryOrders`
| `organizationId` | `claimId, description, name, subscriptionId, subscriptions` | `claimId, counts, description, endDate, isClaimed, limit, name, number, seats, serials, startDate, subscriptionId, subscriptions` | `` +POST /organizations/{organizationId}/inventory/orders/preview
[Preview the results and status of an order claim by the secure order id (BETA)](https://developer.cisco.com/meraki/api-v1/preview-organization-inventory-orders/)
> `previewOrganizationInventoryOrders`
| `organizationId` | `claimId` | `claimId, counts, description, devices, endDate, isClaimed, limit, name, number, pending, quantity, seats, shipments, shippedAt, shipping, sku, startDate, subscriptionId, subscriptions` | `` POST /organizations/{organizationId}/inventory/release
[Release a list of claimed devices from an organization.](https://developer.cisco.com/meraki/api-v1/release-from-organization-inventory/)
> `releaseFromOrganizationInventory`
| `organizationId` | `serials` | `serials` | `dashboard:general:config:write` GET /organizations/{organizationId}/licenses
[List the licenses for an organization](https://developer.cisco.com/meraki/api-v1/get-organization-licenses/)
> `getOrganizationLicenses`
| `organizationId, perPage, startingAfter, endingBefore, deviceSerial, networkId, state` | `` | `activationDate, claimDate, deviceSerial, durationInDays, expirationDate, headLicenseId, id, licenseKey, licenseType, networkId, orderNumber, permanentlyQueuedLicenses, seatCount, state, totalDurationInDays` | `dashboard:licensing:config:read` POST /organizations/{organizationId}/licenses/assignSeats
[Assign SM seats to a network](https://developer.cisco.com/meraki/api-v1/assign-organization-licenses-seats/)
> `assignOrganizationLicensesSeats`
| `organizationId` | `licenseId, networkId, seatCount` | `activationDate, claimDate, deviceSerial, durationInDays, expirationDate, headLicenseId, id, licenseKey, licenseType, networkId, orderNumber, permanentlyQueuedLicenses, resultingLicenses, seatCount, state, totalDurationInDays` | `dashboard:licensing:config:write` @@ -793,10 +811,8 @@ GET /organizations/{organizationId}/licenses/{licenseId}
[Display a licen PUT /organizations/{organizationId}/licenses/{licenseId}
[Update a license](https://developer.cisco.com/meraki/api-v1/update-organization-license/)
> `updateOrganizationLicense`
| `organizationId, licenseId` | `deviceSerial` | `activationDate, claimDate, deviceSerial, durationInDays, expirationDate, headLicenseId, id, licenseKey, licenseType, networkId, orderNumber, permanentlyQueuedLicenses, seatCount, state, totalDurationInDays` | `dashboard:licensing:config:write` GET /organizations/{organizationId}/licensing/coterm/licenses
[List the licenses in a coterm organization](https://developer.cisco.com/meraki/api-v1/get-organization-licensing-coterm-licenses/)
> `getOrganizationLicensingCotermLicenses`
| `organizationId, perPage, startingAfter, endingBefore, invalidated, expired` | `` | `claimedAt, count, counts, duration, edition, editions, expired, invalidated, invalidatedAt, key, mode, model, organizationId, productType, startedAt` | `dashboard:licensing:config:read` POST /organizations/{organizationId}/licensing/coterm/licenses/move
[Moves a license to a different organization (coterm only)](https://developer.cisco.com/meraki/api-v1/move-organization-licensing-coterm-licenses/)
> `moveOrganizationLicensingCotermLicenses`
| `organizationId` | `count, counts, destination, key, licenses, mode, model, organizationId` | `claimedAt, count, counts, duration, edition, editions, expired, invalidated, invalidatedAt, key, mode, model, movedLicenses, organizationId, productType, remainderLicenses, startedAt` | `dashboard:licensing:config:write` -POST /organizations/{organizationId}/licensing/orders/claim
[Claim an order by the secure unique order claim number, the order claim id (BETA)](https://developer.cisco.com/meraki/api-v1/claim-organization-licensing-orders/)
> `claimOrganizationLicensingOrders`
| `organizationId` | `claimId, description, name, subscriptionId, subscriptions` | `assigned, available, claimId, counts, description, endDate, isClaimed, limit, name, networks, number, organizations, seats, serials, startDate, subscriptionId, subscriptions` | `` -POST /organizations/{organizationId}/licensing/orders/preview
[Preview the results and status of an order claim by the secure order id (BETA)](https://developer.cisco.com/meraki/api-v1/preview-organization-licensing-orders/)
> `previewOrganizationLicensingOrders`
| `organizationId` | `claimId` | `assigned, available, claimId, counts, description, devices, endDate, isClaimed, limit, networks, number, organizations, pending, quantity, seats, shipments, shippedAt, shipping, sku, startDate, subscriptionId, subscriptions` | `` -GET /organizations/{organizationId}/loginSecurity
[Returns the login security settings for an organization.](https://developer.cisco.com/meraki/api-v1/get-organization-login-security/)
> `getOrganizationLoginSecurity`
| `organizationId` | `` | `accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, numDifferentPasswords, passwordExpirationDays, ranges` | `dashboard:iam:config:read` -PUT /organizations/{organizationId}/loginSecurity
[Update the login security settings for an organization](https://developer.cisco.com/meraki/api-v1/update-organization-login-security/)
> `updateOrganizationLoginSecurity`
| `organizationId` | `accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, numDifferentPasswords, passwordExpirationDays, ranges` | `accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, numDifferentPasswords, passwordExpirationDays, ranges` | `dashboard:iam:config:write` +GET /organizations/{organizationId}/loginSecurity
[Returns the login security settings for an organization.](https://developer.cisco.com/meraki/api-v1/get-organization-login-security/)
> `getOrganizationLoginSecurity`
| `organizationId` | `` | `accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, minimumPasswordLength, numDifferentPasswords, passwordExpirationDays, ranges` | `dashboard:iam:config:read` +PUT /organizations/{organizationId}/loginSecurity
[Update the login security settings for an organization](https://developer.cisco.com/meraki/api-v1/update-organization-login-security/)
> `updateOrganizationLoginSecurity`
| `organizationId` | `accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, minimumPasswordLength, numDifferentPasswords, passwordExpirationDays, ranges` | `accountLockoutAttempts, apiAuthentication, enabled, enforceAccountLockout, enforceDifferentPasswords, enforceIdleTimeout, enforceLoginIpRanges, enforcePasswordExpiration, enforceStrongPasswords, enforceTwoFactorAuth, idleTimeoutMinutes, ipRestrictionsForKeys, loginIpRanges, minimumPasswordLength, numDifferentPasswords, passwordExpirationDays, ranges` | `dashboard:iam:config:write` GET /organizations/{organizationId}/networks
[List the networks that the user has privileges on in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-networks/)
> `getOrganizationNetworks`
| `organizationId, configTemplateId, isBoundToConfigTemplate, tags, tagsFilterType, productTypes, perPage, startingAfter, endingBefore` | `` | `enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url` | `dashboard:general:config:read` POST /organizations/{organizationId}/networks
[Create a network](https://developer.cisco.com/meraki/api-v1/create-organization-network/)
> `createOrganizationNetwork`
| `organizationId` | `copyFromNetworkId, name, notes, productTypes, tags, timeZone` | `enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, tags, timeZone, url` | `dashboard:general:config:write` POST /organizations/{organizationId}/networks/combine
[Combine multiple networks into a single network](https://developer.cisco.com/meraki/api-v1/combine-organization-networks/)
> `combineOrganizationNetworks`
| `organizationId` | `enrollmentString, name, networkIds` | `enrollmentString, id, isBoundToConfigTemplate, name, notes, organizationId, productTypes, resultingNetwork, tags, timeZone, url` | `dashboard:general:config:write` @@ -827,6 +843,10 @@ POST /organizations/{organizationId}/samlRoles
[Create a SAML role](https GET /organizations/{organizationId}/samlRoles/{samlRoleId}
[Return a SAML role](https://developer.cisco.com/meraki/api-v1/get-organization-saml-role/)
> `getOrganizationSamlRole`
| `organizationId, samlRoleId` | `` | `access, camera, id, networks, orgAccess, orgWide, role, tag, tags` | `dashboard:iam:config:read` PUT /organizations/{organizationId}/samlRoles/{samlRoleId}
[Update a SAML role](https://developer.cisco.com/meraki/api-v1/update-organization-saml-role/)
> `updateOrganizationSamlRole`
| `organizationId, samlRoleId` | `access, id, networks, orgAccess, role, tag, tags` | `access, camera, id, networks, orgAccess, orgWide, role, tag, tags` | `dashboard:iam:config:write` DELETE /organizations/{organizationId}/samlRoles/{samlRoleId}
[Remove a SAML role](https://developer.cisco.com/meraki/api-v1/delete-organization-saml-role/)
> `deleteOrganizationSamlRole`
| `organizationId, samlRoleId` | `` | `` | `dashboard:iam:config:write` +GET /organizations/{organizationId}/sase/connectivity/enrollableNetworks
[List of MX networks or templates that can be enrolled into Secure Access (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-sase-connectivity-enrollable-networks/)
> `getOrganizationSaseConnectivityEnrollableNetworks`
| `organizationId, perPage, startingAfter, endingBefore` | `` | `address, counts, defaultRoute, enabled, items, meta, model, name, networkId, region, remaining, routing, street, total, type, vpn` | `` +DELETE /organizations/{organizationId}/sase/connectivity/sites/bulkDetach
[Detach sites in this organization from Secure Access (BETA)](https://developer.cisco.com/meraki/api-v1/delete-organization-sase-connectivity-sites-bulk-detach/)
> `deleteOrganizationSaseConnectivitySitesBulkDetach`
| `organizationId` | `callback, httpServer, id, merakiEnrollments, network, payloadTemplate, sharedSecret, siteId, url` | `action, callback, id, message, request, siteId, status, url` | `` +POST /organizations/{organizationId}/sase/connectivity/sites/bulkEnroll
[Enroll sites in this organization to Secure Access (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-sase-connectivity-sites-bulk-enroll/)
> `createOrganizationSaseConnectivitySitesBulkEnroll`
| `organizationId` | `callback, httpServer, id, merakiEnrollments, network, payloadTemplate, region, sharedSecret, url` | `action, callback, id, message, regionId, request, siteId, status, url` | `` +GET /organizations/{organizationId}/sase/connectivity/sites/{id}
[Get details of a site in this organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-sase-connectivity-site/)
> `getOrganizationSaseConnectivitySite`
| `organizationId, id, id` | `` | `address, defaultRoute, enabled, id, model, name, networkId, region, routing, street, type, vpn` | `` GET /organizations/{organizationId}/secureConnect/privateApplicationGroups
[Provides a list of private application groups for an Organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-secure-connect-private-application-groups/)
> `getOrganizationSecureConnectPrivateApplicationGroups`
| `organizationId, perPage, startingAfter, endingBefore, nameIncludes, applicationGroupIds, sortBy, sortOrder` | `` | `applicationGroupId, applicationIds, createdAt, data, description, meta, modifiedAt, name, total` | `` POST /organizations/{organizationId}/secureConnect/privateApplicationGroups
[Creates a group of private applications to apply to policy (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-secure-connect-private-application-group/)
> `createOrganizationSecureConnectPrivateApplicationGroup`
| `organizationId` | `applicationIds, description, name` | `applicationGroupId, applicationIds, createdAt, description, modifiedAt, name` | `` PUT /organizations/{organizationId}/secureConnect/privateApplicationGroups/{id}
[Update an application group in an Organization (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-secure-connect-private-application-group/)
> `updateOrganizationSecureConnectPrivateApplicationGroup`
| `organizationId, id` | `applicationIds, description, name` | `applicationGroupId, applicationIds, createdAt, description, modifiedAt, name` | `` @@ -880,6 +900,7 @@ GET /organizations/{organizationId}/snmp
[Return the SNMP settings for an PUT /organizations/{organizationId}/snmp
[Update the SNMP settings for an organization](https://developer.cisco.com/meraki/api-v1/update-organization-snmp/)
> `updateOrganizationSnmp`
| `organizationId` | `peerIps, v2cEnabled, v3AuthMode, v3AuthPass, v3Enabled, v3PrivMode, v3PrivPass` | `hostname, peerIps, port, v2CommunityString, v2cEnabled, v3AuthMode, v3Enabled, v3PrivMode, v3User` | `dashboard:general:telemetry:write` GET /organizations/{organizationId}/snmp/traps/byNetwork
[Retrieve the SNMP trap configuration for the networks in an organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-snmp-traps-by-network/)
> `getOrganizationSnmpTrapsByNetwork`
| `organizationId, networkIds` | `` | `address, community, id, mode, name, network, port, receiver, users, v2, v3` | `` DELETE /organizations/{organizationId}/spaces/integration/remove
[Remove the Spaces integration from Meraki (BETA)](https://developer.cisco.com/meraki/api-v1/delete-organization-spaces-integration-remove/)
> `deleteOrganizationSpacesIntegrationRemove`
| `organizationId` | `` | `message, status` | `dashboard:general:config:write` +POST /organizations/{organizationId}/spaces/integration/remove
[Remove the Spaces integration from Meraki (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-spaces-integration-remove/)
> `createOrganizationSpacesIntegrationRemove`
| `organizationId` | `` | `message, status` | `dashboard:general:config:write` GET /organizations/{organizationId}/splash/assets/{id}
[Get a Splash Theme Asset](https://developer.cisco.com/meraki/api-v1/get-organization-splash-asset/)
> `getOrganizationSplashAsset`
| `organizationId, id` | `` | `fileData, id, name` | `` DELETE /organizations/{organizationId}/splash/assets/{id}
[Delete a Splash Theme Asset](https://developer.cisco.com/meraki/api-v1/delete-organization-splash-asset/)
> `deleteOrganizationSplashAsset`
| `organizationId, id` | `` | `` | `` GET /organizations/{organizationId}/splash/themes
[List Splash Themes](https://developer.cisco.com/meraki/api-v1/get-organization-splash-themes/)
> `getOrganizationSplashThemes`
| `organizationId` | `` | `id, name, themeAssets` | `` @@ -910,6 +931,11 @@ GET /organizations/{organizationId}/switch/ports/profiles/automations
[li POST /organizations/{organizationId}/switch/ports/profiles/automations
[Create a port profile automation for an organization (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-switch-ports-profiles-automation/)
> `createOrganizationSwitchPortsProfilesAutomation`
| `organizationId` | `assignedSwitchPorts, attribute, conditions, description, fallbackProfile, id, name, portIds, priority, profile, rules, serial, switch, values` | `assigned, assignedSwitchPorts, attribute, conditions, counts, description, devices, fallbackProfile, id, isOrganizationWide, name, networks, portIds, ports, priority, profile, rules, serial, switch, types, values` | `` PUT /organizations/{organizationId}/switch/ports/profiles/automations/{id}
[Update a port profile automation in an organization (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-switch-ports-profiles-automation/)
> `updateOrganizationSwitchPortsProfilesAutomation`
| `organizationId, id` | `assignedSwitchPorts, attribute, conditions, description, fallbackProfile, id, name, portIds, priority, profile, rules, serial, switch, values` | `assigned, assignedSwitchPorts, attribute, conditions, counts, description, devices, fallbackProfile, id, isOrganizationWide, name, networks, portIds, ports, priority, profile, rules, serial, switch, types, values` | `` DELETE /organizations/{organizationId}/switch/ports/profiles/automations/{id}
[Delete an automation port profile from an organization (BETA)](https://developer.cisco.com/meraki/api-v1/delete-organization-switch-ports-profiles-automation/)
> `deleteOrganizationSwitchPortsProfilesAutomation`
| `organizationId, id` | `` | `` | `` +GET /organizations/{organizationId}/switch/ports/profiles/networks/assignments
[Fetch all Network - Smart Port Profile associations for an organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-switch-ports-profiles-networks-assignments/)
> `getOrganizationSwitchPortsProfilesNetworksAssignments`
| `organizationId, perPage, page` | `` | `assignmentId, counts, id, items, meta, network, profile, remaining, total, type` | `` +POST /organizations/{organizationId}/switch/ports/profiles/networks/assignments
[Create Network and Smart Ports Profile association for a specific profile (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-switch-ports-profiles-networks-assignment/)
> `createOrganizationSwitchPortsProfilesNetworksAssignment`
| `organizationId` | `id, network, profile, type` | `assignmentId, id, network, profile, type` | `` +POST /organizations/{organizationId}/switch/ports/profiles/networks/assignments/batchCreate
[Batch Create Network and Smart Ports Profile associations for a specific profile (BETA)](https://developer.cisco.com/meraki/api-v1/batch-organization-switch-ports-profiles-networks-assignments-create/)
> `batchOrganizationSwitchPortsProfilesNetworksAssignmentsCreate`
| `organizationId` | `id, items, network, profile, type` | `assignmentId, id, items, network, profile, type` | `` +POST /organizations/{organizationId}/switch/ports/profiles/networks/assignments/bulkDelete
[Bulk delete Network and Smart Port Profile associations (BETA)](https://developer.cisco.com/meraki/api-v1/bulk-organization-switch-ports-profiles-networks-assignments-delete/)
> `bulkOrganizationSwitchPortsProfilesNetworksAssignmentsDelete`
| `organizationId` | `assignmentId, items` | `` | `` +DELETE /organizations/{organizationId}/switch/ports/profiles/networks/assignments/{assignmentId}
[Delete Network and Smart Port profile association for a specific profile (BETA)](https://developer.cisco.com/meraki/api-v1/delete-organization-switch-ports-profiles-networks-assignment/)
> `deleteOrganizationSwitchPortsProfilesNetworksAssignment`
| `organizationId, assignmentId` | `` | `` | `` GET /organizations/{organizationId}/switch/ports/profiles/overview/byProfile
[List the port profiles in an organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-switch-ports-profiles-overview-by-profile/)
> `getOrganizationSwitchPortsProfilesOverviewByProfile`
| `organizationId, networkIds, formattedStaticAssignments, searchQuery, perPage, startingAfter, endingBefore` | `` | `access, assigned, automations, counts, createdAt, description, excluded, id, included, isOrganizationWide, items, meta, name, network, networks, networksCount, ports, profileId, switches, total, type, updatedAt, values` | `` GET /organizations/{organizationId}/switch/ports/profiles/{id}
[Get detailed information about a port profile (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-switch-ports-profile/)
> `getOrganizationSwitchPortsProfile`
| `organizationId, id` | `` | `access, accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, assignedSwitchports, associatedPorts, associatedSwitches, automations, createdAt, daiTrusted, description, enabled, id, isOrganizationWide, isolationEnabled, mac, macAllowList, model, name, networkId, networks, peerSgtCapable, poeEnabled, port, portId, portIds, portName, portNum, profile, profileId, rstpEnabled, serial, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, switch, switchId, tags, template, type, udld, updatedAt, values, vlan, voiceVlan` | `` PUT /organizations/{organizationId}/switch/ports/profiles/{id}
[Update a port profile in an organization (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-switch-ports-profile/)
> `updateOrganizationSwitchPortsProfile`
| `organizationId, id` | `accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, daiTrusted, description, id, isOrganizationWide, isolationEnabled, macAllowList, name, networkId, networks, peerSgtCapable, poeEnabled, port, rstpEnabled, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, tags, type, udld, values, vlan, voiceVlan` | `access, accessPolicyNumber, accessPolicyType, adaptivePolicyGroupId, allowedVlans, assignedSwitchports, associatedPorts, associatedSwitches, automations, createdAt, daiTrusted, description, enabled, id, isOrganizationWide, isolationEnabled, mac, macAllowList, model, name, networkId, networks, peerSgtCapable, poeEnabled, port, portId, portIds, portName, portNum, profile, profileId, rstpEnabled, serial, stickyMacAllowList, stickyMacAllowListLimit, stormControlEnabled, stpGuard, switch, switchId, tags, template, type, udld, updatedAt, values, vlan, voiceVlan` | `` @@ -937,19 +963,35 @@ POST /organizations/{organizationId}/webhooks/webhookTests
[Send a test w GET /organizations/{organizationId}/webhooks/webhookTests/{webhookTestId}
[Return the status of a webhook test for an organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-webhooks-webhook-test/)
> `getOrganizationWebhooksWebhookTest`
| `organizationId, webhookTestId` | `` | `id, status, url` | `` GET /organizations/{organizationId}/wireless/airMarshal/rules
[Returns the current Air Marshal rules for this organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-air-marshal-rules/)
> `getOrganizationWirelessAirMarshalRules`
| `organizationId, networkIds, perPage, startingAfter, endingBefore` | `` | `counts, createdAt, id, items, match, meta, name, network, ruleId, string, total, type, updatedAt` | `` GET /organizations/{organizationId}/wireless/airMarshal/settings/byNetwork
[Returns the current Air Marshal settings for this network](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-air-marshal-settings-by-network/)
> `getOrganizationWirelessAirMarshalSettingsByNetwork`
| `organizationId, networkIds, perPage, startingAfter, endingBefore` | `` | `counts, defaultPolicy, items, meta, networkId, remaining, total` | `` +GET /organizations/{organizationId}/wireless/certificates/openRoaming/certificateAuthority
[Query for details on the organization's OpenRoaming Certificate Authority certificate (CAs). (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-certificates-open-roaming-certificate-authority/)
> `getOrganizationWirelessCertificatesOpenRoamingCertificateAuthority`
| `organizationId` | `` | `contents, status` | `wireless:config:read` GET /organizations/{organizationId}/wireless/clients/overview/byDevice
[List access point client count at the moment in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-clients-overview-by-device/)
> `getOrganizationWirelessClientsOverviewByDevice`
| `organizationId, networkIds, serials, campusGatewayClusterIds, perPage, startingAfter, endingBefore` | `` | `byStatus, counts, id, items, meta, network, online, remaining, serial, total` | `` GET /organizations/{organizationId}/wireless/devices/channelUtilization/byDevice
[Get average channel utilization for all bands in a network, split by AP](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-channel-utilization-by-device/)
> `getOrganizationWirelessDevicesChannelUtilizationByDevice`
| `organizationId, networkIds, serials, perPage, startingAfter, endingBefore, t0, t1, timespan, interval` | `` | `band, byBand, id, mac, network, nonWifi, percentage, serial, total, wifi` | `wireless:telemetry:read` GET /organizations/{organizationId}/wireless/devices/channelUtilization/byNetwork
[Get average channel utilization across all bands for all networks in the organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-channel-utilization-by-network/)
> `getOrganizationWirelessDevicesChannelUtilizationByNetwork`
| `organizationId, networkIds, serials, perPage, startingAfter, endingBefore, t0, t1, timespan, interval` | `` | `band, byBand, id, network, nonWifi, percentage, total, wifi` | `wireless:telemetry:read` GET /organizations/{organizationId}/wireless/devices/channelUtilization/history/byDevice/byInterval
[Get a time-series of average channel utilization for all bands, segmented by device.](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-channel-utilization-history-by-device-by-interval/)
> `getOrganizationWirelessDevicesChannelUtilizationHistoryByDeviceByInterval`
| `organizationId, networkIds, serials, perPage, startingAfter, endingBefore, t0, t1, timespan, interval` | `` | `band, byBand, endTs, id, mac, network, nonWifi, percentage, serial, startTs, total, wifi` | `wireless:telemetry:read` GET /organizations/{organizationId}/wireless/devices/channelUtilization/history/byNetwork/byInterval
[Get a time-series of average channel utilization for all bands](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-channel-utilization-history-by-network-by-interval/)
> `getOrganizationWirelessDevicesChannelUtilizationHistoryByNetworkByInterval`
| `organizationId, networkIds, serials, perPage, startingAfter, endingBefore, t0, t1, timespan, interval` | `` | `band, byBand, endTs, id, network, nonWifi, percentage, startTs, total, wifi` | `wireless:telemetry:read` GET /organizations/{organizationId}/wireless/devices/ethernet/statuses
[List the most recent Ethernet link speed, duplex, aggregation and power mode and status information for wireless devices.](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-ethernet-statuses/)
> `getOrganizationWirelessDevicesEthernetStatuses`
| `organizationId, perPage, startingAfter, endingBefore, networkIds` | `` | `ac, aggregation, duplex, enabled, id, isConnected, linkNegotiation, mode, name, network, poe, ports, power, serial, speed, standard` | `wireless:telemetry:read` +GET /organizations/{organizationId}/wireless/devices/latency/byClient
[Get latency summaries for all wireless devices in an organization. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-latency-by-client/)
> `getOrganizationWirelessDevicesLatencyByClient`
| `organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, networkIds, bands, ssids, macs` | `` | `average, device, frames, id, mac, name, network, overall, serial` | `` +GET /organizations/{organizationId}/wireless/devices/latency/byDevice
[Get latency summaries for all wireless devices in an organization. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-latency-by-device/)
> `getOrganizationWirelessDevicesLatencyByDevice`
| `organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, networkIds, serials, bands, ssids` | `` | `average, device, frames, id, mac, name, network, overall, serial` | `` +GET /organizations/{organizationId}/wireless/devices/latency/byNetwork
[Get per-network latency summaries for all wireless networks in an organization. (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-latency-by-network/)
> `getOrganizationWirelessDevicesLatencyByNetwork`
| `organizationId, perPage, startingAfter, endingBefore, t0, t1, timespan, networkIds, serials, bands, ssids` | `` | `average, frames, id, name, network, overall` | `` GET /organizations/{organizationId}/wireless/devices/packetLoss/byClient
[Get average packet loss for the given timespan for all clients in the organization.](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-packet-loss-by-client/)
> `getOrganizationWirelessDevicesPacketLossByClient`
| `organizationId, networkIds, ssids, bands, macs, perPage, startingAfter, endingBefore, t0, t1, timespan` | `` | `client, downstream, id, lossPercentage, lost, mac, name, network, total, upstream` | `` GET /organizations/{organizationId}/wireless/devices/packetLoss/byDevice
[Get average packet loss for the given timespan for all devices in the organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-packet-loss-by-device/)
> `getOrganizationWirelessDevicesPacketLossByDevice`
| `organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan` | `` | `device, downstream, id, lossPercentage, lost, mac, name, network, serial, total, upstream` | `` GET /organizations/{organizationId}/wireless/devices/packetLoss/byNetwork
[Get average packet loss for the given timespan for all networks in the organization.](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-packet-loss-by-network/)
> `getOrganizationWirelessDevicesPacketLossByNetwork`
| `organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan` | `` | `downstream, id, lossPercentage, lost, name, network, total, upstream` | `` GET /organizations/{organizationId}/wireless/devices/power/mode/history
[Return a record of power mode changes for wireless devices in the organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-power-mode-history/)
> `getOrganizationWirelessDevicesPowerModeHistory`
| `organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, networkIds, serials` | `` | `events, id, items, mac, model, name, network, powerMode, serial, tags, ts` | `` +GET /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
[Query for details on the organization's RADSEC device Certificate Authority certificates (CAs)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-radsec-certificates-authorities/)
> `getOrganizationWirelessDevicesRadsecCertificatesAuthorities`
| `organizationId, certificateAuthorityIds` | `` | `certificateAuthorityId, contents, counts, items, meta, remaining, status, total` | `dashboard:iam:config:read` +PUT /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
[Update an organization's RADSEC device Certificate Authority (CA) state](https://developer.cisco.com/meraki/api-v1/update-organization-wireless-devices-radsec-certificates-authorities/)
> `updateOrganizationWirelessDevicesRadsecCertificatesAuthorities`
| `organizationId` | `certificateAuthorityId, status` | `certificateAuthorityId, contents, status` | `dashboard:iam:config:write` +POST /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
[Create an organization's RADSEC device Certificate Authority (CA)](https://developer.cisco.com/meraki/api-v1/create-organization-wireless-devices-radsec-certificates-authority/)
> `createOrganizationWirelessDevicesRadsecCertificatesAuthority`
| `organizationId` | `` | `certificateAuthorityId, contents, status` | `dashboard:iam:config:write` +GET /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls
[Query for certificate revocation list (CRL) for the organization's RADSEC device Certificate Authorities (CAs).](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-radsec-certificates-authorities-crls/)
> `getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrls`
| `organizationId, certificateAuthorityIds` | `` | `certificateAuthorityId, counts, crl, items, meta, remaining, total` | `dashboard:iam:config:read` +GET /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls/deltas
[Query for all delta certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id.](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-radsec-certificates-authorities-crls-deltas/)
> `getOrganizationWirelessDevicesRadsecCertificatesAuthoritiesCrlsDeltas`
| `organizationId, certificateAuthorityIds` | `` | `certificateAuthorityId, counts, crl, items, meta, remaining, total` | `dashboard:iam:config:read` +GET /organizations/{organizationId}/wireless/devices/signalQuality/byClient
[Get average signal quality for all clients in the organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-signal-quality-by-client/)
> `getOrganizationWirelessDevicesSignalQualityByClient`
| `organizationId, networkIds, serials, ssids, bands, macs, perPage, startingAfter, endingBefore, t0, t1, timespan` | `` | `client, id, mac, name, network, rssi, snr` | `` +GET /organizations/{organizationId}/wireless/devices/signalQuality/byDevice
[Get average signal quality for all devices in the organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-signal-quality-by-device/)
> `getOrganizationWirelessDevicesSignalQualityByDevice`
| `organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan` | `` | `id, name, network, rssi, snr` | `` +GET /organizations/{organizationId}/wireless/devices/signalQuality/byNetwork
[Get average signal quality for all networks in the organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-signal-quality-by-network/)
> `getOrganizationWirelessDevicesSignalQualityByNetwork`
| `organizationId, networkIds, serials, ssids, bands, perPage, startingAfter, endingBefore, t0, t1, timespan` | `` | `id, name, network, rssi, snr` | `` GET /organizations/{organizationId}/wireless/devices/system/cpu/load/history
[Return the CPU Load history for a list of wireless devices in the organization.](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-system-cpu-load-history/)
> `getOrganizationWirelessDevicesSystemCpuLoadHistory`
| `organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, networkIds, serials` | `` | `cpuCount, cpuLoad5, id, items, mac, model, name, network, serial, series, tags, ts` | `` GET /organizations/{organizationId}/wireless/devices/wirelessControllers/byDevice
[List of Catalyst access points information](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-devices-wireless-controllers-by-device/)
> `getOrganizationWirelessDevicesWirelessControllersByDevice`
| `organizationId, networkIds, serials, controllerSerials, perPage, startingAfter, endingBefore` | `` | `controller, countryCode, counts, details, id, items, joinedAt, meta, mode, model, name, network, policy, remaining, rf, serial, site, tags, total, value` | `` -GET /organizations/{organizationId}/wireless/location/scanning/byNetwork
[Return scanning API settings (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-location-scanning-by-network/)
> `getOrganizationWirelessLocationScanningByNetwork`
| `organizationId, perPage, startingAfter, endingBefore, networkIds` | `` | `api, counts, enabled, items, meta, name, networkId, remaining, string, total, validator` | `wireless:telemetry:read` +GET /organizations/{organizationId}/wireless/location/scanning/byNetwork
[Return scanning API settings](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-location-scanning-by-network/)
> `getOrganizationWirelessLocationScanningByNetwork`
| `organizationId, perPage, startingAfter, endingBefore, networkIds` | `` | `api, counts, enabled, items, meta, name, networkId, remaining, string, total, validator` | `wireless:telemetry:read` +GET /organizations/{organizationId}/wireless/location/scanning/receivers
[Return scanning API receivers](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-location-scanning-receivers/)
> `getOrganizationWirelessLocationScanningReceivers`
| `organizationId, perPage, startingAfter, endingBefore, networkIds` | `` | `counts, id, items, meta, name, network, radio, receiverId, remaining, total, type, url, version` | `wireless:telemetry:read` +POST /organizations/{organizationId}/wireless/location/scanning/receivers
[Add new receiver for scanning API](https://developer.cisco.com/meraki/api-v1/create-organization-wireless-location-scanning-receiver/)
> `createOrganizationWirelessLocationScanningReceiver`
| `organizationId` | `id, network, radio, sharedSecret, type, url, version` | `id, name, network, radio, receiverId, type, url, version` | `wireless:telemetry:write` +PUT /organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId}
[Change scanning API receiver settings](https://developer.cisco.com/meraki/api-v1/update-organization-wireless-location-scanning-receiver/)
> `updateOrganizationWirelessLocationScanningReceiver`
| `organizationId, receiverId` | `radio, type, url, version` | `id, name, network, radio, receiverId, type, url, version` | `wireless:telemetry:write` +DELETE /organizations/{organizationId}/wireless/location/scanning/receivers/{receiverId}
[Delete a scanning API receiver](https://developer.cisco.com/meraki/api-v1/delete-organization-wireless-location-scanning-receiver/)
> `deleteOrganizationWirelessLocationScanningReceiver`
| `organizationId, receiverId` | `` | `` | `wireless:telemetry:write` GET /organizations/{organizationId}/wireless/opportunisticPcap/byNetwork
[List the Opportunistic Pcap settings of an organization by network (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-opportunistic-pcap-by-network/)
> `getOrganizationWirelessOpportunisticPcapByNetwork`
| `organizationId, networkIds` | `` | `enablement, name, networkId, networkWide, serials, tags` | `` GET /organizations/{organizationId}/wireless/opportunisticPcap/license/byNetwork
[Check the Opportunistic Pcap license status of an organization by network (BETA)](https://developer.cisco.com/meraki/api-v1/by-organization-wireless-opportunistic-pcap-license-network/)
> `byOrganizationWirelessOpportunisticPcapLicenseNetwork`
| `organizationId, networkIds` | `` | `licensed, name, networkId` | `` GET /organizations/{organizationId}/wireless/radio/afc/position/byDevice
[List the AFC power limits of an organization by device (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-radio-afc-position-by-device/)
> `getOrganizationWirelessRadioAfcPositionByDevice`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, serials` | `` | `antenna, cableLength, elevation, gps, height, id, name, network, serial, uncertainty` | `` @@ -958,14 +1000,14 @@ GET /organizations/{organizationId}/wireless/radio/autoRf/byNetwork
[List GET /organizations/{organizationId}/wireless/radio/autoRf/channels/planning/activities
[List the channel planning activities of an organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-radio-auto-rf-channels-planning-activities/)
> `getOrganizationWirelessRadioAutoRfChannelsPlanningActivities`
| `organizationId, networkIds, deviceSerials, bands, channels, serials, gFloorplanId, tags, models, rfProfiles, minimumRfHealthScore, maximumRfHealthScore` | `` | `band, channel, device, endsAt, id, mac, name, network, reason, serial, severity, startedAt, tags, type` | `` POST /organizations/{organizationId}/wireless/radio/autoRf/channels/recalculate
[Recalculates automatically assigned channels for every AP within specified the specified network(s)](https://developer.cisco.com/meraki/api-v1/recalculate-organization-wireless-radio-auto-rf-channels/)
> `recalculateOrganizationWirelessRadioAutoRfChannels`
| `organizationId` | `networkIds` | `estimatedCompletedAt` | `` GET /organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice
[List the RF profiles of an organization by device](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-rf-profiles-assignments-by-device/)
> `getOrganizationWirelessRfProfilesAssignmentsByDevice`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, productTypes, name, mac, serial, model, macs, serials, models` | `` | `counts, id, isIndoorDefault, isOutdoorDefault, items, meta, model, name, network, remaining, rfProfile, serial, total` | `` -GET /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries
[List the L2 isolation allow list MAC entry in an organization (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-ssids-firewall-isolation-allowlist-entries/)
> `getOrganizationWirelessSsidsFirewallIsolationAllowlistEntries`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, ssids` | `` | `client, counts, createdAt, description, entryId, id, items, mac, meta, name, network, number, remaining, ssid, total, updatedAt` | `` -POST /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries
[Create isolation allow list MAC entry for this organization (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-wireless-ssids-firewall-isolation-allowlist-entry/)
> `createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry`
| `organizationId` | `client, description, id, mac, network, number, ssid` | `client, createdAt, description, entryId, id, mac, name, network, number, ssid, updatedAt` | `` -DELETE /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{id}
[Destroy isolation allow list MAC entry for this organization (BETA)](https://developer.cisco.com/meraki/api-v1/delete-organization-wireless-ssids-firewall-isolation-allowlist-entry/)
> `deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry`
| `organizationId, id` | `` | `` | `` -PUT /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{id}
[Update isolation allow list MAC entry info (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-wireless-ssids-firewall-isolation-allowlist-entry/)
> `updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry`
| `organizationId, id` | `client, description, mac` | `client, createdAt, description, entryId, id, mac, name, network, number, ssid, updatedAt` | `` +GET /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries
[List the L2 isolation allow list MAC entry in an organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-ssids-firewall-isolation-allowlist-entries/)
> `getOrganizationWirelessSsidsFirewallIsolationAllowlistEntries`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, ssids` | `` | `client, counts, createdAt, description, entryId, id, items, lastUpdatedAt, mac, meta, name, network, number, remaining, ssid, total` | `` +POST /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries
[Create isolation allow list MAC entry for this organization](https://developer.cisco.com/meraki/api-v1/create-organization-wireless-ssids-firewall-isolation-allowlist-entry/)
> `createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry`
| `organizationId` | `client, description, id, mac, network, number, ssid` | `client, createdAt, description, entryId, id, lastUpdatedAt, mac, name, network, number, ssid` | `` +DELETE /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId}
[Destroy isolation allow list MAC entry for this organization](https://developer.cisco.com/meraki/api-v1/delete-organization-wireless-ssids-firewall-isolation-allowlist-entry/)
> `deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry`
| `organizationId, entryId` | `` | `` | `` +PUT /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId}
[Update isolation allow list MAC entry info](https://developer.cisco.com/meraki/api-v1/update-organization-wireless-ssids-firewall-isolation-allowlist-entry/)
> `updateOrganizationWirelessSsidsFirewallIsolationAllowlistEntry`
| `organizationId, entryId` | `client, description, mac` | `client, createdAt, description, entryId, id, lastUpdatedAt, mac, name, network, number, ssid` | `` GET /organizations/{organizationId}/wireless/ssids/statuses/byDevice
[List status information of all BSSIDs in your organization](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-ssids-statuses-by-device/)
> `getOrganizationWirelessSsidsStatusesByDevice`
| `organizationId, networkIds, serials, bssids, hideDisabled, perPage, startingAfter, endingBefore` | `` | `advertised, band, basicServiceSets, bssid, channel, channelWidth, counts, enabled, id, index, isBroadcasting, items, meta, name, network, number, power, radio, remaining, serial, ssid, total` | `wireless:telemetry:read` GET /organizations/{organizationId}/wireless/zigbee/byNetwork
[Return list of Zigbee configs (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-zigbee-by-network/)
> `getOrganizationWirelessZigbeeByNetwork`
| `organizationId, perPage, startingAfter, endingBefore, networkIds` | `` | `address, channel, defaults, enabled, id, iotController, lockManagement, mac, name, network, serial, status, transmitPowerLevel, username` | `` GET /organizations/{organizationId}/wireless/zigbee/devices
[List the Zigbee MR Nodes for and organization or the supplied network(s) (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-zigbee-devices/)
> `getOrganizationWirelessZigbeeDevices`
| `organizationId, perPage, startingAfter, endingBefore, networkIds, isEnrolled, search` | `` | `byStatus, channel, counts, doorLocks, dormant, enrolled, gateway, id, mac, name, network, offline, online, panId, serial, status, tags, transmitPowerLevel` | `` -PUT /organizations/{organizationId}/wireless/zigbee/devices/{id}
[Endpoint to update zigbee gateways (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-wireless-zigbee-device/)
> `updateOrganizationWirelessZigbeeDevice`
| `organizationId, id` | `enrolled` | `byStatus, channel, counts, doorLocks, dormant, enrolled, gateway, id, mac, name, network, offline, online, panId, serial, status, tags, transmitPowerLevel` | `` +PUT /organizations/{organizationId}/wireless/zigbee/devices/{id}
[Endpoint to update zigbee gateways (BETA)](https://developer.cisco.com/meraki/api-v1/update-organization-wireless-zigbee-device/)
> `updateOrganizationWirelessZigbeeDevice`
| `organizationId, id` | `channel, enrolled` | `byStatus, channel, counts, doorLocks, dormant, enrolled, gateway, id, mac, name, network, offline, online, panId, serial, status, tags, transmitPowerLevel` | `` POST /organizations/{organizationId}/wireless/zigbee/disenrollments
[Enqueue a job to start disenrolling doorlocks on zigbee configured MRs (BETA)](https://developer.cisco.com/meraki/api-v1/create-organization-wireless-zigbee-disenrollment/)
> `createOrganizationWirelessZigbeeDisenrollment`
| `organizationId` | `doorLockIds` | `disenrollmentId, doorLockIds, request, status, url` | `` GET /organizations/{organizationId}/wireless/zigbee/disenrollments/{id}
[Return a disenrollment job (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-zigbee-disenrollment/)
> `getOrganizationWirelessZigbeeDisenrollment`
| `organizationId, id` | `` | `disenrollmentId, doorLockId, doorLockIds, doorLocks, request, status, url` | `` GET /organizations/{organizationId}/wireless/zigbee/doorLocks
[Return the list of doorlocks for a network (BETA)](https://developer.cisco.com/meraki/api-v1/get-organization-wireless-zigbee-door-locks/)
> `getOrganizationWirelessZigbeeDoorLocks`
| `organizationId, networkIds, serial, perPage, startingAfter, endingBefore` | `` | `doorLockId, enrolledAt, eui64, gateway, id, lastSeenAt, lqi, name, network, rssi, serial, shortId, status` | ``