Get All FQDN Object - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All FQDN 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":"**Get the list of all fully-qualified domain names.**","operationId":"getAllFQDNObject","parameters":[{"description":"To be used in conjunction with \u003ccode\u003e\"unusedOnly:true\"\u003c/code\u003e to search for unused objects and \u003ccode\u003e\"nameOrValue:{nameOrValue}\"\u003c/code\u003e to search for both name and value.\u003cbr/\u003e\u003ccode\u003e\"ids:id1,id2,...\"\u003c/code\u003e.\u003ccode\u003eids\u003c/code\u003e is a comma-separated list of rule IDs.","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"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"},{"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/3333-4444-5555-666/object/fqdns ( Get all paginated FQDN objects )":{"value":{"items":[{"id":"1111-2222-3333-4444","links":{"parent":"/fmc_config/v1/domain/default/object/networkaddresses","self":"/fmc_config/v1/domain/default/object/fqdns/1111-2222-3333-4444"},"name":"newFQDN","type":"FQDN"},{"id":"2222-3333-4444-5555","links":{"parent":"/fmc_config/v1/domain/default/object/networkaddresses","self":"/fmc_config/v1/domain/default/object/fqdns/2222-3333-4444-5555"},"name":"Test1","type":"FQDN"}],"links":{"self":"/fmc_config/v1/domain/default/object/fqdns?offset=0&limit=2"},"paging":{"count":2,"limit":2,"offset":0,"pages":1}}},"Example 2 : GET /fmc_config/v1/domain/3333-4444-5555-666/object/fqdns?expanded=true ( Get all paginated FQDN objects with expanded set to true )":{"value":{"items":[{"description":" ","dnsResolution":"IPV4_ONLY","id":"1111-2222-3333-4444","links":{"parent":"/fmc_config/v1/domain/default/object/networkaddresses","self":"/fmc_config/v1/domain/default/object/fqdns/1111-2222-3333-4444"},"metadata":{"domain":{"id":"domainUuid","name":"Global"},"lastUser":{"name":"admin"},"parentType":"NetworkAddress"},"name":"MarketPlace","overridable":false,"type":"FQDN","value":"marketplace.cisco.com"},{"description":" ","dnsResolution":"IPV4_AND_IPV6","id":"2222-3333-4444-5555","links":{"parent":"/fmc_config/v1/domain/default/object/networkaddresses","self":"/fmc_config/v1/domain/default/object/fqdns/2222-3333-4444-5555"},"metadata":{"domain":{"id":"domainUuid","name":"Global"},"lastUser":{"name":"admin"},"parentType":"NetworkAddress"},"name":"Test1","overridable":false,"type":"FQDN","value":"downloads.cisco.com"}],"links":{"self":"/fmc_config/v1/domain/default/object/fqdns?offset=0&limit=2"},"paging":{"count":2,"limit":2,"offset":0,"pages":1}}},"Example 3 : GET /fmc_config/v1/domain/domainUuid/object/fqdns?expanded=true&overrideTargetId=4444-5555-6666-7777 ( Success: Test GET ALL method from global domain for fqdnObject when overrides are assigned to child domain )":{"value":{"items":[{"description":" ","id":"2222-3333-4444-5555","links":{"parent":"/fmc_config/v1/domain/domainUuid/object/networkaddresses","self":"/fmc_config/v1/domain/domainUuid/object/fqdns/2222-3333-4444-5555?overrideTargetId=3333-4444-5555-666"},"metadata":{"domain":{"id":"3333-4444-5555-666","name":"Global \\ Asia"},"ipType":"V_4","lastUser":{"name":"pvs"},"parentType":"NetworkAddress"},"name":"pvs_global","overridable":true,"overrides":{"parent":{"id":"2222-3333-4444-5555","type":"FQDN"},"target":{"id":"3333-4444-5555-666","name":"Global \\ Asia","type":"Domain"}},"type":"FQDN","value":"marketplace.cisco.com"}],"links":{"self":"/fmc_config/v1/domain/domainUuid/object/fqdns?offset=0&limit=1"},"paging":{"count":1,"limit":1,"offset":0,"pages":1}}},"Example 4 : GET /fmc_config/v1/domain/4444-5555-6666-7777/object/fqdns?expanded=true&overrideTargetId=4444-5555-6666-7777 ( Success: Test GET ALL method from child domain for fqdnObject when overrides are assigned to child domain )":{"value":{"items":[{"description":" ","id":"2222-3333-4444-5555","links":{"parent":"/fmc_config/v1/domain/3333-4444-5555-666/object/networkaddresses","self":"/fmc_config/v1/domain/3333-4444-5555-666/object/fqdns/2222-3333-4444-5555?overrideTargetId=3333-4444-5555-666"},"metadata":{"domain":{"id":"3333-4444-5555-666","name":"Global \\ Asia"},"ipType":"V_4","lastUser":{"name":"pvs"},"parentType":"NetworkAddress"},"name":"pvs_global","overridable":true,"overrides":{"parent":{"id":"2222-3333-4444-5555","type":"FQDN"},"target":{"id":"3333-4444-5555-666","name":"Global \\ Asia","type":"Domain"}},"type":"FQDN","value":"marketplace.cisco.com"}],"links":{"self":"/fmc_config/v1/domain/3333-4444-5555-666/object/fqdns?offset=0&limit=1&overrideTargetId=3333-4444-5555-666"},"paging":{"count":1,"limit":1,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","properties":{"description":{"type":"string"},"dnsResolution":{"enum":["IPV4_ONLY","IPV6_ONLY","IPV4_AND_IPV6"],"type":"string"},"id":{"type":"string"},"links":{"type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"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":{"type":"string"},"overridable":{"type":"boolean"},"overrideTargetId":{"type":"string"},"overrides":{"type":"object","description":"Defines the override details for this object.","properties":{"parent":{"description":"Link to the parent/global resource which is overriden.","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"},"target":{"description":"The device or the domain target on which this override is enabled.","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"}},"$$ref":"#/components/schemas/IOverride"},"type":{"type":"string"},"value":{"type":"string"},"version":{"type":"string"}},"required":["dnsResolution"],"$$ref":"#/components/schemas/FQDNObject"},"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/FQDNObjectListContainer"}}},"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":["Object"],"__originalOperationId":"getAllFQDNObject","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/fqdns"}}