Create Health Policy - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Health Policy","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":"**Create a health policy. _Check the response section for applicable examples (if any)._**","operationId":"createHealthPolicy","parameters":[{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/healthpolicies ( To create a new policy with any existing policy as base policy )":{"value":{"basePolicyID":"\u003cId of the Health policy used as a base policy\u003e","description":"\u003cDescription of the Health policy\u003e","name":"\u003cName of the Health policy\u003e","policyType":"Type can be either DevicePolicy or ManagementCenterPolicy","type":"HealthPolicy"}},"Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/policy/healthpolicies ( To create with minimum fields - takes default device policy as base policy if not basePolicyID provided )":{"value":{"description":"\u003cDescription of the Health policy\u003e","name":"\u003cName of the Health policy\u003e","policyType":"Type can be either DevicePolicy or ManagementCenterPolicy","type":"HealthPolicy"}},"Example 3 : POST /api/fmc_config/v1/domain/DomainUUID/policy/healthpolicies ( To create a new one by all the fields )":{"value":{"description":"\u003cDescription of the Health policy\u003e","healthModules":[{"alertConfig":[{"enabled":"\u003cParticular alert config is enabled if true\u003e","name":"\u003cName of the alertConfig\u003e","thresholds":[{"type":"Type can be either red or yellow","value":"\u003cInteger value of the threshold limit\u003e"}]}],"alertEnabled":"\u003cIf true alertConfig will be enabled\u003e","criticalThreshold":"\u003cInteger value to mention critical threshold limit, limit will differ for each module\u003e","customThresholds":[{"type":"Type can be either Red-FC or Yellow-FC","value":"\u003cInteger value to mention custom threshold limit, limit will differ for each module\u003e"}],"enabled":"\u003cParticular is Enabled or not true/false\u003e","moduleId":"\u003cUnique Identifier, in string format, of the Module Category. Eg.hm_cpu\u003e","severity":"\u003cSeverity can be Info/Major/Minor/Warning/Critical\u003e","type":"\u003cType can be FTD/SENSOR/FMC_FTD/FMC\u003e","warningThreshold":"\u003cInteger value to mention warning threshold limit, limit will differ for each module\u003e"}],"name":"\u003cName of the Health policy\u003e","policyType":"Type can be either DevicePolicy or ManagementCenterPolicy","setting":{"alertEvaluationInterval":"\u003cInteger value range between 1-60\u003e","certFileContent":"\u003cContent of the certificate\u003e","certFileName":"\u003cName of the certificate\u003e","certFileType":"\u003cType of the certificate\u003e","certPassphrase":"\u003cCert password\u003e","configType":"\u003cType can be Dial-Out/Dial-IN\u003e","dataCollectionInterval":"\u003c\u003cInteger value range between 5-60\u003e","dialInHosts":[{"host":"\u003cHost ID\u003e","port":"\u003cPort enabled for Dial IN range between 1024-65535\u003e"}],"dialOutHosts":[{"host":"\u003cHost ID\u003e","port":"\u003cPort enabled for Dial OUT range between 1024-65535\u003e"}],"enabledOpenConfig":"\u003cTrue if open config is enabled\u003e","grpcPassword":"\u003cPassword of the user\u003e","grpcUsername":"\u003cUser name\u003e","readOnly":false},"type":"HealthPolicy"}}},"schema":{"type":"object","properties":{"basePolicyID":{"type":"string"},"defaultPolicy":{"type":"boolean"},"description":{"type":"string"},"healthModules":{"items":{"type":"object","properties":{"alertConfig":{"items":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"thresholds":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthThreshold"},"type":"array"}},"$$ref":"#/components/schemas/HealthAlertConfig"},"type":"array"},"alertEnabled":{"type":"boolean"},"criticalThreshold":{"format":"int32","type":"integer"},"customThresholds":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthThreshold"},"type":"array"},"enabled":{"type":"boolean"},"moduleId":{"type":"string"},"severity":{"type":"string"},"type":{"type":"string"},"warningThreshold":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthModule"},"type":"array"},"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"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","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"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","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"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","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"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"type":"string"},"policyType":{"type":"string"},"setting":{"type":"object","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":{"type":"object","properties":{"host":{"type":"string"},"port":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/DialHost"},"type":"array"},"dialOutHosts":{"items":{"type":"object","properties":{"host":{"type":"string"},"port":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/DialHost"},"type":"array"},"enabledOpenConfig":{"type":"boolean"},"grpcPassword":{"type":"string"},"grpcUsername":{"type":"string"},"readOnly":{"type":"boolean"}},"$$ref":"#/components/schemas/HealthSetting"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/HealthPolicy"}}},"description":"Input representation of health policy.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/healthpolicies ( To create a new policy with any existing policy as base policy )":{"value":{"defaultPolicy":false,"description":"DevicePolicy","healthModules":[{"enabled":false,"moduleId":"hm_platform_faults","severity":"Critical","type":"FTD"},{"criticalThreshold":90,"customThresholds":[{"type":"Red-FC","value":99},{"type":"Yellow-FC","value":97}],"enabled":true,"moduleId":"hm_du","type":"FMC_FTD","warningThreshold":85},{"alertConfig":[{"enabled":false,"name":"snort-down"},{"enabled":false,"name":"nat-xlate-failed"},{"enabled":false,"name":"punt-limit"},{"enabled":true,"name":"conn-limit-exceeded"},{"enabled":false,"name":"nat-no-xlate-to-pat-pool"},{"enabled":false,"name":"pdts-punt-limit-exceeded"},{"enabled":false,"name":"snort-busy"},{"enabled":false,"name":"no-route"},{"enabled":true,"name":"nat-rpf-failed"}],"alertEnabled":true,"enabled":true,"moduleId":"hm_asp_drop","type":"FTD"}],"id":"6c770af4-94b6-11ee-833a-0d41577689c0","links":{"self":"https://u32c01p23-vrouter.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/healthpolicies/6c770af4-94b6-11ee-833a-0d41577689c0"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"id":"\u003cid\u003e","name":"\u003cname\u003e","type":"\u003ctype\u003e"},"timestamp":1702019787},"name":"Initial_Health_Policy 2023-12-07 04:09:31","policyType":"DevicePolicy","setting":{"alertEvaluationInterval":5,"certFileContent":"\u003ccontent\u003e","certFileName":"\u003cname\u003e","certFileType":"\u003ctype\u003e","certPassphrase":"","configType":"DIAL-OUT","dataCollectionInterval":1,"dialOutHosts":[{"host":"hostname","port":1234}],"enabledOpenConfig":true,"grpcPassword":"\u003cpassword\u003e","grpcUsername":"user1","readOnly":false},"type":"HealthPolicy"}},"Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/policy/healthpolicies ( To create with minimum fields - takes default device policy as base policy if not basePolicyID provided )":{"value":{"defaultPolicy":false,"description":"DevicePolicy","healthModules":[{"enabled":false,"moduleId":"hm_platform_faults","severity":"Critical","type":"FTD"},{"criticalThreshold":90,"customThresholds":[{"type":"Red-FC","value":99},{"type":"Yellow-FC","value":97}],"enabled":true,"moduleId":"hm_du","type":"FMC_FTD","warningThreshold":85},{"alertConfig":[{"enabled":false,"name":"snort-down"},{"enabled":false,"name":"nat-xlate-failed"},{"enabled":false,"name":"punt-limit"},{"enabled":true,"name":"conn-limit-exceeded"},{"enabled":false,"name":"nat-no-xlate-to-pat-pool"},{"enabled":false,"name":"pdts-punt-limit-exceeded"},{"enabled":false,"name":"snort-busy"},{"enabled":false,"name":"no-route"},{"enabled":true,"name":"nat-rpf-failed"}],"alertEnabled":true,"enabled":true,"moduleId":"hm_asp_drop","type":"FTD"}],"id":"6c770af4-94b6-11ee-833a-0d41577689c0","links":{"self":"https://u32c01p23-vrouter.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/healthpolicies/6c770af4-94b6-11ee-833a-0d41577689c0"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"id":"\u003cid\u003e","name":"\u003cname\u003e","type":"\u003ctype\u003e"},"timestamp":1702019787},"name":"Initial_Health_Policy 2023-12-07 04:09:31","policyType":"DevicePolicy","setting":{"alertEvaluationInterval":5,"certFileContent":"\u003ccontent\u003e","certFileName":"\u003cname\u003e","certFileType":"\u003ctype\u003e","certPassphrase":"","configType":"DIAL-OUT","dataCollectionInterval":1,"dialOutHosts":[{"host":"hostname","port":1234}],"enabledOpenConfig":true,"grpcPassword":"\u003cpassword\u003e","grpcUsername":"user1","readOnly":false},"type":"HealthPolicy"}},"Example 3 : POST /api/fmc_config/v1/domain/DomainUUID/policy/healthpolicies ( To create a new one by all the fields )":{"value":{"defaultPolicy":false,"description":"DevicePolicy","healthModules":[{"enabled":false,"moduleId":"hm_platform_faults","severity":"Critical","type":"FTD"},{"criticalThreshold":90,"customThresholds":[{"type":"Red-FC","value":99},{"type":"Yellow-FC","value":97}],"enabled":true,"moduleId":"hm_du","type":"FMC_FTD","warningThreshold":85},{"alertConfig":[{"enabled":false,"name":"snort-down"},{"enabled":false,"name":"nat-xlate-failed"},{"enabled":false,"name":"punt-limit"},{"enabled":true,"name":"conn-limit-exceeded"},{"enabled":false,"name":"nat-no-xlate-to-pat-pool"},{"enabled":false,"name":"pdts-punt-limit-exceeded"},{"enabled":false,"name":"snort-busy"},{"enabled":false,"name":"no-route"},{"enabled":true,"name":"nat-rpf-failed"}],"alertEnabled":true,"enabled":true,"moduleId":"hm_asp_drop","type":"FTD"}],"id":"6c770af4-94b6-11ee-833a-0d41577689c0","links":{"self":"https://u32c01p23-vrouter.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/healthpolicies/6c770af4-94b6-11ee-833a-0d41577689c0"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"id":"\u003cid\u003e","name":"\u003cname\u003e","type":"\u003ctype\u003e"},"timestamp":1702019787},"name":"Initial_Health_Policy 2023-12-07 04:09:31","policyType":"DevicePolicy","setting":{"alertEvaluationInterval":5,"certFileContent":"\u003ccontent\u003e","certFileName":"\u003cname\u003e","certFileType":"\u003ctype\u003e","certPassphrase":"","configType":"DIAL-OUT","dataCollectionInterval":1,"dialOutHosts":[{"host":"hostname","port":1234}],"enabledOpenConfig":true,"grpcPassword":"\u003cpassword\u003e","grpcUsername":"user1","readOnly":false},"type":"HealthPolicy"}}},"schema":{"type":"object","properties":{"basePolicyID":{"type":"string"},"defaultPolicy":{"type":"boolean"},"description":{"type":"string"},"healthModules":{"items":{"type":"object","properties":{"alertConfig":{"items":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"thresholds":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthThreshold"},"type":"array"}},"$$ref":"#/components/schemas/HealthAlertConfig"},"type":"array"},"alertEnabled":{"type":"boolean"},"criticalThreshold":{"format":"int32","type":"integer"},"customThresholds":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthThreshold"},"type":"array"},"enabled":{"type":"boolean"},"moduleId":{"type":"string"},"severity":{"type":"string"},"type":{"type":"string"},"warningThreshold":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/HealthModule"},"type":"array"},"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"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","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"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","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"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","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"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"type":"string"},"policyType":{"type":"string"},"setting":{"type":"object","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":{"type":"object","properties":{"host":{"type":"string"},"port":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/DialHost"},"type":"array"},"dialOutHosts":{"items":{"type":"object","properties":{"host":{"type":"string"},"port":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/DialHost"},"type":"array"},"enabledOpenConfig":{"type":"boolean"},"grpcPassword":{"type":"string"},"grpcUsername":{"type":"string"},"readOnly":{"type":"boolean"}},"$$ref":"#/components/schemas/HealthSetting"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/HealthPolicy"}}},"description":"Created"},"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":["Policy"],"__originalOperationId":"createHealthPolicy","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/healthpolicies"}}