Networks
Devices
UplinkMost Dashboard API calls require either the organization
ID or the network ID as part of the endpoint. (You will
see later in this chapter how to obtain these IDs and how
to make Dashboard API calls.) When you have these IDs,
you can build and make more advanced calls to collect
data, create and update new resources, and configure
and make changes to the network. Remember that all
API calls require an API key.
If your Meraki dashboard contains a large number of
organizations, networks, and devices, you might have to
consider pagination when making API calls. Recall from
Chapter 7 that pagination is used when the data returned
from an API call is too large and needs to be limited to a
subset of the results. The Meraki Dashboard API
supports three special query parameters for pagination:
perPage: The number of entries to be returned in the current request
startingAfter: A value used to indicate that the returned data will
start immediately after this value
endingBefore: A value used to indicate that the returned data will
end immediately before this valueWhile the types of the startingAfter and
endingBefore values differ based on API endpoints,
they generally are either timestamps specifying windows
in time for which the data should be returned or integer
values specifying IDs and ranges of IDs.
The Dashboard API also supports action batches, which
make it possible to submit multiple configuration
requests in a single transaction and are ideal for initial
provisioning of a large number of devices or performing
large configuration changes throughout the whole
network. Action batches also provide a mechanism to
avoid hitting the rate limitations implemented in the API
for high-scale configuration changes as you can