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.

Get a count of discovered assets.

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

Returns a count of discovered assets.

https://www.halosecurity.com/user/security/discovery/

Query Parameters

Name	Type	Description
fqdn	String	Search the host or IP field.
scanned	String	"all" (default) "yes" "no" "ack"
source	String	"all" (default) "domain" "integration" "network"
source_id	Integer	ID of the object whose type is specified by the source field. For example, if source is "domain", this is the ID of the domain.

200

{
    "total": 121
}

Get list of discovered assets.

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

Returns a paginated list of discovered assets.

https://www.halosecurity.com/user/security/discovery/

Query Parameters

The parameters in host-summary are available, along with the following additional parameters:

Name	Type	Description
sort	Integer	0 = FQDN (default)
sort_desc	Integer	0 = No (default) 1 = Yes
hostinfo	Integer	0 = No (default) 1 = Yes

200: OK

{
    "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.

https://www.halosecurity.com/user/security/discovery/domains/

Query Parameters

Name	Type	Description
sort	Integer	0 = Domain (default)
sort_desc	Integer	0 = No (default) 1 = Yes
domain	String	Filter by domain, e.g. "example.com"

200

{
    "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.

https://www.halosecurity.com/user/security/discovery/?source=domain

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

200

{
    "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.

https://www.halosecurity.com/user/security/discovery/

Query Parameters

Name	Type	Description
sort	Integer	0 = Domain (default)
sort_desc	Integer	0 = No (default) 1 = Yes
domain	String	Filter by domain

200

{
    "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.

https://www.halosecurity.com/user/security/discovery/networks/

Query Parameters

Name	Type	Description
sort	Integer	0 = Network (default)
sort_desc	Integer	0 = No (default) 1 = Yes

200

{
    "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.

https://www.halosecurity.com/user/security/discovery/networks/ips

Query Parameters

Name	Type	Description
sort	Integer	0 = IP (default)
sort_desc	Integer	0 = No (default) 1 = Yes

200: OK

{
    "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.

https://www.halosecurity.com/user/security/discovery/networks/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

200: OK

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