Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Company Digital Footprint

List all the IP addresses that belong to the company.

List all the IPs that are located under this company. Not all IPs defined under a company is included in the Black Kite scans. For example an IP with status Inactive is not included in the scan.

get/api/v2/companies/{id}/ips

Path parameters

idinteger required

The id of the target company.

Query parameters

page_numberinteger
Example:1

The number of the page requested.

page_size10 | 20 | 30 | 50 | 100 | 250
Example:10

The number of result items in a single response.

status'active' | 'inactive'
Example:active

The status of the IP; active or inactive. If omitted, both will be returned.

querystring
Example:192.168.4.3

The value will be searched in the IP address and CIDR response fields.

start_datestring date-time
Example:2026-01-01T00:00:00.000Z

Filters IP addresses discovered or last updated on or after this date. Must be provided with end_date. The date range must not exceed 15 days.

end_datestring date-time
Example:2026-01-15T23:59:59.000Z

Filters IP addresses discovered or last updated on or before this date. Must be provided with start_date. The date range must not exceed 15 days.

Response

Success

IPAddressstring

The IP Address.

SourceAssetstring[] nullable

The domain or subdomain associated with the IP address (if any). The IP address can also be related to the company through an SSL certificate on it. That is shown by using a source asset structure such as; SSL_CERT_f369e5037f9c52299757395f6f3a51f37601bb459f1660ec767c8cb3fb6ffbcf.imap.example.com which means that on an SSL certificate whose SHA256 value is f369e5037f9c52299757395f6f3a51f37601bb459f1660ec767c8cb3fb6ffbcf mentions the subdomain imap.example.com that belongs to the example.com

Descriptionstring nullable

The IP block description. Parsed from other sources, so output validation might be a good idea when rendering.

Namestring nullable

The NetName value of the IP block that this IP address belongs to.

NetCIDRstring

The CIDR value of the IP block that this IP address belongs to.

Status'Active' | 'Inactive'

Whether the IP address is active (included) or inactive (excluded) in the security scans' scope. When the IP address is active, then it is included in the scans. Excluded otherwise. Excluded IP addresses won't be scanned, therefore, won't affect the risk scores.

EmailAddressesstring[] nullable

The email address(es) that the IP address registered with.

OpenPortsnumber[] nullable

The open port values on the IP address.

IsManuallyAddedboolean

True if added manually through the API or manually through the portal.

DiscoveredDatestring date-time

The date when Black Kite discovered the IP address.

LastUpdateDatestring date-time

The date when Black Kite last updated the IP address.

Example response

[
  {
    "IPAddress": "192.168.77.172 ",
    "SourceAsset": [
      "nasa.acmeinc.com"
    ],
    "Description": "Acme Inc.",
    "Name": "ACME-NET-TTR",
    "NetCIDR": "192.168.77.172/30 ",
    "Status": "Active",
    "EmailAddresses": [
      "abuse@acmeinc.com"
    ],
    "OpenPorts": [
      80
    ],
    "DiscoveredDate": "2026-01-01T10:20:30.000Z",
    "LastUpdateDate": "2026-01-03T10:20:30.000Z"
  }
]