Cisco Meraki Campus Gateway API
The campusGateway API from Cisco Meraki — 13 operation(s) for campusgateway.
OpenAPI Specification
openapi: 3.0.1
info:
title: Meraki Dashboard API — campusGateway
description: 'A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.
> Date: 05 August, 2026
>
> [Recent Updates](https://meraki.io/whats-new/)
---
[API Documentation](https://meraki.io/api)
[Community Support](https://meraki.io/community)
[Meraki Homepage](https://www.meraki.com)
'
contact:
name: Meraki Developer Community
url: https://meraki.io/community
version: 1.73.0
x-provenance:
method: harvested
authored_by: Cisco Meraki
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
provider_published: true
derived_view: Per-first-tag view of the source document, tag 'campusGateway'. Operations and schemas are the provider's,
unmodified.
x-evidence:
- type: source
url: https://github.com/meraki/openapi/blob/master/openapi/spec3.json
- type: raw
url: https://raw.githubusercontent.com/meraki/openapi/master/openapi/spec3.json
- type: alternate
url: https://api.meraki.com/api/v1/openapiSpec
servers:
- url: https://api.meraki.com/{basePath}
variables:
basePath:
default: api/v1
security:
- meraki_api_key: []
- bearerAuth: []
tags:
- name: campusGateway
paths:
/networks/{networkId}/campusGateway/clusters:
post:
description: Create a cluster and add campus gateways to it
operationId: createNetworkCampusGatewayCluster
parameters:
- name: networkId
in: path
description: Network ID
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the new cluster
uplinks:
type: array
items:
type: object
properties:
interface:
type: string
description: Interface identifier, should be set to man1
vlan:
type: integer
description: VLAN ID of the interface
addresses:
type: array
items:
type: object
properties:
assignmentMode:
type: string
enum:
- dynamic
- static
description: Assignment mode of the interface
protocol:
type: string
enum:
- ipv4
description: Protocol of the interface when assignment mode is static
gateway:
type: string
description: Gateway of the interface when assignment mode is static
subnetMask:
type: string
description: Subnet mask of the interface when assignment mode is static
required:
- assignmentMode
description: Addresses of the interface
required:
- interface
- vlan
- addresses
description: Uplink interface settings of the cluster
tunnels:
type: array
items:
type: object
properties:
uplink:
type: object
properties:
interface:
type: string
description: Uplink interface identifier
required:
- interface
description: Uplink interface details if uplink is reused as tunnel
interface:
type: string
description: Interface identifier, should be set to tun1. Specify this interface only if uplink isn't
reused as tunnel
vlan:
type: integer
description: VLAN ID of the interface
addresses:
type: array
items:
type: object
properties:
protocol:
type: string
enum:
- ipv4
description: Protocol of the interface
gateway:
type: string
description: Gateway of the interface
subnetMask:
type: string
description: Subnet mask of the interface
required:
- protocol
- gateway
- subnetMask
description: Addresses of the interface
description: 'Tunnel interface settings of the cluster: Reuse uplink or specify tunnel interface'
nameservers:
type: object
properties:
addresses:
type: array
items:
type: string
description: Addresses of the nameservers
description: Nameservers of the cluster
portChannels:
type: array
items:
type: object
properties:
name:
type: string
description: Name of the port channel
vlan:
type: integer
description: VLAN ID of the port channel
allowedVlans:
type: string
description: Allowed VLANs of the port channel
required:
- name
- vlan
- allowedVlans
description: Port channel settings of the cluster
devices:
type: array
items:
type: object
properties:
serial:
type: string
description: Serial of the device
uplinks:
type: array
items:
type: object
properties:
interface:
type: string
description: Uplink interface name
addresses:
type: array
items:
type: object
properties:
protocol:
type: string
enum:
- ipv4
description: Protocol of the interface
address:
type: string
description: IP address of the interface
required:
- protocol
- address
description: Uplink IP addresses of the device
required:
- interface
- addresses
description: Uplink settings of the device when uplink assignment mode of cluster is static
tunnels:
type: array
items:
type: object
properties:
interface:
type: string
description: Tunnel interface name
addresses:
type: array
items:
type: object
properties:
protocol:
type: string
enum:
- ipv4
description: Protocol of the interface
address:
type: string
description: IP address of the interface
required:
- protocol
- address
description: Tunnel IP addresses of the device
required:
- interface
- addresses
description: Tunnel settings of the device when tunnel interface of cluster is specified
required:
- serial
description: Devices to be added to the cluster
notes:
type: string
description: Notes about cluster with max size of 511 characters allowed
example:
name: North Campus
uplinks:
- interface: man1
vlan: 5
addresses:
- assignmentMode: static
protocol: ipv4
gateway: 1.2.3.5
subnetMask: 255.255.255.0
tunnels:
- uplink:
interface: man1
interface: tun1
vlan: 6
addresses:
- protocol: ipv4
gateway: 2.3.5.6
subnetMask: 255.255.255.0
nameservers:
addresses:
- 8.8.8.8
- 8.8.4.4
portChannels:
- name: Port-channel1
vlan: 25
allowedVlans: 10-20
devices:
- serial: Q234-ABCD-0001
uplinks:
- interface: man1
addresses:
- protocol: ipv4
address: 5.1.2.3
tunnels:
- interface: tun1
addresses:
- protocol: ipv4
address: 6.2.6.7
notes: This cluster is for New York Office
required:
- name
- uplinks
- tunnels
- nameservers
- portChannels
required: true
responses:
'201':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
clusterId:
type: string
description: ID of the cluster
name:
type: string
description: Name of the cluster
uplinks:
type: array
items:
type: object
properties:
interface:
type: string
description: Name of the interface
vlan:
type: integer
description: VLAN of the interface
addresses:
type: array
items:
type: object
properties:
assignmentMode:
type: string
description: Assignment mode of the interface
protocol:
type: string
description: Protocol of the interface
gateway:
type: string
description: Gateway of the interface
subnetMask:
type: string
description: Subnet mask of the interface
description: Addresses of the interface
description: Uplink settings of the cluster
tunnels:
type: array
items:
type: object
properties:
uplink:
type: object
properties:
interface:
type: string
description: Uplink interface name
description: Use uplink interface as tunnel interface
interface:
type: string
description: Name of the interface
vlan:
type: integer
description: VLAN ID of the interface
addresses:
type: array
items:
type: object
properties:
protocol:
type: string
description: Protocol of the interface
gateway:
type: string
description: Gateway of the interface
subnetMask:
type: string
description: Subnet mask of the interface
description: Addresses of the interface
description: Tunnel settings of the cluster
nameservers:
type: object
properties:
addresses:
type: array
items:
type: string
description: Addresses of the nameservers
description: Nameservers of the cluster
portChannels:
type: array
items:
type: object
properties:
id:
type: string
description: ID of the port channel
name:
type: string
description: Name of the port channel
vlan:
type: integer
description: VLAN ID of the port channel
allowedVlans:
type: string
description: Allowed VLANs of the port channel
description: Port channel settings of the cluster
devices:
type: array
items:
type: object
properties:
serial:
type: string
description: Serial of the device
memberId:
type: string
description: Member number assigned to the device within cluster - This is a read only attribute
and cannot be altered using post/put operations
uplinks:
type: array
items:
type: object
properties:
interface:
type: string
description: Uplink interface name
addresses:
type: array
items:
type: object
properties:
protocol:
type: string
description: Protocol of the interface
address:
type: string
description: IP address of the interface
description: Uplink IP addresses of the device
description: Uplink settings of the device
tunnels:
type: array
items:
type: object
properties:
interface:
type: string
description: Tunnel interface name
addresses:
type: array
items:
type: object
properties:
protocol:
type: string
description: Protocol of the interface
address:
type: string
description: IP address of the interface
description: Tunnel IP addresses of the device
description: Tunnel settings of the device
description: Devices in the cluster
notes:
type: string
description: Notes about cluster
url:
type: string
description: URL to display cluster details
example:
clusterId: '1284392014818'
name: North Campus
uplinks:
- interface: man1
vlan: 5
addresses:
- assignmentMode: static
protocol: ipv4
gateway: 1.2.3.5
subnetMask: 255.255.255.0
tunnels:
- uplink:
interface: man1
interface: tun1
vlan: 6
addresses:
- protocol: ipv4
gateway: 2.3.5.6
subnetMask: 255.255.255.0
nameservers:
addresses:
- 8.8.8.8
- 8.8.4.4
portChannels:
- id: '1284392014830'
name: Port-channel1
vlan: 25
allowedVlans: 10-20
devices:
- serial: Q234-ABCD-0001
memberId: '1'
uplinks:
- interface: man1
addresses:
- protocol: ipv4
address: 5.1.2.3
tunnels:
- interface: tun1
addresses:
- protocol: ipv4
address: 6.2.6.7
notes: This cluster is for New York Office
url: https://n123.meraki.com/networkName/n/abc123/manage/campus_gateways/clusters
summary: Create a cluster and add campus gateways to it
tags:
- campusGateway
- configure
- clusters
/networks/{networkId}/campusGateway/clusters/{clusterId}:
put:
description: Update a cluster and add/remove campus gateways to/from it
operationId: updateNetworkCampusGatewayCluster
parameters:
- name: networkId
in: path
description: Network ID
schema:
type: string
required: true
- name: clusterId
in: path
description: Cluster ID
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the cluster
uplinks:
type: array
items:
type: object
properties:
interface:
type: string
description: Interface identifier, should be set to man1
vlan:
type: integer
description: VLAN ID of the interface
addresses:
type: array
items:
type: object
properties:
assignmentMode:
type: string
enum:
- dynamic
- static
description: Assignment mode of the interface
protocol:
type: string
enum:
- ipv4
description: Protocol of the interface when assignmentMode is static
gateway:
type: string
description: Gateway of the interface when assignmentMode is static
subnetMask:
type: string
description: Subnet mask of the interface when assignmentMode is static
description: Addresses of the interface
required:
- interface
description: Uplink interface settings of the cluster
tunnels:
type: array
items:
type: object
properties:
uplink:
type: object
properties:
interface:
type: string
description: Uplink interface identifier
required:
- interface
description: Uplink interface details if uplink is reused as tunnel
interface:
type: string
description: Interface identifier, should be set to tun1. Specify this interface only if uplink isn't
reused as tunnel
vlan:
type: integer
description: VLAN ID of the interface
addresses:
type: array
items:
type: object
properties:
protocol:
type: string
enum:
- ipv4
description: Protocol of the interface
gateway:
type: string
description: Gateway of the interface
subnetMask:
type: string
description: Subnet mask of the interface
description: Addresses of the interface
description: 'Tunnel interface settings of the cluster: Reuse uplink or specify tunnel interface'
nameservers:
type: object
properties:
addresses:
type: array
items:
type: string
description: Addresses of the nameservers
description: Nameservers of the cluster
portChannels:
type: array
items:
type: object
properties:
name:
type: string
description: Name of the port channel
vlan:
type: integer
description: VLAN ID of the port channel
allowedVlans:
type: string
description: Allowed VLANs of the port channel
required:
- name
description: Port channel settings of the cluster
devices:
type: array
items:
type: object
properties:
serial:
type: string
description: Serial of the device
uplinks:
type: array
items:
type: object
properties:
interface:
type: string
description: Uplink interface name
addresses:
type: array
items:
type: object
properties:
protocol:
type: string
enum:
- ipv4
description: Protocol of the interface
address:
type: string
description: IP address of the interface
required:
- address
description: Uplink IP addresses of the device
required:
- interface
- addresses
description: Uplink settings of the device when uplink assignment mode of cluster is static
tunnels:
type: array
items:
type: object
properties:
interface:
type: string
description: Tunnel interface name
addresses:
type: array
items:
type: object
properties:
protocol:
type: string
enum:
- ipv4
description: Protocol of the interface
address:
type: string
description: IP address of the interface
required:
- address
description: Tunnel IP addresses of the device
required:
- interface
- addresses
description: Tunnel settings of the device when tunnel interface of cluster is specified
required:
- serial
description: Devices in the cluster
notes:
type: string
description: Notes about cluster with max size of 511 characters allowed
example:
name: North Campus
uplinks:
- interface: man1
vlan: 5
addresses:
- assignmentMode: static
protocol: ipv4
gateway: 1.2.3.5
subnetMask: 255.255.255.0
tunnels:
- uplink:
interface: man1
interface: tun1
vlan: 6
addresses:
- protocol: ipv4
gateway: 2.3.5.6
subnetMask: 255.255.255.0
nameservers:
addresses:
- 8.8.8.8
- 8.8.4.4
portChannels:
- name: Port-channel1
vlan: 25
allowedVlans: 10-20
devices:
- serial: Q234-ABCD-0001
uplinks:
- interface: man1
addresses:
- protocol: ipv4
address: 5.1.2.3
tunnels:
- interface: tun1
addresses:
- protocol: ipv4
address: 6.2.6.7
notes: This cluster is for New York Office
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
clusterId:
type: string
description: ID of the cluster
name:
type: string
description: Name of the cluster
uplinks:
type: array
items:
type: object
properties:
interface:
type: string
description: Name of the interface
vlan:
type: integer
description: VLAN of the interface
addresses:
type: array
items:
type: object
properties:
assignmentMode:
type: string
description: Assignment mode of the interface
protocol:
type: string
description: Protocol of the interface
gateway:
type: string
description: Gateway of the interface
subnetMask:
type: string
description: Subnet mask of the interface
description: Addresses of the interface
description: Uplink settings of the cluster
tunnels:
type: array
items:
type: object
properties:
uplink:
type: object
properties:
interface:
type: string
# --- truncated at 32 KB (144 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-meraki/refs/heads/main/openapi/cisco-meraki-campusgateway-api-openapi.yml