How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 Routing API is one of 16 APIs that Cisco Nexus Dashboard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Routing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and an API reference.

This API exposes 4 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 10.5.0.

Requests are made against a single base URL, https://{switchIp}/api.

4 operations 4 paths 12 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
10.5.0
Base URL
https://{switch-ip}/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Cisco Nexus Dashboard Routing API declares 1 security scheme for authenticating requests. An API key is passed in the cookie as APIC-cookie (cookieAuth). By default, every request must be authenticated.

  • cookieAuth — Session cookie obtained from the /api/aaaLogin endpoint. The cookie has a configurable idle timeout (default 600 seconds) and must be included in all subsequen…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Routing 4

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

POST
/mo/sys/ipv4/inst.json
Create or Modify Ipv4 Static Routes
configureStaticRoute body → 200400
GET
/mo/sys/ipv4/inst/dom-{vrfName}/rt-[{prefix}].json
Retrieve a Specific Ipv4 Static Route
getStaticRoute 3 params → 200404
GET
/class/ipv4Route.json
List All Ipv4 Static Routes
listStaticRoutes 3 params → 200400
GET
/mo/sys/bgp.json
Retrieve Full Bgp Configuration
getBgpConfiguration 2 params → 200404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are BgpEntityResponse (2 properties), ImDataResponse (2 properties), Ipv4RouteResponse (2 properties), BgpEntity (2 properties). Each schema is shown below with its type and property counts.

BgpEntityResponse
object
2 properties
Ipv4RouteListResponse
object
2 properties
BgpEntity
object
Top-level BGP entity managed object. DN is sys/bgp.
2 properties
Ipv4RouteResponse
object
2 properties
BgpInst
object
BGP instance managed object containing AS number and domain configuration. DN is sys/bgp/inst.
1 property
BgpPeer
object
BGP peer (neighbor) managed object. DN format is sys/bgp/inst/dom-{name}/peer-{addr}.
1 property
Ipv4Nexthop
object
IPv4 next-hop specification for a static route. DN format is sys/ipv4/inst/dom-{vrfName}/rt-[{prefix}]/nh-[{nhIf}]-addr-[{nhAddr}]-vrf-[{nhVrf}].
1 property
ImDataResponse
object
Standard NX-API REST response wrapper
2 properties
ErrorResponse
object
Error response from NX-API REST
1 property
Ipv4Route
object
IPv4 static route managed object. DN format is sys/ipv4/inst/dom-{vrfName}/rt-[{prefix}].
2 properties
BgpDom
object
BGP domain (VRF) managed object. DN format is sys/bgp/inst/dom-{name}.
1 property
Ipv4InstPayload
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-nexus-routing-api-openapi.yml Raw ↑

Other APIs Cisco Nexus Dashboard publishes across the network.

Cisco NX-API CLI
Cisco Nexus Dashboard REST API
Cisco Nexus Dashboard Fabric Controller API
Cisco Nexus Dashboard Orchestrator API
Cisco Nexus Dashboard Insights API
Cisco DCNM REST API
Cisco NETCONF/YANG API
Cisco NX-OS RESTCONF API
Cisco NX-OS gNMI/gRPC API
Cisco NX-OS Model-Driven Telemetry API
Cisco NX-OS Python SDK API
Cisco Nexus Dashboard Authentication API
Where this information came from

This is an independent, third-party profile of Cisco Nexus Dashboard Routing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.