# Brocade Fabric OS REST API

**Canonical:** https://apis.io/apis/brocade/brocade-fabric-os-rest-api/  
**Provider:** Brocade — https://apis.io/providers/brocade/  
**Base URL:** https://{switch-ip}/rest  
**Documentation:** https://techdocs.broadcom.com/us/en/fibre-channel-networking/fabric-os/fabric-os-rest-api/9-2-x.html

Brocade Fabric OS REST API is one of 12 APIs that [Brocade](https://apis.io/providers/brocade/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Fabric OS, Fibre Channel, Network Management, SAN, and Switches. The published artifact set on APIs.io includes API documentation, an API reference, authentication docs, and a getting-started guide.

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 and monitoring switch resources including chassis, ports, zoning, security, logging, MAPS, and Fibre Channel features. Supported on Fabric OS 8.2.0 and later.

## Machine-readable artifacts (6)

- **Documentation** — https://techdocs.broadcom.com/us/en/fibre-channel-networking/fabric-os/fabric-os-rest-api/9-2-x.html
- **Reference** — https://techdocs.broadcom.com/us/en/fibre-channel-networking/fabric-os/fabric-os-rest-api/10-0-x.html
- **Authentication** — https://techdocs.broadcom.com/us/en/fibre-channel-networking/fabric-os/fabric-os-rest-api/9-2-x/v26395730/v24190001.html
- **GettingStarted** — https://techdocs.broadcom.com/us/en/fibre-channel-networking/fabric-os/fabric-os-rest-api/9-2-x/v26395730/v24190001.html
- **SDKs** — https://github.com/brocade/pyfos
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/brocade/refs/heads/main/apis.yml

## Other Brocade APIs (11)

- [Brocade SANnav Management Portal REST API](https://apis.io/apis/brocade/brocade-sannav-management-portal-rest-api/)
- [Brocade SANnav Northbound Streaming API](https://apis.io/apis/brocade/brocade-sannav-northbound-streaming-api/)
- [Brocade Network Advisor REST API](https://apis.io/apis/brocade/brocade-network-advisor-rest-api/)
- [Brocade Workflow Composer API](https://apis.io/apis/brocade/brocade-workflow-composer-api/)
- [Brocade VCS Fabric API](https://apis.io/apis/brocade/brocade-vcs-fabric-api/)
- [Brocade Chassis API](https://apis.io/apis/brocade/brocade-chassis-api/)
- [Brocade Interfaces API](https://apis.io/apis/brocade/brocade-interfaces-api/)
- [Brocade Operations API](https://apis.io/apis/brocade/brocade-operations-api/)
- [Brocade Session API](https://apis.io/apis/brocade/brocade-session-api/)
- [Brocade Switch API](https://apis.io/apis/brocade/brocade-switch-api/)
- [Brocade Zoning API](https://apis.io/apis/brocade/brocade-zoning-api/)

## Tags

Fabric OS, Fibre Channel, Network Management, SAN, Switches

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/brocade/brocade-fabric-os-rest-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/brocade/.