Get All File Rule Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All File Rule Model","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 the list of all file rules.**","operationId":"getAllFileRuleModel","parameters":[{"description":"The container id under which this specific resource is contained.","in":"path","name":"containerUUID","required":true,"schema":{"type":"string"}},{"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/policy/filepolicies/filepolicyUUID/filerules?limit=2&expanded=true ( Success: Test GET ALL success of all the file rules with expanded=true )":{"value":{"items":[{"action":"DETECT","direction":"ANY","fileCategories":[{"id":"2","name":"Archive","type":"FileCategory"}],"fileTypes":[{"id":"19","name":"7Z","type":"FileType"}],"id":"exampleFileRuleId1","links":{"self":"https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules/fileruleId"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"id":"68d03c42-d9bd-11dc-89f2-b7961d42c462","name":"admin","type":"user"},"readOnly":{"state":false},"timestamp":1673362666},"protocol":"ANY","type":"FileRule"},{"action":"DETECT","direction":"ANY","fileCategories":[{"id":"2","name":"Archive","type":"FileCategory"}],"fileTypes":[{"id":"19","name":"7Z","type":"FileType"}],"id":"exampleFileRuleId2","links":{"self":"https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules/fileruleId"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"id":"68d03c42-d9bd-11dc-89f2-b7961d42c462","name":"admin","type":"user"},"readOnly":{"state":false},"timestamp":1673362666},"protocol":"ANY","type":"FileRule"}],"links":{"self":"https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules?limit=2&expanded=true"},"paging":{"count":2,"limit":2,"offset":0,"pages":1}}},"Example 2 : GET /fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules?limit=2&expanded=false ( Success: Test GET ALL success of all the file categories with expanded=false )":{"value":{"items":[{"id":"exampleFileRuleId","links":{"self":"https://u45c01p01-vrouter.cisco.com:6321/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/filepolicies/1a048a88-8ec4-11ed-acbf-ee690fe4b009/filerules/d200d3c7-267b-2c22-134a-000000000000"},"type":"FileRule"},{"id":"exampleFileRuleId2","links":{"self":"https://u45c01p01-vrouter.cisco.com:6321/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/filepolicies/1a048a88-8ec4-11ed-acbf-ee690fe4b009/filerules/d200d3c7-267b-2c22-134a-000000000000"},"type":"FileRule"}],"links":{"self":"https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules?limit=2&expanded=false"},"paging":{"count":2,"limit":2,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Object representing a FileRule object within FilePolicy.","properties":{"action":{"description":"Action to be performed on a file (DETECT, BLOCK_WITH_RESET, DETECT_MALWARE, BLOCK_MALWARE_WITH_RESET).","type":"string"},"analysis":{"description":"Defines a list of analysis options applied to selected file types (capacity, spero, sandbox, clamscan).","items":{"type":"string"},"type":"array"},"description":{"description":"Description of the file rule.","type":"string"},"direction":{"description":"Direction of file transfer (ANY, UPLOAD, DOWNLOAD).","type":"string"},"fileCategories":{"description":"Defines a list of file categories for inspection.","items":{"type":"object"},"type":"array"},"fileTypes":{"description":"Defines a list of file types for inspection.","items":{"type":"object"},"type":"array"},"id":{"description":"Unique identifier representing the FileRule.","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"},"metadata":{"description":"Object representing metadata attributes for the FileRule object.","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":{"description":"Name of the FileRule object.","type":"string"},"protocol":{"description":"Defines a protocol for file inspection (ANY, HTTP, SMTP, IMAP, POP3, FTP, SMB).","type":"string"},"storeFiles":{"description":"List of file dispositions that should be stored (MALWARE, CUSTOM, CLEAN, UNKNOWN).","items":{"type":"string"},"type":"array"},"type":{"description":"Type must be FileRule.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/FileRuleModel"},"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/FileRuleModelListContainer"}}},"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":["Policy"],"__originalOperationId":"getAllFileRuleModel","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules"}}