Create Multiple Snort 3 Intrusion Rule Groups Object - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Multiple Snort 3 Intrusion Rule Groups Object","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 Snort3 intrusion rule group. _Check the response section for applicable examples (if any)._**","operationId":"createMultipleSnort3IntrusionRuleGroupsObject","parameters":[{"description":"Boolean indicating whether this is a bulk operation.","in":"query","name":"bulk","required":false,"schema":{"type":"boolean"}},{"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/object/intrusionrulegroups ( Success: POST method for Snort3IntrusionRuleGroupsObject with minimum required fields )":{"value":{"description":"Custom Intrusion Rule group1","name":"Custom RuleGroup 1","type":"IntrusionRuleGroup"}}},"schema":{"description":"Object representing details for Snort 3 intrusion rulegroup.","properties":{"canonicalName":{"description":"Fully Qualified name of Snort 3 intrusion rulegroup.","type":"string"},"childGroups":{"description":"List of IntrusionRuleGroups associated with the parent rulegroup.","items":{"properties":{"canonicalName":{"type":"string"},"childGroups":{"items":{"$ref":"#/components/schemas/ISnort3IntrusionRuleGroupsModel","type":"object"},"type":"array"},"defaultSecurityLevel":{"enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"isSystemDefined":{"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":{"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"},"name":{"type":"string"},"overrideSecurityLevel":{"enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"parentGroup":{"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"},"totalRuleCount":{"format":"int32","type":"integer"},"type":{"type":"string"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ISnort3IntrusionRuleGroupsModel"},"type":"array"},"defaultSecurityLevel":{"enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"description":{"description":"Description of the Snort 3 intrusion rulegroup.","type":"string"},"id":{"description":"Unique identifier of the Snort 3 intrusion rulegroup.","type":"string"},"isSystemDefined":{"description":"Read-only field indicating if the rulegroup is system-defined (i.e., Talos provided). If value is false, then rule is user-defined.","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 Snort 3 intrusion rulegroup.","type":"object","properties":{"container":{"description":"Container reference of rule group.","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"},"domain":{"type":"object","description":"The details about the domain.","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":{"type":"object","description":"This object defines details about the user.","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"},"mitreId":{"description":"Mitre Id of the rule group.","type":"string"},"readOnly":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","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"},"ruleCount":{"description":"Rule count of each intrusion rule group.","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"},"securityLevels":{"items":{"type":"object","description":"Object representing the security levels of Snort 3 intrusion rulegroup.","properties":{"description":{"description":"Description of the Snort 3 intrusion rulegroup.","type":"string"},"level":{"description":"Security levels of a Snort 3 intrusion rulegroup.","enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"warning":{"description":"Warning for each level of Snort 3 intrusion rulegroup","type":"string"}},"$$ref":"#/components/schemas/ISnort3IntrusionRuleGroupSecLevels"},"type":"array"},"sortOrder":{"description":"Sort order of the rule group.","format":"int32","type":"integer"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Snort3IntrusionRuleGroupMetadata"},"name":{"description":"Name of the Snort 3 intrusion rulegroup.","type":"string"},"overrideSecurityLevel":{"enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"parentGroup":{"description":"Object representing parent group of the current Snort 3 intrusion rulegroup.","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"},"totalRuleCount":{"description":"Total rules count for the current Snort 3 intrusion rulegroup.","format":"int32","type":"integer"},"type":{"description":"Type of the response object. This value is always IntrusionRuleGroup.","type":"string"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/Snort3IntrusionRuleGroupsObject"}}},"description":"Input representation of Snort 3 rule group.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/intrusionrulegroups ( Success: POST method for Snort3IntrusionRuleGroupsObject with minimum required fields )":{"value":{"description":"Custom Intrusion Rule group1","id":"0050568A-ED69-0ed3-0000-055834574910","isSystemDefined":false,"links":{"parent":"https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups","self":"https://u32c01p10-vrouter.cisco.com:10514/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/intrusionrulegroups/0050568A-ED69-0ed3-0000-055834574910"},"name":"Custom RuleGroup 1","type":"IntrusionRuleGroup"}}},"schema":{"description":"Object representing details for Snort 3 intrusion rulegroup.","properties":{"canonicalName":{"description":"Fully Qualified name of Snort 3 intrusion rulegroup.","type":"string"},"childGroups":{"description":"List of IntrusionRuleGroups associated with the parent rulegroup.","items":{"properties":{"canonicalName":{"type":"string"},"childGroups":{"items":{"$ref":"#/components/schemas/ISnort3IntrusionRuleGroupsModel","type":"object"},"type":"array"},"defaultSecurityLevel":{"enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"isSystemDefined":{"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":{"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"},"name":{"type":"string"},"overrideSecurityLevel":{"enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"parentGroup":{"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"},"totalRuleCount":{"format":"int32","type":"integer"},"type":{"type":"string"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ISnort3IntrusionRuleGroupsModel"},"type":"array"},"defaultSecurityLevel":{"enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"description":{"description":"Description of the Snort 3 intrusion rulegroup.","type":"string"},"id":{"description":"Unique identifier of the Snort 3 intrusion rulegroup.","type":"string"},"isSystemDefined":{"description":"Read-only field indicating if the rulegroup is system-defined (i.e., Talos provided). If value is false, then rule is user-defined.","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 Snort 3 intrusion rulegroup.","type":"object","properties":{"container":{"description":"Container reference of rule group.","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"},"domain":{"type":"object","description":"The details about the domain.","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":{"type":"object","description":"This object defines details about the user.","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"},"mitreId":{"description":"Mitre Id of the rule group.","type":"string"},"readOnly":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","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"},"ruleCount":{"description":"Rule count of each intrusion rule group.","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"},"securityLevels":{"items":{"type":"object","description":"Object representing the security levels of Snort 3 intrusion rulegroup.","properties":{"description":{"description":"Description of the Snort 3 intrusion rulegroup.","type":"string"},"level":{"description":"Security levels of a Snort 3 intrusion rulegroup.","enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"warning":{"description":"Warning for each level of Snort 3 intrusion rulegroup","type":"string"}},"$$ref":"#/components/schemas/ISnort3IntrusionRuleGroupSecLevels"},"type":"array"},"sortOrder":{"description":"Sort order of the rule group.","format":"int32","type":"integer"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Snort3IntrusionRuleGroupMetadata"},"name":{"description":"Name of the Snort 3 intrusion rulegroup.","type":"string"},"overrideSecurityLevel":{"enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4","DEFAULT"],"type":"string"},"parentGroup":{"description":"Object representing parent group of the current Snort 3 intrusion rulegroup.","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"},"totalRuleCount":{"description":"Total rules count for the current Snort 3 intrusion rulegroup.","format":"int32","type":"integer"},"type":{"description":"Type of the response object. This value is always IntrusionRuleGroup.","type":"string"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/Snort3IntrusionRuleGroupsObject"}}},"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":["Object"],"__originalOperationId":"createMultipleSnort3IntrusionRuleGroupsObject","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulegroups"}}