Sign in

v1

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

List all the subdomains that are located under the company.

List all the subdomains that are located under this company. Not all domains defined under a company is scanned. For example subdomains with status Inactive are not scanned.

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

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 subdomain; active or inactive. If omitted, both will be returned.

querystring
Example:nasa.acmeinc.com

The value will be searched in the subdomain, IP addresses, title and CMS response fields.

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

Filters subdomains 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 subdomains 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

DomainIdinteger

The identifier of the domain that this subdomain belongs to.

Domainstring

The domain value that this subdomain belongs to.

Subdomainstring

The subdomain value itself.

IPAddressesstring[] nullable

When null, the subdomain is classified as dormant, that is, it will not be included in the security scans and won't affect the security risk scores.

StatusCodestring nullable

HTTP status code for the request sent to the subdomain. null or N/A means no response to the HTTP requests.

Titlestring nullable

The title of the web page associated with the subdomain (if any). Parsed from other sources, so output validation might be a good idea when rendering.

HasSslTlsSupportboolean

True if an SSL/TLS is supported on the subdomain.

IsManuallyAddedboolean

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

Status'Active' | 'Inactive'

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

Cpesstring[]

A list of related CPEs.

Productsstring[]

A list of product names.

IsSaasboolean

True if subdomain is associated with a Software-as-Service (SaaS) application.

DiscoveredDatestring date-time

The date when Black Kite discovered the subdomain.

LastUpdateDatestring date-time

The date when Black Kite last updated the subdomain.

Example response

[
  {
    "DomainId": 12345,
    "Domain": "acmeinc.com",
    "Subdomain": "nasa.acmeinc.com",
    "IPAddresses": [
      "192.168.4.3"
    ],
    "StatusCode": "200",
    "Title": "Log in - Self-Service Portal",
    "SslTlsSecurity": {
      "PassedCipherSuites": [
        "TLS_AES_256_GCM_SHA384"
      ],
      "FailedCipherSuites": [
        "TLS_RSA_WITH_RC4_128_SHA"
      ],
      "PassedProtocols": [
        "TLSv1.3"
      ],
      "FailedProtocols": [
        "SSLv3"
      ],
      "Hsts": true
    },
    "Status": "Active",
    "Cpes": [
      "cpe:/a:product:product:4.89:rc5"
    ],
    "Products": [
      "Wordpress 5.2.11"
    ],
    "DiscoveredDate": "2026-01-01T10:20:30.000Z",
    "LastUpdateDate": "2026-01-03T10:20:30.000Z"
  }
]