openapi: 3.2.0 info: title: Cisco Secure Firewall Chassis API version: 1.13.0 contact: name: Cisco Firepower TAC email: ngfw-support@cisco.com description: 'Operations tagged Chassis across 2 of this provider''s published API definitions: cdfmc-openapi.yaml, cisco-secure-firewall-cdfmc-openapi.yml. Each path carries the servers of the definition it was published in.' x-provenance: method: harvested first_party: true harvested: '2026-08-19' source: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml source_repo: https://github.com/CiscoDevNet/scc-public-api-docs note: Verbatim first-party OpenAPI published by Cisco in the CiscoDevNet scc-public-api-docs repository, the source of record for developer.cisco.com/docs/cisco-security-cloud-control-firewall-manager/. Not authored or modified by API Evangelist. derived_view: Per-tag view of cisco-secure-firewall-cdfmc-openapi.yml, the provider's source document. Operations and schemas are the provider's, unmodified; only the partition is ours. derived_from: cisco-secure-firewall-cdfmc-openapi.yml operation_coverage: 43/43 x-evidence: fetched: '2026-08-19' url: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml http_status: 200 servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 tags: - name: Chassis paths: /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis: get: deprecated: false description: '**Get a list of all chassis managed devices from the Firewall Management Center**' operationId: getAllFMCManagedChassis parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis?expanded=true ( Success: Test GET ALL success )' : value: items: - chassisName: 192.168.0.74 id: chassisUUID1 isConnected: false links: self: /api/fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/chassisUUID1 metadata: domain: id: GlobalDomainUUID name: Global type: Domain model: Cisco Secure Firewall 3120 Threat Defense type: FMCManagedChassis - chassisName: 192.168.0.72 id: chassisUUID2 isConnected: true links: self: /api/fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/chassisUUID2 metadata: domain: id: GlobalDomainUUID name: Global type: Domain model: Cisco Secure Firewall 3140 Threat Defense type: FMCManagedChassis links: self: /api/fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FMCManagedChassisListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/appinfo: get: deprecated: false description: '**Get all image versions available for instance creation on the chassis.**' operationId: getChassisAppInfo parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/appinfo ( Example payload for GET on App Info )' : value: items: - appVersion: 7.4.0.1024 type: AppInfo - appVersion: 7.4.0.1075 type: AppInfo links: self: /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/appinfo?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisAppInfoListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/chassisinterfaceevents: get: deprecated: false description: '**Get a list of all NetMod events on the device.**' operationId: getChassisInterfaceEvent parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChassisInterfaceEventListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis post: deprecated: false description: '**Creates a NetMod event on the device. _Check the response section for applicable examples (if any)._**' operationId: createChassisInterfaceEvent parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/ChassisInterfaceEvent' type: object description: The input representing action to be performed on netmod events. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ChassisInterfaceEvent' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/chassisinterfaces: get: deprecated: true description: '**Retrieve chassis interfaces. (deprecated) Please use /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces and /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces/{interfaceUUID} instead**' operationId: getAllChassisInterface parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{chassisUUid}/chassisinterfaces?expanded=true ( Success: Test GET ALL success )' : value: items: - autoNegState: 'No' duplex: FULL fecvalue: AUTO id: chassisinterfaceUUid1 links: self: /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{chassisUUid}/chassisinterfaces/{chassisinterfaceUUid1} mediaType: rj45 metadata: domain: id: GlobalDominaUUid name: Global type: Domain supportedSpeed: '[100mbps, 10mbps, 1gbps, auto]' timestamp: 1628243570146.0 name: Ethernet1/1 sfptype: none speed: 1gbps type: ChassisInterface - autoNegState: 'No' duplex: FULL fecvalue: AUTO id: chassisinterfaceUUid2 links: self: /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{chassisUUid}/chassisinterfaces/{chassisinterfaceUUid2} mediaType: rj45 metadata: domain: id: GlobalDominaUUid name: Global type: Domain supportedSpeed: '[100mbps, 10mbps, 1gbps, auto]' timestamp: 1628243570146.0 name: Ethernet1/2 sfptype: none speed: 1gbps type: ChassisInterface links: self: /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{chassisUUid}/chassisinterfaces?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisInterfaceListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/chassisinterfaces/{interfaceUUID} : get: deprecated: true description: '**Retrieve chassis interfaces. (deprecated) Please use /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces and /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces/{interfaceUUID} instead**' operationId: getChassisInterface parameters: - description: Unique identifier of a chassis interface. in: path name: interfaceUUID required: true schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{chassisUUid}/chassisinterfaces/{chassisinterfaceUUid1} ( Success: Test GET success )' : value: autoNegState: 'Yes' duplex: FULL fecvalue: AUTO id: chassisinterfaceUUid1 links: self: /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{chassisUUid}/chassisinterfaces/{chassisinterfaceUUid1} mediaType: sfp metadata: domain: id: GlobalDominaUUid name: Global type: Domain supportedSpeed: '[100mbps, 10gbps, 1gbps, auto, sfpdetect]' timestamp: 1628474064343.0 name: Ethernet2/8 sfptype: none speed: sfpdetect type: ChassisInterface schema: $ref: '#/components/schemas/ChassisInterface' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/chassisinterfaces/{interfaceUUID}/evaluateoperation : get: deprecated: false description: '**Validate Interface usage.**' operationId: getEvaluateChassisOperation parameters: - description: UUID of the chassis interface. in: path name: interfaceUUID required: true schema: type: string - description: The specific chassis operation to be evaluated. Possible values are BREAKOUT and JOIN. in: query name: operationType required: true schema: type: string - description: The specific breakout type to be evaluated. in: query name: breakoutType required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: schema: $ref: '#/components/schemas/EvaluateChassisOperationListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces: get: deprecated: false description: '**Get a list of chassis EtherChannel interface configurations.**' operationId: getAllEtherChannelInterface parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces ( Success: Test GET ALL success )' : value: items: - adminState: DISABLED etherChannelId: 3 hardware: autoNegState: true duplex: FULL speed: TEN_GBPS id: etherChanneluuid1 lacpMode: ACTIVE lacpRate: DEFAULT links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//etherchannelinterfaces/etherChanneluuid1 metadata: isBreakoutCapable: false isSplitInterface: false mediaType: none supportedSpeed: TEN_GBPS,ONE_GBPS name: Port-channel3 portType: DATA selectedInterfaces: - id: memberInterfaceId name: memberInterfaceName type: PhysicalInterface type: EtherChannelInterface - adminState: DISABLED etherChannelId: 2 hardware: autoNegState: true duplex: FULL speed: FORTY_GBPS id: etherChanneluuid2 lacpMode: ACTIVE lacpRate: DEFAULT links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//etherchannelinterfaces/etherChanneluuid2 metadata: isBreakoutCapable: false isSplitInterface: false mediaType: none supportedSpeed: TEN_GBPS,ONE_GBPS name: Port-channel2 portType: DATA selectedInterfaces: - id: memberInterfaceId name: memberInterfaceName type: PhysicalInterface type: EtherChannelInterface links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//etherchannelinterfaces?offset=0&limit=25 paging: count: 7 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/EtherChannelInterfaceListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis post: deprecated: false description: '**Create an EtherChannel interface configuration. _Check the response section for applicable examples (if any)._**' operationId: createEtherChannelInterface parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces ( Success: Test POST success )' : value: adminState: DISABLED etherChannelId: 3 hardware: autoNegState: true duplex: FULL speed: TEN_GBPS lacpMode: ACTIVE lacpRate: DEFAULT portType: DATA selectedInterfaces: - id: memberInterfaceId name: memberInterfaceName type: PhysicalInterface type: EtherChannelInterface schema: $ref: '#/components/schemas/EtherChannelInterface' type: object description: The input create EtherChannel interface configuration. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces ( Success: Test POST success )' : value: adminState: DISABLED etherChannelId: 3 hardware: autoNegState: true duplex: FULL speed: TEN_GBPS id: etherChanneluuid lacpMode: ACTIVE lacpRate: DEFAULT name: Port-channel3 portType: DATA selectedInterfaces: - id: memberInterfaceId name: memberInterfaceName type: PhysicalInterface type: EtherChannelInterface schema: $ref: '#/components/schemas/EtherChannelInterface' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces/{interfaceUUID} : get: deprecated: false description: '**Get the specified chassis EtherChannel configuration.**' operationId: getEtherChannelInterface parameters: - description: UUID of the EtherChannel interface. in: path name: interfaceUUID required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces/{etherChanneluuid} ( Success: Test GET success )' : value: adminState: DISABLED etherChannelId: 2 hardware: autoNegState: true duplex: FULL speed: FORTY_GBPS id: etherChanneluuid2 lacpMode: ACTIVE lacpRate: DEFAULT links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//etherchannelinterfaces/etherChanneluuid2 metadata: isBreakoutCapable: false isSplitInterface: false mediaType: none supportedSpeed: TEN_GBPS,ONE_GBPS name: Port-channel2 portType: DATA selectedInterfaces: - id: memberInterfaceId name: memberInterfaceName type: PhysicalInterface type: EtherChannelInterface schema: $ref: '#/components/schemas/EtherChannelInterface' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis put: deprecated: false description: '**Modify the specified chassis EtherChannel configuration _Check the response section for applicable examples (if any)._**' operationId: updateEtherChannelInterface parameters: - description: UUID of the EtherChannel interface. in: path name: interfaceUUID required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces/{etherchannelinterfaceUUid} ( Success: Test PUT success )' : value: adminState: DISABLED etherChannelId: 3 hardware: autoNegState: true duplex: FULL speed: TEN_GBPS id: etherchannelinterfaceUUid lacpMode: ACTIVE lacpRate: DEFAULT portType: DATA selectedInterfaces: - id: memberInterfaceId name: memberInterfaceName type: PhysicalInterface type: EtherChannelInterface schema: $ref: '#/components/schemas/EtherChannelInterface' type: object description: The input create EtherChannel interface configuration. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces/{etherchannelinterfaceUUid} ( Success: Test PUT success )' : value: adminState: DISABLED etherChannelId: 3 hardware: autoNegState: true duplex: FULL speed: TEN_GBPS id: etherChanneluuid lacpMode: ACTIVE lacpRate: DEFAULT name: Port-channel3 portType: DATA selectedInterfaces: - id: memberInterfaceId name: memberInterfaceName type: PhysicalInterface type: EtherChannelInterface schema: $ref: '#/components/schemas/EtherChannelInterface' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces/{objectId} : delete: deprecated: false description: '**Delete the specified chassis EtherChannel configuration _Check the response section for applicable examples (if any)._**' operationId: deleteEtherChannelInterface parameters: - description: UUID of the EtherChannel interface. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/etherchannelinterfaces/{etherChanneluuid} ( Success: Test DELETE success )' : value: adminState: DISABLED etherChannelId: 2 hardware: autoNegState: true duplex: FULL speed: FORTY_GBPS id: etherChanneluuid lacpMode: ACTIVE lacpRate: DEFAULT links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//etherchannelinterfaces/etherChanneluuid metadata: isBreakoutCapable: false isSplitInterface: false mediaType: none supportedSpeed: TEN_GBPS,ONE_GBPS name: Port-channel2 portType: DATA selectedInterfaces: - id: memberInterfaceId name: memberInterfaceName type: PhysicalInterface type: EtherChannelInterface schema: $ref: '#/components/schemas/EtherChannelInterface' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/faultsummary: get: deprecated: false description: '**Get fault data from the chassis.**' operationId: getChassisFaultSummary parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/faultsummary ( Example payload for GET on Chassis Fault Summary )' : value: items: - faultList: - cause: device-registration-pending createdTime: 2022-07-04 17:10:03.435000 description: Device registration for 10.10.41.6 pending. highestSeverity: info id: 27429 isAcknowledged: 'no' lastTransitionTime: 2022-07-04 17:12:22.467000 occurrence: '1' severity: cleared modifiedTime: '2022-07-05T06:39:25Z' type: FaultSummary links: self: /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/faultsummary?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisFaultSummaryListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/instancesummary: get: deprecated: false description: '**Get instance summary data from the chassis.**' operationId: getChassisInstanceSummary parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/instancesummary ( Example payload for GET on Chassis Instance Summary )' : value: items: - instanceList: - adminState: enabled coresUsed: 6 deployType: container ipv4: gateway: 192.168.3.68 ip: 192.168.3.78 mask: 255.255.255.0 ipv6: gateway: 3::1 ip: 3::2 prefixLength: '33' managementPort: Management1 name: ftdmi2 operationalState: online startupVersion: 7.3.0.1402 modifiedTime: '2022-07-05T06:39:25Z' type: InstanceSummary links: self: /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/instancesummary?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisInstanceSummaryListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces: get: deprecated: false description: '**Get all chassis interfaces.**' operationId: getAllChassisAllInterfacesModel parameters: - description: Query parameter used to search interfaces by name or port type. Use "name:{name}" to search by hardware name of interface.
Use "type:{type1,type2}" to search by interface type. Type can be PhysicalInterface,SubInterface or EtherChannelInterface
Use "portType:{portType1,portType2}" to search by interface port type. Port type can be DATA,MANAGEMENT,DATA_SHARING or CLUSTER in: query name: filter required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces ( Success: Test GET ALL success )' : value: items: - adminState: DISABLED hardware: autoNegState: boolean duplex: FULL fecMode: AUTO speed: DETECT_SFP id: interfaceId2 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis/{container_UUID}/physicalinterfaces/{interfaceId2} metadata: isBreakoutCapable: boolean isSplitInterface: boolean mediaType: sfp sfpType: none supportedSpeed: TEN_GBPS,DETECT_SFP name: Ethernet2/2/2 portType: DATA type: PhysicalInterface - id: subinterfaceuuid links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis/{container_UUID}/subinterfaces/subinterfaceuuid name: Ethernet1/1.1 parentInterface: id: parentInterfaceuuid name: parentInterfaceName type: PhysicalInterface portType: DATA subIntfId: 1 type: SubInterface vlanId: 1 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//physicalinterfaces?offset=0&limit=25 paging: count: 7 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisAllInterfacesModelListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfaces/{interfaceUUID}: get: deprecated: false description: '**Get information for the specified chassis interface.**' operationId: getChassisAllInterfacesModel parameters: - description: UUID of the chassis interface. in: path name: interfaceUUID required: true schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain//chassis/fmcmanagedchassis/{container_UUID}/interfaces/{interfaceId1} ( Success: Test GET success )' : value: adminState: DISABLED hardware: autoNegState: boolean duplex: FULL fecMode: AUTO speed: DETECT_SFP id: interfaceId1 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis/{container_UUID}/physicalinterfaces/{interfaceId1} metadata: isBreakoutCapable: boolean isSplitInterface: boolean mediaType: sfp sfpType: none supportedSpeed: TEN_GBPS,DETECT_SFP name: Ethernet2/2/3 portType: DATA type: PhysicalInterface schema: $ref: '#/components/schemas/ChassisAllInterfacesModel' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfacesummary: get: deprecated: false description: '**Get interface summary data from the chassis.**' operationId: getChassisInterfaceSummary parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/interfacesummary ( Example payload for GET on Chassis Interface Summary )' : value: items: - interfaceList: - adminDuplex: fullDuplex adminSpeed: 1gbps adminState: disabled autoNegotiation: 'yes' mediaType: rj45 name: Ethernet1/8 operationalSpeed: 10mbps operationalState: up portType: data type: PhysicalInterface - adminDuplex: fullDuplex adminSpeed: 1gbps adminState: disabled autoNegotiation: 'yes' mediaType: rj45 name: Ethernet1/7 operationalSpeed: 1gbps operationalState: up portType: data type: PhysicalInterface - adminDuplex: fullDuplex adminSpeed: 1gbps adminState: disabled autoNegotiation: 'yes' mediaType: rj45 name: Ethernet1/6 operationalSpeed: 1gbps operationalState: up portType: data type: PhysicalInterface - adminDuplex: fullDuplex adminSpeed: 1gbps adminState: disabled autoNegotiation: 'yes' mediaType: rj45 name: Ethernet1/5 operationalSpeed: 1gbps operationalState: up portType: data type: PhysicalInterface - adminDuplex: fullDuplex adminSpeed: 1gbps adminState: disabled autoNegotiation: 'yes' mediaType: rj45 name: Ethernet1/4 operationalSpeed: 10mbps operationalState: up portType: data type: PhysicalInterface - adminDuplex: fullDuplex adminSpeed: 1gbps adminState: disabled autoNegotiation: 'yes' mediaType: rj45 name: Ethernet1/3 operationalSpeed: 1gbps operationalState: up portType: data type: PhysicalInterface - adminDuplex: fullDuplex adminSpeed: 1gbps adminState: enabled autoNegotiation: 'yes' mediaType: rj45 name: Ethernet1/2 operationalSpeed: 1gbps operationalState: up portType: data type: PhysicalInterface - adminDuplex: fullDuplex adminSpeed: 1gbps adminState: enabled autoNegotiation: 'yes' mediaType: rj45 name: Ethernet1/1 operationalSpeed: 1gbps operationalState: up portType: data type: PhysicalInterface - adminDuplex: fullDuplex adminSpeed: 1gbps adminState: enabled autoNegotiation: 'yes' mediaType: rj45 name: Port-channel48 operationalSpeed: 1gbps operationalState: up portType: data type: EtherChannelInterface modifiedTime: '2022-07-05T06:39:25Z' type: InterfaceSummary links: self: /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/interfacesummary?offset=0&limit=25 paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisInterfaceSummaryListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/inventorysummary: get: deprecated: false description: '**Get Inventory summary data from the chassis.**' operationId: getChassisInventorySummary parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/inventorysummary ( Example payload for GET on Chassis Inventory Summary )' : value: items: - fanList: - id: 1 model: N/A module: 1 operability: operable operationalState: operable power: 'on' thermalStatus: ok tray: 1 vendor: N/A - id: 2 model: N/A module: 1 operability: operable operationalState: operable power: 'on' thermalStatus: ok tray: 1 vendor: N/A memoryList: - array: 1 bank: 0 capacity: 65536 id: 1 model: HMAA8GR7AJR4N-XN operability: operable operationalState: operable performance: ok power: not-supported serialNumber: 942ECC1A thermalStatus: ok vendor: Hynix modifiedTime: '2022-07-05T06:39:25Z' powerSupplyList: - id: 2 model: FPR2K-PWR-AC-400 operability: operable operationalState: operable serialNumber: LIT24452CCQ thermalStatus: ok vendor: Cisco Systems, Inc processorList: - id: 1 model: 49 AMD EPYC 7282 16-Core Processor operability: operable operationalState: operable thermalStatus: ok type: CPU vendor: AuthenticAMD securityModuleList: - availableCores: 24 id: 1 model: FPR-3120 operability: operable operationalState: ok serialNumber: FJC25111YAW totalCores: 32 vendor: Cisco Systems, Inc storageControllerList: - id: 1 model: FPR_SOFTRAID operability: unknown operationalState: unknown serialNumber: '1234567' storageLocalDisk: - id: 1 model: Micron_7300_MTFDHBE960TDF operability: operable serialNumber: MSA244302V7 thermalStatus: unknown vendor: Cisco Systems, Inc thermalStatus: unknown vendor: Cisco Systems Inc links: self: /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/inventorysummary?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisInventorySummaryListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/logicaldevices: get: deprecated: false description: '**Get the list of all logical devices available on the specified chassis.**' operationId: getAllLogicalDevice parameters: - description: Data from cache. This only applies to the UI. in: query name: useCache required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/logicaldevices ( Success: Test GET ALL success )' : value: items: - deviceRegistration: accessPolicy: id: name: AC Policy name type: AccessPolicy deviceGroup: id: name: DeviceGroup name type: DeviceGroup licenseCaps: - MALWARE - URLFilter - CARRIER - PROTECT externalPortLink: - id: name: Ethernet1/1 type: ChassisInterface - id: name: Ethernet2/2.1 type: ChassisInterface id: links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//logicaldevices/ managementBootstrap: adminPassword: adminPwd adminState: enabled dnsServers: 192.168.0.123 firepowerManagerIP: 192.168.1.32 firewallMode: Routed fqdn: fqdn ipv4: gateway: 192.168.3.68 ip: 192.168.3.78 mask: 255.255.255.0 natId: natId permitExpertMode: 'yes' registrationKey: regKey searchDomain: string name: ftd1 operationalState: string type: LogicalDevice - deviceRegistration: accessPolicy: id: name: AC Policy name type: AccessPolicy licenseCaps: - MALWARE - URLFilter - CARRIER - VPN id: links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//logicaldevices/ managementBootstrap: dnsServers: firepowerManagerIP: 192.168.1.21 firewallMode: Routed ipv4: gateway: 10.10.36.1 ip: 10.10.36.9 mask: 255.255.255.0 ipv6: {} permitExpertMode: 'yes' searchDomain: string name: ftd2 operationalState: string type: LogicalDevice links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//logicaldevices?offset=0&limit=25 paging: count: 7 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/LogicalDeviceListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis post: deprecated: false description: '**Create a logical device on the chassis. _Check the response section for applicable examples (if any)._**' operationId: createLogicalDevice parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/logicaldevices ( Success: Test POST success )' : value: deviceRegistration: accessPolicy: id: name: AC Policy name type: AccessPolicy deviceGroup: id: name: DeviceGroup name type: DeviceGroup licenseCaps: - MALWARE - URLFilter - CARRIER - PROTECT externalPortLink: - id: name: Ethernet1/1 type: ChassisInterface - id: name: Ethernet2/2.1 type: ChassisInterface managementBootstrap: adminPassword: adminPwd dnsServers: 192.168.0.123 firepowerManagerIP: 192.168.1.32 firewallMode: Routed fqdn: fqdn ipv4: gateway: 192.168.3.68 ip: 192.168.3.78 mask: 255.255.255.0 natId: natId permitExpertMode: 'yes' registrationKey: regKey searchDomain: string name: ftd1 type: LogicalDevice schema: $ref: '#/components/schemas/LogicalDevice' type: object description: The input representation of logical device Model. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/logicaldevices ( Success: Test POST success )' : value: deviceRegistration: accessPolicy: id: name: AC Policy name type: AccessPolicy deviceGroup: id: name: DeviceGroup name type: DeviceGroup licenseCaps: - MALWARE - URLFilter - CARRIER - PROTECT externalPortLink: - id: name: Ethernet1/1 type: ChassisInterface - id: name: Ethernet2/2.1 type: ChassisInterface id: links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//logicaldevices/ managementBootstrap: adminPassword: adminPwd dnsServers: 192.168.0.123 firepowerManagerIP: 192.168.1.32 firewallMode: Routed fqdn: fqdn ipv4: gateway: 192.168.3.68 ip: 192.168.3.78 mask: 255.255.255.0 natId: natId permitExpertMode: 'yes' registrationKey: regKey searchDomain: string name: ftd1 operationalState: string type: LogicalDevice schema: $ref: '#/components/schemas/LogicalDevice' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/logicaldevices/{objectId}: delete: deprecated: false description: '**Delete the specified logical device. _Check the response section for applicable examples (if any)._**' operationId: deleteLogicalDevice parameters: - description: UUID of the logical device. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/logicaldevices/{objectId} ( Success: Test DELETE success )' : value: deviceRegistration: accessPolicy: id: name: AC Policy name type: AccessPolicy deviceGroup: id: name: DeviceGroup name type: DeviceGroup licenseCaps: - MALWARE - URLFilter - CARRIER - VPN externalPortLink: - id: name: Ethernet1/1 type: ChassisInterface - id: name: Ethernet2/2.1 type: ChassisInterface id: links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//logicaldevices/ managementBootstrap: adminState: enabled dnsServers: 10.106.134.254 firepowerManagerIP: 10.10.15.221 firewallMode: routed ipv4: gateway: 10.10.2.129 ip: 10.10.2.166 mask: 255.255.255.192 ipv6: {} permitExpertMode: 'yes' searchDomain: string name: FTD2 type: LogicalDevice schema: $ref: '#/components/schemas/LogicalDevice' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis get: deprecated: false description: '**Get information on the specified logical device.**' operationId: getLogicalDevice parameters: - description: UUID of the logical device. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/logicaldevices/{objectId} ( Success: Test GET success )' : value: deviceRegistration: accessPolicy: id: name: AC Policy name type: AccessPolicy deviceGroup: id: name: DeviceGroup name type: DeviceGroup licenseCaps: - MALWARE - URLFilter - CARRIER - VPN externalPortLink: - id: name: Ethernet1/1 type: PhysicalInterface - id: name: Ethernet2/2.1 type: SubInterface id: links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//logicaldevices/ managementBootstrap: adminState: enabled dnsServers: firepowerManagerIP: 192.168.1.21 firewallMode: Routed ipv4: gateway: 10.10.36.1 ip: 10.10.36.9 mask: 255.255.255.0 ipv6: {} permitExpertMode: 'yes' searchDomain: string name: ftd2 type: LogicalDevice schema: $ref: '#/components/schemas/LogicalDevice' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis put: deprecated: false description: '**Modify the specified logical device. _Check the response section for applicable examples (if any)._**' operationId: updateLogicalDevice parameters: - description: UUID of the logical device. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/logicaldevices/{objectId} ( Success: Test PUT success )' : value: id: managementBootstrap: adminPassword: adminPwd adminState: enabled dnsServers: 192.168.0.123 firepowerManagerIP: 192.168.1.32 firewallMode: Routed fqdn: fqdn ipv4: gateway: 192.168.3.68 ip: 192.168.3.78 mask: 255.255.255.0 natId: natId permitExpertMode: 'yes' registrationKey: regKey searchDomain: string name: ftd1 type: LogicalDevice schema: $ref: '#/components/schemas/LogicalDevice' type: object description: The input representation of logical device Model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/logicaldevices/{objectId} ( Success: Test PUT success )' : value: deviceRegistration: accessPolicy: id: name: AC Policy name type: AccessPolicy deviceGroup: id: name: DeviceGroup name type: DeviceGroup licenseCaps: - MALWARE - URLFilter - CARRIER - PROTECT externalPortLink: - id: name: Ethernet1/1 type: ChassisInterface - id: name: Ethernet2/2.1 type: ChassisInterface id: links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//logicaldevices/ managementBootstrap: adminPassword: adminPwd adminState: enable dnsServers: 192.168.0.123 firepowerManagerIP: 192.168.1.32 firewallMode: Routed fqdn: fqdn ipv4: gateway: 192.168.3.68 ip: 192.168.3.78 mask: 255.255.255.0 natId: natId permitExpertMode: 'yes' registrationKey: regKey searchDomain: string name: ftd1 operationalState: string type: LogicalDevice schema: $ref: '#/components/schemas/LogicalDevice' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/networkmodules: get: deprecated: false description: '**Get a list of all network modules on the specified device.**' operationId: getAllNetworkModule parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/networkmodules?expanded=true ( GET All paginated on Network Modules with ?expanded=true )' : value: items: - description: 8-port 10 Gigabit Ethernet Expansion Module id: networkModuleUUID1 links: self: /api/fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/chassisUUID/networkmodules/networkModuleUUID1 metadata: domain: id: GlobalDomainUUID name: Global type: Domain timestamp: 1628473885490.0 model: FPR-X-NM-8X10G moduleState: ENABLED name: Network Module 2 numOfPorts: 8 operationState: online slotId: '2' type: NetworkModule vendor: Cisco Systems, Inc. - description: Cisco FPR 8X1G 8X10G 1RU Module id: networkModuleUUID2 links: self: /api/fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/chassisUUID/networkmodules/networkModuleUUID2 metadata: domain: id: GlobalDomainUUID name: Global type: Domain timestamp: 1628243571086.0 model: FPR-3120 moduleState: ENABLED name: Network Module 1 numOfPorts: 16 operationState: ok slotId: '1' type: NetworkModule vendor: Cisco Systems, Inc. - id: networkModuleUUID3 links: self: /api/fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/chassisUUID/networkmodules/networkModuleUUID3 metadata: domain: id: GlobalDomainUUID name: Global type: Domain timestamp: 1628243571086.0 moduleState: ENABLED name: Network Module 0 numOfPorts: 1 operationState: ok slotId: '0' type: NetworkModule links: self: /api/fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/chassisUUID/networkmodules?offset=0&limit=25&expanded=true paging: count: 3 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/NetworkModuleListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/networkmodules/{objectId}: get: deprecated: false description: '**Get information on the specified network module.**' operationId: getNetworkModule parameters: - description: UUID of the network module. in: path name: objectId required: true schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/networkmodules/networkModuleUUID ( Success: Test GET success )' : value: description: Cisco FPR 8X1G 8X10G 1RU Module id: networkModuleUUID links: self: /api/fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/chassisUUID/networkmodules/networkModuleUUID metadata: domain: id: GlobalDomainUUID name: Global type: Domain timestamp: 1628243571086.0 model: FPR-3120 moduleState: ENABLED name: Network Module 1 numOfPorts: 16 operationState: ok slotId: '1' type: NetworkModule vendor: Cisco Systems, Inc. schema: $ref: '#/components/schemas/NetworkModule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis put: deprecated: false description: '**Modify the specified network module. _Check the response section for applicable examples (if any)._**' operationId: updateNetworkModule parameters: - description: UUID of the network module. in: path name: objectId required: true schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/networkmodules/networkModuleUUID ( Example payload for PUT on Network Module )' : value: id: networkModuleUUID moduleState: DISABLED type: NetworkModule schema: $ref: '#/components/schemas/NetworkModule' type: object description: The input representation of network module model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/networkmodules/networkModuleUUID ( Example payload for PUT on Network Module )' : value: id: networkModuleUUID metadata: task: id: links: self: http://api/fmc_config/v1/domain/{domainUUID}/job/taskstatuses/jobId moduleState: DISABLED type: NetworkModule schema: $ref: '#/components/schemas/NetworkModule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/operational/breakoutinterfaces: post: deprecated: false description: '**Perform an interface breakout. _Check the response section for applicable examples (if any)._**' operationId: createBreakoutInterface parameters: - description: Boolean indicating whether to ignore warning alerts for the breakout operation. in: query name: ignoreWarning required: false schema: type: boolean - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/containerUUID/operational/breakoutinterfaces ( Success: POST method for BreakoutInterface with minimum required fields )' : value: targetInterfaces: - id: InterfaceId name: InterfaceName type: PhysicalInterface type: BreakoutInterface ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/containerUUID/operational/breakoutinterfaces ( Success: POST method for BreakoutInterface with breakout Type )' : value: breakOutType: requiredBreakoutType targetInterfaces: - id: InterfaceId name: InterfaceName type: PhysicalInterface type: BreakoutInterface schema: $ref: '#/components/schemas/BreakoutInterface' type: object description: The input representation of break interface model. required: true responses: '202': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/containerUUID/operational/breakoutinterfaces ( Success: POST method for BreakoutInterface with minimum required fields )' : value: metadata: task: id: TaskId links: self: /fmc_config/v1/domain/domainUUID/job/taskstatuses/taskStatusId targetInterfaces: - id: InterfaceId type: PhysicalInterface type: BreakoutInterface ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/containerUUID/operational/breakoutinterfaces ( Success: POST method for BreakoutInterface with breakout Type )' : value: metadata: task: id: TaskId links: self: /fmc_config/v1/domain/domainUUID/job/taskstatuses/taskStatusId targetInterfaces: - id: InterfaceId type: PhysicalInterface type: BreakoutInterface schema: $ref: '#/components/schemas/BreakoutInterface' type: object description: Accepted default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/operational/joininterfaces: post: deprecated: false description: '**Join an interface. _Check the response section for applicable examples (if any)._**' operationId: createJoinInterface parameters: - description: Boolean indicating whether to ignore warning alerts for the join operation. in: query name: ignoreWarning required: false schema: type: boolean - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/containerUUID/operational/joininterfaces ( Success: POST method for BreakoutInterface with minimum required fields )' : value: targetInterfaces: - id: InterfaceId name: InterfaceName type: PhysicalInterface type: JoinInterface schema: $ref: '#/components/schemas/JoinInterface' type: object description: The input representation of join interface model. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/JoinInterface' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/operational/syncnetworkmodule: put: deprecated: false description: '**Get network module data from FXOS and update Firewall Management Center. _Check the response section for applicable examples (if any)._**' operationId: updateNetworkModuleSync parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/operational/syncnetworkmodule ( Success: Test PUT method for NetworkModuleSync )' : value: syncStatus: NETWORK_MODULE_SYNC_SUCCESS type: NetworkModuleSync schema: $ref: '#/components/schemas/NetworkModuleSync' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/physicalinterfaces: get: deprecated: false description: '**Get the chassis Physical interface configurations.**' operationId: getAllPhysicalInterface parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/physicalinterfaces ( Success: Test GET ALL success )' : value: items: - adminState: DISABLED hardware: autoNegState: boolean duplex: FULL fecMode: AUTO speed: DETECT_SFP id: interfaceId2 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis/{container_UUID}/physicalinterfaces/{interfaceId2} metadata: isBreakoutCapable: boolean isSplitInterface: boolean mediaType: sfp sfpType: none supportedSpeed: TEN_GBPS,DETECT_SFP name: Ethernet2/2/2 portType: DATA type: PhysicalInterface - adminState: DISABLED hardware: autoNegState: boolean duplex: FULL fecMode: AUTO speed: DETECT_SFP id: interfaceId1 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis/{container_UUID}/physicalinterfaces/{interfaceId1} metadata: isBreakoutCapable: boolean isSplitInterface: boolean mediaType: sfp sfpType: none supportedSpeed: TEN_GBPS,DETECT_SFP name: Ethernet2/2/3 portType: DATA type: PhysicalInterface links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//physicalinterfaces?offset=0&limit=25 paging: count: 7 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/PhysicalInterfaceListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/physicalinterfaces/{interfaceUUID} : get: deprecated: false description: '**Get information on the specified physical interface.**' operationId: getPhysicalInterface parameters: - description: UUID of the chassis physical interface. in: path name: interfaceUUID required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain//chassis/fmcmanagedchassis/{container_UUID}/physicalinterfaces/{interfaceId1} ( Success: Test GET success )' : value: adminState: DISABLED hardware: autoNegState: boolean duplex: FULL fecMode: AUTO speed: DETECT_SFP id: interfaceId1 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis/{container_UUID}/physicalinterfaces/{interfaceId1} metadata: isBreakoutCapable: boolean isSplitInterface: boolean mediaType: sfp sfpType: none supportedSpeed: TEN_GBPS,DETECT_SFP name: Ethernet2/2/3 portType: DATA type: PhysicalInterface schema: $ref: '#/components/schemas/PhysicalInterface' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis put: deprecated: false description: '**Modify the specified physical interface. _Check the response section for applicable examples (if any)._**' operationId: updatePhysicalInterface parameters: - description: UUID of the chassis physical interface. in: path name: interfaceUUID required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/physicalinterfaces/{interfaceUUID} ( Success: Test PUT success )' : value: adminState: DISABLED hardware: autoNegState: true duplex: FULL fecMode: AUTO speed: DETECT_SFP id: name: Ethernet1/16 portType: DATA type: PhysicalInterface schema: $ref: '#/components/schemas/PhysicalInterface' type: object description: The input representation of chassis interface model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/physicalinterfaces/{interfaceUUID} ( Success: Test PUT success )' : value: adminState: DISABLED hardware: autoNegState: boolean duplex: FULL fecMode: AUTO speed: DETECT_SFP id: interfaceUUID name: Ethernet1/16 portType: DATA type: PhysicalInterface schema: $ref: '#/components/schemas/PhysicalInterface' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/snmpsettings: get: deprecated: false description: '**Get SNMP settings for a chassis.**' operationId: getAllChassisSnmpSettings parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/snmpsettings ( Example payload for GET ALL on SNMP Settings Policy )' : value: items: - id: snmpsettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/snmpsettings/snmpsettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 snmpAdminInstance: id: logicalDeviceUuid name: ftd3 type: LogicalDevice type: SnmpSetting links: self: /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/snmpsettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisSnmpSettingsListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/snmpsettings/{objectId}: get: deprecated: false description: '**Get detailed information for an SNMP settings policy.**' operationId: getChassisSnmpSettings parameters: - description: UUID for the SNMP settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/snmpsettings/{objectId} ( Example payload for GET on SnmpSettings policy )' : value: id: snmpsettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/snmpsettings/snmpsettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 snmpAdminInstance: id: logicalDeviceUuid name: ftd3 type: LogicalDevice type: SnmpSetting schema: $ref: '#/components/schemas/ChassisSnmpSettings' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis put: deprecated: false description: '**Modify the specified SNMP settings policy. _Check the response section for applicable examples (if any)._**' operationId: updateChassisSnmpSettings parameters: - description: UUID for the SNMP settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/snmpsettings/{objectId} ( Example payload for PUT on SNMP Settings Policy. )' : value: id: snmpsettingsUUID2 snmpAdminInstance: id: logicalDeviceUuid name: ftd3 type: LogicalDevice type: SnmpSetting schema: $ref: '#/components/schemas/ChassisSnmpSettings' type: object description: The input representation of SNMP settings policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/snmpsettings/{objectId} ( Example payload for PUT on SNMP Settings Policy. )' : value: id: snmpsettingsUUID2 links: self: /api/fmc_config/v1/domain/domainUUID/chassis/fmcmanagedchassis/containerUUID/snmpsettings/snmpsettingsUUID2 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain timestamp: 1640170486880.0 snmpAdminInstance: id: logicalDeviceUuid name: ftd3 type: LogicalDevice type: SnmpSetting schema: $ref: '#/components/schemas/ChassisSnmpSettings' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces: get: deprecated: false description: '**Get the chassis subinterface configurations.**' operationId: getAllSubInterface parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces ( Success: Test GET ALL success )' : value: items: - id: subInterfaceId1 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//subinterfaces/subInterfaceId1 name: Ethernet1/5.4 parentInterface: id: parentInterfaceuuid name: parentInterfaceName type: PhysicalInterface portType: DATA subIntfId: 4 type: SubInterface vlanId: 5 - id: subInterfaceId2 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//subinterfaces/subInterfaceId2 name: Ethernet1/1.1 parentInterface: id: parentInterfaceuuid name: parentInterfaceName type: PhysicalInterface portType: DATA subIntfId: 1 type: SubInterface vlanId: 1 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//subinterfaces?offset=0&limit=25 paging: count: 7 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SubInterfaceListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis post: deprecated: false description: '**Create a subinterface configuration on the chassis. _Check the response section for applicable examples (if any)._**' operationId: createSubInterface parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces ( Success: Test POST success )' : value: parentInterface: id: parentInterfaceuuid name: parentInterfaceName type: PhysicalInterface portType: DATA subIntfId: 4 type: SubInterface vlanId: 5 schema: $ref: '#/components/schemas/SubInterface' type: object description: The input representation of subinterface model. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces ( Success: Test POST success )' : value: id: subInterfaceUUID name: Ethernet1/5.4 parentInterface: id: parentInterfaceuuid name: Ethernet1/5 type: PhysicalInterface portType: DATA subIntfId: 4 type: SubInterface vlanId: 5 schema: $ref: '#/components/schemas/SubInterface' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces/{interfaceUUID}: get: deprecated: false description: '**Get information on the specified chassis subinterface configuration.**' operationId: getSubInterface parameters: - description: UUID of the chassis subinterface configuration. in: path name: interfaceUUID required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces/{subInterfaceId1} ( Success: Test GET success )' : value: id: subInterfaceId2 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//subinterfaces/subInterfaceId2 name: Ethernet1/1.1 parentInterface: id: parentInterfaceuuid name: parentInterfaceName type: PhysicalInterface portType: DATA subIntfId: 1 type: SubInterface vlanId: 1 schema: $ref: '#/components/schemas/SubInterface' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis put: deprecated: false description: '**Modify the specified chassis subinterface configuration. _Check the response section for applicable examples (if any)._**' operationId: updateSubInterface parameters: - description: UUID of the chassis subinterface configuration. in: path name: interfaceUUID required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces/{subInterfaceUUID} ( Success: Test PUT success )' : value: id: subInterfaceUUID parentInterface: id: parentInterfaceuuid name: parentInterfaceName type: PhysicalInterface portType: DATA subIntfId: 4 type: SubInterface vlanId: 5 schema: $ref: '#/components/schemas/SubInterface' type: object description: The input representation of subinterface model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces/{subInterfaceUUID} ( Success: Test PUT success )' : value: id: subInterfaceUUID parentInterface: id: parentInterfaceuuid name: parentInterfaceName type: PhysicalInterface portType: DATA subIntfId: 4 type: SubInterface vlanId: 5 schema: $ref: '#/components/schemas/SubInterface' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces/{objectId}: delete: deprecated: false description: '**Delete the specified chassis subinterface configuration. _Check the response section for applicable examples (if any)._**' operationId: deleteSubInterface parameters: - description: UUID of the chassis subinterface configuration. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{containerUUID}/subinterfaces/subInterfaceId2 ( Success: Test DELETE success )' : value: id: subInterfaceId2 links: self: /api/fmc_config/v1/domain//chassis/fmcmanagedchassis//subinterfaces/subInterfaceId2 name: Ethernet1/1.1 parentInterface: id: parentInterfaceuuid name: parentInterfaceName type: PhysicalInterface portType: DATA subIntfId: 1 type: SubInterface vlanId: 1 schema: $ref: '#/components/schemas/SubInterface' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/{objectId}: get: deprecated: false description: '**Get a list of all chassis managed devices from the Firewall Management Center**' operationId: getFMCManagedChassis parameters: - description: UUID of a chassis. in: path name: objectId required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/containerUUID ( Success: Test GET success )': value: chassisName: 192.168.0.74 id: chassisUUID isConnected: true links: self: /api/fmc_config/v1/domain/DomainUUID/chassis/fmcmanagedchassis/chassisUUID metadata: domain: id: GlobalDomainUUID name: Global type: Domain model: Cisco Secure Firewall 3120 Threat Defense type: FMCManagedChassis schema: $ref: '#/components/schemas/FMCManagedChassis' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/operational/switchmode: post: deprecated: false description: '**Operational API to convert a Chassis Mode from Native to Multi-Instance _Check the response section for applicable examples (if any)._**' operationId: createChassisConversionModel parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/operational/switchmode ( Success: Chassis Conversion )' : value: conversionType: NATIVE_TO_MULTI_INSTANCE items: - displayName: BLR_CHASSIS id: 4d5bdd84-431c-11ee-aa3b-94ac3daed36c schema: $ref: '#/components/schemas/ChassisConversionModel' type: object description: The input Chassis Conversion Model. required: true responses: '202': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/operational/switchmode ( Success: Chassis Conversion )' : value: conversionType: NATIVE_TO_MULTI_INSTANCE items: - displayName: BLR_CHASSIS id: 4d5bdd84-431c-11ee-aa3b-94ac3daed36c metadata: task: id: '223338299442' message: Chassis Conversion task is started, the progress can be tracked with Status API /job/taskstatuses/223338299442 status: RUNNING taskType: CHASSIS_CONVERSION_REQUEST type: TaskStatus schema: $ref: '#/components/schemas/ChassisConversionModel' type: object description: Accepted default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/operational/switchmodereadinesscheck: post: deprecated: false description: '**Check if a device or devices are ready to convert to multi-instance mode. _Check the response section for applicable examples (if any)._**' operationId: createDeviceConversionReadinessModel parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/operational/switchmodereadinesscheck ( Success: Chassis is ready for conversion )' : value: conversionType: NATIVE_TO_MULTI_INSTANCE devices: - id: DeviceUUID1 type: Device schema: $ref: '#/components/schemas/DeviceConversionReadinessModel' type: object description: The input DeviceSwitchModeReadiness Model required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/{domainUUID}/chassis/fmcmanagedchassis/operational/switchmodereadinesscheck ( Success: Chassis is ready for conversion )' : value: conversionType: NATIVE_TO_MULTI_INSTANCE devices: - id: DeviceUUID1 readinessStatus: errorMsgs: - Device deployment is going on, try after some time status: NOT-READY type: Device schema: $ref: '#/components/schemas/DeviceConversionReadinessModel' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Chassis servers: - url: https://api.us.security.cisco.com/firewall description: US - url: https://api.eu.security.cisco.com/firewall description: EU - url: https://api.apj.security.cisco.com/firewall description: APJ - url: https://api.au.security.cisco.com/firewall description: AUS - url: https://api.in.security.cisco.com/firewall description: IN - url: https://api.int.security.cisco.com/firewall description: Staging - url: https://scale.manage.security.cisco.com/api/rest description: Scale - url: https://ci.manage.security.cisco.com/api/rest description: CI - url: https://manage.stg.secure.cisco/api/rest description: Stgf9 components: schemas: NetworkModuleListContainer: properties: items: $ref: '#/components/schemas/NetworkModule' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object SubInterfaceListContainer: properties: items: $ref: '#/components/schemas/SubInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IMetadataUser: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object ReferenceObject: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object ChassisProcessor: properties: id: format: int32 type: integer model: type: string operability: type: string operationalState: type: string serialNumber: type: string thermalStatus: type: string type: type: string vendor: type: string type: object ChassisInterfaceEvent: properties: action: enum: - SYNC_WITH_DEVICE - ACCEPT_CHANGES type: string change: type: string description: type: string hasPendingChanges: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string state: enum: - DISASSOCIATED - ASSOCIATED - MODIFIED type: string type: type: string version: type: string type: object ChassisPowerSupply: properties: id: format: int32 type: integer model: type: string operability: type: string operationalState: type: string serialNumber: type: string thermalStatus: type: string vendor: type: string type: object DeviceGroup: description: A model representing a DeviceGroup. properties: description: description: 'User provided resource description. ' type: string id: description: Unique identifier of response object. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing related links. type: object members: description: Represents devices included in group. items: $ref: '#/components/schemas/IBaseDevice' type: object type: array metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata properties of DeviceGroup. type: object name: description: User assigned resource name. type: string type: description: 'Response object associated with resource: DeviceGroup.' type: string version: description: Version number of the response object. type: string type: object JoinInterface: properties: description: type: string id: type: string ignoreWarning: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/EpmRequestMetadata' type: object name: type: string targetInterfaces: items: $ref: '#/components/schemas/IReference' type: object type: array type: type: string version: type: string type: object DeviceAcessPolicy: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object LogicalDevice: description: Logical Device Model for Chassis properties: adminState: description: Admin State of the Logical Device. Possible values are 'enabled'/'disabled' type: string description: type: string deviceRegistration: $ref: '#/components/schemas/DeviceRegistration' type: object externalPortLink: description: Interface assignment to the Logical Device. Atleast one interface should be assigned items: $ref: '#/components/schemas/ExternalPortLink' type: object type: array ftdApplicationVersion: description: FTD version. This is applicable only for CREATE request type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object logicalDeviceMode: type: string managementBootstrap: $ref: '#/components/schemas/MgmtBootstrap' type: object metadata: $ref: '#/components/schemas/LogicalDeviceMetadata' type: object name: description: Logical Device name. This is applicable only for CREATE request type: string operationalState: type: string resourceProfile: $ref: '#/components/schemas/ReferenceObject' description: Resource Profile assigned to the Logical Device type: object type: type: string version: type: string type: object HealthModule: properties: alertConfig: items: $ref: '#/components/schemas/HealthAlertConfig' type: object type: array alertEnabled: type: boolean criticalThreshold: format: int32 type: integer customThresholds: items: $ref: '#/components/schemas/HealthThreshold' type: object type: array enabled: type: boolean moduleId: type: string severity: type: string type: type: string warningThreshold: format: int32 type: integer type: object PhysicalInterface: properties: adminState: enum: - ENABLED - DISABLED - ONLINE - BUSY - ENABLE_IN_PROGRESS - DISABLE_IN_PROGRESS type: string channelGroupId: format: int32 type: integer description: type: string hardware: $ref: '#/components/schemas/IInterfaceHardwareContainer' type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string portType: enum: - DATA - DATA_SHARING type: string type: type: string version: type: string type: object ChassisAllInterfacesModelListContainer: properties: items: $ref: '#/components/schemas/ChassisAllInterfacesModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ChassisAllInterfacesModel: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string type: object ChassisStorageController: properties: id: format: int32 type: integer model: type: string operability: type: string operationalState: type: string partNumber: type: string serialNumber: type: string storageLocalDisk: items: $ref: '#/components/schemas/ChassisStorageLocalDisk' type: object type: array thermalStatus: type: string vendor: type: string type: object SummaryInterfaceModel: properties: adminDuplex: type: string adminSpeed: type: string adminState: type: string autoNegotiation: type: string mediaType: type: string name: type: string operationalSpeed: type: string operationalState: type: string portType: type: string receivedBytes: type: string transmittedBytes: type: string type: type: string type: object SummaryInstanceModel: properties: adminState: type: string coresUsed: format: int32 type: integer deployType: type: string ipv4: $ref: '#/components/schemas/IPV4' type: object ipv6: $ref: '#/components/schemas/IPV6' type: object managementPort: type: string name: type: string operationalState: type: string slotId: type: string startupVersion: type: string type: object ChassisSnmpSettings: description: Description of Chassis SnmpSettings policy properties: description: type: string id: description: Unique Identifier of the Snmp Settings Policy. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the Snmp Settings policy. type: object name: type: string snmpAdminInstance: $ref: '#/components/schemas/LogicalDevicePolicy' description: Details of the logical device that is SNMP Admin Instance type: object type: description: Type of the Snmp Settings policy; this value is always SnmpSetting. type: string version: type: string type: object ErrorMessagesContainer: properties: bulkPayloadIndex: description: More details about the error. type: string code: description: More details about the error. type: string description: description: More details about the error. type: string details: description: More details about the error. type: string errorCode: description: More details about the error. type: string location: description: More details about the error. type: string severity: description: Specifies the Highest level severity among all the error messages. enum: - ERROR - WARN type: string type: object ChassisSnmpSettingsListContainer: properties: items: $ref: '#/components/schemas/ChassisSnmpSettings' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ReadOnly: description: Defines the read only conditions if the referenced resource is read only. properties: reason: description: Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain). enum: - RBAC - SYSTEM - DOMAIN type: string state: description: True if this resource us read only and false otherwise. type: boolean type: object ChassisFaultSummary: properties: description: type: string faultList: description: List of all faults on the chassis items: $ref: '#/components/schemas/SummaryFaultModel' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object modifiedTime: description: Time (in ISO 8601 format) when this fault data was obtained from chassis type: string name: type: string type: description: Type of the fault summary. This is always FaultSummary type: string version: type: string type: object FMCManagedChassis: description: Represents the chassis of the FMC Managed Device. properties: chassisHostName: type: string chassisMode: description: Describes the mode of the chassis, native/multi-instance enum: - MULTIINSTANCE - NATIVE - MULTIINSTANCE_LEGACY type: string chassisName: description: Describes the name of the chassis. type: string description: type: string deviceGroup: $ref: '#/components/schemas/DeviceGroup' description: Refers to the device group type: object id: description: UUID of the chassis. type: string isConnected: description: Tells if the device is connected to FMC or not type: boolean links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes of the Device. type: object model: description: Describes model type of the chassis. type: string modelNumber: description: Model number of the registered device. type: string natID: description: Unique ID for a Network address translation (NAT) (optional; used for chassis registration). If the chassis to be registered and the Firepower Management Center are separated by a NAT device, enter a unique NAT ID. type: string regKey: description: Registration Key that you entered while configuring FMC on the device. type: string swBuild: type: string swVersion: description: Chassis version type: string type: description: Type of the payload. This will always be FMCManagedChassis. type: string version: type: string required: - regKey type: object Domain: description: The details about the domain. properties: id: description: Unique UUID of this domain type: string links: $ref: '#/components/schemas/ILinks' description: Links to the domain resource URLs. type: object name: description: Name of the domain. type: string type: description: Domain type definition (fixed). type: string uuid: type: string type: object SummaryFaultModel: properties: cause: type: string code: type: string createdTime: type: string description: type: string highestSeverity: type: string id: format: int32 type: integer isAcknowledged: type: string lastTransitionTime: type: string occurrence: type: string severity: type: string type: object Metadata: description: Defines read only details about the object - whether it is system defined, last user who modified the object etc. properties: domain: $ref: '#/components/schemas/Domain' description: Defines the domains this instance belongs to (if applicable). type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' description: The last user who modified this instance. type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' description: Details regarding the read only status of this instance type: object timestamp: description: The last updated timestamp. format: int32 type: integer type: object MetadataUser: description: This object defines details about the user. properties: id: description: The unique UUID of the user type: string links: $ref: '#/components/schemas/ILinks' description: Contains the self referencing links to this resource type: object name: description: Name of the user. type: string type: description: The user type (fixed). type: string type: object ExternalPortLink: properties: id: type: string name: type: string portType: type: string type: type: string type: object ErrorResponse: properties: category: description: Describes the category of the error thrown. enum: - FRAMEWORK - OTHER - VALIDATION type: string messages: description: List of error messages which the response has. items: $ref: '#/components/schemas/ErrorMessagesContainer' type: object type: array severity: description: Specifies the Highest level severity among all the error messages. enum: - ERROR - WARN type: string type: object EvaluateChassisOperationListContainer: properties: items: $ref: '#/components/schemas/EvaluateChassisOperation' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object BreakoutInterface: properties: breakOutType: enum: - FOUR_X_TEN - FOUR_X_TEN_TWENTYFIVE - FOUR_X_HUNDRED - TWO_X_HUNDRED - TWO_X_TWOHUNDRED type: string description: type: string id: type: string ignoreWarning: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/EpmRequestMetadata' type: object name: type: string targetInterfaces: items: $ref: '#/components/schemas/IReference' type: object type: array type: type: string version: type: string type: object ChassisInterfaceSummaryListContainer: properties: items: $ref: '#/components/schemas/ChassisInterfaceSummary' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DeviceConversionReadinessDeviceEntity: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string readinessStatus: $ref: '#/components/schemas/DeviceConversionReadinessData' type: object type: type: string type: object LogicalDeviceListContainer: properties: items: $ref: '#/components/schemas/LogicalDevice' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DeviceRegistration: description: Data required for auto registration. This is applicable only for CREATE request properties: accessPolicy: $ref: '#/components/schemas/DeviceAcessPolicy' type: object deviceGroup: $ref: '#/components/schemas/ReferenceObject' type: object licenseCaps: description: Licenses assigned to the Logical Device items: type: string type: array platformSettings: $ref: '#/components/schemas/ReferenceObject' type: object type: object IMetadata: properties: domain: $ref: '#/components/schemas/IDomain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/IMetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/IReadonly' type: object timestamp: format: int32 type: integer type: object ChassisAppInfoListContainer: properties: items: $ref: '#/components/schemas/ChassisAppInfo' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IHealthPolicy: description: Description of Health Policy. properties: basePolicyID: type: string defaultPolicy: type: boolean description: description: Description of Health Policy. type: string healthModules: items: $ref: '#/components/schemas/HealthModule' type: object type: array id: description: Unique identifier (UUID) representing the Health policy. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the Health policy. type: object name: description: User-specified name of the Health policy. type: string policyType: type: string setting: $ref: '#/components/schemas/HealthSetting' type: object type: description: Type of the Health policy; this value is always HealthPolicy. type: string version: description: Version number of the response object. type: string type: object ChassisInstanceSummaryListContainer: properties: items: $ref: '#/components/schemas/ChassisInstanceSummary' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object FMCManagedChassisListContainer: properties: items: $ref: '#/components/schemas/FMCManagedChassis' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object TaskStatus: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object message: type: string metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string showDetailedDeviceStatus: type: string status: type: string subTasks: items: $ref: '#/components/schemas/ISubTask' type: object type: array taskType: enum: - DEVICE_REGISTRATION - SMART_LICENSE - DEVICE_DEPLOYMENT - DEVICE_ROLLBACK - NGFWHA_OPERATIONS - COPY_CONFIG_REQUEST - HIT_COUNT_REFRESH - FTD_CLUSTER_BOOTSTRAP - FTD_CLUSTER_CREATE - FTD_CLUSTER_BREAK - FTD_CLUSTER_ADD_NODES - FTD_CLUSTER_REMOVE_NODES - DEVICE_BACKUP - FTD_CLUSTER_UPDATE_BOOTSTRAP - FTD_CLUSTER_COMMAND - SSP_EPM_OIR - SSP_EPM_BREAKOUT_DEPLOY - DEVICE_EXPORT - DEVICE_IMPORT - POLICY_EXPORT - CHASSIS_REGISTRATION - CHANGE_MANAGER - CONFIGURE_DEVICE_VALIDATE - CONFIGURE_DEVICE - CONFIGURE_MANAGER - CONFIGURE_MANAGER_ADD - CONFIGURE_MANAGER_DELETE - INITIATE_MIGRATION - DISCARD_MIGRATION - SWITCH_TO_ANALYTICS - DELETE_DEVICE - GENERATE_REPORTS - FLEXCONFIG_MIGRATION - DEVICE_UNREGISTRATION - PENDING_CHANGES_REQUEST - DEVICE_TROUBLESHOOT - DEVICE_MODEL_MIGRATION - DEVICE_TEMPLATE_CREATION - CHASSIS_CONVERSION_REQUEST - SNORT_PROFILER - CPU_PROFILER - POLICY_REPORT_GENERATION - DEVICE_TEMPLATE_APPLY - LTP_ONBOARDING - POLICY_CLONE_OPERATION - DEVICE_CERTIFICATE_MANAGEMENT - OOB_CHANGES_REQUEST - UPLOAD_TROUBLESHOOT type: string type: type: string type: object ChassisConversionModel: properties: conversionType: enum: - NATIVE_TO_MULTI_INSTANCE type: string description: type: string id: type: string items: items: $ref: '#/components/schemas/ChassisConversionDeviceModel' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/ChassisConversionMetadata' type: object name: type: string type: type: string version: type: string type: object IInterfaceHardwareContainer: properties: autoNegState: type: boolean duplex: enum: - AUTO - FULL - HALF type: string fecMode: enum: - AUTO - CL108RS - CL74FC - CL91RS - DISABLE type: string speed: enum: - AUTO - TEN_MBPS - HUNDRED_MBPS - ONE_GBPS - TEN_GBPS - TWENTY_FIVE_GBPS - FORTY_GBPS - HUNDRED_GBPS - TWO_HUNDRED_GBPS - FOUR_HUNDRED_GBPS - DETECT_SFP type: string type: object HealthAlertConfig: properties: enabled: type: boolean name: type: string thresholds: items: $ref: '#/components/schemas/HealthThreshold' type: object type: array type: object ChassisConversionMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object task: $ref: '#/components/schemas/TaskStatus' type: object timestamp: format: int32 type: integer type: object IPolicyModel: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object HealthSetting: properties: alertEvaluationInterval: format: int32 type: integer certFileContent: type: string certFileName: type: string certFileType: type: string certPassphrase: type: string configType: type: string dataCollectionInterval: format: int32 type: integer dialInHosts: items: $ref: '#/components/schemas/DialHost' type: object type: array dialOutHosts: items: $ref: '#/components/schemas/DialHost' type: object type: array enabledOpenConfig: type: boolean grpcPassword: type: string grpcUsername: type: string readOnly: type: boolean type: object ChassisConversionDeviceModel: description: Represents the payload required for a Device for Chassis Conversion properties: displayName: description: Display name of the device after conversion type: string id: description: UUID of the Device type: string ipv4: $ref: '#/components/schemas/IPV4' description: IPv4 bootstrap details for the device after conversion type: object ipv6: $ref: '#/components/schemas/IPV6' description: IPv6 bootstrap details for the device after conversion type: object natID: type: string regKey: type: string type: object EtherChannelInterface: properties: adminState: enum: - ENABLED - DISABLED - ONLINE - BUSY - ENABLE_IN_PROGRESS - DISABLE_IN_PROGRESS type: string description: type: string etherChannelId: format: int32 type: integer hardware: $ref: '#/components/schemas/IInterfaceHardwareContainer' type: object id: type: string lacpMode: enum: - ACTIVE - 'ON' - PASSIVE type: string lacpRate: enum: - DEFAULT - FAST - NORMAL type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string portType: enum: - DATA - DATA_SHARING type: string selectedInterfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array type: type: string version: type: string type: object IReference: description: Contains reference information. properties: id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object name: description: User chosen resource name. type: string type: description: Response object associated with resource. type: string type: object ChassisInterfaceSummary: properties: description: type: string id: type: string interfaceList: description: List of all interfaces on the chassis items: $ref: '#/components/schemas/SummaryInterfaceModel' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object modifiedTime: description: Time (in ISO 8601 format) when this interface data was obtained from chassis type: string name: type: string type: description: Type of the interface summary. This is always InterfaceSummary type: string version: type: string type: object SubInterface: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string parentInterface: $ref: '#/components/schemas/IFTDInterface' type: object portType: enum: - DATA - DATA_SHARING type: string subIntfId: format: int32 type: integer type: type: string version: type: string vlanId: format: int32 type: integer type: object LogicalDeviceMetadata: properties: containerDetails: $ref: '#/components/schemas/IBaseDevice' type: object deviceRecordDetails: $ref: '#/components/schemas/IReference' type: object domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer type: object IAdvanced: properties: enableOGS: type: boolean type: object ITarget: description: This is the target device. properties: description: type: string id: description: Unique ID of the device. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: description: Name of the device. type: string type: description: Device type: string version: type: string type: object IPV4: description: IPv4 details properties: gateway: description: IPv4 Gateway type: string ip: description: IPv4 IP Address type: string mask: description: IPv4 Netmask type: string type: object ChassisInterfaceMetadata: properties: breakoutCapability: type: string breakoutFactor: type: string breakoutType: enum: - FOUR_X_TEN - FOUR_X_TEN_TWENTYFIVE - FOUR_X_HUNDRED - TWO_X_HUNDRED - TWO_X_TWOHUNDRED type: string domain: $ref: '#/components/schemas/Domain' type: object instances: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array isBreakOutCapable: type: boolean isBreakoutCapable: type: boolean isLocked: type: boolean isSplitInterface: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object lockingStatus: $ref: '#/components/schemas/IPolicyLockData' type: object matches: items: type: string type: array mediaType: type: string netModEventState: type: string readOnly: $ref: '#/components/schemas/ReadOnly' type: object sfpType: type: string sfptype: type: string supportedSpeed: type: string timestamp: format: int32 type: integer type: object EpmRequestMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object task: $ref: '#/components/schemas/TaskStatus' type: object timestamp: format: int32 type: integer type: object ChassisFaultSummaryListContainer: properties: items: $ref: '#/components/schemas/ChassisFaultSummary' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object NetworkModuleSync: description: Represents sync status of the Network Modules. properties: metadata: $ref: '#/components/schemas/Metadata' type: object syncStatus: description: Describes the status of the Sync operation. type: string type: description: Payload type. This will always be NetworkModuleSync. type: string type: object ChassisInstanceSummary: description: Description of Chassis Instance Summary api properties: description: type: string id: type: string instanceList: description: List of all instances on the chassis items: $ref: '#/components/schemas/SummaryInstanceModel' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object modifiedTime: description: Time (in ISO 8601 format) when this instance data was obtained from chassis type: string name: type: string type: description: Type of the instance summary. This is always InstanceSummary type: string version: type: string type: object IUsageData: properties: action: type: string cause: type: string conflictType: type: string description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string policyGroupInfo: $ref: '#/components/schemas/IReference' type: object severity: type: string type: type: string type: object NetworkModule: description: Represents the Network Module of the Chassis. properties: description: description: A one line description of the EPM. type: string id: description: Describes the UUID of the module object. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object model: description: Model of the EPM inserted. type: string moduleState: description: User configurable setting to power On/Off EPM (permissible values enabled/disabled). enum: - ENABLED - DISABLED - ONLINE - BUSY - ENABLE_IN_PROGRESS - DISABLE_IN_PROGRESS type: string name: description: Name of the Network Module. type: string numOfPorts: description: Number of Ports present on EPM, Maryland has 4 ports, Brentwood has 8 ports. format: int32 type: integer operationState: description: Operation State returned by FXOS, (sample values operable/inoperable/degraded/powered-off/power-problem/voltage-problem/thermal-problem/performance-problem/accessibility-problem/disabled ). type: string slotId: description: ' Slot ID of the EPM slot.' type: string type: description: Payload type. This will always be NetworkModule. type: string vendor: description: Describes the vendor name of the module. type: string version: type: string type: object ISubTask: properties: description: type: string id: type: string message: type: string metadata: $ref: '#/components/schemas/IMetadata' type: object status: type: string target: $ref: '#/components/schemas/ITarget' type: object type: object ChassisInterfaceListContainer: properties: items: $ref: '#/components/schemas/ChassisInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPolicyLockData: description: Represents information about a policy's lock status. properties: lock: description: Boolean indicating whether the policy must be locked or unlocked. When set to 'true' policy is locked and when set to 'false' will unlock the policy. type: boolean lockParentsInHierarchy: description: Boolean indicating whether the policy and all parents in hierarchy must be locked or unlocked. When set to 'true' policy and parents in hierarchy are locked and will 'unlock' when set to false. type: boolean metadata: $ref: '#/components/schemas/IPolicyLockMetadata' description: Object representing metadata attributes for Policy Lock. type: object policy: $ref: '#/components/schemas/IReference' description: specifies the details of the policy which was locked type: object status: description: String indicating whether the policy is locked enum: - LOCKED - UNLOCKED type: string type: description: Type must be PolicyLock type: string required: - policy - status - type type: object ChassisInterface: description: Represents ChassisInterface attributes. properties: autoNegState: description: Describes the auto negotiation state of the interface. type: string duplex: description: Describes the duplex value of the interface. enum: - AUTO - FULL - HALF type: string fecvalue: description: Describes the Forward Error Correction value of the chassis interface. enum: - AUTO - CL108RS - CL74FC - CL91RS - DISABLE type: string id: description: UUID of the chassis interface. type: string isBreakOutCapable: type: boolean isSplitInterface: type: boolean links: $ref: '#/components/schemas/ILinks' type: object mediaType: description: Describes the media type of the interface type: string metadata: $ref: '#/components/schemas/ChassisInterfaceMetadata' type: object name: type: string portType: enum: - DATA - DATA_SHARING type: string sfptype: description: Describes the sfp type of the interface. type: string speed: description: Describes the administration speed of the interface. type: string type: description: Type of the payload. This will always be ChassisInterface. type: string type: object ChassisInterfaceEventListContainer: properties: items: $ref: '#/components/schemas/ChassisInterfaceEvent' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ChassisSecurityModule: properties: availableCores: format: int32 type: integer id: format: int32 type: integer model: type: string operability: type: string operationalState: type: string partNumber: type: string serialNumber: type: string totalCores: format: int32 type: integer vendor: type: string type: object ChassisMemory: properties: array: format: int32 type: integer bank: format: int32 type: integer capacity: format: int32 type: integer id: format: int32 type: integer location: type: string model: type: string operability: type: string operationalState: type: string performance: type: string power: type: string serialNumber: type: string thermalStatus: type: string vendor: type: string type: object IPV6: description: IPv6 details properties: gateway: description: IPv6 gateway type: string ip: description: IPv6 IP Address type: string prefixLength: description: IPv6 prefix length type: string type: object LogicalDevicePolicy: properties: id: type: string name: type: string type: type: string type: object IReadonly: properties: reason: enum: - RBAC - SYSTEM - DOMAIN type: string state: type: boolean type: object ChassisFan: properties: id: format: int32 type: integer model: type: string module: format: int32 type: integer operability: type: string operationalState: type: string power: type: string serialNumber: type: string thermalStatus: type: string tray: format: int32 type: integer vendor: type: string type: object ILinks: description: This defines the self referencing links for the given resource. properties: parent: description: Full resource URL path to reference the parent (if any) for this resource. type: string self: description: Full resource URL path to reference this particular resource. type: string type: object IFTDInterface: properties: description: type: string id: type: string ifname: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object MgmtBootstrap: description: Management bootstrap for Logical Device properties: adminPassword: description: Admin Password to login to the FTD. This is applicable only for CREATE request type: string dnsServers: type: string firepowerManagerIP: description: Manager IP to manage the FTD from type: string firewallMode: description: Firewall Mode for Logical Device. Possible values are 'routed'/'transparent' type: string fqdn: description: FQDN configuration for the Logical Device. This is applicable only for CREATE request type: string ipv4: $ref: '#/components/schemas/IPV4' description: IPv4 details for Logical Device. This is applicable only for CREATE request type: object ipv6: $ref: '#/components/schemas/IPV6' description: IPv6 details for Logical Device. This is applicable only for CREATE request type: object natId: type: string permitExpertMode: description: Permit Expert mode for CLI. Possible values are 'yes'/'no' type: string registrationKey: type: string searchDomain: type: string type: object DialHost: properties: host: type: string port: format: int32 type: integer type: object HealthThreshold: properties: type: type: string value: format: int32 type: integer type: object ChassisInventorySummary: properties: description: type: string fanList: description: List of all fans on the chassis items: $ref: '#/components/schemas/ChassisFan' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object memoryList: description: List of all memory units on the chassis items: $ref: '#/components/schemas/ChassisMemory' type: object type: array metadata: $ref: '#/components/schemas/Metadata' type: object modifiedTime: description: Time (in ISO 8601 format) when this inventory data was obtained from chassis type: string name: type: string powerSupplyList: description: List of all power supplies on the chassis items: $ref: '#/components/schemas/ChassisPowerSupply' type: object type: array processorList: description: List of all processors on the chassis items: $ref: '#/components/schemas/ChassisProcessor' type: object type: array securityModuleList: description: List of all security modules on the chassis items: $ref: '#/components/schemas/ChassisSecurityModule' type: object type: array storageControllerList: description: List of all storage controllers on the chassis items: $ref: '#/components/schemas/ChassisStorageController' type: object type: array type: description: Type of the inventory summary. This is always InventorySummary type: string version: type: string type: object PhysicalInterfaceListContainer: properties: items: $ref: '#/components/schemas/PhysicalInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ChassisInventorySummaryListContainer: properties: items: $ref: '#/components/schemas/ChassisInventorySummary' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object EtherChannelInterfaceListContainer: properties: items: $ref: '#/components/schemas/EtherChannelInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object PagingContainer: properties: count: format: int32 type: integer limit: format: int32 type: integer offset: format: int32 type: integer pages: format: int32 type: integer type: object DeviceConversionReadinessData: properties: errorMsgs: items: type: string type: array status: enum: - READY - NOT_READY type: string type: object IDomain: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object IBaseDevice: properties: accessPolicy: $ref: '#/components/schemas/IPolicyModel' type: object advanced: $ref: '#/components/schemas/IAdvanced' type: object description: type: string healthMessage: type: string healthPolicy: $ref: '#/components/schemas/IHealthPolicy' type: object healthStatus: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object model: type: string modelId: type: string modelNumber: type: string modelType: type: string name: type: string role: type: string status: type: string sw_version: type: string type: type: string version: type: string type: object IPolicyLockMetadata: description: Represents the information of the Metadata for Policy lock properties: domain: $ref: '#/components/schemas/IDomain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/IMetadataUser' type: object lockedByUser: $ref: '#/components/schemas/IMetadataUser' description: String indicating the user who has locked the policy. This field will be empty if the policy is not locked. type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/IReadonly' type: object timestamp: format: int32 type: integer required: - lockedByUser type: object DeviceConversionReadinessModel: description: Represents the payload required to check readiness of Devices for Conversion properties: conversionType: description: Conversion type enum: - NATIVE_TO_MULTI_INSTANCE type: string description: type: string devices: description: List of devices which user wants to verify for conversion items: $ref: '#/components/schemas/DeviceConversionReadinessDeviceEntity' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object ChassisAppInfo: properties: appVersion: description: Image version type: string description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: description: Type of the data. This will be AppInfo type: string version: type: string type: object ChassisStorageLocalDisk: properties: id: format: int32 type: integer model: type: string operability: type: string serialNumber: type: string thermalStatus: type: string vendor: type: string type: object EvaluateChassisOperation: properties: breakoutType: type: string breakoutTypeSelected: type: string description: type: string evaluateAction: type: string id: type: string interfaceUUID: type: string interfaceUsages: items: $ref: '#/components/schemas/IUsageData' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string operationType: type: string readinessState: enum: - READY - NOT_READY - READY_WITH_WARNING type: string type: type: string version: type: string type: object parameters: expanded: description: If set to true, the GET response displays a list of objects with additional attributes. in: query name: expanded required: false schema: type: boolean offset: description: Index of first item to return. in: query name: offset required: false schema: format: int32 type: integer domainUUID: description: Domain UUID in: path name: domainUUID required: true schema: type: string limit: description: Number of items to return. in: query name: limit required: false schema: format: int32 type: integer securitySchemes: bearerAuth: bearerFormat: JWT scheme: bearer type: http x-refined-from: - cdfmc-openapi.yaml - cisco-secure-firewall-cdfmc-openapi.yml