Cisco Secure Firewall Device HA Pairs API

The Device HA Pairs API from Cisco Secure Firewall — 6 operation(s) for device ha pairs.

OpenAPI Specification

cisco-secure-firewall-device-ha-pairs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cisco Secure Firewall Device HA Pairs API
  version: 1.13.0
  contact:
    name: Cisco Firepower TAC
    email: ngfw-support@cisco.com
  description: 'Operations tagged Device HA Pairs 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: 13/13
  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: Device HA Pairs
paths:
  /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs:
    get:
      deprecated: false
      description: '**Get a list of all Firewall Threat Defense High Availability pairs.**'
      operationId: getAllFTDHADeviceContainer
      parameters:
      - description: Filter for analytics only HA<br/><code>analyticsOnly</code> -- Allowed values are <code>{true|false}</code><br/>
        in: query
        name: filter
        required: false
        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/devicehapairs/ftddevicehapairs ( Get all paginated HA
                  container objects without offset and limit )'
                : value:
                    items:
                    - id: <container_uuid>
                      links:
                        self: <fmc_url>/api/fmc_config/v1/domain/<domainUuid>/devicehapairs/ftddevicehapairs/<container_uuid>
                      name: <HA_NAME>
                    - id: <container_uuid>
                      links:
                        self: <fmc_url>/api/fmc_config/v1/domain/<domainUuid>/devicehapairs/ftddevicehapairs/<container_uuid>
                      name: <HA_NAME>
                    - id: <container_uuid>
                      links:
                        self: <fmc_url>/api/fmc_config/v1/domain/<domainUuid>/devicehapairs/ftddevicehapairs/<container_uuid>
                      name: <HA_NAME>
                    links:
                      self: <fmc_url>/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs?offset=0&limit=3
                    paging:
                      count: 3
                      limit: 3
                      offset: 0
                      pages: 1
              schema:
                $ref: '#/components/schemas/FTDHADeviceContainerListContainer'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Device HA Pairs
    post:
      deprecated: false
      description: '**Create a Firewall Threat Defense High Availability pair. _Check the response section for applicable
        examples (if any)._**'
      operationId: createFTDHADeviceContainer
      parameters:
      - $ref: '#/components/parameters/domainUUID'
        name: domainUUID
      requestBody:
        content:
          application/json:
            examples:
              'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devicehapairs/ftddevicehapairs ( Creation of FTD HA )':
                value:
                  ftdHABootstrap:
                    encKeyGenerationScheme: CUSTOM
                    isEncryptionEnabled: 'false'
                    lanFailover:
                      activeIP: 1.1.1.1
                      interfaceObject:
                        id: <uuid>
                        name: GigabitEthernet0/0
                        type: PhysicalInterface
                      logicalName: LAN-INTERFACE
                      standbyIP: 1.1.1.2
                      subnetMask: 255.255.255.0
                      useIPv6Address: 'false'
                    sharedKey: cisco123
                    statefulFailover:
                      activeIP: 1.1.1.1
                      interfaceObject:
                        id: <uuid>
                        name: GigabitEthernet0/0
                        type: PhysicalInterface
                      logicalName: STATEFUL-INTERFACE
                      standbyIP: 1.1.1.2
                      subnetMask: 255.255.255.0
                      useIPv6Address: 'true'
                    useSameLinkForFailovers: 'true'
                  name: <ha-name>
                  primary:
                    id: primary_uuid
                  secondary:
                    id: secondary_uuid
                  type: DeviceHAPair
            schema:
              $ref: '#/components/schemas/FTDHADeviceContainer'
              type: object
        description: Input representation of Firewall Threat Defense HA pair.
        required: true
      responses:
        '202':
          content:
            application/json:
              examples:
                'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devicehapairs/ftddevicehapairs ( Creation of FTD HA )':
                  value:
                    ftdHABootstrap:
                      isEncryptionEnabled: false
                      lanFailover:
                        activeIP: 1.1.1.1
                        interfaceObject:
                          MTU: 0
                          enabled: false
                          managementOnly: false
                          mode: NONE
                        standbyIP: 1.1.1.2
                        subnetMask: 255.255.255.0
                      statefulFailover:
                        activeIP: 1.1.1.1
                        interfaceObject:
                          MTU: 0
                          enabled: false
                          managementOnly: false
                          mode: NONE
                        standbyIP: 1.1.1.2
                        subnetMask: 255.255.255.0
                      useSameLinkForFailovers: true
                    metadata:
                      task:
                        id: <Task Id>
                        name: FTD HA Device Registration
                        type: Task
                    version: 6.0.1
              schema:
                $ref: '#/components/schemas/FTDHADeviceContainer'
                type: object
          description: Accepted
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Device HA Pairs
    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}/devicehapairs/ftddevicehapairs/{containerUUID}/failoverinterfacemacaddressconfigs
  : get:
      deprecated: false
      description: '**Get the a list of all Firewall Threat Defense High Availability failover policy interface MAC addresses
        records.**'
      operationId: getAllFTDHAInterfaceMACAddresses
      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/FTDHAInterfaceMACAddressesListContainer'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Device HA Pairs
    post:
      deprecated: false
      description: '**Create a Firewall Threat Defense High Availability failover policy interface MAC addresses record. _Check
        the response section for applicable examples (if any)._**'
      operationId: createFTDHAInterfaceMACAddresses
      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:
            schema:
              $ref: '#/components/schemas/FTDHAInterfaceMACAddresses'
              type: object
        description: Input representation of Firewall Threat Defense HA failover policy interface MAC addresses.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FTDHAInterfaceMACAddresses'
                type: object
          description: Created
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Device HA Pairs
    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}/devicehapairs/ftddevicehapairs/{containerUUID}/failoverinterfacemacaddressconfigs/{objectId}
  : delete:
      deprecated: false
      description: '**Delete the Firewall Threat Defense High Availability failover policy interface MAC addresses record
        associated with the specified Firewall Threat Defense High Availability pair. _Check the response section for applicable
        examples (if any)._**'
      operationId: deleteFTDHAInterfaceMACAddresses
      parameters:
      - description: UUID of the Firewall Threat Defense High Availability failover policy interface MAC addresses record.
        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/devicehapairs/ftddevicehapairs/ha_container_uuid/failoverinterfacemacaddressconfigs/<failover-interface-mac-address-uuid>
                  ( Deletes the FTD HA device container failover interface MAC addresses object. )'
                : value:
                    failoverActiveMac: 0050.56a9.603c
                    failoverStandbyMac: 0050.56a9.603d
                    id: <failover_interface_mac-address_uuid>
                    physicalInterface:
                      MTU: 1500
                      enabled: false
                      id: <uuid>
                      managementOnly: false
                      name: GigabitEthernet0/0
                      type: PhysicalInterface
                    type: FailoverInterfaceMACAddressConfig
              schema:
                $ref: '#/components/schemas/FTDHAInterfaceMACAddresses'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Device HA Pairs
    get:
      deprecated: false
      description: '**Get the Firewall Threat Defense High Availability failover policy interface MAC addresses record associated
        with the specified Firewall Threat Defense High Availability pair.**'
      operationId: getFTDHAInterfaceMACAddresses
      parameters:
      - description: UUID of the Firewall Threat Defense High Availability failover policy interface MAC addresses record.
        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/devicehapairs/ftddevicehapairs/ha_container_uuid/failoverinterfacemacaddressconfigs/<failover-interface-mac-address-uuid>
                  ( Get of a specific failover interface MAC addresses object for FTD HA device container. Failover interface
                  MAC addresses object UUID should be passed as Object id. )'
                : value:
                    failoverActiveMac: 0050.56a9.603c
                    failoverStandbyMac: 0050.56a9.603d
                    id: <failover_interface_mac-address_uuid>
                    physicalInterface:
                      MTU: 1500
                      enabled: false
                      id: <uuid>
                      managementOnly: false
                      name: GigabitEthernet0/0
                      type: PhysicalInterface
                    type: FailoverInterfaceMACAddressConfig
                ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/devicehapairs/ftddevicehapairs/ha_container_uuid/failoverinterfacemacaddressconfigs
                  ( GetAll of FTD HA device container failover interface MAC addresses object. )'
                : value:
                    items:
                    - id: <failover_interface_mac-address_uuid>
                      links:
                        self: <fmc_url>/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/failoverinterfacemacaddressconfigs/<failover-interface-mac-address-uuid>
                      type: FailoverInterfaceMACAddressConfig
                    - id: <failover_interface_mac-address_uuid>
                      links:
                        self: <fmc_url>/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/failoverinterfacemacaddressconfigs/<failover-interface-mac-address-uuid>
                      type: FailoverInterfaceMACAddressConfig
                    - id: <failover_interface_mac-address_uuid>
                      links:
                        self: <fmc_url>/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/failoverinterfacemacaddressconfigs/<failover-interface-mac-address-uuid>
                      type: FailoverInterfaceMACAddressConfig
                    links:
                      self: <fmc_url>/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/failoverinterfacemacaddressconfigs?offset=0&limit=3
                    paging:
                      count: 3
                      limit: 3
                      offset: 0
                      pages: 1
              schema:
                $ref: '#/components/schemas/FTDHAInterfaceMACAddresses'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Device HA Pairs
    put:
      deprecated: false
      description: '**Modify the Firewall Threat Defense High Availability failover policy interface MAC addresses record
        associated with the specified Firewall Threat Defense HA pair. _Check the response section for applicable examples
        (if any)._**'
      operationId: updateFTDHAInterfaceMACAddresses
      parameters:
      - description: UUID of the Firewall Threat Defense High Availability failover policy interface MAC addresses record.
        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/devicehapairs/ftddevicehapairs/ha_container_uuid/failoverinterfacemacaddressconfigs/<failover-interface-mac-address-uuid>
                ( Update of  failover interface MAC addresses object for a FTD HA device container. Failover interface MAC
                addresses object UUID should be passed as Object id. )'
              : value:
                  failoverActiveMac: 0050.56a9.603c
                  failoverStandbyMac: 0050.56a9.603d
                  id: <failover_interface_mac-address_uuid>
                  type: FailoverInterfaceMACAddressConfig
            schema:
              $ref: '#/components/schemas/FTDHAInterfaceMACAddresses'
              type: object
        description: Input representation of Firewall Threat Defense HA failover policy interface MAC addresses.
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/devicehapairs/ftddevicehapairs/ha_container_uuid/failoverinterfacemacaddressconfigs/<failover-interface-mac-address-uuid>
                  ( Update of  failover interface MAC addresses object for a FTD HA device container. Failover interface MAC
                  addresses object UUID should be passed as Object id. )'
                : value:
                    failoverActiveMac: 0050.56a9.603c
                    failoverStandbyMac: 0050.56a9.603d
                    id: <failover_interface_mac-address_uuid>
                    physicalInterface:
                      MTU: 1500
                      enabled: false
                      id: <uuid>
                      managementOnly: false
                      name: GigabitEthernet0/0
                      type: PhysicalInterface
                    type: FailoverInterfaceMACAddressConfig
              schema:
                $ref: '#/components/schemas/FTDHAInterfaceMACAddresses'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Device HA Pairs
    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}/devicehapairs/ftddevicehapairs/{containerUUID}/monitoredinterfaces:
    get:
      deprecated: false
      description: '**Get a list of all Firewall Threat Defense HA monitored interface policy records.**'
      operationId: getAllFTDHAMonitoredInterfaces
      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/FTDHAMonitoredInterfacesListContainer'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Device HA Pairs
    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}/devicehapairs/ftddevicehapairs/{containerUUID}/monitoredinterfaces/{objectId}
  : get:
      deprecated: false
      description: '**Get the Firewall Threat Defense High Availabiliy Monitored interface policy record associated with the
        specified Firewall Threat Defense High Availability pair.**'
      operationId: getFTDHAMonitoredInterfaces
      parameters:
      - description: UUID of the Firewall Threat Defense High Availabiliy Monitored interface policy record.
        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/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces/<monitored_interface_policy_uuid>
                  ( Get of HA device container monitored interfaces object. Monitored interface policy UUID should be passed
                  as Object id. )'
                : value:
                    id: <monitored_interface_policy_uuid>
                    interfaceLogicalName: <interface-nameif>
                    ipv4Configuration:
                      activeIPv4Address: 192.0.2.1
                      activeIPv4Mask: '25'
                      standbyIPv4Address: 192.0.2.2
                    ipv6Configuration:
                      activeIPv6LinkLocalAddress: FE80::C800:EFF:FE74:8
                      ipv6ActiveStandbyPair:
                      - activeIPv6: 2006::/32
                        standbyIPv6: 2006::/31
                      - activeIPv6: 2005::/32
                        standbyIPv6: 2005::/31
                      standbyIPv6LinkLocalAddress: FE80::C800:EFF:FE74:9
                    monitorForFailures: 'true'
                ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces
                  ( GetAll of HA device container monitored interfaces object. )'
                : value:
                    items:
                    - id: <monitored_interface_policy_uuid>
                      links:
                        self: <fmc_url>/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces/<monitored_interface_policy_uuid>
                      name: <Monitored-interface-logical-name>
                      type: PixFailoverIntfMonitorTable
                    - id: <monitored_interface_policy_uuid>
                      links:
                        self: <fmc_url>/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces/<monitored_interface_policy_uuid>
                      name: <Monitored-interface-logical-name>
                      type: PixFailoverIntfMonitorTable
                    - id: <monitored_interface_policy_uuid>
                      links:
                        self: <fmc_url>/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces/<monitored_interface_policy_uuid>
                      name: <Monitored-interface-logical-name>
                      type: PixFailoverIntfMonitorTable
                    links:
                      self: <fmc_url>/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces?offset=0&limit=3
                    paging:
                      count: 3
                      limit: 3
                      offset: 0
                      pages: 1
              schema:
                $ref: '#/components/schemas/FTDHAMonitoredInterfaces'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Device HA Pairs
    put:
      deprecated: false
      description: '**Modify the Firewall Threat Defense High Availability Monitored interface policy record associated with
        the specified Firewall Threat Defense High Availability pair. _Check the response section for applicable examples
        (if any)._**'
      operationId: updateFTDHAMonitoredInterfaces
      parameters:
      - description: UUID of the Firewall Threat Defense High Availabiliy Monitored interface policy record.
        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/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces/<monitored_interface_policy_uuid>
                ( Modify monitored interfaces object for HA device container. Monitored interface policy UUID should be passed
                as Object id. )'
              : value:
                  id: <monitored_interface_policy_uuid>
                  ipv4Configuration:
                    standbyIPv4Address: 192.0.2.2
                  ipv6Configuration:
                    ipv6ActiveStandbyPair:
                    - activeIPv6: 2006::/32
                      standbyIPv6: 2006::31
                    - activeIPv6: 2005::/32
                      standbyIPv6: 2005::31
                    standbyIPv6LinkLocalAddress: FE80::C800:EFF:FE74:9
                  monitorForFailures: 'true'
                  name: <interface-nameif>
            schema:
              $ref: '#/components/schemas/FTDHAMonitoredInterfaces'
              type: object
        description: Input representation of Firewall Threat Defense HA Monitored interface policy.
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/devicehapairs/ftddevicehapairs/ha_container_uuid/monit

# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-secure-firewall/refs/heads/main/openapi/cisco-secure-firewall-device-ha-pairs-api-openapi.yml