Create Snort 3 IPS Rules File Upload - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Snort 3 IPS Rules File Upload","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":"**Import custom Snort3 intrusion rules. _Check the response section for applicable examples (if any)._**","operationId":"createSnort3IPSRulesFileUpload","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":{"multipart/form-data":{"examples":{"Example 1 : POST /fmc_config/v1/domain/domainUUID/object/intrusionrulesupload ( Success: Test POST method for Snort3IPSRulesFileUpload )":{"value":{"payloadFile":".rules or .txt format Snort3 rule file","ruleGroups":"group-id1,group-id2,group-id3","ruleImportMode":"ENUM (MERGE, REPLACE)","validateOnly":"TRUE or FALSE"}}},"schema":{"properties":{"payloadFile":{"description":"File containing the custom Snort 3 intrusion rules. \u003ccode\u003e.rules and .txt\u003c/code\u003e are supported file formats.\u003ccode\u003e*required\u003c/code\u003e","format":"binary","type":"string"},"ruleComment":{"description":"Rule comment.","type":"string"},"ruleGroups":{"description":"Comma-separated list of rulegroups to which rules should be associated. Example are group-id1,group-id2.","type":"string"},"ruleImportMode":{"description":"Enums used to add, update or replace the rules in the rulegroups.\u003ccode\u003eMERGE\u003c/code\u003e and \u003ccode\u003eREPLACE\u003c/code\u003e are supported enums.\u003ccode\u003e*required\u003c/code\u003e","type":"string"},"validateOnly":{"description":"Boolean identifier to validate or import rules. \u003ccode\u003etrue\u003c/code\u003e is the default value.","type":"boolean"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","description":"An object that represents the details for Snort3 custom rule import.","properties":{"files":{"items":{"type":"object","properties":{"attrib":{"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"},"name":{"type":"string"},"path":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IFileWrapper"},"type":"array"},"ruleComment":{"type":"string"},"ruleGroups":{"description":"Indicates the comma separated List of rule groups to which rules should be associated.","type":"object","$$ref":"#/components/schemas/Object"},"ruleImportMode":{"description":"Indicates the rule Import mode. Can be either MERGE or REPLACE.","enum":["MERGE","REPLACE"],"type":"string"},"summary":{"description":"Object representing details of Deleted,Added,Unassociated,Updated,Skipped rules.","type":"object","properties":{"added":{"description":"Specifies the details of added rule.","type":"object","properties":{"count":{"description":"Specifies the count of added,udpated,deleted,skipped,unassociated rules.By default shows 0","format":"int32","type":"integer"},"rules":{"description":"Specifies the rule details in the format GID:SID for the imported rules.","items":{"type":"string"},"type":"array"},"type":{"description":"Type of the response object. This value is always ruleimportsummaryentry.","type":"string"}},"$$ref":"#/components/schemas/RuleImportSummaryEntry"},"deleted":{"description":"Specifies the details of deleted rule.","type":"object","properties":{"count":{"description":"Specifies the count of added,udpated,deleted,skipped,unassociated rules.By default shows 0","format":"int32","type":"integer"},"rules":{"description":"Specifies the rule details in the format GID:SID for the imported rules.","items":{"type":"string"},"type":"array"},"type":{"description":"Type of the response object. This value is always ruleimportsummaryentry.","type":"string"}},"$$ref":"#/components/schemas/RuleImportSummaryEntry"},"skipped":{"description":"Specifies the details of skipped rule.","type":"object","properties":{"count":{"description":"Specifies the count of added,udpated,deleted,skipped,unassociated rules.By default shows 0","format":"int32","type":"integer"},"rules":{"description":"Specifies the rule details in the format GID:SID for the imported rules.","items":{"type":"string"},"type":"array"},"type":{"description":"Type of the response object. This value is always ruleimportsummaryentry.","type":"string"}},"$$ref":"#/components/schemas/RuleImportSummaryEntry"},"type":{"description":"Type of the response object. This value is always ruleimportsummary.","type":"string"},"unassociated":{"description":"Specifies the details of unassociated rule.","type":"object","properties":{"count":{"description":"Specifies the count of added,udpated,deleted,skipped,unassociated rules.By default shows 0","format":"int32","type":"integer"},"rules":{"description":"Specifies the rule details in the format GID:SID for the imported rules.","items":{"type":"string"},"type":"array"},"type":{"description":"Type of the response object. This value is always ruleimportsummaryentry.","type":"string"}},"$$ref":"#/components/schemas/RuleImportSummaryEntry"},"updated":{"description":"Specifies the details of updated rule.","type":"object","properties":{"count":{"description":"Specifies the count of added,udpated,deleted,skipped,unassociated rules.By default shows 0","format":"int32","type":"integer"},"rules":{"description":"Specifies the rule details in the format GID:SID for the imported rules.","items":{"type":"string"},"type":"array"},"type":{"description":"Type of the response object. This value is always ruleimportsummaryentry.","type":"string"}},"$$ref":"#/components/schemas/RuleImportSummaryEntry"}},"$$ref":"#/components/schemas/RuleImportSummary"},"validateOnly":{"description":"Specifies if rules should be validated or validated and imported. Default value is true.","type":"boolean"}},"$$ref":"#/components/schemas/Snort3IPSRulesFileUpload"}}},"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":"createSnort3IPSRulesFileUpload","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/intrusionrulesupload"}}