Brocade Operations API

openapi: 3.1.0
info:
  title: Brocade Fabric OS REST Chassis Operations API
  description: The Brocade Fabric OS (FOS) REST API is a RESTCONF (RFC 8040) interface built on YANG 1.1 data models for managing Brocade SAN switches. It exposes operations for authentication, chassis, ports, zoning, security, and monitoring on Fabric OS 8.2.0 and later. Login returns an Authorization token used for subsequent calls.
  version: 9.2.x
  contact:
    name: Brocade Fabric OS REST API
    url: https://techdocs.broadcom.com/us/en/fibre-channel-networking/fabric-os/fabric-os-rest-api/9-2-x.html
servers:
- url: https://{switch-ip}/rest
  description: Brocade switch REST endpoint
  variables:
    switch-ip:
      default: 10.0.0.1
      description: IP address or hostname of the Brocade switch
security:
- BasicAuth: []
- SessionToken: []
tags:
- name: Operations
paths:
  /operations/zone:
    post:
      summary: Run zoning operation
      description: RPC operation for activating or disabling a zone configuration.
      operationId: zoneOperation
      tags:
      - Operations
      requestBody:
        required: true
        content:
          application/yang-data+json:
            schema:
              type: object
      responses:
        '200':
          description: Operation result
          content:
            application/yang-data+json:
              schema:
                type: object
  /operations/show-status:
    get:
      summary: Show asynchronous operation status
      operationId: showStatus
      tags:
      - Operations
      parameters:
      - name: message-id
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Status
          content:
            application/yang-data+json:
              schema:
                type: object
  /operations/configupload:
    post:
      summary: Upload device configuration
      operationId: configUpload
      tags:
      - Operations
      requestBody:
        required: true
        content:
          application/yang-data+json:
            schema:
              type: object
      responses:
        '200':
          description: Operation started
          content:
            application/yang-data+json:
              schema:
                type: object
  /operations/configdownload:
    post:
      summary: Download configuration to device
      operationId: configDownload
      tags:
      - Operations
      requestBody:
        required: true
        content:
          application/yang-data+json:
            schema:
              type: object
      responses:
        '200':
          description: Operation started
          content:
            application/yang-data+json:
              schema:
                type: object
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
    SessionToken:
      type: apiKey
      in: header
      name: Authorization