Get Network Address - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Network Address","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 types of network objects including Network, Host, Range, and FQDN.**","operationId":"getNetworkAddress","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 and \u003ccode\u003e\"type:{subType}\"\u003c/code\u003e to search for specific subType of the network object. \u003ccode\u003e\"type:{FQDN,RANGE,HOST,NETWORK}\"\u003c/code\u003e is for include and \u003ccode\u003e\"type!{FQDN,RANGE,HOST,NETWORK}\"\u003c/code\u003e is for exclude. To search for wildcard object type:NETWORK;includeWildcard:true.","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/domainUUID/object/networkaddresses ( GET ALL NetworkAddresses )":{"value":{"items":[{"id":"Network-UUID-1","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-1"},"name":"any","type":"Network"},{"id":"Network-UUID-2","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-2"},"name":"any-ipv4","type":"Network"},{"id":"Host-UUID-1","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-1"},"name":"any-ipv6","type":"Host"},{"id":"Network-UUID-3","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses//Network-UUID-3"},"name":"IPv4-Benchmark-Tests","type":"Network"},{"id":"Network-UUID-4","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-4"},"name":"IPv4-Link-Local","type":"Network"},{"id":"Network-UUID-5","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-5"},"name":"IPv4-Multicast","type":"Network"},{"id":"Network-UUID-6","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-6"},"name":"IPv4-Private-10.0.0.0-8","type":"Network"},{"id":"Network-UUID-7","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-7"},"name":"IPv4-Private-172.16.0.0-12","type":"Network"},{"id":"Network-UUID-8","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-8"},"name":"IPv4-Private-192.168.0.0-16","type":"Network"},{"id":"Network-UUID-9","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-9"},"name":"IPv6-IPv4-Mapped","type":"Network"},{"id":"Network-UUID-10","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-10"},"name":"IPv6-Link-Local","type":"Network"},{"id":"Network-UUID-11","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-11"},"name":"IPv6-Private-Unique-Local-Addresses","type":"Network"},{"id":"Network-UUID-12","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-12"},"name":"IPv6-to-IPv4-Relay-Anycast","type":"Network"},{"id":"Network-UUID-13","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-13"},"name":"NewTest","type":"Network"},{"id":"Network-UUID-14","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-14"},"name":"TestGlobal","type":"Network"},{"id":"Host-UUID-2","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-2"},"name":"TestHost","type":"Host"},{"id":"Host-UUID-3","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-3"},"name":"TestHost1","type":"Host"},{"id":"Host-UUID-4","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-4"},"name":"TestHostTestDomain","type":"Host"},{"id":"Host-UUID-5","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-5"},"name":"TestTestDomain","type":"Network"}],"links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses?offset=0&limit=19"},"paging":{"count":19,"limit":19,"offset":0,"pages":1}}},"Example 2 : GET /fmc_config/v1/domain/domainUUID/object/networkaddresses?expanded=true ( GET ALL NetworkAddresses )":{"value":{"items":[{"description":" ","id":"Network-UUID-1","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-1"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"any","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-2","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-2"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"any-ipv4","overridable":false,"type":"Network"},{"description":" ","id":"Host-UUID-1","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-1"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"any-ipv6","overridable":false,"type":"Host"},{"description":" ","id":"Network-UUID-3","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-3"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv4-Benchmark-Tests","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-4","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-4"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv4-Link-Local","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-5","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-5"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv4-Multicast","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-6","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-6"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv4-Private-10.0.0.0-8","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-7","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-7"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv4-Private-172.16.0.0-12","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-8","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-8"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv4-Private-192.168.0.0-16","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-9","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-9"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv6-IPv4-Mapped","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-10","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-10"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv6-Link-Local","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-11","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-11"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv6-Private-Unique-Local-Addresses","overridable":false,"type":"Network"},{"description":" ","id":"Network-UUID-12","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-12"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"},"readOnly":{"reason":"SYSTEM","state":true}},"name":"IPv6-to-IPv4-Relay-Anycast","overridable":false,"type":"Network"},{"description":"Test New","id":"Network-UUID-13","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-13"},"metadata":{"domain":{"id":"domainUUID","name":"Global \\ TestDomain"},"lastUser":{"name":"testuser"}},"name":"NewTest","overridable":false,"type":"Network"},{"description":"TestGlobal","id":"Network-UUID-14","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Network-UUID-14"},"metadata":{"domain":{"id":"Global-domain-UUID","name":"Global"},"lastUser":{"name":"testuser"}},"name":"TestGlobal","overridable":false,"type":"Network"},{"description":" ","id":"Host-UUID-2","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-2"},"metadata":{"domain":{"id":"domainUUID","name":"Global \\ TestDomain"},"lastUser":{"name":"testuser"}},"name":"TestHost","overridable":false,"type":"Host"},{"description":" ","id":"Host-UUID-3","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-3"},"metadata":{"domain":{"id":"domainUUID","name":"Global \\ TestDomain"},"lastUser":{"name":"testuser"}},"name":"TestHost1","overridable":false,"type":"Host"},{"description":" ","id":"Host-UUID-4","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-4"},"metadata":{"domain":{"id":"domainUUID","name":"Global \\ TestDomain"},"lastUser":{"name":"testuser"}},"name":"TestHostTestDomain","overridable":false,"type":"Host"},{"description":"TestTestDomain","id":"Host-UUID-5","links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses/Host-UUID-5"},"metadata":{"domain":{"id":"domainUUID","name":"Global \\ TestDomain"},"lastUser":{"name":"testuser"}},"name":"TestTestDomain","overridable":false,"type":"Network"}],"links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/object/networkaddresses?offset=0&limit=19"},"paging":{"count":19,"limit":19,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"A model representing Network Address definition representing parent of Network sub types.","properties":{"description":{"type":"string"},"id":{"description":"Unique identifier of response object.","type":"string"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata properties of response object.","type":"object","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 chosen resource name.","type":"string"},"overridable":{"description":"Boolean indicating whether object values can be overridden.","type":"boolean"},"overrideTargetId":{"description":"Unique identifier of domain or device when override assigned to child domain. Used as path parameter to GET override details for a specific object on a specific target (device or domain).","type":"string"},"overrides":{"description":"An object override allows you to define an alternate value for an object.","type":"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":{"description":"Subtype of NetworkAddress (Host | Network | Range | NetworkGroup).","type":"string"},"value":{"description":"Actual value of child object.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/NetworkAddress"},"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/NetworkAddressListContainer"}}},"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":"getNetworkAddress","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/networkaddresses"}}