Create Intrusion Policy - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Intrusion 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 an intrusion policy. _Check the response section for applicable examples (if any)._**","operationId":"createIntrusionPolicy","parameters":[{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/DomainUUID/policy/intrusionpolicies ( Test intrusion policy creation )":{"value":{"basePolicy":{"id":"intrusionPolicyUUID","name":"test1","type":"IntrusionPolicy"},"description":"Created via automation","inspectionMode":"PREVENTION","name":"test1","type":"IntrusionPolicy"}}},"schema":{"type":"object","description":"An object that represents the details for Intrusion Policy.","properties":{"basePolicy":{"description":"Object representing the base policy of the Intrusion Policy.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing 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":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"description":{"description":"Description of the Intrusion Policy.","type":"string"},"id":{"description":"Unique identifier of the Intrusion Policy.","type":"string"},"inlineDrop":{"description":"Indicates the inspection mode. Applicable for Snort 2 engine only. Value can be 0 or 1.","format":"int32","type":"integer"},"inspectionMode":{"description":"Indicates the inspection mode. Can be either DETECTION or PREVENTION. Only applicable for Snort 3 engine.","enum":["PREVENTION","DETECTION"],"type":"string"},"isSystemDefined":{"type":"boolean"},"links":{"description":"Object containing 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"},"metadata":{"description":"Object representing metadata properties of Intrusion Policy.","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"},"mappedPolicy":{"type":"object","properties":{"id":{"type":"string"},"inspectionMode":{"enum":["PREVENTION","DETECTION"],"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"},"snortEngine":{"enum":["SNORT2","SNORT3"],"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IIntrusionMappedPolicy"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"recommendationsDeletedNetworks":{"items":{"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"},"value":{"type":"string"}},"$$ref":"#/components/schemas/Snort3IPSReferenceObject"},"type":"array"},"ruleCount":{"type":"object","properties":{"alert":{"format":"int32","type":"integer"},"block":{"format":"int32","type":"integer"},"disabled":{"format":"int32","type":"integer"},"drop":{"format":"int32","type":"integer"},"overridden":{"format":"int32","type":"integer"},"pass":{"format":"int32","type":"integer"},"reject":{"format":"int32","type":"integer"},"rewrite":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/ISnort3PolicyRuleCount"},"snortEngine":{"enum":["SNORT2","SNORT3"],"type":"string"},"timestamp":{"format":"int32","type":"integer"},"usage":{"type":"object","properties":{"accesspolicy":{"format":"int32","type":"integer"},"asscoiatedAcPolicies":{"items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing 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":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"},"asscoiatedZeroTrustPolicies":{"items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing 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":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"},"devices":{"format":"int32","type":"integer"},"templates":{"format":"int32","type":"integer"},"zerotrustpolicy":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IIntrusionUsage"}},"$$ref":"#/components/schemas/IIntrusionPolicyMetadata"},"name":{"description":"Name of the Intrusion Policy.","type":"string"},"ruleRecommendation":{"description":"Indicates the rule recommendation configuration for a given Snort3 Intrusion Policy.","type":"object","properties":{"acceptDisabledRules":{"description":"Indicates whether to accept the setting to disable rules or not for rule recommendation per Snort3 Intrusion Policy.","type":"boolean"},"lastUpdatedTime":{"format":"int32","type":"integer"},"networks":{"description":"Indicates an array of input network/host objects for rule recommendation per Snort3 Intrusion Policy.","items":{"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"},"value":{"type":"string"}},"$$ref":"#/components/schemas/Snort3IPSReferenceObject"},"type":"array"},"recommendationInUse":{"description":"Indicates whether the rule recommendation generated is in use and indicates rule recommendation is already applied.","type":"boolean"},"securityLevel":{"enum":["LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4"],"type":"string"}},"$$ref":"#/components/schemas/RuleRecommendation"},"snortEngine":{"description":"Indicates the Snort engine version.","enum":["SNORT2","SNORT3"],"type":"string"},"sseProxyData":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"$$ref":"#/components/schemas/SseProxyData"},"type":{"description":"Type of the object. This value is always 'intrusionpolicy'.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/IntrusionPolicy"}}},"description":"Input representation of intrusion policy.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","description":"An object that represents the details for Intrusion Policy.","properties":{"basePolicy":{"description":"Object representing the base policy of the Intrusion Policy.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing 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":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"description":{"description":"Description of the Intrusion Policy.","type":"string"},"id":{"description":"Unique identifier of the Intrusion Policy.","type":"string"},"inlineDrop":{"description":"Indicates the inspection mode. Applicable for Snort 2 engine only. Value can be 0 or 1.","format":"int32","type":"integer"},"inspectionMode":{"description":"Indicates the inspection mode. Can be either DETECTION or PREVENTION. Only applicable for Snort 3 engine.","enum":["PREVENTION","DETECTION"],"type":"string"},"isSystemDefined":{"type":"boolean"},"links":{"description":"Object containing 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"},"metadata":{"description":"Object representing metadata properties of Intrusion Policy.","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"},"mappedPolicy":{"type":"object","properties":{"id":{"type":"string"},"inspectionMode":{"enum":["PREVENTION","DETECTION"],"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"},"snortEngine":{"enum":["SNORT2","SNORT3"],"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IIntrusionMappedPolicy"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"recommendationsDeletedNetworks":{"items":{"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"},"value":{"type":"string"}},"$$ref":"#/components/schemas/Snort3IPSReferenceObject"},"type":"array"},"ruleCount":{"type":"object","properties":{"alert":{"format":"int32","type":"integer"},"block":{"format":"int32","type":"integer"},"disabled":{"format":"int32","type":"integer"},"drop":{"format":"int32","type":"integer"},"overridden":{"format":"int32","type":"integer"},"pass":{"format":"int32","type":"integer"},"reject":{"format":"int32","type":"integer"},"rewrite":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/ISnort3PolicyRuleCount"},"snortEngine":{"enum":["SNORT2","SNORT3"],"type":"string"},"timestamp":{"format":"int32","type":"integer"},"usage":{"type":"object","properties":{"accesspolicy":{"format":"int32","type":"integer"},"asscoiatedAcPolicies":{"items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing 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":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"},"asscoiatedZeroTrustPolicies":{"items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing 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":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"},"devices":{"format":"int32","type":"integer"},"templates":{"format":"int32","type":"integer"},"zerotrustpolicy":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IIntrusionUsage"}},"$$ref":"#/components/schemas/IIntrusionPolicyMetadata"},"name":{"description":"Name of the Intrusion Policy.","type":"string"},"ruleRecommendation":{"description":"Indicates the rule recommendation configuration for a given Snort3 Intrusion Policy.","type":"object","properties":{"acceptDisabledRules":{"description":"Indicates whether to accept the setting to disable rules or not for rule recommendation per Snort3 Intrusion Policy.","type":"boolean"},"lastUpdatedTime":{"format":"int32","type":"integer"},"networks":{"description":"Indicates an array of input network/host objects for rule recommendation per Snort3 Intrusion Policy.","items":{"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"},"value":{"type":"string"}},"$$ref":"#/components/schemas/Snort3IPSReferenceObject"},"type":"array"},"recommendationInUse":{"description":"Indicates whether the rule recommendation generated is in use and indicates rule recommendation is already applied.","type":"boolean"},"securityLevel":{"enum":["LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4"],"type":"string"}},"$$ref":"#/components/schemas/RuleRecommendation"},"snortEngine":{"description":"Indicates the Snort engine version.","enum":["SNORT2","SNORT3"],"type":"string"},"sseProxyData":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"$$ref":"#/components/schemas/SseProxyData"},"type":{"description":"Type of the object. This value is always 'intrusionpolicy'.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/IntrusionPolicy"}}},"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":"createIntrusionPolicy","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/intrusionpolicies"}}