Cisco Meraki Cellular Gateway API
The cellularGateway API from Cisco Meraki — 16 operation(s) for cellulargateway.
OpenAPI Specification
openapi: 3.0.1
info:
title: Meraki Dashboard API — cellularGateway
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 'cellularGateway'. 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: cellularGateway
paths:
/devices/{serial}/cellularGateway/lan:
get:
description: Show the LAN Settings of a MG
operationId: getDeviceCellularGatewayLan
parameters:
- name: serial
in: path
description: Serial
schema:
type: string
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
deviceName:
type: string
description: Name of the MG.
deviceLanIp:
type: string
description: Lan IP of the MG
deviceSubnet:
type: string
description: Subnet configuration of the MG.
fixedIpAssignments:
type: array
items:
type: object
properties:
name:
type: string
description: A descriptive name of the assignment
ip:
type: string
description: The IP address you want to assign to a specific server or device
mac:
type: string
description: The MAC address of the server or device that hosts the internal resource that you wish
to receive the specified IP address
description: list of all fixed IP assignments for a single MG
reservedIpRanges:
type: array
items:
type: object
properties:
start:
type: string
description: Starting IP included in the reserved range of IPs
end:
type: string
description: Ending IP included in the reserved range of IPs
comment:
type: string
description: Comment explaining the reserved IP range
description: list of all reserved IP ranges for a single MG
example:
deviceName: name of the MG
deviceLanIp: 192.168.0.33
deviceSubnet: 192.168.0.32/27
fixedIpAssignments:
- name: server 1
ip: 192.168.0.10
mac: 0b:00:00:00:00:ac
reservedIpRanges:
- start: 192.168.1.0
end: 192.168.1.1
comment: A reserved IP range
security:
- oauth2:
- sdwan:config:read
summary: Show the LAN Settings of a MG
tags:
- cellularGateway
- configure
- lan
put:
description: Update the LAN Settings for a single MG.
operationId: updateDeviceCellularGatewayLan
parameters:
- name: serial
in: path
description: Serial
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
reservedIpRanges:
type: array
items:
type: object
properties:
start:
type: string
description: Starting IP included in the reserved range of IPs
end:
type: string
description: Ending IP included in the reserved range of IPs
comment:
type: string
description: Comment explaining the reserved IP range
required:
- start
- end
- comment
description: list of all reserved IP ranges for a single MG
fixedIpAssignments:
type: array
items:
type: object
properties:
name:
type: string
description: A descriptive name of the assignment
ip:
type: string
description: The IP address you want to assign to a specific server or device
mac:
type: string
description: The MAC address of the server or device that hosts the internal resource that you wish
to receive the specified IP address
required:
- ip
- mac
description: list of all fixed IP assignments for a single MG
example:
reservedIpRanges:
- start: 192.168.1.0
end: 192.168.1.1
comment: A reserved IP range
fixedIpAssignments:
- name: server 1
ip: 192.168.0.10
mac: 0b:00:00:00:00:ac
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
deviceName:
type: string
description: Name of the MG.
deviceLanIp:
type: string
description: Lan IP of the MG
deviceSubnet:
type: string
description: Subnet configuration of the MG.
fixedIpAssignments:
type: array
items:
type: object
properties:
name:
type: string
description: A descriptive name of the assignment
ip:
type: string
description: The IP address you want to assign to a specific server or device
mac:
type: string
description: The MAC address of the server or device that hosts the internal resource that you wish
to receive the specified IP address
description: list of all fixed IP assignments for a single MG
reservedIpRanges:
type: array
items:
type: object
properties:
start:
type: string
description: Starting IP included in the reserved range of IPs
end:
type: string
description: Ending IP included in the reserved range of IPs
comment:
type: string
description: Comment explaining the reserved IP range
description: list of all reserved IP ranges for a single MG
example:
deviceName: name of the MG
deviceLanIp: 192.168.0.33
deviceSubnet: 192.168.0.32/27
fixedIpAssignments:
- name: server 1
ip: 192.168.0.10
mac: 0b:00:00:00:00:ac
reservedIpRanges:
- start: 192.168.1.0
end: 192.168.1.1
comment: A reserved IP range
security:
- oauth2:
- sdwan:config:write
summary: Update the LAN Settings for a single MG.
tags:
- cellularGateway
- configure
- lan
/devices/{serial}/cellularGateway/portForwardingRules:
get:
description: Returns the port forwarding rules for a single MG.
operationId: getDeviceCellularGatewayPortForwardingRules
parameters:
- name: serial
in: path
description: Serial
schema:
type: string
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
rules:
type: array
items:
type: object
properties:
name:
type: string
description: A descriptive name for the rule
lanIp:
type: string
description: The IP address of the server or device that hosts the internal resource that you wish
to make available on the WAN
publicPort:
type: string
description: A port or port ranges that will be forwarded to the host on the LAN
localPort:
type: string
description: A port or port ranges that will receive the forwarded traffic from the WAN
allowedIps:
type: array
items:
type: string
description: An array of ranges of WAN IP addresses that are allowed to make inbound connections
on the specified ports or port ranges.
protocol:
type: string
description: TCP or UDP
access:
type: string
description: '`any` or `restricted`. Specify the right to make inbound connections on the specified
ports or port ranges. If `restricted`, a list of allowed IPs is mandatory.'
description: An array of port forwarding params
example:
rules:
- name: test
lanIp: 172.31.128.5
publicPort: 11-12
localPort: '4'
allowedIps:
- 10.10.10.10
- 10.10.10.11
protocol: tcp
access: any
security:
- oauth2:
- sdwan:config:read
summary: Returns the port forwarding rules for a single MG.
tags:
- cellularGateway
- configure
- portForwardingRules
put:
description: Updates the port forwarding rules for a single MG.
operationId: updateDeviceCellularGatewayPortForwardingRules
parameters:
- name: serial
in: path
description: Serial
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
rules:
type: array
items:
type: object
properties:
name:
type: string
description: A descriptive name for the rule
lanIp:
type: string
description: The IP address of the server or device that hosts the internal resource that you wish
to make available on the WAN
publicPort:
type: string
description: A port or port ranges that will be forwarded to the host on the LAN
localPort:
type: string
description: A port or port ranges that will receive the forwarded traffic from the WAN
allowedIps:
type: array
items:
type: string
description: An array of ranges of WAN IP addresses that are allowed to make inbound connections on
the specified ports or port ranges.
protocol:
type: string
description: TCP or UDP
access:
type: string
description: '`any` or `restricted`. Specify the right to make inbound connections on the specified
ports or port ranges. If `restricted`, a list of allowed IPs is mandatory.'
required:
- lanIp
- publicPort
- localPort
- protocol
- access
description: An array of port forwarding params
example:
rules:
- name: test
lanIp: 172.31.128.5
publicPort: 11-12
localPort: '4'
allowedIps:
- 10.10.10.10
- 10.10.10.11
protocol: tcp
access: any
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
rules:
type: array
items:
type: object
properties:
name:
type: string
description: A descriptive name for the rule
lanIp:
type: string
description: The IP address of the server or device that hosts the internal resource that you wish
to make available on the WAN
publicPort:
type: string
description: A port or port ranges that will be forwarded to the host on the LAN
localPort:
type: string
description: A port or port ranges that will receive the forwarded traffic from the WAN
allowedIps:
type: array
items:
type: string
description: An array of ranges of WAN IP addresses that are allowed to make inbound connections
on the specified ports or port ranges.
protocol:
type: string
description: TCP or UDP
access:
type: string
description: '`any` or `restricted`. Specify the right to make inbound connections on the specified
ports or port ranges. If `restricted`, a list of allowed IPs is mandatory.'
description: An array of port forwarding params
example:
rules:
- name: test
lanIp: 172.31.128.5
publicPort: 11-12
localPort: '4'
allowedIps:
- 10.10.10.10
- 10.10.10.11
protocol: tcp
access: any
security:
- oauth2:
- sdwan:config:write
summary: Updates the port forwarding rules for a single MG.
tags:
- cellularGateway
- configure
- portForwardingRules
/networks/{networkId}/cellularGateway/connectivityMonitoringDestinations:
get:
description: Return the connectivity testing destinations for an MG network
operationId: getNetworkCellularGatewayConnectivityMonitoringDestinations
parameters:
- name: networkId
in: path
description: Network ID
schema:
type: string
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
destinations:
type: array
items:
type: object
properties:
ip:
type: string
description: The IP address to test connectivity with
description:
type: string
description: Description of the testing destination. Optional, defaults to an empty string
default:
type: boolean
description: Boolean indicating whether this is the default testing destination (true) or not (false).
Defaults to false. Only one default is allowed
description: The list of connectivity monitoring destinations
example:
destinations:
- ip: 1.2.3.4
description: Google
default: false
security:
- oauth2:
- sdwan:telemetry:read
summary: Return the connectivity testing destinations for an MG network
tags:
- cellularGateway
- configure
- connectivityMonitoringDestinations
put:
description: Update the connectivity testing destinations for an MG network
operationId: updateNetworkCellularGatewayConnectivityMonitoringDestinations
parameters:
- name: networkId
in: path
description: Network ID
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
destinations:
type: array
items:
type: object
properties:
ip:
type: string
description: The IP address to test connectivity with
description:
type: string
description: Description of the testing destination. Optional, defaults to an empty string
default: ''
nullable: true
default:
type: boolean
description: Boolean indicating whether this is the default testing destination (true) or not (false).
Defaults to false. Only one default is allowed
default: false
required:
- ip
description: The list of connectivity monitoring destinations
example:
destinations:
- ip: 1.2.3.4
description: Google
default: false
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
destinations:
type: array
items:
type: object
properties:
ip:
type: string
description: The IP address to test connectivity with
description:
type: string
description: Description of the testing destination. Optional, defaults to an empty string
default:
type: boolean
description: Boolean indicating whether this is the default testing destination (true) or not (false).
Defaults to false. Only one default is allowed
description: The list of connectivity monitoring destinations
example:
destinations:
- ip: 1.2.3.4
description: Google
default: false
security:
- oauth2:
- sdwan:telemetry:write
summary: Update the connectivity testing destinations for an MG network
tags:
- cellularGateway
- configure
- connectivityMonitoringDestinations
/networks/{networkId}/cellularGateway/dhcp:
get:
description: List common DHCP settings of MGs
operationId: getNetworkCellularGatewayDhcp
parameters:
- name: networkId
in: path
description: Network ID
schema:
type: string
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
dhcpLeaseTime:
type: string
enum:
- 1 day
- 1 hour
- 1 week
- 12 hours
- 30 minutes
- 4 hours
description: DHCP Lease time for all MG in the network.
dnsNameservers:
type: string
enum:
- custom
- google_dns
- opendns
- upstream_dns
description: DNS name servers mode for all MG in the network.
dnsCustomNameservers:
type: array
items:
type: string
description: List of fixed IPs representing the the DNS Name servers when the mode is 'custom'.
example:
dhcpLeaseTime: 1 hour
dnsNameservers: custom
dnsCustomNameservers:
- 172.16.2.111
- 172.16.2.30
security:
- oauth2:
- sdwan:config:read
summary: List common DHCP settings of MGs
tags:
- cellularGateway
- configure
- dhcp
put:
description: Update common DHCP settings of MGs
operationId: updateNetworkCellularGatewayDhcp
parameters:
- name: networkId
in: path
description: Network ID
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
dhcpLeaseTime:
type: string
description: DHCP Lease time for all MG of the network. Possible values are '30 minutes', '1 hour', '4 hours',
'12 hours', '1 day' or '1 week'.
dnsNameservers:
type: string
description: 'DNS name servers mode for all MG of the network. Possible values are: ''upstream_dns'', ''google_dns'',
''opendns'', ''custom''.'
dnsCustomNameservers:
type: array
items:
type: string
description: list of fixed IPs representing the the DNS Name servers when the mode is 'custom'
example:
dhcpLeaseTime: 1 hour
dnsNameservers: custom
dnsCustomNameservers:
- 172.16.2.111
- 172.16.2.30
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
dhcpLeaseTime:
type: string
enum:
- 1 day
- 1 hour
- 1 week
- 12 hours
- 30 minutes
- 4 hours
description: DHCP Lease time for all MG in the network.
dnsNameservers:
type: string
enum:
- custom
- google_dns
- opendns
- upstream_dns
description: DNS name servers mode for all MG in the network.
dnsCustomNameservers:
type: array
items:
type: string
description: List of fixed IPs representing the the DNS Name servers when the mode is 'custom'.
example:
dhcpLeaseTime: 1 hour
dnsNameservers: custom
dnsCustomNameservers:
- 172.16.2.111
- 172.16.2.30
security:
- oauth2:
- sdwan:config:write
summary: Update common DHCP settings of MGs
tags:
- cellularGateway
- configure
- dhcp
/networks/{networkId}/cellularGateway/subnetPool:
get:
description: Return the subnet pool and mask configured for MGs in the network.
operationId: getNetworkCellularGatewaySubnetPool
parameters:
- name: networkId
in: path
description: Network ID
schema:
type: string
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
deploymentMode:
type: string
description: Deployment mode for the cellular gateways in the network. (Passthrough/Routed)
cidr:
type: string
description: CIDR of the pool of subnets. Each MG in this network will automatically pick a subnet from
this pool.
mask:
type: integer
description: Mask used for the subnet of all MGs in this network.
subnets:
type: array
items:
type: object
properties:
serial:
type: string
description: Serial Number of the MG.
name:
type: string
description: Name of the MG.
applianceIp:
type: string
description: Appliance IP of the MG device.
subnet:
type: string
description: Subnet of MG device.
description: List of subnets of all MGs in this network.
example:
deploymentMode: routed
cidr: 192.168.0.0/16
mask: 24
subnets:
- serial: AAAA-AAAA-AAAA
name: my first MG
applianceIp: 192.168.0.1
subnet: 192.168.0.0/24
security:
- oauth2:
- sdwan:config:read
summary: Return the subnet pool and mask configured for MGs in the network.
tags:
- cellularGateway
- configure
- subnetPool
put:
description: Update the subnet pool and mask configuration for MGs in the network.
operationId: updateNetworkCellularGatewaySubnetPool
parameters:
- name: networkId
in: path
description: Network ID
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
mask:
type: integer
description: Mask used for the subnet of all MGs in this network.
cidr:
type: string
description: CIDR of the pool of subnets. Each MG in this network will automatically pick a subnet from
this pool.
example:
mask: 24
cidr: 192.168.0.0/16
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
deploymentMode:
type: string
description: Deployment mode for the cellular gateways in the network. (Passthrough/Routed)
cidr:
type: string
description: CIDR of the pool of subnets. Each MG in this network will automatically pick a subnet from
this pool.
mask:
type: integer
description: Mask used for the subnet of all MGs in this network.
subnets:
type: array
items:
type: object
properties:
serial:
type: string
description: Serial Number of the MG.
name:
type: string
description: Name of the MG.
applianceIp:
type: string
description: Appliance IP of the MG device.
subnet:
type: string
description: Subnet of MG device.
description: List of subnets of all MGs in this network.
example:
deploymentMode: routed
cidr: 192.168.0.0/16
mask: 24
subnets:
- serial: AAAA-AAAA-AAAA
name: my first MG
applianceIp: 192.168.0.1
subnet: 192.168.0.0/24
security:
- oauth2:
- sdwan:config:write
summary: Update the subnet pool and mask configuration for MGs in the network.
tags:
- cellularGateway
- configure
- subnetPool
/networks/{networkId}/cellularGateway/uplink:
get:
description: Returns the uplink settings for your MG network.
operationId: getNetworkCellularGatewayUplink
parameters:
- name: networkId
in: path
description: Network ID
schema:
type: string
required:
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-meraki/refs/heads/main/openapi/cisco-meraki-cellulargateway-api-openapi.yml