Cisco Meraki Service Graph Connector API Endpoints
Summarize
Summary of Cisco Meraki Service Graph Connector API Endpoints
The Cisco Meraki Service Graph Connector integrates data from the Cisco Meraki Dashboard API into the ServiceNow AI Platform® Configuration Management Database (CMDB). This integration leverages multiple API endpoints to collect detailed organizational, network, device, and status information, enabling ServiceNow customers to maintain an accurate and up-to-date CMDB with Meraki infrastructure details.
Show less
Key API Endpoints and Their Functions
- Organizations Endpoint: Retrieves organization details such as organization ID, name, MSP ID, customer number, and API IP restriction mode. This forms the foundational organizational context.
- Licenses Overview Endpoint: Used specifically for organizations with a CO-TERM licensing model to obtain license expiration dates at the organization level, since this data is not available per device.
- Networks Endpoint: Provides information about networks within an organization, including network ID, name, and descriptive notes, facilitating network-level visibility.
- Traffic Shaping Endpoints: Include uplink selection and uplink bandwidth APIs used to disable certain network-level calls to optimize API rate limits, especially for large customers.
- Devices Endpoint: Returns comprehensive device details such as serial number, name, network association, model, MAC address, firmware version, geolocation, address, and descriptive notes, supporting detailed device inventory management.
- Device Statuses Endpoint: Provides current device operational status and networking IP details, including public IP, WAN IPs, gateways, and DNS settings, contributing to real-time device health monitoring.
- Uplink Statuses Endpoint: Delivers detailed uplink interface status and configuration per device, including high availability settings, IP addresses, DNS, and cellular interface specifics.
- Switch Ports Endpoint: Reports on switch port statuses by switch serial number and network ID, indicating which ports are connected or disconnected to aid in network topology and troubleshooting.
- Device Inventory Endpoint: Supplies additional inventory details such as order number and license expiration date per device, which is critical for asset lifecycle and compliance management.
Benefits for ServiceNow Customers
- Comprehensive CMDB Enrichment: Enables automated, detailed ingestion of Meraki organizational, network, device, and status data into ServiceNow CMDB, improving accuracy and operational insight.
- Efficient Data Retrieval: Supports intelligent API call management to reduce load and adhere to Meraki API rate limits, beneficial for large-scale deployments.
- Improved Asset and License Management: Provides visibility into device licensing and inventory details, aiding compliance and renewal planning.
- Enhanced Network and Device Monitoring: Real-time status and uplink information support proactive incident management and network troubleshooting within ServiceNow workflows.
The Service Graph Connector for Meraki integrates Cisco Meraki Dashboard API data into ServiceNow AI Platform®Configuration Management Database (CMDB). This document details the API endpoints used and how data flows through the system.
| Description | API response |
|---|---|
| Organizations API response
|
|
| Description | API response |
|---|---|
| Licenses overview API response
Called for organizations with a CO-TERM licensing model ( |
| Description | Endpoint |
|---|---|
| Networks API response
|
|
| Description | Endpoint |
|---|---|
| Uplink selection endpoint
|
|
| Uplink bandwidth endpoint
|
| Description | Endpoint |
|---|---|
| Devices API response
|
|
| Description | Endpoint |
|---|---|
| Devices statuses API response
|
|
| Description | Endpoint |
|---|---|
| Uplink statuses endpoint
|
|
| Description | Endpoint |
|---|---|
| Switch ports endpoint
|
|
| Description | Endpoint |
|---|---|
| Device inventory endpoint
|
|