GET: My Infrastructure Report – Bitsight Knowledge Base

Publication Date – May 17, 2023

⇤ Companies

https://api.bitsighttech.com/ratings/v1/companies/company_guid/infrastructure

Get or download a CSV of your infrastructure information.

Track IP addresses and domains attributed to your organization.
Stay informed of existing infrastructure elements and new items that are added to your infrastructure.
Work with registrars to keep registrations up-to-date (if applicable). Such quick turnarounds will ensure that an organization's Bitsight Security Rating will correctly reflect their security posture.

Sections:

Parameters
CSV Format
- Example Request
- Example Response
JSON Format

Parameters

*Required.

Parameter		Description	Values
asn Query		Filter by autonomous system numbers (ASN) assigned to the company. Applicable to IP addresses/CIDR only.	[String] Comma-separated ASN.
attributed_to.guid Query		Filter by the entity attributed to the infrastucture.	[String] Comma-separated company unique identifiers [`entity_guid`]. See GET: Portfolio Details.
company_guid Path		Identify the company to query.	[String] Company unique identifier [`entity_guid`]. See GET: Portfolio Details.
country.code Query		Filter by the country stated in the registration.	[String Comma-separated 2-letter country codes.
Date Ranges		Date filters.	[String] `YYYY-MM-DD`
	start_date Query	Filter by when this infrastructure was attributed to the company.
	start_date_lt Query	Before this infrastructure was attributed to the company.
	start_date_lte Query	When and before this infrastructure was attributed to the company.
	start_date_gt Query	After this infrastructure was attributed to the company.
	start_date_gte Query	When and after this infrastructure was attributed to the company.
	end_date Query	When this infrastructure was no longer attributed.
	end_date_lt Query	Before this infrastructure was no longer attributed.
	end_date_lte Query	When and before this infrastructure was no longer attributed.
	end_date_gt Query	After this infrastructure was no longer attributed.
	end_date_gte Query	When and after this infrastructure was no longer attributed.
format Query		Set the format for the response data.	[String] `CSV` `JSON` (default)
IP Counts		Filter by the number of IP addresses.	[Integer]
	ip_count Query	Filter by the number of IP addresses.
	ip_count_lt Query	Filter by less than a set number of IP addresses.
	ip_count_lte Query	Filter by a set number or less amount of IP addresses.
	ip_count_gt Query	Filter by more than a set number of IP addresses.
	ip_count_gte Query	Filter by a set number or more amount of IP addresses.
is_active Query		Filter by records that are still attributed or was previously attributed to the organization.	[Boolean] `true` = Include only active records, i.e. records without an end date. `false` = Include all records regardless of the attribution end date.
limit Query		Set the maximum number of results.	[Integer] If not provided and `format=json`, `limit` defaults to `100`. If not provided and `format=csv`, `limit defaults to null.`
q Query		Perform a full-text search for matches on all searchable fields.	[String] Fields: ASN `attributed_to` Country name `source` `value`
source Query		Filter by the source used to associate the infrastructure to the company.	[String] Comma-separated source name. See infrastucture data sources.
tag_contains Query		Filter by infrastructure tags.	[String] Comma-separated tag names.
type Query		Filter by asset type.	[String] Comma-separated: `IP` (includes both IPv4 and IPv6) `IPV4_CIDR` `IPV6_CIDR` `Domain`
value Query		Filter by IP address, CIDR block, or domain name.	[String] Comma-separated: IP name CIDR name Domain name

CSV Format

Example Request

curl 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/infrastructure?format=csv&type=ip' -u api_token -o output_file

Example Response

Value,Type,Source,Tags,Country,Start Date,End Date,Is Active,Attributed To,CIDR Size,Link,AS Number,Reasons,Notes
192.199.225.10,IP,Customer-Provided,Data Center 1,,2011-01-01,2020-09-14,False,Saperix WFH-RO,1,,,,
192.199.225.10,IP,Customer-Provided,Data Center 1,,2022-06-17,Active,True,Awesome Inc,1,,,,
128.197.192.143,IP,Customer-Provided,,,2011-01-01,Active,True,"Saperix, Inc.",1,,,,
192.12.185.111,IP,Customer-Provided,,,2011-01-01,Active,True,"Saperix, Inc.",1,,,,
192.12.185.143,IP,Customer-Provided,,,2011-01-01,Active,True,"Saperix, Inc.",1,,,,
192.12.185.147,IP,Customer-Provided,,,2011-01-01,Active,True,"Saperix, Inc.",1,,,,
192.12.189.15,IP,Customer-Provided,,,2011-01-01,Active,True,"Saperix, Inc.",1,,,,
192.75.80.84,IP,Customer-Provided,,,2011-01-01,Active,True,"Saperix, Inc.",1,,,,
128.197.192.251,IP,DNS,"Primary Website,Security Lab",,2022-10-05,Active,True,"Saperix, Inc.",1,,,DNS hostname: joresources.bu.edu,
,,,,,,,,,,,,,
Disclaimer: This document contains sensitive information intended only for authorized viewers. Use of this data must adhere to the Bitsight Terms and Conditions.,,,,,,,,,,,,,

JSON Format

Example Request

curl 'https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/infrastructure?type=domain&limit=2' -u api_token -o output_file

Example Response

{
  "links": {
    "next": "https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/infrastructure?limit=2&offset=2&type=domain",
    "previous": null
  },
  "count": 99,
  "results": [
    […]
    {
      "temporary_id": "X2bR5bTaXZ4d9dccf32a5bcc52b2b13361158f24c2",
      "value": "saperix.com",
      "type": "DOMAIN",
      "source": null,
      "country": null,
      "start_date": "2011-01-01",
      "end_date": null,
      "is_active": true,
      "attributed_to": {
        "guid": "9f16aca1-44ef-4fff-a413-f22ce2894bc7",
        "name": "Saperix Corporate - US East"
      },
      "ip_count": null,
      "is_suppressed": false,
      "tags": [
        {
          "guid": "087a81d2-e0bd-4189-80f2-7b5cad2560b5",
          "id": 88170,
          "name": "Primary Website",
          "is_public": true
        }
      ],
      "asn": null
    }
  ]
}

Response Attributes

Field					Description
links Object					Navigation for multiple pages of results. See pagination.
	next String				The URL for navigating to the next page of results.
	previous String				The URL for navigating to the previous page of results.
count Integer					The number of assets.
results Array					Assets and their infrastucture details.
	Object				An asset and its infrastucture details.
		temporary_id String			A temporary identifier for this asset.
		value String			The name of this asset.
		type String			The type of asset.
		source String			The source used to associate the infrastructure to the company.
		country String			The country stated in the registration.
		start_date String [`YYYY-MM-DD`]			When this infrastructure was attributed to the company.
		end_date String [`YYYY-MM-DD`]			When this infrastructure was no longer attributed.
		is_active Boolean			Indicates if the infrastructure is still attributed or was previously attributed to the organization. `true` = Active. `false` = Inactive (has an end date).
		attributed_to Object			The entity attributed to the infrastucture.
			guid String [`entity_guid`]		This company’s unique identifier.
			name String		This company’s.
		ip_count Integer			The number of IP addresses.
		is_suppressed Boolean
		tags Array			Infrastucture tags.
			Object		An infrastructure tag.
				guid String [`entity_guid`]	The company associated with the tag.
				id Integer
				name String	The tag name.
				is_public Boolean	Indicates if this tag is public.
		asn String			The autonomous system number.

Articles in this section

Parameters

CSV Format

Example Request

Example Response

JSON Format

Example Request

Example Response

Response Attributes

Related articles