LogoLogo
DocsSupportDashboard
  • Introduction
    • Data Types
    • Target Filtering
    • Scan Selection
    • Pagination & Sorting
    • Permissions
    • Appendix
  • Authentication
  • Webhooks
  • Events
  • Appendix
    • Targets Filter
    • Date Match
    • IP Range
  • Endpoints
    • Discovery
    • Target
    • Scan
    • Issue
    • Tag
    • Port
    • DNS
    • HTTP
    • Whois
    • Technology
    • Website
    • Acknowledged
    • Event
    • Dark Web
    • Integration
    • PCI
    • Report
    • User
    • Account
    • Security
    • File
    • Work
Powered by GitBook

© 2024 Halo Security

On this page
  • Get a count of discovered assets.
  • Get list of discovered assets.
  • Get list of domains set for discovery.
  • Get list of discovered hostnames.
  • Get list of discovered tlds.
  • Get list of networks set for discovery.
  • Get list of discovered network ips.
  • Get list of network ports.

Was this helpful?

  1. Endpoints

Discovery

The discovery endpoints allows you to access the domains and networks being used for discovery, as well as the the discovered hosts and IPs.

PreviousIP RangeNextTarget

Last updated 11 months ago

Was this helpful?

Get a count of discovered assets.

GET https://api.halosecurity.com/api/v1/discovery/host-summary.json

Returns a count of discovered assets.

{
    "total": 0
}

Get list of discovered assets.

GET https://api.halosecurity.com/api/v1/discovery/host-list.json

Returns a paginated list of discovered assets.

Query Parameters

Name
Type
Description

sort

Integer

0

= fqdn (default)

sort_desc

Integer

0 = No (default)

1 = Yes

hostinfo

Integer

0 = No (default)

1 = Yes

{
    "request": {
        "target_count": 1,
        "sort": "1"
    },
    "pagination": {
        "next": 100,
        "total": 0,
        "start": 0,
        "limit": 100
    },
    "list": [
        {
            "fqdn": "www.example.com",
            "hostinfo": {
                "geo": "US-WA",
                "http_code": 200,
                "ip": "0.0.0.0",
                "favicon_hash": "0",
                "pop_rank": 1,
                "http_location": "https://www.example.com/",
                "tags": [
                    "one",
                    "two"
                ]
            },
            "target": {
                "ip": "0.0.0.0",
                "name": "example",
                "host": "www.example.com",
                "id": 1,
                "scan_id": "0"
            }
        }
    ]
}

Get list of domains set for discovery.

GET https://docs.halosecurity.com/api/v1/discovery/domain-list.json

Returns a paginated list of domains.

Query Parameters

Name
Type
Description

sort

Integer

0

= domain (default)

sort_desc

Integer

0 = No (default)

1 = Yes

domain

String

Filter by domain

{
    "list": [
        {
            "domain": {
                "domain_id": 1,
                "domain": "example.com"
            }
        }
    ]
}

Get list of discovered hostnames.

GET https://docs.halosecurity.com/api/v1/discovery/domain-host-list.json

Returns a paginated list of discovered hostnames.

Query Parameters

Name
Type
Description

sort

Integer

0

= domain (default)

sort_desc

Integer

0 = No (default)

1 = Yes

domain

String

Filter by domain

host

String

Filter by subdomain

{
    "list": [
        {
            "domain": {
                "domain_id": 1,
                "domain": "example.com"
            },
            "host": {
                "domain_id": 1,
                "fqdn": "www.example.com",
                "ip": "0.0.0.0",
                "host": "www",
                "target_id": "1"
            }
        }
    ]
}

Get list of discovered tlds.

GET https://docs.halosecurity.com/api/v1/discovery/domain-tld-list.json

Returns a paginated list of discovered tlds.

Query Parameters

Name
Type
Description

sort

Integer

0

= domain (default)

sort_desc

Integer

0 = No (default)

1 = Yes

domain

String

Filter by domain

{
    "list": [
        {
            "domain": {
                "domain_id": 1,
                "domain": "example.com"
            },
            "tld": {
                "domain_id": 1,
                "fqdn": "example.ph",
                "ip": "0.0.0.0",
                "tld": "ph"
            }
        }
    ]
}

Get list of networks set for discovery.

GET https://docs.halosecurity.com/api/v1/discovery/network-list.json

Returns a paginated list of networks.

Query Parameters

Name
Type
Description

sort

Integer

0

= network (default)

sort_desc

Integer

0 = No (default)

1 = Yes

{
    "list": [
        {
            "network": {
                "network_id": 1,
                "network_name": "example",
                "network": "0.0.0.0/24"
            }
        }
    ]
}

Get list of discovered network ips.

GET https://docs.halosecurity.com/api/v1/discovery/network-ip-list.json

Returns a paginated list of discovered network ips.

Query Parameters

Name
Type
Description

sort

Integer

0

= ip (default)

sort_desc

Integer

0 = No (default)

1 = Yes

{
    "list": [
        {
            "ip": "0.0.0.0",
            "network": {
                "network_id": 1,
                "network_name": "example",
                "network": "0.0.0.0/24"
            }
        }
    ]
}

Get list of network ports.

GET https://docs.halosecurity.com/api/v1/discovery/network-port-list.json

Returns a paginated list of discovered network ports.

Query Parameters

Name
Type
Description

sort

Integer

0

= ip (default)

sort_desc

Integer

0 = No (default)

1 = Yes

protocol

String

Filter by protocol

port

Integer

Filter by port

ip

String

Filter by ip

{
    "list": [
        {
            "port": {
                "protocol": "tcp",
                "port": 80,
                "ip": "0.0.0.0"
            },
            "network": {
                "network_id": 1,
                "network_name": "example",
                "network": "0.0.0.0/24"
            }
        }
    ]
}

https://www.halosecurity.com/user/security/discovery/
https://www.halosecurity.com/user/security/discovery/
https://www.halosecurity.com/user/security/discovery/domains/
https://www.halosecurity.com/user/security/discovery/?source=domain
https://www.halosecurity.com/user/security/discovery/
https://www.halosecurity.com/user/security/discovery/networks/
https://www.halosecurity.com/user/security/discovery/networks/ips
https://www.halosecurity.com/user/security/discovery/networks/ports