Get Cluster Health Monitor Settings Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Cluster Health Monitor Settings Model","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 health check monitor settings of a Firewall Threat Defense cluster.**","operationId":"getClusterHealthMonitorSettingsModel","parameters":[{"description":"UUID of the Firewall Threat Defense cluster.","in":"path","name":"clusterUuid","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/deviceclusters/ftddevicecluster/{clusterUuid}/clusterhealthmonitorsettings/{clusterUuid} ( Success:GET method to update health check monitor settings of FTD Cluster )":{"value":{"holdTime":3,"id":"clusterUuid","interfaceAutoRejoin":{"clusterInterface":{"attempts":3,"interval":5,"nextInterval":1},"dataInterface":{"attempts":3,"interval":5,"nextInterval":2}},"isHealthCheckEnabled":true,"monitorInterface":{"debounceTime":500,"isServiceApplicationEnabled":false},"systemAutoRejoin":{"attempts":3,"interval":5,"nextInterval":2},"type":"ClusterHealthMonitorSetting","unMonitorInterface":["GigabitEthernet0/1","GigabitEthernet0/2"]}},"Example 2 : GET /fmc_config/v1/domain/DomainUUID/deviceclusters/ftddevicecluster/{clusterUuid}/clusterhealthmonitorsettings/{clusterUuid} ( Success:GET response when health check is disabled )":{"value":{"id":"clusterUuid","isHealthCheckEnabled":false,"monitorInterface":{"debounceTime":5000,"isServiceApplicationEnabled":true},"systemAutoRejoin":{"attempts":3,"interval":5,"nextInterval":2},"type":"ClusterHealthMonitorSetting","unMonitorInterface":["GigabitEthernet0/1","GigabitEthernet0/2"]}}},"schema":{"type":"object","description":"A model representing FTD Cluster Health Check Monitor Settings","properties":{"holdTime":{"description":"hold-time determines the amount of time between unit heartbeat status messages","type":"number"},"id":{"type":"string"},"interfaceAutoRejoin":{"description":"Data and Cluster Interface auto rejoin","type":"object","properties":{"clusterInterface":{"type":"object","properties":{"attempts":{"format":"int32","type":"integer"},"interval":{"format":"int32","type":"integer"},"nextInterval":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IClusterAutoRejoin"},"dataInterface":{"type":"object","properties":{"attempts":{"format":"int32","type":"integer"},"interval":{"format":"int32","type":"integer"},"nextInterval":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IClusterAutoRejoin"}},"$$ref":"#/components/schemas/IInterfaceAutoRejoin"},"isHealthCheckEnabled":{"description":"To toggle health check","type":"boolean"},"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"},"metadata":{"type":"object","properties":{"analyticsOnly":{"type":"boolean"},"clusterControlLinkMTU":{"type":"string"},"clusterhealthmonitorsettings":{"type":"object","properties":{"description":{"type":"string"},"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"},"type":{"type":"string"}},"$$ref":"#/components/schemas/ClusterHealthMonitorSettingMetadata"},"isLocked":{"type":"boolean"},"matches":{"items":{"type":"string"},"type":"array"},"maxDataInterfaceMTU":{"type":"string"},"task":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"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","EXECUTE_BULK_COMMANDS","FA_TELEMETRY_DATA_GENERATION"],"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/RestTaskStatus"}},"$$ref":"#/components/schemas/RestFTDClusterDeviceMetadata"},"monitorInterface":{"description":"monitor interface parmas like debounce time and service module","type":"object","properties":{"debounceTime":{"format":"int32","type":"integer"},"isServiceApplicationEnabled":{"type":"boolean"}},"$$ref":"#/components/schemas/IClusterMonitorInterface"},"systemAutoRejoin":{"description":"Sets system auto rejoin params if the failure is due to system","type":"object","properties":{"attempts":{"format":"int32","type":"integer"},"interval":{"format":"int32","type":"integer"},"nextInterval":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IClusterAutoRejoin"},"type":{"type":"string"},"unMonitorInterface":{"description":"un-monitor interfaces","items":{"type":"string"},"type":"array"}},"$$ref":"#/components/schemas/ClusterHealthMonitorSettingsModel"}}},"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 Clusters"],"__originalOperationId":"getClusterHealthMonitorSettingsModel","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deviceclusters/ftddevicecluster/{containerUUID}/clusterhealthmonitorsettings/{clusterUuid}"}}