Cisco Meraki
App Vendor: Cisco
App Category: Network Security
Connector Version: 1.1.0
API Version: 1.0.0
About App
The Cisco Meraki app enables security teams to integrate with Cisco Meraki enterprise application to interact directly with the Meraki cloud platform and Meraki managed devices.
The Cisco Meraki app enables security teams to retrieve details of devices, networks, organizations, branding policies, and network appliances. The Cisco Meraki app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Get Details of Device | This action retrieves the details of a device, such as geographic location, MAC and LAN IP address, URL, model, firmware version, network ID, and floor plan ID, using the device serial number from the Cisco Meraki application. |
Get Details of Network | This action retrieves the details of a network, such as URL, network name, tags, notes, time zone, product types, and organization ID, using the network ID. |
Get List of Organizations | This action retrieves a list of organizations. |
Get Details of an Organization | This action retrieves the details of an organization, such as API details, URL, and organization name, using the organization ID. |
Get a List of Organization Branding Policies | This action retrieves the list of branding policies of an organization using the organization ID. |
Get Details of Organization Branding Policy | This action retrieves the details of the branding policy of an organization, such as policy name, status, help settings, and admin settings, using the organization ID and branding policy ID. |
Get a List of Organization Devices | This action retrieves a list of devices in an organization using the organization ID. |
Get List of organization networks | This action retrieves a list of networks in an organization using the organization ID. |
Get a List of Statuses of Organization Devices | This action retrieves a list of statuses of the devices in an organization using organization id and/or additional query parameters. |
Get Network Appliance Content Filtering Categories | This action retrieves a list of network appliance content filtering categories using network id. |
Get Network Appliance Content Filtering | This action retrieves network appliance content filtering using network id. |
Update Network Appliance Content Filtering | This action updates network appliance content filtering using network id and content filtering. |
Get Network Appliance Security Events | This action retrieves network appliance security events using network id and query parameters. |
Claim Network Devices | This action claims network devices. |
Get Cellular Firewall Rules | This action returns cellular firewall rules for an MX network. |
Get Device Management Interface | This action returns management interface settings for a device. |
Get Firewalled Services | This action lists the appliance services and their accessibility rules. |
Get Firmware Status | This action retrieves firmware upgrade information for a network. |
Get Inbound Firewall Rules | This action returns inbound firewall rules for an MX network. |
Get L3 Firewall Rules | This action returns L3 firewall rules for an MX network. |
Get L7 Firewall Rules | This action retrieves L7 firewall rules for an MX network. |
Get Network Appliance Security Intrusion | This action returns the supported intrusion settings for an MX network. |
Get Network Appliance Security Malware | This action returns the supported malware settings for an MX network. |
Get Network Auth Users | This actions lists the users configured under meraki authentication for a network. |
Get Network Health Status | This action returns network health alerts and connectivity issues with the appliances present in the environment. |
Get One to Many NAT Rules | This action returns one-to-many NAT mapping rules for an MX network. |
Get One to One NAT Rules | This action returns one-to-one NAT mapping rules for an MX network. |
Get Port Forwarding Rules | This action returns port forwarding rules for an MX network. |
Push Network Firmware Upgrades | This action pushes firmware upgrade information for a network. |
Update Device Management Interface | This action updates management interface settings for a device. |
Update Network Group Policy | This action updates a network group policy. |
Update Network Meraki Auth User | This action updates a user configured with meraki authentication. |
Configuration Parameters
The following configuration parameters are required for the Cisco Meraki app to communicate with the Cisco Meraki enterprise application. The parameters can be configured by creating instances in the Cisco Meraki app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
API Key | Enter the Cisco Meraki API key. Example: "aT1xxxx5rzs" | Text | Required |
Action: Get Details of Device
This action retrieves the details of a device, such as geographic location, MAC and LAN IP address, URL, model, firmware version, network ID, and floor plan ID, using the device serial number from the Cisco Meraki application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device Serial | Enter the device serial number to retrieve the details. Example: "Q2BV-CTWR-JKRD" | Text | Required | You can retrieve the Device Serial using the Get a List of Organization Devices action. |
Example Request
[
{
"device_serial": "Q2BV-CTWR-JKRD"
}
]Action: Get Details of Network
This action retrieves the details of a network, such as URL, network name, tags, notes, time zone, product types, and organization ID, using the network ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID to get the details of the network. Example: "L_573083052582908089" | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "L_573083052582908089"
}
]Action: Get List of Organizations
This action retrieves a list of all the organizations in the Cisco Meraki application.
Action Input Parameters
This action does not require any input parameter.
Action: Get Details of an Organization
This action retrieves the details of an organization, such as API details, URL, and organization name, using the organization ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID to retrieve the details. Example: "463308" | Text | Required | You can retrieve the Organization ID using the Get List of Organizations action. |
Example Request
[
{
"org_id": "463308"
}
]Action: Get a List of Organization Branding Policies
This action retrieves the list of branding policies of an organization using the organization ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID to retrieve the list of branding policies of the organization. Example: "463308" | Text | Required | You can retrieve the Organization ID using the Get List of Organizations action. |
Example Request
[
{
"org_id": "463308"
}
]Action: Get Details of Organization Branding Policy
This action retrieves the details of the branding policy of an organization, such as policy name, status, help settings, and admin settings, using the organization ID and branding policy ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID. Example: "463308" | Text | Required | You can retrieve the Organization ID using the Get List of Organizations action. |
Branding Policy ID | Enter the branding policy ID. Example: "573083052582895882" | Text | Required | You can retrieve the Organization ID using the Get List of Organization Branding Policies action. |
Example Request
[
{
"org_id": "463308",
"policy_id": "573083052582895882"
}
]Action: Get a List of Organization Devices
This action retrieves a list of devices in an organization using the organization ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID. Example: "463308" | Text | Required | You can retrieve the Organization ID using the Get List of Organizations action. |
Additional Query Parameters | Enter the additional query parameters in the form of key value pairs. Example: {"perpage": 10} | Key Value | Optional | Allowed values:
|
Example Request
[
{
"org_id": "463308",
"extra_params": {
"perpage": 10
}
}
]Action: Get List of Organization Networks
This action retrieves a list of networks in an organization using the organization ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID. Example: "463308" | Text | Required | You can retrieve the Organization ID using the Get List of Organizations action. |
Additional Query Parameters | Enter the additional query parameters in the form of key value pairs. Example: {"perpage": 10} | Key Value | Optional | Allowed values:
|
Example Request
[
{
"org_id": "463308",
"extra_params": {
"perpage": 10
}
}
]Action: Get a List of Statuses of Organization Devices
This action retrieves a list of statuses of the devices in an organization using organization id and/or additional query parameters.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID. Example: "463308" | Text | Required | You can retrieve the Organization ID using the Get List of Organizations action. |
Additional Query Parameters | Enter the additional query parameters in the form of key value pairs. Example: {"perpage": 10} | Key Value | Optional | Allowed values:
|
Example Request
[
{
"org_id": "463308",
"extra_params": {
"perpage": 10
}
}
]Action: Get Network Appliance Content Filtering Categories
This action retrieves a list of network appliance content filtering categories using network id.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: "L_573083052582908089" | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "L_573083052582908089"
}
]Action: Get Network Appliance Content Filtering
This action retrieves the network appliance content filtering using network id.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: "L_573083052582908089" | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "L_573083052582908089"
}
]Action: Update Network Appliance Content Filtering
This action updates network appliance content filtering using network id and content filtering.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: "L_573083052582908089" | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Allowed URL Patterns | Enter the allowed URL patterns. Example: [ "*.com", "*.in" ] | List | Optional | |
Blocked URL Patterns | Enter the blocked URL patterns. Example: [ "*.pl", "*.ml" ] | List | Optional | |
Blocked URL Categories | Enter the blocked URL categories. Example: [ "meraki:contentFiltering/category/1", "meraki:contentFiltering/category/7" ] | List | Optional | |
URL Category List Size | Enter the URL category list size. Example: "topSites" | Text | Optional | Allowed values:
Default value: "topsites" |
Example Request
[
{
"network_id": "L_573083052582908089",
"allowed_url_patterns": [
"*.com",
"*.in"
],
"blocked_url_patterns": [
"*.pl",
"*.ml"
],
"blocked_url_categories": [
"meraki:contentFiltering/category/1",
"meraki:contentFiltering/category/7"
],
"url_category_list_size": "topSites"
}
]Action: Get Network Appliance Security Events
This action retrieves network appliance security events using network id and query parameters.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: "L_573083052582908089" | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Additional Query Parameters | Enter the additional query parameters in the form of key value pairs. Example: { "perpage": 10 } | Key Value | Optional | Allowed values:
|
Example Request
[
{
"network_id": "L_573083052582908089",
"extra_params": {
"perpage": 10
}
}
]Action: Claim Network Devices
This action claims network devices. If your device is recently claimed, then it can take additional minutes for the API request to succeed.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Device ID | Enter the device ID. Example: "62BV-CTWR-JKRD" | Text | Required |
|
Example Request
[
{
"network_id": "L_573083052582908089",
“device_id”: "62BV-CTWR-JKRD"
}
]Action: Get Cellular Firewall Rules
This action returns cellular firewall rules for an MX network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get Device Management Interface
This action returns management interface settings for a device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device Serial | Enter the device serial. Example: “q23-wfsd-sddc” | Text | Required | You can retrieve the Device Serial using the Get a List of Organization Devices action. |
Example Request
[
{
"device_serial": “q23-wfsd-sddc”
}
]Action: Get Firewalled Services
This action lists the appliance services and their accessibility rules.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get Firmware Status
This action retrieves firmware upgrade information for a network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get Inbound Firewall Rules
This action returns inbound firewall rules for an MX network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get L3 Firewall Rules
This action returns L3 firewall rules for an MX network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get L7 Firewall Rules
This action retrieves L7 firewall rules for an MX network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get Network Appliance Security Intrusion
This action returns the supported intrusion settings for an MX network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get Network Appliance Security Malware
This action returns the supported malware settings for an MX network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get Network Auth Users
This actions lists the users configured under meraki authentication for a network.
Example: Splash guest or radius users for a wireless network and client VPN users for a wired network)
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get Network Health Status
This action returns network health alerts and connectivity issues with the appliances present in the environment.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get One to Many NAT Rules
This action returns one-to-many NAT mapping rules for an MX network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get One to One NAT Rules
This action returns one-to-one NAT mapping rules for an MX network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Get Port Forwarding Rules
This action returns port forwarding rules for an MX network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Example Request
[
{
"network_id": "l_12sarf32121234"
}
]Action: Push Network Firmware Upgrades
This action pushes firmware upgrade information for a network.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Product and Version | Enter the product and its version. Example: “switch:75682” | Text | Required |
Example Request
[
{
"network_id": "L_573083052582908089",
“product_w_versions”: “switch:75682”
}
]Action: Update Device Management Interface
This action updates management interface settings for a device.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Device Serial | Enter the device serial. Example: “q23-wfsd-sddc” | Text | Required | You can retrieve the Device Serial using Get a List of Organization Devices action. |
WAN Configuration | Enter the dictionary of values to be sent in the form of payload. Example: {'wanenabled': 'enabled', 'usingstaticip': false, 'vlan': 2} | Key Value | Required | Allowed keys for WAN 2 settings:
|
Example Request
[
{
"device_serial": “q23-wfsd-sddc”,
“extra_params”: {'wanenabled': 'enabled', 'usingstaticip': false, 'vlan': 2}
}
]Action: Update Network Group Policy
This action updates a network group policy.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using Get a List of Organization Networks action. |
Group Policy ID | Enter the group policy ID. Example: “65345876” | Text | Required |
Example Request
[
{
"network_id": "L_573083052582908089",
“group_policy_id”: “65345876”
}
]Action: Update Network Meraki Auth User
This action updates a user configured with meraki authentication. Only 802.1x radius, splash guest, and client VPN users can be updated using this action.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Network ID | Enter the network ID. Example: “l_12sarf32121234” | Text | Required | You can retrieve the Network ID using the Get a List of Organization Networks action. |
Meraki Auth User ID | Enter the Meraki auth user ID. Example: “sampleuser@organization.com” | Text | Required |
Example Request
[
{
"network_id": "L_573083052582908089",
“meraki_auth_user_id”: “sampleuser@organization.com”
}
]