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 VLANs API

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

Cisco Nexus Dashboard VLANs 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 VLANs. 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 6 operations across 4 paths, and defines 9 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.

6 operations 4 paths 9 schemas 1 DELETE3 GET2 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 VLANs 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 6

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

VLANs 6

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

POST
/mo/sys/bd.json
Create or Modify a Vlan Bridge Domain
createVlan body → 200400403
GET
/mo/sys/bd/bd-[{vlanEncap}].json
Retrieve a Specific Vlan Bridge Domain
getVlan 3 params → 200400404
DELETE
/mo/sys/bd/bd-[{vlanEncap}].json
Delete a Vlan Bridge Domain
deleteVlan 1 param → 200404
GET
/class/l2BD.json
List All Vlan Bridge Domains
listVlans 4 params → 200400
GET
/mo/sys/intf/svi-[{sviId}].json
Retrieve an Svi (vlan Interface) Configuration
getSviInterface 3 params → 200404
POST
/mo/sys/intf/svi-[{sviId}].json
Create or Modify an Svi (vlan Interface)
configureSviInterface 1 param body → 200400

Schemas 9

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

SviIfPayload
object
1 property
SviInterfaceResponse
object
2 properties
ImDataResponse
object
Standard NX-API REST response wrapper
2 properties
L2BD
object
Layer 2 bridge domain managed object representing a VLAN. DN format is sys/bd/bd-[{fabEncap}].
1 property
BdEntityPayload
object
1 property
VlanBridgeDomainResponse
object
2 properties
ErrorResponse
object
Error response from NX-API REST
1 property
VlanBridgeDomainListResponse
object
2 properties
SviIf
object
Switch Virtual Interface managed object for Layer 3 VLAN routing. DN format is sys/intf/svi-[{id}].
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-nexus-vlans-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 VLANs 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.