Brocade

Brocade, now part of Broadcom, provides Fibre Channel networking solutions for storage area networks (SANs). The Brocade portfolio includes SAN switches, directors, Fabric OS software, and the SANnav management platform, all offering REST APIs for programmable management and automation of SAN infrastructure.

6 APIs 0 Features

Data CenterDirectorsFibre ChannelNetwork AutomationNetworkingSANStorage Area NetworksSwitchesFortune 1000

APIs

Brocade Fabric OS REST API

The Brocade Fabric OS REST API provides a programmable web-service interface for managing Brocade SAN switches across a fabric. It supports YANG-based modules for configuring an...

Brocade SANnav Management Portal REST API

The Brocade SANnav Management Portal REST API provides a programmable web-service interface for accessing and managing the SANnav Management Portal server. REST API services inc...

Brocade SANnav Northbound Streaming API

The Brocade SANnav Northbound Streaming API enables real-time streaming of SAN telemetry and event data from the SANnav Management Portal to external systems. It provides northb...

Brocade Network Advisor REST API

The Brocade Network Advisor REST API provided a web-services interface for configuring and monitoring Brocade SAN switches, including fabric management, topology, zoning, and pe...

Brocade Workflow Composer API

The Brocade Workflow Composer was a network automation platform based on StackStorm for event-driven automation and orchestration workflows. The product was transferred to Extre...

Brocade VCS Fabric API

The Brocade VCS Fabric API provided REST interfaces for Virtual Cluster Switching fabric configuration on Brocade VDX switches. The VCS Fabric product line was transferred to Ex...

Collections

Brocade Fabric OS REST API

OPEN

Pricing Plans

Brocade Plans Pricing

3 plans

PLANS

Rate Limits

Brocade Rate Limits

5 limits

RATE LIMITS

FinOps

Brocade Finops

FINOPS

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Brocade Fabric OS REST API
  version: 9.2.x
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Session
    type: folder
  items:
  - info:
      name: Log in to a Fabric OS switch
      type: http
    http:
      method: POST
      url: https://{switch-ip}/rest/login
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Authenticate using basic credentials or an encrypted authorization token. Returns an authorization token in the
      response Authorization header.
  - info:
      name: Log out of a session
      type: http
    http:
      method: POST
      url: https://{switch-ip}/rest/logout
    docs: Log out of a session
- info:
    name: Chassis
    type: folder
  items:
  - info:
      name: Get chassis configuration
      type: http
    http:
      method: GET
      url: https://{switch-ip}/rest/running/brocade-chassis/chassis
    docs: Get chassis configuration
  - info:
      name: Update chassis configuration
      type: http
    http:
      method: PATCH
      url: https://{switch-ip}/rest/running/brocade-chassis/chassis
      body:
        type: json
        data: '{}'
    docs: Update chassis configuration
- info:
    name: Switch
    type: folder
  items:
  - info:
      name: Get Fibre Channel switch attributes
      type: http
    http:
      method: GET
      url: https://{switch-ip}/rest/running/brocade-fibrechannel-switch/fibrechannel-switch
    docs: Get Fibre Channel switch attributes
  - info:
      name: Update Fibre Channel switch attributes
      type: http
    http:
      method: PATCH
      url: https://{switch-ip}/rest/running/brocade-fibrechannel-switch/fibrechannel-switch
      body:
        type: json
        data: '{}'
    docs: Update Fibre Channel switch attributes
- info:
    name: Interfaces
    type: folder
  items:
  - info:
      name: List Fibre Channel interfaces
      type: http
    http:
      method: GET
      url: https://{switch-ip}/rest/running/brocade-interface/fibrechannel
    docs: List Fibre Channel interfaces
  - info:
      name: Get Fibre Channel interface statistics
      type: http
    http:
      method: GET
      url: https://{switch-ip}/rest/running/brocade-interface/fibrechannel-statistics
    docs: Get Fibre Channel interface statistics
- info:
    name: Zoning
    type: folder
  items:
  - info:
      name: Get defined zoning configuration
      type: http
    http:
      method: GET
      url: https://{switch-ip}/rest/running/brocade-zone/defined-configuration
    docs: Get defined zoning configuration
  - info:
      name: Update defined zoning
      type: http
    http:
      method: PATCH
      url: https://{switch-ip}/rest/running/brocade-zone/defined-configuration
      body:
        type: json
        data: '{}'
    docs: Update defined zoning
  - info:
      name: Get effective zoning configuration
      type: http
    http:
      method: GET
      url: https://{switch-ip}/rest/running/brocade-zone/effective-configuration
    docs: Get effective zoning configuration
- info:
    name: Operations
    type: folder
  items:
  - info:
      name: Run zoning operation
      type: http
    http:
      method: POST
      url: https://{switch-ip}/rest/operations/zone
      body:
        type: json
        data: '{}'
    docs: RPC operation for activating or disabling a zone configuration.
  - info:
      name: Show asynchronous operation status
      type: http
    http:
      method: GET
      url: https://{switch-ip}/rest/operations/show-status
      params:
      - name: message-id
        value: ''
        type: query
    docs: Show asynchronous operation status
  - info:
      name: Upload device configuration
      type: http
    http:
      method: POST
      url: https://{switch-ip}/rest/operations/configupload
      body:
        type: json
        data: '{}'
    docs: Upload device configuration
  - info:
      name: Download configuration to device
      type: http
    http:
      method: POST
      url: https://{switch-ip}/rest/operations/configdownload
      body:
        type: json
        data: '{}'
    docs: Download configuration to device
bundled: true