- Release Notes
- API Changelog
- Overview
- Generally Available
- v1.57.0
- v1.56.0
- v1.55.0
- v1.54.0
- v1.53.0
- v1.52.0
- v1.51.1
- v1.50.0
- v1.49.0
- v1.48.0
- v1.47.0
- v1.46.0
- v1.45.0
- v1.44.0
- v1.43.0
- v1.42.0
- v1.41.0
- v1.40.0
- v1.39.0
- v1.38.0
- v1.37.0
- v1.36.0
- v1.35.0
- v1.34.0
- v1.33.0
- v1.32.0
- v1.31.0
- v1.30.0
- v1.29.0
- v1.28.0
- v1.27.0
- v1.26.0
- v1.25.0
- v1.24.0
- v1.23.0
- v1.22.0
- v1.21.0
- v1.20.0
- v1.19.0
- v1.18.0
- v1.17.0
- v1.16.0
- v1.15.0
- v1.14.0
- v1.13.0
- v1.12.0
- v1.11.0
- v1.10.0
- v1.8.0
- v1.7.0
- v1.6.0
- v1.5.0
- v1.4.0
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.0
- v0.11.0
- v0.10.0
- v0.9.0
- v0.8.0
- v0.7.0
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.0
- v0.2.0
- Beta
- What's Updated
- What's New
- [ cellularGateway ]
- esims
- The eSIM inventory of a given organization.
- Toggle the status of an eSIM
- Service providers customers can add accounts for.
- Inventory of service provider accounts tied to the organization.
- Add a service provider account.
- The communication plans available for a given provider.
- The rate plans available for a given provider.
- Edit service provider account info stored in Meraki's database.
- Remove a service provider account's integration with the Dashboard.
- Swap which profile an eSIM uses.
- Get the status of a profile swap.
- esims
- [ cellularGateway ]
Version 1.49.0 to 1.50.0
Summary of Changes
9 - New
37 - Updated
743 - Total operations
490 - Total Paths
What's Updated
[ licensing ]
subscription
List available subscriptions
GET /administered/licensing/subscription/subscriptions
- Optional property
webOrderLineId
Added
- Optional property
smartAccountStatus
Added
- Optional property
smartAccount
Added
- Response property
webOrderLineId
value added
- Response property
smartAccountStatus
value added
- Response property
smartAccount
value added
Claim a subscription into an organization.
POST /administered/licensing/subscription/subscriptions/claim
- Optional property
webOrderLineId
Added
- Optional property
smartAccountStatus
Added
- Optional property
smartAccount
Added
Find a subscription by claim key
POST /administered/licensing/subscription/subscriptions/claimKey/validate
- Optional property
webOrderLineId
Added
- Optional property
smartAccountStatus
Added
- Optional property
smartAccount
Added
[ devices ]
lldpCdp
List LLDP and CDP information for a device
GET /devices/{serial}/lldpCdp
- Optional property
name
Added
- Optional property
model
Added
- Optional property
version
Added
- Optional property
device
Added
- Response property
name
value added
- Response property
model
value added
- Response property
version
value added
- Response property
device
value added
[ networks ]
events
List the events for the network
GET /networks/{networkId}/events
- Optional param
isCatalyst
added
service
Return a network
GET /networks/{networkId}
- Optional property
isVirtual
Added
- Response property
isVirtual
value added
Split a combined network into individual networks for each type of device
POST /networks/{networkId}/split
- Optional property
isVirtual
Added
Unbind a network from a template.
POST /networks/{networkId}/unbind
- Optional property
isVirtual
Added
Update a network
PUT /networks/{networkId}
- Optional property
isVirtual
Added
[ camera ]
qualityRetentionProfiles
List the quality retention profiles for this network
GET /networks/{networkId}/camera/qualityRetentionProfiles
- Response property
smartRetention
value added
Retrieve a single quality retention profile
GET /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
- Response property
smartRetention
value added
Creates new quality retention profile for this network.
POST /networks/{networkId}/camera/qualityRetentionProfiles
- Optional property
smartRetention
Added
Update an existing quality retention profile for this network.
PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}
- Optional property
smartRetention
Added
[ switch ]
stacks
Update a layer 3 static route for a switch stack
PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}
- Optional property
managementNextHop
Added
[ organizations ]
inventory
Returns list of networks eligible for adding cloud monitored device
GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks
- Optional property
isVirtual
Added
- Response property
isVirtual
value added
networks
List the networks that the user has privileges on in an organization
GET /organizations/{organizationId}/networks
- Optional property
isVirtual
Added
- Response property
isVirtual
value added
Create a network
POST /organizations/{organizationId}/networks
- Optional property
isVirtual
Added
Combine multiple networks into a single network
POST /organizations/{organizationId}/networks/combine
- Optional property
isVirtual
Added
What's New
[ cellularGateway ]
esims
PATH /organizations/{organizationId}/cellularGateway/esims/inventory
- Path added
- New operation
The eSIM inventory of a given organization.
GET
/organizations/{organizationId}/cellularGateway/esims/inventory
Code SnippetCopy[ { "items": [ { "device": { "name": "My cellular gateway", "model": "mg52", "serial": "Q234-ABCD-5678", "url": "https://n1.meraki.com//n//manage/nodes/new_list/000000000000" }, "active": true, "eid": "89000000000000000000000000000000", "lastUpdatedAt": "2023-02-01T00:00:00Z", "network": { "id": "N_24329156" }, "profiles": [ { "customApns": [ "internet" ], "iccid": "8900000000000000000", "status": "activated", "serviceProvider": { "name": "ATT", "plans": [ { "name": "1 Cisco IoT SDO AT&T eSIM Test Plan downloadable", "type": "communication" } ] } } ] } ], "meta": { "counts": { "items": { "total": 1, "remaining": 0 } } } } ]
PATH /organizations/{organizationId}/cellularGateway/esims/inventory/{id}
- Path added
- New operation
Toggle the status of an eSIM
PUT
/organizations/{organizationId}/cellularGateway/esims/inventory/{id}
Code SnippetCopy{ "device": { "name": "My cellular gateway", "model": "mg52", "serial": "Q234-ABCD-5678", "url": "https://n1.meraki.com//n//manage/nodes/new_list/000000000000" }, "active": true, "eid": "89000000000000000000000000000000", "lastUpdatedAt": "2023-02-01T00:00:00Z", "network": { "id": "N_24329156" }, "profiles": [ { "customApns": [ "internet" ], "iccid": "8900000000000000000", "status": "activated", "serviceProvider": { "name": "ATT", "plans": [ { "name": "1 Cisco IoT SDO AT&T eSIM Test Plan downloadable", "type": "communication" } ] } } ] }
PATH /organizations/{organizationId}/cellularGateway/esims/serviceProviders
- Path added
- New operation
Service providers customers can add accounts for.
GET
/organizations/{organizationId}/cellularGateway/esims/serviceProviders
Code SnippetCopy{ "items": [ { "name": "AT&T", "logo": { "url": "Logo URL" }, "isBootstrap": false, "terms": { "content": "Legal jargon", "name": "AT&T Terms and Conditions" } } ], "meta": { "counts": { "items": { "total": 42, "remaining": 0 } } } }
PATH /organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts
- Path added
- New operation
Inventory of service provider accounts tied to the organization.
GET
/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts
Code SnippetCopy[ { "items": [ { "accountId": "0987654321", "lastUpdatedAt": "2023-08-21T00:00:00Z", "serviceProvider": { "name": "ATT", "logo": { "url": "serviceproviderlogo.url" } }, "title": "My AT&T account", "username": "MerakiUser" } ], "meta": { "counts": { "items": { "total": 1, "remaining": 0 } } } } ]
- New operation
Add a service provider account.
POST
/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts
Code SnippetCopy{ "accountId": "0987654321", "lastUpdatedAt": "2023-08-21T00:00:00Z", "serviceProvider": { "name": "ATT", "logo": { "url": "serviceproviderlogo.url" } }, "title": "My AT&T account", "username": "MerakiUser" }
PATH /organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/communicationPlans
- Path added
- New operation
The communication plans available for a given provider.
GET
/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/communicationPlans
Code SnippetCopy{ "items": [ { "accountId": "some account ID", "apns": [ { "name": "Some APN" } ], "name": "A communication plan" } ], "meta": { "counts": { "items": { "total": 2, "remaining": 0 } } } }
PATH /organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/ratePlans
- Path added
- New operation
The rate plans available for a given provider.
GET
/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/ratePlans
Code SnippetCopy{ "items": [ { "accountId": "account ID", "name": "A rate plan" } ], "meta": { "counts": { "items": { "total": 2, "remaining": 0 } } } }
PATH /organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/{accountId}
- Path added
- New operation
Edit service provider account info stored in Meraki's database.
PUT
/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/{accountId}
Code SnippetCopy{ "accountId": "0987654321", "lastUpdatedAt": "2023-08-21T00:00:00Z", "serviceProvider": { "name": "ATT", "logo": { "url": "serviceproviderlogo.url" } }, "title": "My AT&T account", "username": "MerakiUser" }
- New operation
Remove a service provider account's integration with the Dashboard.
DELETE
/organizations/{organizationId}/cellularGateway/esims/serviceProviders/accounts/{accountId}
PATH /organizations/{organizationId}/cellularGateway/esims/swap
- Path added
- New operation
Swap which profile an eSIM uses.
POST
/organizations/{organizationId}/cellularGateway/esims/swap
Code SnippetCopy{ "eid": "1234567890", "iccid": "9876543210", "status": "Completed" }
PATH /organizations/{organizationId}/cellularGateway/esims/swap/{id}
- Path added
- New operation
Get the status of a profile swap.
PUT
/organizations/{organizationId}/cellularGateway/esims/swap/{id}
Code SnippetCopy{ "eid": "1234567890", "iccid": "9876543210", "status": "Completed" }