Cisco Nexus Dashboard website screenshot

Cisco Nexus Dashboard

APIs for managing and monitoring Cisco Nexus data center switches and network infrastructure.

Cisco Nexus Dashboard publishes 5 APIs on the APIs.io network, including Authentication API, Interfaces API, Routing API, and 2 more. Tagged areas include Data Center, Infrastructure, Network Automation, Networking, and SDN.

The Cisco Nexus Dashboard catalog on APIs.io includes 2 JSON-LD contexts and 2 Spectral governance rulesets.

Cisco Nexus Dashboard’s developer surface includes authentication, engineering blog, training material, sandbox, support, code examples, and 5 more developer resources.

🌐 Visit website 📡 Source on GitHub
49.6/100 developing ▬ flat Agent 34/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessSelf serve
16 APIs 8 Features 5 Use Cases
Data CenterInfrastructureNetwork AutomationNetworkingSDNSwitches

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 49.6/100 · developing
Contract Quality 16.2 / 25
Developer Ergonomics 6.5 / 20
Commercial Clarity 5.8 / 20
Operational Transparency 6.8 / 13
Governance 7.0 / 12
Discoverability 7.2 / 10
Agent readiness — 34/100 · agent aware
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/cisco-nexus: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 16

Individual APIs this provider publishes, each with its own machine-readable definition.

Cisco NX-API CLI

API that accepts show commands and configuration commands in CLI format.

Cisco Nexus Dashboard REST API

Unified API for Nexus Dashboard Insights, Orchestrator, and Fabric Controller.

Cisco Nexus Dashboard Fabric Controller API

REST API for managing and automating Nexus and MDS fabrics including LAN, SAN, and IP Fabric for Media deployments.

Cisco Nexus Dashboard Orchestrator API

API for multi-site orchestration of ACI, Cloud ACI, and DCNM fabrics with policy management and segmentation.

Cisco Nexus Dashboard Insights API

API for network analytics, telemetry, anomaly detection, and troubleshooting across data center fabrics.

Cisco DCNM REST API

Data Center Network Manager API for managing Nexus fabric deployments.

Cisco NETCONF/YANG API

Model-driven API using YANG data models for Nexus devices.

Cisco NX-OS RESTCONF API

HTTP-based protocol for configuring YANG-defined data on Nexus switches supporting XML and JSON payload encodings.

Cisco NX-OS gNMI/gRPC API

gRPC Network Management Interface for streaming telemetry and configuration management on Nexus switches.

Cisco NX-OS Model-Driven Telemetry API

Streaming telemetry interface for real-time operational data collection from Nexus switches using YANG models.

Cisco NX-OS Python SDK API

Python Software Development Kit for programmatic access to Nexus 9000 Series switch modules including interfaces, VLANs, ACLs, and routes.

Cisco Nexus Dashboard Authentication API

Session authentication and token management via aaaLogin and aaaLogout

Cisco Nexus Dashboard Interfaces API

Physical interface configuration and operational state using the l1PhysIf managed object class (DN sys/intf/phys-[id])

Cisco Nexus Dashboard Routing API

IPv4 and IPv6 static route configuration using ipv4Route/ipv6Route managed objects and BGP protocol management using bgpEntity hierarchy

Cisco Nexus Dashboard System API

Top-level system information and feature management via topSystem and fmEntity managed objects

Cisco Nexus Dashboard VLANs API

VLAN bridge domain management using the l2BD managed object class (DN sys/bd/bd-[vlan-id]) and SVI interface configuration using sviIf

Scroll for all 16

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Cisco NX-API REST

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Cisco Nexus Plans Pricing

1 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Cisco Nexus Rate Limits

3 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Cisco Nexus Finops

FINOPS

Features 8

Notable capabilities this provider offers.

DME Object Model REST API

RESTful access to the NX-OS Data Management Engine object model for switch configuration and operational state through managed objects.

VLAN and SVI Management

Create, modify, and delete VLAN bridge domains and Switch Virtual Interfaces for Layer 2 and Layer 3 networking.

Interface Configuration

Programmatically configure physical Ethernet interfaces including speed, duplex, MTU, switchport mode, and VLAN assignment.

BGP Routing Management

Configure and monitor BGP routing protocol including neighbors, route policies, and address families.

Static Route Management

Create and manage IPv4 static routes across VRFs with next-hop specifications and route preferences.

Feature Management

Enable and disable NX-OS features programmatically including interface-vlan, BGP, OSPF, and LACP.

Streaming Telemetry

Real-time operational data collection using gNMI/gRPC and model-driven telemetry with YANG models.

Multi-Site Orchestration

Unified policy management and orchestration across multiple ACI, Cloud ACI, and DCNM fabrics.

Scroll for all 8

Semantic Vocabularies 2

JSON-LD contexts and semantic vocabularies used across these APIs.

Cisco Nexus Context

3 classes · 15 properties

JSON-LD

Cisco Nexus Nxapi Rest Context

0 classes · 0 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Cisco Nexus Dashboard API Rules

6 rules · 4 warnings 2 info

SPECTRAL

Cisco Nexus Dashboard API Rules

15 rules · 8 errors 6 warnings 1 info

SPECTRAL

JSON Schema 57

Standalone JSON Schema definitions for this provider's data models.

AaaLoginResponse

2 properties

JSON SCHEMA

BdEntityPayload

1 properties

JSON SCHEMA

BgpDom

1 properties

JSON SCHEMA

BgpEntity

2 properties

JSON SCHEMA

BgpEntityResponse

2 properties

JSON SCHEMA

BgpInst

1 properties

JSON SCHEMA

BgpPeer

1 properties

JSON SCHEMA

ErrorResponse

1 properties

JSON SCHEMA

FmEntityPayload

1 properties

JSON SCHEMA

ImDataResponse

2 properties

JSON SCHEMA

Cisco Nexus NX-API REST Interface Schema

0 properties

JSON SCHEMA

InterfaceEntityPayload

1 properties

JSON SCHEMA

Ipv4InstPayload

1 properties

JSON SCHEMA

Ipv4Nexthop

1 properties

JSON SCHEMA

Ipv4Route

2 properties

JSON SCHEMA

Ipv4RouteListResponse

2 properties

JSON SCHEMA

Ipv4RouteResponse

2 properties

JSON SCHEMA

L1PhysIf

1 properties

JSON SCHEMA

L2BD

1 properties

JSON SCHEMA

AaaLoginResponse

2 properties

JSON SCHEMA

BdEntityPayload

1 properties

JSON SCHEMA

BgpDom

1 properties

JSON SCHEMA

BgpEntityResponse

2 properties

JSON SCHEMA

BgpEntity

2 properties

JSON SCHEMA

BgpInst

1 properties

JSON SCHEMA

BgpPeer

1 properties

JSON SCHEMA

ErrorResponse

1 properties

JSON SCHEMA

FmEntityPayload

1 properties

JSON SCHEMA

ImDataResponse

2 properties

JSON SCHEMA

InterfaceEntityPayload

1 properties

JSON SCHEMA

Ipv4InstPayload

1 properties

JSON SCHEMA

Ipv4Nexthop

1 properties

JSON SCHEMA

Ipv4RouteListResponse

2 properties

JSON SCHEMA

Ipv4RouteResponse

2 properties

JSON SCHEMA

Ipv4Route

2 properties

JSON SCHEMA

L1PhysIf

1 properties

JSON SCHEMA

L2BD

1 properties

JSON SCHEMA

PhysicalInterfaceListResponse

2 properties

JSON SCHEMA

PhysicalInterfaceResponse

2 properties

JSON SCHEMA

SviIfPayload

1 properties

JSON SCHEMA

SviIf

1 properties

JSON SCHEMA

SviInterfaceResponse

2 properties

JSON SCHEMA

TopSystemPayload

1 properties

JSON SCHEMA

TopSystemResponse

2 properties

JSON SCHEMA

TopSystem

1 properties

JSON SCHEMA

VlanBridgeDomainListResponse

2 properties

JSON SCHEMA

VlanBridgeDomainResponse

2 properties

JSON SCHEMA

PhysicalInterfaceListResponse

2 properties

JSON SCHEMA

PhysicalInterfaceResponse

2 properties

JSON SCHEMA

SviIf

1 properties

JSON SCHEMA

SviIfPayload

1 properties

JSON SCHEMA

SviInterfaceResponse

2 properties

JSON SCHEMA

TopSystem

1 properties

JSON SCHEMA

TopSystemPayload

1 properties

JSON SCHEMA

TopSystemResponse

2 properties

JSON SCHEMA

VlanBridgeDomainListResponse

2 properties

JSON SCHEMA

VlanBridgeDomainResponse

2 properties

JSON SCHEMA

Scroll for all 57

JSON Structure 29

JSON Structure definitions describing this provider's data shapes.

Cisco Nexus Nxapi Rest Aaa Login Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Bd Entity Payload Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Bgp Dom Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Bgp Entity Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Bgp Entity Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Bgp Inst Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Bgp Peer Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Error Response Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Fm Entity Payload Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Im Data Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Interface Entity Payload Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Ipv4 Inst Payload Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Ipv4 Nexthop Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Ipv4 Route List Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Ipv4 Route Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Ipv4 Route Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest L1 Phys If Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest L2 Bd Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Physical Interface List Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Physical Interface Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Svi If Payload Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Svi If Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Svi Interface Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Top System Payload Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Top System Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Top System Structure

1 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Vlan Bridge Domain List Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Nxapi Rest Vlan Bridge Domain Response Structure

2 properties

JSON STRUCTURE

Cisco Nexus Structure

0 properties

JSON STRUCTURE

Scroll for all 29

Examples 34

Example request and response payloads for these APIs.

Cisco Nexus Authenticateuser Example

6 fields

EXAMPLE

Cisco Nexus Configurefeatures Example

6 fields

EXAMPLE

Cisco Nexus Configurephysicalinterface Example

6 fields

EXAMPLE

Cisco Nexus Configurestaticroute Example

6 fields

EXAMPLE

Cisco Nexus Configuresviinterface Example

6 fields

EXAMPLE

Cisco Nexus Createvlan Example

6 fields

EXAMPLE

Cisco Nexus Nxapi Rest Aaa Login Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Bd Entity Payload Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Bgp Dom Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Bgp Entity Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Bgp Entity Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Bgp Inst Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Bgp Peer Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Error Response Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Fm Entity Payload Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Im Data Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Interface Entity Payload Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Ipv4 Inst Payload Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Ipv4 Nexthop Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Ipv4 Route Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Ipv4 Route List Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Ipv4 Route Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest L1 Phys If Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest L2 Bd Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Physical Interface List Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Physical Interface Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Svi If Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Svi If Payload Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Svi Interface Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Top System Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Top System Payload Example

1 fields

EXAMPLE

Cisco Nexus Nxapi Rest Top System Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Vlan Bridge Domain List Response Example

2 fields

EXAMPLE

Cisco Nexus Nxapi Rest Vlan Bridge Domain Response Example

2 fields

EXAMPLE

Scroll for all 34

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Cisco Nexus Authentication

apiKey · 1 scheme

SECURITY

Cisco Nexus Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Cisco Nexus Agentic Access

18 operations · 9 acting · 2 human-in-the-loop

18 operations · 9 acting

AGENTIC

Use Cases 5

What developers build with this provider.

Data Center Network Automation

Automate switch configuration, VLAN provisioning, and routing changes across large-scale data center fabrics.

Network Monitoring and Analytics

Collect real-time telemetry data from Nexus switches for performance monitoring, anomaly detection, and capacity planning.

Multi-Site Fabric Management

Orchestrate network policies and connectivity across geographically distributed data center fabrics.

Infrastructure as Code

Define and manage network infrastructure configurations using YANG models, NETCONF, and RESTCONF for version-controlled deployments.

Compliance and Auditing

Programmatically verify switch configurations against security baselines and generate compliance reports.

Integrations 5

Pre-built integrations with other platforms and tools.

Ansible

Automate Nexus switch configuration using Ansible NX-OS modules and playbooks for declarative network management.

Terraform

Provision and manage Cisco ACI and Nexus infrastructure using the Terraform Cisco provider.

Cisco ACI

Application Centric Infrastructure integration for policy-driven network automation with Nexus 9000 switches.

Splunk

Forward NX-OS streaming telemetry and syslog data to Splunk for network analytics and SIEM integration.

ServiceNow

Integrate Nexus Dashboard events and alerts with ServiceNow ITSM for automated incident management.

Resources

Get Started 2

Portal, sign-up, and the first successful call

DeveloperPortal
DeveloperPortal
 Sandbox
Sandbox

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Build 2

SDKs, sample code, and the tooling you integrate with

GitHubOrganization
GitHubOrganization
 CodeExamples
CodeExamples

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication

Learn 1

Tutorials, courses, talks, and written guidance

Training
Training

Operate 2

Status, limits, changes, and where to get help

Support
Support
 StatusPage
StatusPage

Company 1

The organization behind the API

Blog
Blog

Source (apis.yml)

apis.yml Raw ↑ 
name: Cisco Nexus Dashboard
description: APIs for managing and monitoring Cisco Nexus data center switches and network infrastructure.
accessModel:
  pricing: unknown
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
url: https://developer.cisco.com/site/nexus/
created: '2024'
modified: '2026-05-19'
tags:
- Data Center
- Infrastructure
- Network Automation
- Networking
- SDN
- Switches
apis:
- name: Cisco NX-API CLI
  description: API that accepts show commands and configuration commands in CLI format.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://developer.cisco.com/docs/nx-os/#!working-with-nx-api-cli
  baseURL: https://{switch-ip}/ins
  tags:
  - CLI
  - Configuration
  - Show Commands
  properties:
  - type: Documentation
    url: https://developer.cisco.com/docs/nx-os/#!nx-api-cli
  - type: SDKs
    url: https://github.com/CiscoDevNet/nxapi-learning-labs
  - type: Sandbox
    url: https://devnetsandbox.cisco.com/RM/Topology
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco Nexus Dashboard REST API
  description: Unified API for Nexus Dashboard Insights, Orchestrator, and Fabric Controller.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://developer.cisco.com/docs/nexus-dashboard/latest/
  baseURL: https://{nexus-dashboard}/api/v1
  tags:
  - ACI
  - Dashboard
  - Fabric Controller
  - Insights
  - Orchestration
  properties:
  - type: Documentation
    url: https://developer.cisco.com/docs/nexus-dashboard/
  - type: APIReference
    url: https://developer.cisco.com/docs/nexus-dashboard/#!api-reference
  - type: GettingStarted
    url: https://developer.cisco.com/docs/nexus-dashboard/latest/getting-started/
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco Nexus Dashboard Fabric Controller API
  description: REST API for managing and automating Nexus and MDS fabrics including LAN, SAN, and IP Fabric for Media deployments.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://developer.cisco.com/docs/nexus-dashboard-fabric-controller/latest/
  baseURL: https://{nexus-dashboard}/appcenter/cisco/ndfc/api/v1
  tags:
  - EVPN
  - Fabric Management
  - LAN
  - NDFC
  - SAN
  - VXLAN
  properties:
  - type: Documentation
    url: https://developer.cisco.com/docs/nexus-dashboard-fabric-controller/latest/
  - type: GettingStarted
    url: https://developer.cisco.com/docs/nexus-dashboard-fabric-controller/latest/getting-started/
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco Nexus Dashboard Orchestrator API
  description: API for multi-site orchestration of ACI, Cloud ACI, and DCNM fabrics with policy management and segmentation.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://developer.cisco.com/docs/nexus-dashboard-orchestrator/latest/
  baseURL: https://{nexus-dashboard}/appcenter/cisco/ndo/api/v1
  tags:
  - ACI
  - Multi-Site
  - Orchestrator
  - Policy Management
  - Segmentation
  properties:
  - type: Documentation
    url: https://developer.cisco.com/docs/nexus-dashboard-orchestrator/latest/
  - type: GettingStarted
    url: https://developer.cisco.com/docs/nexus-dashboard-orchestrator/latest/getting-started/
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco Nexus Dashboard Insights API
  description: API for network analytics, telemetry, anomaly detection, and troubleshooting across data center fabrics.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://developer.cisco.com/docs/nexus-dashboard-insights/latest/
  baseURL: https://{nexus-dashboard}/appcenter/cisco/ndi/api/v1
  tags:
  - Analytics
  - Anomaly Detection
  - Insights
  - Telemetry
  - Troubleshooting
  properties:
  - type: Documentation
    url: https://developer.cisco.com/docs/nexus-dashboard-insights/latest/
  - type: GettingStarted
    url: https://developer.cisco.com/docs/nexus-dashboard-insights/latest/getting-started/
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco DCNM REST API
  description: Data Center Network Manager API for managing Nexus fabric deployments.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://developer.cisco.com/docs/data-center-network-manager/
  baseURL: https://{dcnm-server}/rest
  tags:
  - DCNM
  - EVPN
  - Fabric Management
  - VXLAN
  properties:
  - type: Documentation
    url: https://developer.cisco.com/docs/data-center-network-manager/
  - type: UseCases
    url: https://developer.cisco.com/docs/data-center-network-manager/#!use-cases
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco NETCONF/YANG API
  description: Model-driven API using YANG data models for Nexus devices.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://developer.cisco.com/docs/nx-os/#!working-with-netconf
  baseURL: netconf://{switch-ip}:830
  tags:
  - Automation
  - Model-Driven
  - NETCONF
  - YANG
  properties:
  - type: Documentation
    url: https://developer.cisco.com/docs/nx-os/#!working-with-netconf
  - type: GitHubRepository
    url: https://github.com/YangModels/yang/tree/master/vendor/cisco/nx
  - type: Tutorials
    url: https://developer.cisco.com/learning/labs/tags/Nexus/
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco NX-OS RESTCONF API
  description: HTTP-based protocol for configuring YANG-defined data on Nexus switches supporting XML and JSON payload encodings.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://www.cisco.com/c/en/us/td/docs/dcn/nx-os/nexus9000/106x/programmability/cisco-nexus-9000-series-nx-os-programmability-guide-106x/chapter-2.html
  baseURL: https://{switch-ip}/restconf
  tags:
  - HTTP
  - Model-Driven
  - RESTCONF
  - YANG
  properties:
  - type: Documentation
    url: https://www.cisco.com/c/en/us/td/docs/dcn/nx-os/nexus9000/106x/programmability/cisco-nexus-9000-series-nx-os-programmability-guide-106x/chapter-2.html
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco NX-OS gNMI/gRPC API
  description: gRPC Network Management Interface for streaming telemetry and configuration management on Nexus switches.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://www.cisco.com/c/en/us/td/docs/dcn/nx-os/nexus9000/106x/programmability/cisco-nexus-9000-series-nx-os-programmability-guide-106x/m-gnmi.html
  baseURL: grpc://{switch-ip}:50051
  tags:
  - gNMI
  - gRPC
  - Model-Driven
  - Streaming
  - Telemetry
  properties:
  - type: Documentation
    url: https://www.cisco.com/c/en/us/td/docs/dcn/nx-os/nexus9000/106x/programmability/cisco-nexus-9000-series-nx-os-programmability-guide-106x/m-gnmi.html
  - type: GitHubRepository
    url: https://github.com/CiscoDevNet/nx-telemetry-proto
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco NX-OS Model-Driven Telemetry API
  description: Streaming telemetry interface for real-time operational data collection from Nexus switches using YANG models.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://www.cisco.com/c/en/us/td/docs/dcn/nx-os/nexus9000/102x/programmability/cisco-nexus-9000-series-nx-os-programmability-guide-release-102x/m-n9k-model-driven-telemetry-101x.html
  baseURL: grpc://{switch-ip}:50051
  tags:
  - Dial-Out
  - Monitoring
  - Streaming
  - Telemetry
  - YANG
  properties:
  - type: Documentation
    url: https://www.cisco.com/c/en/us/td/docs/dcn/nx-os/nexus9000/102x/programmability/cisco-nexus-9000-series-nx-os-programmability-guide-release-102x/m-n9k-model-driven-telemetry-101x.html
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- name: Cisco NX-OS Python SDK API
  description: Python Software Development Kit for programmatic access to Nexus 9000 Series switch modules including interfaces,
    VLANs, ACLs, and routes.
  image: https://www.cisco.com/c/en/us/products/switches/nexus-series-switches/index.jpg
  humanURL: https://developer.cisco.com/docs/nx-os/cisco-nexus-9000-series-python-sdk-user-guide-and-api-reference/
  baseURL: https://{switch-ip}
  tags:
  - Automation
  - On-Box
  - Python
  - SDK
  properties:
  - type: Documentation
    url: https://developer.cisco.com/docs/nx-os/cisco-nexus-9000-series-python-sdk-user-guide-and-api-reference/
  - type: GitHubRepository
    url: https://github.com/CiscoDevNet/NX-SDK
  contact:
  - FN: Cisco DevNet Support
    email: support@cisco.com
    url: https://developer.cisco.com/site/support/
- aid: cisco-nexus:cisco-nexus-authentication-api
  name: Cisco Nexus Dashboard Authentication API
  description: Session authentication and token management via aaaLogin and aaaLogout
  humanURL: https://developer.cisco.com/docs/nx-os/
  baseURL: https://{switch-ip}/api
  tags:
  - Authentication
  properties:
  - type: OpenAPI
    url: openapi/cisco-nexus-authentication-api-openapi.yml
  - type: Documentation
    url: https://developer.cisco.com/docs/nx-os/#!working-with-nx-api
  - type: Authentication
    url: https://developer.cisco.com/docs/nx-os/#!authentication
  - type: SDKs
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/
  - type: GettingStarted
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/getting-started-with-the-cisco-nexus-3000-and-9000-series-nx-api-rest-sdk/
  - type: APIReference
    url: https://developer.cisco.com/docs/nexus-model/latest/
- aid: cisco-nexus:cisco-nexus-interfaces-api
  name: Cisco Nexus Dashboard Interfaces API
  description: Physical interface configuration and operational state using the l1PhysIf managed object class (DN sys/intf/phys-[id])
  humanURL: https://developer.cisco.com/docs/nx-os/
  baseURL: https://{switch-ip}/api
  tags:
  - Interfaces
  properties:
  - type: OpenAPI
    url: openapi/cisco-nexus-interfaces-api-openapi.yml
  - type: Documentation
    url: https://developer.cisco.com/docs/nx-os/#!working-with-nx-api
  - type: Authentication
    url: https://developer.cisco.com/docs/nx-os/#!authentication
  - type: SDKs
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/
  - type: GettingStarted
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/getting-started-with-the-cisco-nexus-3000-and-9000-series-nx-api-rest-sdk/
  - type: APIReference
    url: https://developer.cisco.com/docs/nexus-model/latest/
- aid: cisco-nexus:cisco-nexus-routing-api
  name: Cisco Nexus Dashboard Routing API
  description: IPv4 and IPv6 static route configuration using ipv4Route/ipv6Route managed objects and BGP protocol management
    using bgpEntity hierarchy
  humanURL: https://developer.cisco.com/docs/nx-os/
  baseURL: https://{switch-ip}/api
  tags:
  - Routing
  properties:
  - type: OpenAPI
    url: openapi/cisco-nexus-routing-api-openapi.yml
  - type: Documentation
    url: https://developer.cisco.com/docs/nx-os/#!working-with-nx-api
  - type: Authentication
    url: https://developer.cisco.com/docs/nx-os/#!authentication
  - type: SDKs
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/
  - type: GettingStarted
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/getting-started-with-the-cisco-nexus-3000-and-9000-series-nx-api-rest-sdk/
  - type: APIReference
    url: https://developer.cisco.com/docs/nexus-model/latest/
- aid: cisco-nexus:cisco-nexus-system-api
  name: Cisco Nexus Dashboard System API
  description: Top-level system information and feature management via topSystem and fmEntity managed objects
  humanURL: https://developer.cisco.com/docs/nx-os/
  baseURL: https://{switch-ip}/api
  tags:
  - System
  properties:
  - type: OpenAPI
    url: openapi/cisco-nexus-system-api-openapi.yml
  - type: Documentation
    url: https://developer.cisco.com/docs/nx-os/#!working-with-nx-api
  - type: Authentication
    url: https://developer.cisco.com/docs/nx-os/#!authentication
  - type: SDKs
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/
  - type: GettingStarted
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/getting-started-with-the-cisco-nexus-3000-and-9000-series-nx-api-rest-sdk/
  - type: APIReference
    url: https://developer.cisco.com/docs/nexus-model/latest/
- aid: cisco-nexus:cisco-nexus-vlans-api
  name: Cisco Nexus Dashboard VLANs API
  description: VLAN bridge domain management using the l2BD managed object class (DN sys/bd/bd-[vlan-id]) and SVI interface
    configuration using sviIf
  humanURL: https://developer.cisco.com/docs/nx-os/
  baseURL: https://{switch-ip}/api
  tags:
  - VLANs
  properties:
  - type: OpenAPI
    url: openapi/cisco-nexus-vlans-api-openapi.yml
  - type: Documentation
    url: https://developer.cisco.com/docs/nx-os/#!working-with-nx-api
  - type: Authentication
    url: https://developer.cisco.com/docs/nx-os/#!authentication
  - type: SDKs
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/
  - type: GettingStarted
    url: https://developer.cisco.com/docs/cisco-nexus-3000-and-9000-series-nx-api-rest-sdk-user-guide-and-api-reference/latest/getting-started-with-the-cisco-nexus-3000-and-9000-series-nx-api-rest-sdk/
  - type: APIReference
    url: https://developer.cisco.com/docs/nexus-model/latest/
common:
- type: AgenticAccess
  url: agentic-access/cisco-nexus-agentic-access.yml
- type: DomainSecurity
  url: security/cisco-nexus-domain-security.yml
- type: Authentication
  url: authentication/cisco-nexus-authentication.yml
- type: DeveloperPortal
  url: https://developer.cisco.com/
- url: https://blogs.cisco.com/tag/nexus/feed
  type: Blog
- type: GitHubOrganization
  url: https://github.com/CiscoDevNet
- type: Training
  url: https://developer.cisco.com/learning/labs/tags/Nexus/
- type: Sandbox
  url: https://devnetsandbox.cisco.com/
- type: Support
  url: https://developer.cisco.com/site/support/
- type: StatusPage
  url: https://status.cisco.com/
- type: CodeExamples
  url: https://developer.cisco.com/codeexchange/
- type: Features
  data:
  - name: DME Object Model REST API
    description: RESTful access to the NX-OS Data Management Engine object model for switch configuration and operational
      state through managed objects.
  - name: VLAN and SVI Management
    description: Create, modify, and delete VLAN bridge domains and Switch Virtual Interfaces for Layer 2 and Layer 3 networking.
  - name: Interface Configuration
    description: Programmatically configure physical Ethernet interfaces including speed, duplex, MTU, switchport mode, and
      VLAN assignment.
  - name: BGP Routing Management
    description: Configure and monitor BGP routing protocol including neighbors, route policies, and address families.
  - name: Static Route Management
    description: Create and manage IPv4 static routes across VRFs with next-hop specifications and route preferences.
  - name: Feature Management
    description: Enable and disable NX-OS features programmatically including interface-vlan, BGP, OSPF, and LACP.
  - name: Streaming Telemetry
    description: Real-time operational data collection using gNMI/gRPC and model-driven telemetry with YANG models.
  - name: Multi-Site Orchestration
    description: Unified policy management and orchestration across multiple ACI, Cloud ACI, and DCNM fabrics.
- type: UseCases
  data:
  - name: Data Center Network Automation
    description: Automate switch configuration, VLAN provisioning, and routing changes across large-scale data center fabrics.
  - name: Network Monitoring and Analytics
    description: Collect real-time telemetry data from Nexus switches for performance monitoring, anomaly detection, and capacity
      planning.
  - name: Multi-Site Fabric Management
    description: Orchestrate network policies and connectivity across geographically distributed data center fabrics.
  - name: Infrastructure as Code
    description: Define and manage network infrastructure configurations using YANG models, NETCONF, and RESTCONF for version-controlled
      deployments.
  - name: Compliance and Auditing
    description: Programmatically verify switch configurations against security baselines and generate compliance reports.
- type: Integrations
  data:
  - name: Ansible
    description: Automate Nexus switch configuration using Ansible NX-OS modules and playbooks for declarative network management.
  - name: Terraform
    description: Provision and manage Cisco ACI and Nexus infrastructure using the Terraform Cisco provider.
  - name: Cisco ACI
    description: Application Centric Infrastructure integration for policy-driven network automation with Nexus 9000 switches.
  - name: Splunk
    description: Forward NX-OS streaming telemetry and syslog data to Splunk for network analytics and SIEM integration.
  - name: ServiceNow
    description: Integrate Nexus Dashboard events and alerts with ServiceNow ITSM for automated incident management.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
  url: https://apievangelist.com