meraki/rest/group-policies

Create a Meraki REST API wrapper for the group policy ressource. See the online documentation for more information.

Source:
Example
const apiKey = 'secret meraki api key'
const organizationId = 'meraki organization id'
const version = 'v0'
const target = 'n12'
const basePath = `/${target}/${version}/networks`
const rateLimiter = {
 enabled: true
}
const policyEndpoints = require('./lib/rest/policies')({ apiKey, target, basePath, baseUrl, rateLimiter })
Parameters:
Name Type Attributes Default Description
apiKey string <optional>
 ''

The Meraki api key
target string <optional>
 'api'

The Meraki target
basePath string <optional>
 '/'

The Meraki base path for the group policy ressource
rateLimiter string

The rate limiter (bottleneck) configuration
logger object <optional>

Logger to use if logging is enabled
Returns:

The initialized Meraki REST API wrapper for the group policy ressource

Type
Object

Methods

(static) listNetworkGroupPolicies(apiKeyopt, targetopt, scopeopt, networkId) → {Promise}

Source:

List the group policies in a network.

Example

Example response

[
  {
    "name": "No video streaming",
    "groupPolicyId": 102
  }
  ...
]
Parameters:
Name Type Attributes Description
apiKey string <optional>

Optional custom apiKey for this request (if not set will take the inital apiKey)
target string <optional>

Optional custom target for this request (if not set will take the inital target)
scope string <optional>

Optional custom scope for rate limiter
networkId string

The id of the network for which to list the group policies
Returns:

A promise holding the group policies of this network

Type
Promise