Get FTDHA Monitored Interfaces - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get FTDHA Monitored Interfaces","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","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"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"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"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/DomainUUID/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces/\u003cmonitored_interface_policy_uuid\u003e ( Get of HA device container monitored interfaces object. Monitored interface policy UUID should be passed as Object id. )":{"value":{"id":"\u003cmonitored_interface_policy_uuid\u003e","interfaceLogicalName":"\u003cinterface-nameif\u003e","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":"\u003cmonitored_interface_policy_uuid\u003e","links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces/\u003cmonitored_interface_policy_uuid\u003e"},"name":"\u003cMonitored-interface-logical-name\u003e","type":"PixFailoverIntfMonitorTable"},{"id":"\u003cmonitored_interface_policy_uuid\u003e","links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces/\u003cmonitored_interface_policy_uuid\u003e"},"name":"\u003cMonitored-interface-logical-name\u003e","type":"PixFailoverIntfMonitorTable"},{"id":"\u003cmonitored_interface_policy_uuid\u003e","links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devicehapairs/ftddevicehapairs/ha_container_uuid/monitoredinterfaces/\u003cmonitored_interface_policy_uuid\u003e"},"name":"\u003cMonitored-interface-logical-name\u003e","type":"PixFailoverIntfMonitorTable"}],"links":{"self":"\u003cfmc_url\u003e/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":{"type":"object","description":"Input representation of Firepower Threat Defense high availability monitored interface","properties":{"description":{"description":"Description of the Firepower Threat Defense high availability monitored interface","type":"string"},"id":{"description":"Unique identifier (UUID) for the Firepower Threat Defense high availability monitored interface","type":"string"},"ipv4Configuration":{"description":"Global","type":"object","properties":{"activeIPv4Address":{"type":"string"},"activeIPv4Mask":{"type":"string"},"standbyIPv4Address":{"type":"string"}},"$$ref":"#/components/schemas/FTDHAIPv4Configuration"},"ipv6Configuration":{"description":"IPv6 Configuration","type":"object","properties":{"activeIPv6LinkLocalAddress":{"type":"string"},"ipv6ActiveStandbyPair":{"items":{"type":"object","properties":{"activeIPv6":{"type":"string"},"standbyIPv6":{"type":"string"}},"$$ref":"#/components/schemas/IFTDHAIPv6ActiveStandbyPair"},"type":"array"},"standbyIPv6LinkLocalAddress":{"type":"string"}},"$$ref":"#/components/schemas/FTDHAIPv6Configuration"},"links":{"description":"URL of the Firepower Threat Defense high availability monitored interface","type":"object","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"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"description":"Object representing metadata properties","type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","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"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","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"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"monitorForFailures":{"description":"Flag indicating failure for monitored interfaces","type":"boolean"},"name":{"description":"Name of the Firepower Threat Defense high availability monitored interface","type":"string"},"type":{"description":"Type of the Firepower Threat Defense high availability monitored interface","type":"string"},"version":{"description":"Firepower Threat Defense high availability monitored interface model version","type":"string"}},"required":["monitorForFailures"],"$$ref":"#/components/schemas/FTDHAMonitoredInterfaces"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","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":{"type":"object","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"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Device HA Pairs"],"__originalOperationId":"getFTDHAMonitoredInterfaces","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devicehapairs/ftddevicehapairs/{containerUUID}/monitoredinterfaces/{objectId}"}}