Get Netmap Host - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Netmap Host","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 host associated with the specified ID in the Network Map.**","operationId":"getNetmapHost","parameters":[{"description":"UUID of the host.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"description":"Boolean indicating whether to include the operating system of the host.","in":"query","name":"includeOs","required":false,"schema":{"type":"boolean"}},{"description":"Boolean indicating whether to include the port, protocol, and confidence of the host.","in":"query","name":"includeService","required":false,"schema":{"type":"boolean"}},{"description":"Boolean indicating whether to include the applications of the host.","in":"query","name":"includeApps","required":false,"schema":{"type":"boolean"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /api/fmc_netmap/v1/domain/DomainUUID/hosts/HostUUID ( Example for GET a Network Map host. )":{"value":{"applications":[{"appVersion":"23.0.1271.97","clientAppId":589}],"criticalityLevel":"0.0","id":"HostUUID1","ipAddress":["21.0.0.6"],"lastSeen":"2024-06-21T16:52:42.000Z","links":{"self":"https://FMC-IP/api/fmc_netmap/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/hosts/188a3462-13a5-4c31-8944-c12c406da542"},"macAddress":"0C:00:00:00:00:06","netmapNum":1,"operatingSystems":[{"osProduct":"Android","osVendor":"Google","osVersion":"6.0, 7.0, 7.1, 9.0, 10.0, 11.0, 12.0"}],"services":[{"confidence":"50.0","port":545,"protocol":"udp"}],"type":"Host"}}},"schema":{"type":"object","description":"Represents the host object in the Network Map","properties":{"applications":{"items":{"type":"object","properties":{"AppVersion":{"type":"string"},"appVersion":{"type":"string"},"clientAppId":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/NetmapApplication"},"type":"array"},"apps":{"type":"string"},"criticalityLevel":{"type":"string"},"description":{"type":"string"},"hostname":{"type":"string"},"id":{"description":"UUID of the host","type":"string"},"ipAddress":{"description":"List of IPs of the host. At this point, when creating a host, only one IP is supported, but must still be in an array","items":{"type":"string"},"type":"array"},"lastSeen":{"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"},"macAddress":{"description":"MAC of the host. This is the primary MAC of the host","type":"string"},"metadata":{"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":{"type":"string"},"netbiosName":{"type":"string"},"netmapNum":{"type":"number"},"operatingSystem":{"items":{"type":"object","properties":{"osProduct":{"type":"string"},"osVendor":{"type":"string"},"osVersion":{"type":"string"}},"$$ref":"#/components/schemas/NetmapOS"},"type":"array"},"operatingSystems":{"items":{"type":"object","properties":{"osProduct":{"type":"string"},"osVendor":{"type":"string"},"osVersion":{"type":"string"}},"$$ref":"#/components/schemas/NetmapOS"},"type":"array"},"os":{"type":"string"},"service":{"type":"string"},"services":{"items":{"type":"object","properties":{"confidence":{"type":"string"},"port":{"format":"int32","type":"integer"},"protocol":{"type":"string"}},"$$ref":"#/components/schemas/NetmapService"},"type":"array"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/NetmapHost"}}},"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":["Network Map"],"__originalOperationId":"getNetmapHost","method":"get","path":"/v1/cdfmc/api/fmc_netmap/v1/domain/{domainUUID}/hosts/{objectId}"}}