Get Allow DNS Rule - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Allow DNS Rule","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 allow rules for a DNS policy.**","operationId":"getAllowDNSRule","parameters":[{"description":"Filter criteria can be specified using the format \u003ccode\u003ename:rule_name\u003c/code\u003e\u003cbr/\u003e\u003cbr/\u003e\u003ccode\u003ename\u003c/code\u003e -- Name of the allow rule to be queried \u003cbr/\u003e","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"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/dnspolicies/dnspolicyUUID/allowdnsrules?expanded=false&offset=0&limit=2 ( Get all paginated DNS Policy Allow Rules for a given DNS Policy UUID with limit set to 2 )":{"value":{"items":[{"action":"ALLOW","name":"DNSRuleName","type":"AllowDNSRule"},{"action":"ALLOW","name":"DNSRuleName","type":"AllowDNSRule"}],"links":{"self":"/fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/allowdnsrules?expanded=false&offset=0&limit=2"},"paging":{"count":"2","limit":"2","offset":"0","pages":"1"}}},"Example 2 : GET /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/allowdnsrules?expanded=true&offset=0&limit=1 ( Get all paginated DNS Policy Allow Rules for a given DNS Policy UUID with limit set to 1 and expanded true )":{"value":{"items":[{"action":"ALLOW","dnsLists":{"objects":[{"id":"SIDNSListUUID","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/sidnslists/SIDNSListUUID"},"name":"Global-Do-Not-Block-List-for-DNS","type":"SIDNSList"}]},"enabled":true,"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},"ruleIndex":0,"timestamp":1601994796},"name":"Global-Do-Not-Block-List-for-DNS","systemDefault":true,"type":"AllowDNSRule"}],"links":{"self":"/fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/allowdnsrules?expanded=true&offset=0&limit=1"},"paging":{"count":"1","limit":"1","offset":"0","pages":"1"}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Description of DNS Policy Rule.","properties":{"action":{"description":"The type of the rule. Possible values are: ALLOW, BLOCK, MONITOR, SINKHOLE, NXDOMAIN","enum":["ALLOW","MONITOR","SINKHOLE","BLOCK","NXDOMAIN"],"type":"string"},"description":{"type":"string"},"dnsFeeds":{"description":"List of DNS Feed objects","type":"object","properties":{"literals":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/IValueLiteral"},"type":"array"},"objects":{"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"}},"$$ref":"#/components/schemas/IReferenceContainer"},"dnsLists":{"description":"List of DNS List objects","type":"object","properties":{"literals":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/IValueLiteral"},"type":"array"},"objects":{"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"}},"$$ref":"#/components/schemas/IReferenceContainer"},"enabled":{"description":"Boolean property indicating if the rule is enabled","type":"boolean"},"id":{"description":"Unique identifier (UUID) representing the DNS policy Rule.","type":"string"},"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":{"description":"User-specified name of the DNS policy Rule.","type":"string"},"networks":{"description":"Contains network objects referenced by the rule. It is split in 2 separate lists: objects and literals","type":"object","properties":{"literals":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/IValueLiteral"},"type":"array"},"objects":{"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"}},"$$ref":"#/components/schemas/IReferenceContainer"},"sinkhole":{"description":"If the action of the rule is SINKHOLE, then this attribute contains the sinkhole object referenced","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"},"sourceZones":{"description":"Contains a list or Security Zone objects referenced by the rule","type":"object","properties":{"literals":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/IValueLiteral"},"type":"array"},"objects":{"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"}},"$$ref":"#/components/schemas/IReferenceContainer"},"systemDefault":{"description":"Boolean property indicating if the current rule is a system defined one","type":"boolean"},"type":{"description":"Type of the DNS Policy Rule; this value is always AllowDNSRule.","type":"string"},"version":{"type":"string"},"vlanTags":{"description":"Contains VLAN tag objects referenced by the rule. It is split in 2 separate lists: objects and literals","type":"object","properties":{"literals":{"items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/IValueLiteral"},"type":"array"},"objects":{"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"}},"$$ref":"#/components/schemas/IReferenceContainer"}},"$$ref":"#/components/schemas/AllowDNSRule"},"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/AllowDNSRuleListContainer"}}},"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":"getAllowDNSRule","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{containerUUID}/allowdnsrules"}}