Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /asset_model/assets

SUMMARY This lists all assets found in the model. This endpoint supports sorting on id, domain_id, vulnerability_count and risk_score_sum, and filtering on all fields. EXCEPTION: LIKE, ILIKE, and BETWEEN do not work on the interfaces(ip_addresses(value)) field. It is possible to use the inequality operators to work around this in most cases. Use of the fields header to request only the necessary fields will improve API performance.

List all assets found in the model. This endpoint supports sorting on id, domain_id, vulnerability_count and risk_score_sum, and filtering on all fields. EXCEPTION: LIKE, ILIKE, and BETWEEN do not work on the interfaces(ip_addresses(value)) field. It is possible to use the inequality operators to work around this in most cases. Use of the fields header to request only the necessary fields will improve API performance.

Table 1: GET /asset_model/assets resource details:

GET /asset_model/assets resource details
MIME Type

application/json

Table 2: GET /asset_model/assets request parameter details:

GET /asset_model/assets request parameter details
Parameter Type Optionality Data Type MIME Type Description

sort

query

Optional

String

text/plain

Optional - This parameter is used to sort the elements in a list.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
Table 3: GET /asset_model/assets response codes:

GET /asset_model/assets response codes
HTTP Response Code Unique Code Description

200

The request to retrieve assets completed successfully.

500

1020

null

500

1021

null

Response Description

List of Asset objects with the following fields:
  • id - Long - The ID of the asset.
  • domain_id - Long - The ID of the domain this asset belongs to.
  • vulnerability_count - Long - The total number of vulnerabilities associated with this asset
  • risk_score_sum - Double - The sum of the CVSS scores of the vulnerabilities on this asset
  • hostnames - Array - The hostnames on this asset
    • id - Long - The ID of this hostname
    • type - Enum - The type of hostname. One of "DNS", "NETBIOS", or "NETBIOSGROUP"
    • name - String - The hostname
    • last_scanned_for - Long - The time this hostname was created. This time is in milliseconds since epoch.
    • first_seen_scanner - Long - The time this hostname was first seen during a vulnerability scan. This time is in milliseconds since epoch.
    • first_seen_profiler - Long - The time this hostname was first seen in event or flow traffic. This time is in milliseconds since epoch.
    • last_seen_scanner - Long - The time this hostname was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.
    • last_seen_profiler - Long - The time this hostname was most recently seen in event or flow traffic. This time is in milliseconds since epoch.
  • interfaces - Array - The interfaces on this asset
    • id - Long - The ID of this interface
    • mac_address - String - The mac address of this interface. Null if Unknown.
    • ip_addresses - Array - The IP addresses on this interface
      • id - Long - The ID of this interface
      • network_id - Long - The ID of the network this IP address belongs to in JSA's network hierarchy
      • value - String - The IP address
      • type - Enum - The type of this IP address. One of "IPV4" or "IPV6"
      • ip_addresses - Array - The IP addresses on this interface
      • created - Long - The time this IP address was created. This time is in milliseconds since epoch.
      • first_seen_scanner - Long - The time this IP address was first seen during a vulnerability scan. This time is in milliseconds since epoch.
      • first_seen_profiler - Long - The time this IP address was first seen in event or flow traffic. This time is in milliseconds since epoch.
      • last_seen_scanner - Long - The time this IP address was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.
      • last_seen_profiler - Long - The time this IP address was most recently seen in event or flow traffic. This time is in milliseconds since epoch.
    • created - Long - The time this interface was created. This time is in milliseconds since epoch.
    • first_seen_scanner - Long - The time this interface was first seen during a vulnerability scan. This time is in milliseconds since epoch.
    • first_seen_profiler - Long - The time this interface was first seen in event or flow traffic. This time is in milliseconds since epoch.
    • last_seen_scanner - Long - The time this interface was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.
    • last_seen_profiler - Long - The time this interface was most recently seen in event or flow traffic. This time is in milliseconds since epoch.
  • products - Array - The software products detected on this asset
    • id - Long - The ID of this software product instance in JSA's asset model
    • product_variant_id - Long - The ID of this software product variant in JSA's catalog of products.
    • created - Long - The time this product was most recently scanned for. This time is in milliseconds since epoch.
    • first_seen_scanner - Long - The time this product was first seen during a vulnerability scan. This time is in milliseconds since epoch.
    • first_seen_profiler - Long - The time this product was first seen in event or flow traffic. This time is in milliseconds since epoch.
    • last_seen_scanner - Long - The time this product was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.
    • last_seen_profiler - Long - The time this product was most recently seen in event or flow traffic. This time is in milliseconds since epoch.
  • properties - Array - Various system and custom properties on this asset
    • id - Long - The ID of this property.
    • type_id - Long - The ID of the type of this property
    • name - String - The name of the type of this property
    • value - String - The value of this property
    • last_reported_by - String - The source of the most recent update to this property
    • last_reported - Long - The time this property was last updated. This time is in milliseconds since epoch.
  • users - Array - The users associated with this asset
    • id - Long - The ID of this username.
    • username - String - The username.
    • first_seen_scanner - Long - The time this username was first seen during a vulnerability scan. This time is in milliseconds since epoch.
    • first_seen_profiler - Long - The time this username was first seen in event or flow traffic. This time is in milliseconds since epoch.
    • last_seen_scanner - Long - The time this username was most recently seen during a vulnerability scan. This time is in milliseconds since epoch.
    • last_seen_profiler - Long - The time this username was most recently seen in event or flow traffic. This time is in milliseconds since epoch.

Response Sample