- What's Changed
- What's Updated
- What's New
- [ organizations ]
- [ appliance ]
- [ campusGateway ]
- [ spaces ]
- [ wireless ]
- devices
- Query for details on the organization's RADSEC device Certificate Authority certificates (CAs). The primary CA signs all the certificates that devices present when establishing a secure connection to RADIUS servers via RADSEC protocol. This API returns an array of the status of all of the CAs as well as their contents, if they've been generated. An organization will have at most one CA unless the CA is being rotated.
- Create an organization's RADSEC device Certificate Authority (CA). Call this endpoint when turning on RADSEC in the firmware for the first time. Calling this endpoint starts an asynchronous process to generate the CA; call GET afterwards to retrieve the contents of the CA. Note this CA is generated and controlled by Meraki. Subsequent calls will not generate a new CA.
- Update an organization's RADSEC device Certificate Authority (CA) state. Note this CA is generated and controlled by Meraki. Call this endpoint to update the state to "trusted", at which point Meraki will generate device certificates. "trusted" means the CA is placed on your RADSEC server(s) and devices establishing a secure connection using certs signed by this CA will pass verification.
- Query for certificate revocation list (CRL) for the organization's RADSEC device Certificate Authorities (CAs).
- Query for all delta certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id.
- devices
Version 1.58.0 to 1.59.0
Summary of Changes
10 - New
79 - Updated
839 - Total Endpoints
569 - Total Paths
What's Changed
[ organizations ]
brandingPolicies
Add a new branding policy to an organization
POST /organizations/{organizationId}/brandingPolicies
- Property
name
became required
- Param
createOrganizationBrandingPolicy
became required
Update a branding policy
PUT /organizations/{organizationId}/brandingPolicies/{brandingPolicyId}
- Property
name
became required
- Param
updateOrganizationBrandingPolicy
became required
What's Updated
[ organizations ]
alerts
Return all health alerts for an organization
GET /organizations/{organizationId}/assurance/alerts
- Optional property
others
Added
Return a singular Health Alert by its id
GET /organizations/{organizationId}/assurance/alerts/{id}
- Optional property
others
Added
devices
Bulk update priorities of pcap schedules
POST /organizations/{organizationId}/devices/packetCapture/schedules/reorder
- Property
pcapScheduleConfigurationId
Deleted
- Optional property
scheduleId
Added
List Packet Captures
GET /organizations/{organizationId}/devices/packetCapture/captures
- Response property
enum
value added
- Response property
enum
value added
List the Packet Capture Schedules
GET /organizations/{organizationId}/devices/packetCapture/schedules
- Response property
enum
value added
[ devices ]
lldpCdp
List LLDP and CDP information for a device
GET /devices/{serial}/lldpCdp
- Optional property
systemDescription
Added
- Optional property
chassisId
Added
- Optional property
managementVlan
Added
- Optional property
portVlan
Added
- Optional property
portDescription
Added
- Optional property
systemCapabilities
Added
- Optional property
platform
Added
- Optional property
nativeVlan
Added
- Optional property
vtpManagementDomain
Added
- Optional property
capabilities
Added
- Response property
systemDescription
value added
- Response property
chassisId
value added
- Response property
managementVlan
value added
- Response property
portVlan
value added
- Response property
portDescription
value added
- Response property
systemCapabilities
value added
- Response property
platform
value added
- Response property
nativeVlan
value added
- Response property
vtpManagementDomain
value added
- Response property
capabilities
value added
[ switch ]
accessPolicies
Create an access policy for a switch network
POST /networks/{networkId}/switch/accessPolicies
- Optional property
dataGroupPolicyId
Added
- Optional property
voiceGroupPolicyId
Added
- Optional property
dataSgtId
Added
- Optional property
voiceSgtId
Added
- Optional property
failedAuthGroupPolicyId
Added
- Optional property
failedAuthSgtId
Added
- Optional property
authentication
Added
- Optional property
preAuthenticationGroupPolicyId
Added
- Optional property
guestGroupPolicyId
Added
- Optional property
guestSgtId
Added
- Optional property
authentication
Added
Update an access policy for a switch network
PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
- Optional property
dataGroupPolicyId
Added
- Optional property
voiceGroupPolicyId
Added
- Optional property
dataSgtId
Added
- Optional property
voiceSgtId
Added
- Optional property
failedAuthGroupPolicyId
Added
- Optional property
failedAuthSgtId
Added
- Optional property
authentication
Added
- Optional property
preAuthenticationGroupPolicyId
Added
- Optional property
guestGroupPolicyId
Added
- Optional property
guestSgtId
Added
- Optional property
authentication
Added
List the access policies for a switch network
GET /networks/{networkId}/switch/accessPolicies
- Optional property
authentication
Added
Return a specific access policy for a switch network
GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
- Optional property
authentication
Added
[ appliance ]
vpn
Update the third party VPN peers for an organization
PUT /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers
- Optional property
peerId
Added
- Optional property
slaPolicy
Added
- Optional property
network
Added
- Optional property
isRouteBased
Added
- Optional property
ebgpNeighbor
Added
- Optional property
priorityInGroup
Added
- Optional property
group
Added
- Optional property
peerId
Added
- Optional property
slaPolicy
Added
- Optional property
network
Added
- Optional property
isRouteBased
Added
- Optional property
ebgpNeighbor
Added
- Optional property
priorityInGroup
Added
- Optional property
group
Added
Return the third party VPN peers for an organization
GET /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers
- Optional property
peerId
Added
- Optional property
slaPolicy
Added
- Optional property
network
Added
- Optional property
isRouteBased
Added
- Optional property
ebgpNeighbor
Added
- Optional property
priorityInGroup
Added
- Optional property
group
Added
- Response property
peerId
value added
- Response property
slaPolicy
value added
- Response property
network
value added
- Response property
isRouteBased
value added
- Response property
ebgpNeighbor
value added
- Response property
priorityInGroup
value added
- Response property
group
value added
What's New
[ organizations ]
alerts
PATH /organizations/{organizationId}/assurance/alerts/taxonomy/categories
- Path added
- New endpoint
Return a list of Category Types
GET
/organizations/{organizationId}/assurance/alerts/taxonomy/categories
[ { "type": "connectivity", "title": "Connectivity" } ]
PATH /organizations/{organizationId}/assurance/alerts/taxonomy/types
- Path added
- New endpoint
Return a list of alert types
GET
/organizations/{organizationId}/assurance/alerts/taxonomy/types
[ { "type": "unreachable", "title": "Unreachable device", "categoryType": "connectivity", "severities": [ { "type": "critical" } ], "deviceTypes": [ "Campus Gateway", "Catalyst AP", "Catalyst Controller", "Catalyst Switch", "MG", "MR", "MS", "MT", "MV", "MX", "VMX", "Z" ] } ]
[ appliance ]
vpn
PATH /organizations/{organizationId}/appliance/vpn/siteToSite/ipsec/peers/slas
- Path added
- New endpoint
Get the list of available IPsec SLA policies for an organization
GET
/organizations/{organizationId}/appliance/vpn/siteToSite/ipsec/peers/slas
{ "items": [ { "id": "12345", "name": "sla policy", "uri": "http://checkthisendpoint.com", "ipsec": { "peerIds": [ "1010", "1011" ] } } ], "meta": { "counts": { "items": { "total": 1, "remaining": 0 } } } }
- New endpoint
Update the IPsec SLA policies for an organization
PUT
/organizations/{organizationId}/appliance/vpn/siteToSite/ipsec/peers/slas
{ "items": [ { "id": "12345", "name": "sla policy", "uri": "http://checkthisendpoint.com", "ipsec": { "peerIds": [ "1010", "1011" ] } } ], "meta": { "counts": { "items": { "total": 1, "remaining": 0 } } } }
[ campusGateway ]
devices
PATH /organizations/{organizationId}/campusGateway/devices/uplinks/localOverrides/byDevice
- Path added
- New endpoint
Uplink overrides configured locally on Campus Gateway devices in an organization.
GET
/organizations/{organizationId}/campusGateway/devices/uplinks/localOverrides/byDevice
{ "items": [ { "serial": "Q234-ABCD-0001", "uplink": { "interface": "man1", "vlan": 5, "addresses": [ { "assignmentMode": "static", "protocol": "ipv4", "gateway": "1.2.3.5", "subnetMask": "255.255.255.0", "address": "121.12.12.1" } ] }, "nameservers": { "addresses": [ "8.8.8.8", "8.8.4.4" ] }, "sgt": 300 } ], "meta": { "counts": { "items": { "total": 10, "remaining": 0 } } } }
clusters
PATH /networks/{networkId}/campusGateway/clusters
- Path added
- New endpoint
Create a cluster and add campus gateways to it
POST
/networks/{networkId}/campusGateway/clusters
{ "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" }
PATH /networks/{networkId}/campusGateway/clusters/{clusterId}
- Path added
- New endpoint
Update a cluster and add/remove campus gateways to/from it
PUT
/networks/{networkId}/campusGateway/clusters/{clusterId}
{ "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" }
[ spaces ]
integration
PATH /organizations/{organizationId}/spaces/integration/remove
- Path added
- New endpoint
Remove the Spaces integration from Meraki
POST
/organizations/{organizationId}/spaces/integration/remove
{ "status": true, "message": "Succesfully fetched the spaces dashboard access" }
[ wireless ]
devices
PATH /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
- Path added
- New endpoint
Query for details on the organization's RADSEC device Certificate Authority certificates (CAs). The primary CA signs all the certificates that devices present when establishing a secure connection to RADIUS servers via RADSEC protocol. This API returns an array of the status of all of the CAs as well as their contents, if they've been generated. An organization will have at most one CA unless the CA is being rotated.
GET
/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
[ { "items": [ { "certificateAuthorityId": "1234", "status": "trusted", "contents": "-----BEGIN CERTIFICATE-----\nMIIDzDCCAragAwIBAgIUOd0ukLcjH43TfTHFG9qE0FtlMVgwCwYJKoZIhvcNAQEL\n...\numkqeYeO30g1uYvDuWLXVA==\n-----END CERTIFICATE-----\n" } ], "meta": { "counts": { "items": { "total": 2, "remaining": 0 } } } } ]
- New endpoint
Create an organization's RADSEC device Certificate Authority (CA). Call this endpoint when turning on RADSEC in the firmware for the first time. Calling this endpoint starts an asynchronous process to generate the CA; call GET afterwards to retrieve the contents of the CA. Note this CA is generated and controlled by Meraki. Subsequent calls will not generate a new CA.
POST
/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
{ "certificateAuthorityId": "1234", "status": "trusted", "contents": "-----BEGIN CERTIFICATE-----\nMIIDzDCCAragAwIBAgIUOd0ukLcjH43TfTHFG9qE0FtlMVgwCwYJKoZIhvcNAQEL\n...\numkqeYeO30g1uYvDuWLXVA==\n-----END CERTIFICATE-----\n" }
- New endpoint
Update an organization's RADSEC device Certificate Authority (CA) state. Note this CA is generated and controlled by Meraki. Call this endpoint to update the state to "trusted", at which point Meraki will generate device certificates. "trusted" means the CA is placed on your RADSEC server(s) and devices establishing a secure connection using certs signed by this CA will pass verification.
PUT
/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities
{ "certificateAuthorityId": "1234", "status": "trusted", "contents": "-----BEGIN CERTIFICATE-----\nMIIDzDCCAragAwIBAgIUOd0ukLcjH43TfTHFG9qE0FtlMVgwCwYJKoZIhvcNAQEL\n...\numkqeYeO30g1uYvDuWLXVA==\n-----END CERTIFICATE-----\n" }
PATH /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls
- Path added
- New endpoint
Query for certificate revocation list (CRL) for the organization's RADSEC device Certificate Authorities (CAs).
GET
/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls
{ "items": [ { "certificateAuthorityId": "1234", "crl": "-----BEGIN X509 CRL-----\nMIICVjCCAj8CAQEwQQD\n...\n-----END X509 CRL-----\n" } ], "meta": { "counts": { "items": { "total": 2, "remaining": 0 } } } }
PATH /organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls/deltas
- Path added
- New endpoint
Query for all delta certificate revocation list (CRL) for the organization's RADSEC device Certificate Authority (CA) with the given id.
GET
/organizations/{organizationId}/wireless/devices/radsec/certificates/authorities/crls/deltas
{ "items": [ { "certificateAuthorityId": "1234", "crl": "-----BEGIN X509 CRL-----\nMIICVjCCAj8CAQEwQQD\n...\n-----END X509 CRL-----\n" } ], "meta": { "counts": { "items": { "total": 2, "remaining": 0 } } } }