Get FMCHA Status - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get FMCHA Status","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 information about the High Availability status of the Secure Firewall Management Center.**","operationId":"getFMCHAStatus","parameters":[{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/domainUUID/integration/fmchastatuses ( Success: Sample response of getfmchastatuses api )":{"value":{"items":[{"fmcPrimary":{"hwRole":"Primary","ipAddress":"10.10.10.161","modelId":66,"role":"Active","swVersion":"7.1.0","uuid":"40679bee-a400-11eb-876e-ae901b2860b3"},"fmcSecondary":{"hwRole":"Secondary","ipAddress":"10.10.10.162","modelId":66,"role":"Standby","swVersion":"7.1.0","uuid":"4446d45a-a400-11eb-8175-b07e3c71576f"},"haOpInProgress":false,"haStatusMessages":["Synchronization task is in progress."],"id":"40679bee-a400-11eb-876e-ae901b2860b3","overallStatus":"GOOD","syncStatus":"IN_PROGRESS","type":"FMCHAStatus"}],"links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/integration/fmchastatuses?offset=0&limit=25&expanded=true"},"paging":{"count":1,"limit":25,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Represents the Firepower Management Center High Availability Status Object.","properties":{"fmcPrimary":{"description":"Object specifying the details of the Primary FMC.","type":"object","properties":{"hwRole":{"description":"String represents the hardware role of the FMC.","type":"string"},"ipAddress":{"description":"String represents the IP address of the FMC.","type":"string"},"modelId":{"description":"Integer represents the model of the FMC.","format":"int32","type":"integer"},"modelName":{"description":"String specifies the model of the FMC.","type":"string"},"role":{"description":"String represents the role of the FMC.","type":"string"},"swVersion":{"description":"String represents the software version of the FMC.","type":"string"},"uuid":{"description":"String represents the UUID of the FMC.","type":"string"}},"$$ref":"#/components/schemas/IFMCServerInfo"},"fmcSecondary":{"description":"Object specifying the details of the Secondary FMC.","type":"object","properties":{"hwRole":{"description":"String represents the hardware role of the FMC.","type":"string"},"ipAddress":{"description":"String represents the IP address of the FMC.","type":"string"},"modelId":{"description":"Integer represents the model of the FMC.","format":"int32","type":"integer"},"modelName":{"description":"String specifies the model of the FMC.","type":"string"},"role":{"description":"String represents the role of the FMC.","type":"string"},"swVersion":{"description":"String represents the software version of the FMC.","type":"string"},"uuid":{"description":"String represents the UUID of the FMC.","type":"string"}},"$$ref":"#/components/schemas/IFMCServerInfo"},"haOpInProgress":{"description":"Boolean which specifies FMC HA operation is in progress.","type":"boolean"},"haStatusMessages":{"description":"Array of status messages of FMC HA.","items":{"type":"string"},"type":"array"},"id":{"description":"UUID of Firepower Management Center.","type":"string"},"overallStatus":{"description":"String specifies the overall status of FMC HA.","enum":["GOOD","DEGRADED","SPLIT_BRAIN"],"type":"string"},"pendingDeviceInfo":{"description":"Specifies the devices pending for registration.","items":{"type":"object","description":"Represents the Pending Device Registration info.","properties":{"deviceName":{"description":"String represents the name of the device.","type":"string"},"deviceUuid":{"description":"String represents the UUID of the device.","type":"string"},"ipAddress":{"description":"String represents the IP address of the device.","type":"string"},"regStatus":{"description":"String represents the registration status of the device.","enum":["PENDING","FAILED"],"type":"string"}},"$$ref":"#/components/schemas/IPendingDeviceRegInfo"},"type":"array"},"syncStatus":{"description":"String specifies the sync status of FMC HA.","enum":["GOOD","IN_PROGRESS","PAUSED","FAILED"],"type":"string"},"type":{"description":"Type of the Response object. This value is always FMCHAStatus.","type":"string"}},"$$ref":"#/components/schemas/FMCHAStatus"},"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"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/FMCHAStatusListContainer"}}},"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":["Integration"],"__originalOperationId":"getFMCHAStatus","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/integration/fmchastatuses"}}