Cisco Meraki Organizations API
The organizations API from Cisco Meraki — 170 operation(s) for organizations.
Operations 239
GET
/organizations/{organizationId}/actionBatches
Return the list of action batches in the organization
#
GET
/organizations/{organizationId}/adaptivePolicy/acls
List adaptive policy ACLs in a organization
#
GET
/organizations/{organizationId}/adaptivePolicy/acls/{aclId}
Returns the adaptive policy ACL information
#
DELETE
/organizations/{organizationId}/adaptivePolicy/acls/{aclId}
Deletes the specified adaptive policy ACL
#
GET
/organizations/{organizationId}/adaptivePolicy/groups
List adaptive policy groups in a organization
#
DELETE
/organizations/{organizationId}/adaptivePolicy/groups/{id}
Deletes the specified adaptive policy group and any associated policies and references
#
GET
/organizations/{organizationId}/adaptivePolicy/overview
Returns adaptive policy aggregate statistics for an organization
#
GET
/organizations/{organizationId}/adaptivePolicy/policies
List adaptive policies in an organization
#
GET
/organizations/{organizationId}/adaptivePolicy/settings
Returns global adaptive policy settings in an organization
#
PUT
/organizations/{organizationId}/adaptivePolicy/settings
Update global adaptive policy settings
#
DELETE
/organizations/{organizationId}/admins/{adminId}
Revoke all access for a dashboard administrator within this organization
#
GET
/organizations/{organizationId}/alerts/profiles
List all organization-wide alert configurations
#
POST
/organizations/{organizationId}/alerts/profiles
Create an organization-wide alert configuration
#
PUT
/organizations/{organizationId}/alerts/profiles/{alertConfigId}
Update an organization-wide alert config
#
DELETE
/organizations/{organizationId}/alerts/profiles/{alertConfigId}
Removes an organization-wide alert config
#
GET
/organizations/{organizationId}/api/rest/provisioning/pipelines/jobs
List pipeline jobs, with optional status filtering
#
GET
/organizations/{organizationId}/api/rest/provisioning/pipelines/jobs/overviews/byPipeline
Retrieves pipeline overviews with aggregated job status counts
#
GET
/organizations/{organizationId}/apiRequests/overview
Return an aggregated overview of API requests data
#
GET
/organizations/{organizationId}/apiRequests/overview/responseCodes/byInterval
Tracks organizations' API requests by response code across a given time period
#
GET
/organizations/{organizationId}/assurance/alerts/overview
Return overview of active health alerts for an organization
#
GET
/organizations/{organizationId}/assurance/alerts/overview/byNetwork
Return a Summary of Alerts grouped by network and severity
#
GET
/organizations/{organizationId}/assurance/alerts/overview/byType
Return a Summary of Alerts grouped by type and severity
#
GET
/organizations/{organizationId}/assurance/alerts/overview/historical
Returns historical health alert overviews
#
GET
/organizations/{organizationId}/assurance/alerts/profiles
List the alert profiles for this organization
#
DELETE
/organizations/{organizationId}/assurance/alerts/profiles/{profileId}
Delete an alert profile for this organization
#
POST
/organizations/{organizationId}/assurance/alerts/restore
Restore health alerts from dismissed
#
GET
/organizations/{organizationId}/assurance/alerts/taxonomy/categories
Return a list of Category Types
#
GET
/organizations/{organizationId}/assurance/alerts/{id}
Return a singular Health Alert by its id
#
GET
/organizations/{organizationId}/brandingPolicies
List the branding policies of an organization
#
POST
/organizations/{organizationId}/brandingPolicies
Add a new branding policy to an organization
#
GET
/organizations/{organizationId}/brandingPolicies/priorities
Return the branding policy IDs of an organization in priority order
#
PUT
/organizations/{organizationId}/brandingPolicies/priorities
Update the priority ordering of an organization's branding policies.
#
DELETE
/organizations/{organizationId}/brandingPolicies/{brandingPolicyId}
Delete a branding policy
#
POST
/organizations/{organizationId}/claim
Claim a list of devices, licenses, and/or orders into an organization inventory
#
GET
/organizations/{organizationId}/clients/bandwidthUsageHistory
Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.
#
GET
/organizations/{organizationId}/clients/overview
Return summary information around client data usage (in kb) across the given organization.
#
POST
/organizations/{organizationId}/clone
Create a new organization by cloning the addressed organization
#
GET
/organizations/{organizationId}/configTemplates
List the configuration templates for this organization
#
GET
/organizations/{organizationId}/configTemplates/{configTemplateId}
Return a single configuration template
#
PUT
/organizations/{organizationId}/configTemplates/{configTemplateId}
Update a configuration template
#
DELETE
/organizations/{organizationId}/configTemplates/{configTemplateId}
Remove a configuration template
#
GET
/organizations/{organizationId}/configurationChanges
View the Change Log for your organization
#
GET
/organizations/{organizationId}/devices
List the devices in an organization that have been assigned to a network.
#
GET
/organizations/{organizationId}/devices/availabilities
List the availability information for devices in an organization
#
GET
/organizations/{organizationId}/devices/availabilities/changeHistory
List the availability history information for devices in an organization.
#
GET
/organizations/{organizationId}/devices/cellular/data/devices
List devices eligible for Cellular Data Management profile assignment in this organization
#
GET
/organizations/{organizationId}/devices/cellular/data/profiles
List cellular data management profiles in this organization
#
POST
/organizations/{organizationId}/devices/cellular/data/profiles
Add a cellular data management profile to this organization
#
GET
/organizations/{organizationId}/devices/cellular/data/profiles/assignments
List Cellular Data Management Profile assignments in this organization
#
POST
/organizations/{organizationId}/devices/cellular/data/profiles/assignments/batchCreate
Assign devices to a Cellular Data Management Profile in batch
#
POST
/organizations/{organizationId}/devices/cellular/data/profiles/assignments/bulkDelete
Unassign devices from a Cellular Data Management Profile in batch
#
PUT
/organizations/{organizationId}/devices/cellular/data/profiles/{profileId}
Update a Cellular Data Management Profile
#
DELETE
/organizations/{organizationId}/devices/cellular/data/profiles/{profileId}
Delete a cellular data management profile from this organization
#
GET
/organizations/{organizationId}/devices/cellular/data/usage/byDevice
List current cellular data usage for devices in this organization
#
GET
/organizations/{organizationId}/devices/cellular/data/usage/history/byDevice/byInterval
List historical cellular data usage grouped by device and interval in this organization
#
GET
/organizations/{organizationId}/devices/cellular/geolocations
List the latest cellular geolocation telemetry for devices in an organization
#
GET
/organizations/{organizationId}/devices/cellular/uplinks/bands/byDevice
List the latest cellular uplink signal information for devices in an organization
#
GET
/organizations/{organizationId}/devices/cellular/uplinks/towers/byDevice
List the latest cellular tower information for devices in an organization
#
POST
/organizations/{organizationId}/devices/controller/migrations
Migrate devices to another controller or management mode
#
GET
/organizations/{organizationId}/devices/controller/migrations
Retrieve device migration statuses in an organization
#
POST
/organizations/{organizationId}/devices/details/bulkUpdate
Updating device details (currently only used for Catalyst devices)
#
GET
/organizations/{organizationId}/devices/overview/byModel
Lists the count for each device model
#
POST
/organizations/{organizationId}/devices/packetCapture/captures
Perform a packet capture on a device and store in Meraki Cloud
#
POST
/organizations/{organizationId}/devices/packetCapture/captures/bulkCreate
Perform a packet capture on multiple devices and store in Meraki Cloud.
#
POST
/organizations/{organizationId}/devices/packetCapture/captures/bulkDelete
BulkDelete packet captures from cloud
#
DELETE
/organizations/{organizationId}/devices/packetCapture/captures/{captureId}
Delete a single packet capture from cloud using captureId
#
POST
/organizations/{organizationId}/devices/packetCapture/captures/{captureId}/downloadUrl/generate
Get presigned download URL for given packet capture id
#
POST
/organizations/{organizationId}/devices/packetCapture/captures/{captureId}/stop
Stop a specific packet capture (not supported for Catalyst devices)
#
GET
/organizations/{organizationId}/devices/packetCapture/schedules
List the Packet Capture Schedules
#
POST
/organizations/{organizationId}/devices/packetCapture/schedules
Create a schedule for packet capture
#
POST
/organizations/{organizationId}/devices/packetCapture/schedules/reorder
Bulk update priorities of pcap schedules
#
PUT
/organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}
Update a schedule for packet capture
#
DELETE
/organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}
Delete schedule from cloud
#
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
#
GET
/organizations/{organizationId}/devices/provisioning/statuses
List the provisioning statuses information for devices in an organization.
#
GET
/organizations/{organizationId}/devices/statuses
List the status of every Meraki device in the organization
#
GET
/organizations/{organizationId}/devices/statuses/overview
Return an overview of current device statuses
#
GET
/organizations/{organizationId}/devices/syslog/servers/byNetwork
Returns syslog servers configured for the networks within an organization.
#
GET
/organizations/{organizationId}/devices/syslog/servers/roles/byNetwork
Returns roles that can be assigned to a syslog server for a given network.
#
GET
/organizations/{organizationId}/devices/system/memory/usage/history/byInterval
Return the memory utilization history in kB for devices in the organization.
#
GET
/organizations/{organizationId}/devices/uplinks/addresses/byDevice
List the current uplink addresses for devices in an organization.
#
GET
/organizations/{organizationId}/devices/uplinksLossAndLatency
Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago
#
GET
/organizations/{organizationId}/earlyAccess/features
List the available early access features for organization
#
GET
/organizations/{organizationId}/earlyAccess/features/optIns
List the early access feature opt-ins for an organization
#
POST
/organizations/{organizationId}/earlyAccess/features/optIns
Create a new early access feature opt-in for an organization
#
GET
/organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
Show an early access feature opt-in for an organization
#
PUT
/organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
Update an early access feature opt-in for an organization
#
DELETE
/organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
Delete an early access feature opt-in
#
GET
/organizations/{organizationId}/firmware/upgrades
Get firmware upgrade information for an organization
#
GET
/organizations/{organizationId}/firmware/upgrades/byDevice
Get firmware upgrade status for the filtered devices
#
GET
/organizations/{organizationId}/floorPlans/autoLocate/devices
List auto locate details for each device in your organization
#
GET
/organizations/{organizationId}/floorPlans/autoLocate/statuses
List the status of auto locate for each floorplan in your organization
#
GET
/organizations/{organizationId}/integrations/deployable
Provides a list of integrations that can be enabled for an Organization.
#
GET
/organizations/{organizationId}/integrations/deployed
Provides a list of integrations enabled for an Organization.
#
GET
/organizations/{organizationId}/integrations/xdr/networks
Returns the networks in the organization that have XDR enabled
#
POST
/organizations/{organizationId}/inventory/claim
Claim a list of devices, licenses, and/or orders into an organization inventory
#
GET
/organizations/{organizationId}/inventory/devices
Return the device inventory for an organization
#
GET
/organizations/{organizationId}/inventory/devices/eox/overview
Fetch the EOX summary for an organization, including counts of devices that are end-of-sale, end-of-support, and end-of-support-soon.
#
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.
#
GET
/organizations/{organizationId}/inventory/devices/swaps/bulk/{id}
List of device swaps for a given request ID ({id}).
#
GET
/organizations/{organizationId}/inventory/devices/{serial}
Return a single device from the inventory of an organization
#
POST
/organizations/{organizationId}/inventory/orders/claim
Claim an order by the secure unique order claim number, the order claim id
#
POST
/organizations/{organizationId}/inventory/orders/preview
Preview the results and status of an order claim by the secure order id
#
POST
/organizations/{organizationId}/inventory/release
Release a list of claimed devices from an organization.
#
GET
/organizations/{organizationId}/licenses/overview
Return an overview of the license state for an organization
#
GET
/organizations/{organizationId}/loginSecurity
Returns the login security settings for an organization.
#
PUT
/organizations/{organizationId}/loginSecurity
Update the login security settings for an organization
#
GET
/organizations/{organizationId}/networks
List the networks that the user has privileges on in an organization
#
POST
/organizations/{organizationId}/networks/combine
Combine multiple networks into a single network
#
GET
/organizations/{organizationId}/networks/groups/overview/byGroup
List the client and status overview information for the network groups in an organization
#
POST
/organizations/{organizationId}/networks/groups/{groupId}/bulkAssign
Add networks to a network group
#
POST
/organizations/{organizationId}/networks/groups/{groupId}/bulkUnassign
Remove networks from a network group
#
POST
/organizations/{organizationId}/networks/moves
Move networks from one organization to another
#
GET
/organizations/{organizationId}/networks/moves
Return a list of network move operations in the organization
#
GET
/organizations/{organizationId}/openapiSpec
Return the OpenAPI Specification of the organization's API documentation in JSON
#
GET
/organizations/{organizationId}/policies/assignments/byClient
Get policies for all clients with policies
#
GET
/organizations/{organizationId}/policies/global/firewall/applicationCategories
List application categories with their associated applications
#
GET
/organizations/{organizationId}/policies/global/firewall/rulesets
List Organization-Wide Policy Firewall Rulesets
#
POST
/organizations/{organizationId}/policies/global/firewall/rulesets
Create an Organization-Wide Policy Firewall Ruleset
#
POST
/organizations/{organizationId}/policies/global/firewall/rulesets/rules
Create an Organization-Wide Policy Firewall Rule
#
GET
/organizations/{organizationId}/policies/global/firewall/rulesets/rules
List Organization-Wide Policy Firewall Rules
#
DELETE
/organizations/{organizationId}/policies/global/firewall/rulesets/rules/{ruleId}
Delete an Organization-Wide Policy Firewall Rule
#
PUT
/organizations/{organizationId}/policies/global/firewall/rulesets/rules/{ruleId}
Update an Organization-Wide Policy Firewall Rule
#
PUT
/organizations/{organizationId}/policies/global/firewall/rulesets/{rulesetId}
Update an Organization-Wide Policy Firewall Ruleset
#
DELETE
/organizations/{organizationId}/policies/global/firewall/rulesets/{rulesetId}
Delete an Organization-Wide Policy Firewall Ruleset
#
GET
/organizations/{organizationId}/policies/global/group/policies
List Organization-Wide Policies
#
POST
/organizations/{organizationId}/policies/global/group/policies
Create an Organization-Wide Policy
#
POST
/organizations/{organizationId}/policies/global/group/policies/adaptivePolicyGroups/assign
Assign adaptive policy groups to a policy
#
GET
/organizations/{organizationId}/policies/global/group/policies/adaptivePolicyGroups/assignments
List adaptive policy group assignments
#
POST
/organizations/{organizationId}/policies/global/group/policies/adaptivePolicyGroups/remove
Remove adaptive policy groups from a policy
#
GET
/organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments
List Organization-Wide Policy Ruleset Assignments
#
POST
/organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments
Create an Organization-Wide Policy Ruleset Assignment
#
PUT
/organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments/{assignmentId}
Update an Organization-Wide Policy Ruleset Assignment
#
DELETE
/organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments/{assignmentId}
Delete an Organization-Wide Policy Ruleset Assignment
#
PUT
/organizations/{organizationId}/policies/global/group/policies/{policyId}
Update an Organization-Wide Policy
#
DELETE
/organizations/{organizationId}/policies/global/group/policies/{policyId}
Delete an Organization-Wide Policy
#
GET
/organizations/{organizationId}/policyObjects
Lists Policy Objects belonging to the organization.
#
GET
/organizations/{organizationId}/policyObjects/groups
Lists Policy Object Groups belonging to the organization.
#
GET
/organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}
Shows details of a Policy Object Group.
#
PUT
/organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}
Updates a Policy Object Group.
#
DELETE
/organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}
Deletes a Policy Object Group.
#
GET
/organizations/{organizationId}/policyObjects/{policyObjectId}
Shows details of a Policy Object.
#
GET
/organizations/{organizationId}/saml
Returns the SAML SSO enabled settings for an organization.
#
PUT
/organizations/{organizationId}/saml
Updates the SAML SSO enabled settings for an organization.
#
GET
/organizations/{organizationId}/sase/integrations/{integrationId}
Get details of a Secure Access integration
#
DELETE
/organizations/{organizationId}/sase/integrations/{integrationId}
Remove a Secure Access integration
#
GET
/organizations/{organizationId}/sase/networks/eligible
List of MX networks or templates that can be enrolled into Secure Access
#
POST
/organizations/{organizationId}/sase/sites/attach
Attach sites in this organization to Secure Access
#
GET
/organizations/{organizationId}/sase/sites/connectivity/history/bySite
Get the connectivity history of SASE sites in this organization
#
GET
/organizations/{organizationId}/sase/sites/connectivity/overview
List high-level SASE site statuses (healthy, degraded, offline)
#
POST
/organizations/{organizationId}/sase/sites/detach
Detach sites in this organization from Secure Access
#
POST
/organizations/{organizationId}/splash/themes/{themeIdentifier}/assets
Create a Splash Theme Asset
#
GET
/organizations/{organizationId}/summary/top/appliances/byUtilization
Return the top 10 appliances sorted by utilization over given time range.
#
GET
/organizations/{organizationId}/summary/top/applications/byUsage
Return the top applications sorted by data usage over given time range
#
GET
/organizations/{organizationId}/summary/top/applications/categories/byUsage
Return the top application categories sorted by data usage over given time range
#
GET
/organizations/{organizationId}/summary/top/clients/byUsage
Return metrics for organization's top 10 clients by data usage (in mb) over given time range.
#
GET
/organizations/{organizationId}/summary/top/clients/manufacturers/byUsage
Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.
#
GET
/organizations/{organizationId}/summary/top/devices/byUsage
Return metrics for organization's top 10 devices sorted by data usage over given time range
#
GET
/organizations/{organizationId}/summary/top/devices/models/byUsage
Return metrics for organization's top 10 device models sorted by data usage over given time range
#
GET
/organizations/{organizationId}/summary/top/networks/byStatus
List the client and status overview information for the networks in an organization
#
GET
/organizations/{organizationId}/summary/top/ssids/byUsage
Return metrics for organization's top 10 ssids by data usage over given time range
#
GET
/organizations/{organizationId}/summary/top/switches/byEnergyUsage
Return metrics for organization's top 10 switches by energy usage over given time range
#
GET
/organizations/{organizationId}/uplinks/statuses
List the uplink status of every Meraki MX, MG and Z series devices in the organization
#
GET
/organizations/{organizationId}/webhooks/alertTypes
Return a list of alert types to be used with managing webhook alerts
#
GET
/organizations/{organizationId}/webhooks/callbacks/statuses/{callbackId}
Return the status of an API callback
#