---
updatedAt: 2026-07-02T14:30:52.000Z
---
# Retrieve an asset
This operation returns an object containing information about a specified asset.
**NOTE:** All display parameters for sites may also be used. See Site APIs for details.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Asset API (Legacy)",
"license": {
"name": "(c) Copyright 2021 WhiteHat Security"
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://sentinel.whitehatsec.com"
}
],
"paths": {
"/api/asset/{asset_id}": {
"get": {
"tags": [
"Asset API v1.0"
],
"summary": "Retrieve an asset",
"description": "This operation returns an object containing information about a specified asset.
**NOTE:** All display parameters for sites may also be used. See Site APIs for details.",
"operationId": "getSingleLegacyAsset",
"parameters": [
{
"name": "asset_id",
"in": "path",
"description": "ID of asset to retrieve. You can find this ID by making a call to the collection endpoint of this API and noting the ID returned in the ''href'' attribute.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "display_all",
"in": "query",
"description": "If set to 1, displays all information available for this asset. If set to 0 or omitted, a smaller set of information will be returned.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "1",
"example": "1",
"enum": [
"0",
"1"
]
}
},
{
"name": "format",
"in": "query",
"description": "Format of results.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"default": "xml",
"example": "json",
"enum": [
"json",
"xml",
"csv"
]
}
}
],
"responses": {
"200": {
"description": "Provides the information of single asset.",
"headers": {},
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/AssetSiteSingle"
}
]
},
"examples": {
"Site ID response": {
"description": "Asset information for site.",
"value": {
"href": "string",
"asset_type": "string",
"asset": {
"custom_asset_id": "string",
"label": "string",
"host_bad": "string",
"service_type": "string",
"tags": [
"string"
],
"entry_points": [
{
"id": 0,
"method": "string",
"date_added_t": "string",
"uri": "string",
"maker": "string",
"href": "string",
"content": "string"
}
],
"client_id": 0,
"scan_schedule": {
"name": "string",
"api-version": 0,
"timezone": "string",
"specs": [
{
"duration": 0,
"cron_spec": "string",
"id": "string",
"type": "string",
"time": "string",
"weekday": "string"
}
],
"id": "string",
"start_date": "string",
"job": {
"id": "string"
},
"href": "string",
"creator": "string"
},
"assessment_complete": true,
"wsi_industry_rank": "string",
"asset_owner_name": "string",
"first_completed_scan": {
"links": [
{
"url": "string",
"reply_content": "string",
"status": "string",
"reply_code": 0,
"state": "string"
}
],
"name": "string",
"id": 0,
"begin": "string",
"duration": 0,
"data": "string",
"status": "string",
"end": "string",
"timestamp": "string",
"job": 0,
"href": "string",
"requested_status": "string",
"link_count": 0
},
"organization": "string",
"asset_phase": "string",
"contract_end_date": "string",
"site_credential_stats": {
"invalid_business_logic_credentials": 0,
"invalid_scanning_credentials": 0
},
"access_issues": [
"string"
],
"description": "string",
"preset": {
"name": "string",
"id": "string"
},
"custom_policy": {
"description": "string",
"id": "string",
"name": "string"
},
"sentinel_features": [
{
"name": "string",
"purchased": true
}
],
"allowed_hosts": [
{
"id": 0,
"scheme": "string",
"href": "string",
"hostname": "string"
}
],
"sentinel_feature_override": [
{
"name": "string",
"purchased": true
}
],
"lh_bad": "string",
"current_scan": {
"links": [
{
"url": "string",
"reply_content": "string",
"status": "string",
"reply_code": 0,
"state": "string"
}
],
"name": "string",
"id": 0,
"begin": "string",
"duration": 0,
"data": "string",
"status": "string",
"end": "string",
"timestamp": "string",
"job": 0,
"href": "string",
"requested_status": "string",
"link_count": 0
},
"vuln_policy": {
"href": "string",
"id": "string"
},
"last_completed_scan": {
"links": [
{
"url": "string",
"reply_content": "string",
"status": "string",
"reply_code": 0,
"state": "string"
}
],
"name": "string",
"id": 0,
"begin": "string",
"duration": 0,
"data": "string",
"status": "string",
"end": "string",
"timestamp": "string",
"job": 0,
"href": "string",
"requested_status": "string",
"link_count": 0
},
"wsi_score": "string",
"site_credentials": [
{
"expire_notify_before": "string",
"cred_group_name": "string",
"wh_managed": true,
"expire_type": "string",
"selenium_script": "string",
"updated_t": 0,
"account_email": "string",
"match_expression": "string",
"secret_key": "string",
"priority": 0,
"expire_begin": "string",
"expire_freeform": "string",
"username": "string",
"creator": "string",
"href": "string",
"status": "string",
"id": 0,
"login_valid_url": "string",
"notes": "string",
"login_url": "string",
"scanning_cred": true
}
],
"id": 0,
"assessment_complete_date": "string",
"groups": [
{
"name": "string",
"href": "string",
"id": 0
}
],
"form_train_selenium_scripts": [
{}
],
"business_logic_assessment": {
"bla_status": "string",
"last_bla_completed": "string",
"last_bla_started": "string"
},
"wsi_global_rank": "string",
"vuln_stats": {
"severity": {
"high": "string",
"critical": "string",
"urgent": "string",
"low": "string",
"medium": "string"
},
"closed": 0,
"advanced": {
"customized": "string",
"likelihood": {
"critical": "string",
"high": "string",
"medium": "string",
"low": "string",
"note": "string"
},
"risk": {
"critical": "string",
"high": "string",
"medium": "string",
"low": "string",
"note": "string"
},
"impact": {
"critical": "string",
"high": "string",
"medium": "string",
"low": "string",
"note": "string"
}
},
"out_of_scope": 0,
"score": {
"critical": "string",
"high": "string",
"medium": "string",
"low": "string",
"note": "string"
},
"accepted": 0,
"customized": "string"
},
"asset_scan_status": "string",
"scan_status": [
"string"
],
"activation_date": "string",
"active_admin": true,
"active_consult": true,
"active_user": true,
"bla_cred_updated_by": "string",
"bla_cred_updated_date": "string",
"create_date": 0,
"discovery": true,
"enable_bla_creds": true,
"enable_scan_creds": true,
"href": "string",
"industry": "string",
"satellite": true,
"scan_cred_updated_by": "string",
"scan_cred_updated_date": "string",
"scan_rate_limit": 0,
"service_level": "string",
"site_url": "string",
"speed": 0,
"visibility": "string",
"weight": 0,
"global_rank": 0,
"market_rank": "string",
"satellite_id": "string",
"last_scan_duration": 0,
"appliance": {
"href": "string",
"id": "string"
},
"last_scan_completed": "string",
"autoremediation": 0,
"user_error_reason": "string",
"has_schedule": 0,
"language": "string",
"created_t": "string",
"compliance": 0
}
}
}
}
},
"application/xml": {
"example": "XML preview is currently not supported."
},
"text/csv, text/comma-separated-values": {
"schema": {
"type": "string",
"description": "Column headers for data that may be returned using this format.",
"example": "asset_type,href"
}
}
}
},
"400": {
"description": "BadRequestResponse indicates a request with invalid parameters.",
"content": {}
},
"401": {
"description": "UnauthorizedResponse signals an unauthorized API access.",
"content": {}
},
"403": {
"description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.",
"content": {}
},
"500": {
"description": "GenericError generic error.",
"content": {}
}
}
}
}
},
"components": {
"schemas": {
"AssetEntryPoint": {
"properties": {
"id": {
"type": "number"
},
"method": {
"type": "string"
},
"date_added_t": {
"type": "string",
"nullable": true
},
"creator_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"uri": {
"type": "string"
},
"maker": {
"type": "string"
},
"href": {
"type": "string"
},
"content": {
"type": "string"
}
}
},
"AssetTagsList": {
"type": "array",
"items": {
"type": "string"
}
},
"AssetLink": {
"properties": {
"url": {
"type": "string"
},
"reply_content": {
"type": "string"
},
"status": {
"type": "string"
},
"reply_code": {
"type": "number"
},
"state": {
"type": "string",
"nullable": true
}
}
},
"AssetSpec": {
"properties": {
"duration": {
"type": "number",
"nullable": true
},
"cron_spec": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"time": {
"type": "string"
},
"weekday": {
"type": "string"
}
}
},
"AssetJob": {
"properties": {
"id": {
"type": "string"
}
}
},
"AssetSchedule": {
"nullable": true,
"properties": {
"name": {
"type": "string"
},
"api-version": {
"type": "number"
},
"timezone": {
"type": "string"
},
"specs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetSpec"
}
},
"id": {
"type": "string"
},
"start_date": {
"type": "string",
"nullable": true
},
"job": {
"$ref": "#/components/schemas/AssetJob"
},
"href": {
"type": "string"
},
"creator": {
"type": "string"
}
}
},
"AssetScan": {
"nullable": true,
"properties": {
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetLink"
}
},
"name": {
"type": "string",
"nullable": true
},
"id": {
"type": "number"
},
"begin": {
"type": "string",
"nullable": true
},
"duration": {
"type": "number",
"nullable": true
},
"data": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"end": {
"type": "string",
"nullable": true
},
"timestamp": {
"type": "string",
"nullable": true
},
"job": {
"type": "number"
},
"href": {
"type": "string",
"nullable": true
},
"requested_status": {
"type": "string",
"nullable": true
},
"link_count": {
"type": "number"
}
}
},
"AssetVulnPolicy": {
"properties": {
"href": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"AssetSiteCredential": {
"nullable": true,
"properties": {
"expire_notify_before": {
"type": "string",
"nullable": true
},
"cred_group_name": {
"type": "string",
"nullable": true
},
"wh_managed": {
"type": "boolean"
},
"expire_type": {
"type": "string",
"nullable": true
},
"selenium_script": {
"type": "string",
"nullable": true
},
"updated_t": {
"type": "number",
"nullable": true
},
"account_email": {
"type": "string",
"nullable": true
},
"match_expression": {
"type": "string",
"nullable": true
},
"secret_key": {
"type": "string",
"nullable": true
},
"priority": {
"type": "number",
"nullable": true
},
"expire_begin": {
"type": "string",
"nullable": true
},
"expire_freeform": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"creator": {
"type": "string",
"nullable": true
},
"href": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"id": {
"type": "number"
},
"login_valid_url": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"login_url": {
"type": "string",
"nullable": true
},
"scanning_cred": {
"type": "boolean"
}
}
},
"AssetGroup": {
"properties": {
"name": {
"type": "string"
},
"href": {
"type": "string"
},
"id": {
"type": "number"
}
}
},
"AssetSeleniumScripts": {
"type": "object"
},
"AssetBLA": {
"properties": {
"bla_status": {
"type": "string"
},
"last_bla_completed": {
"type": "string"
},
"last_bla_started": {
"type": "string"
}
}
},
"AssetSeverity": {
"type": "object",
"properties": {
"high": {
"type": "string"
},
"critical": {
"type": "string"
},
"urgent": {
"type": "string"
},
"low": {
"type": "string"
},
"medium": {
"type": "string"
}
}
},
"AssetAdvanced": {
"properties": {
"customized": {
"type": "string"
},
"likelihood": {
"$ref": "#/components/schemas/AssetScore"
},
"risk": {
"$ref": "#/components/schemas/AssetScore"
},
"impact": {
"$ref": "#/components/schemas/AssetScore"
}
}
},
"AssetScore": {
"properties": {
"critical": {
"type": "string"
},
"high": {
"type": "string"
},
"medium": {
"type": "string"
},
"low": {
"type": "string"
},
"note": {
"type": "string"
}
}
},
"AssetVulnStats": {
"type": "object",
"properties": {
"severity": {
"$ref": "#/components/schemas/AssetSeverity"
},
"closed": {
"type": "number"
},
"open": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"advanced": {
"$ref": "#/components/schemas/AssetAdvanced"
},
"out_of_scope": {
"type": "number"
},
"score": {
"$ref": "#/components/schemas/AssetScore"
},
"accepted": {
"type": "number"
},
"customized": {
"type": "string",
"nullable": true
}
}
},
"AssetSiteCredStats": {
"properties": {
"invalid_business_logic_credentials": {
"type": "number"
},
"invalid_scanning_credentials": {
"type": "number"
}
}
},
"AssetAccessIssues": {
"type": "string"
},
"AssetPreset": {
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string",
"nullable": true
}
}
},
"AssetCustomPolicy": {
"nullable": true,
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"AssetSentinelFeatures": {
"properties": {
"name": {
"type": "string"
},
"purchased": {
"type": "boolean"
}
}
},
"AssetHost": {
"properties": {
"id": {
"type": "number"
},
"scheme": {
"type": "string"
},
"href": {
"type": "string"
},
"hostname": {
"type": "string"
}
}
},
"AssetSite": {
"properties": {
"custom_asset_id": {
"type": "string",
"nullable": true
},
"label": {
"type": "string"
},
"host_bad": {
"type": "string"
},
"service_type": {
"type": "string"
},
"tags": {
"$ref": "#/components/schemas/AssetTagsList"
},
"entry_points": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetEntryPoint"
}
},
"client_id": {
"type": "number"
},
"scan_schedule": {
"$ref": "#/components/schemas/AssetSchedule"
},
"assessment_complete": {
"type": "boolean"
},
"wsi_industry_rank": {
"type": "string",
"nullable": true
},
"asset_owner_name": {
"type": "string"
},
"first_completed_scan": {
"$ref": "#/components/schemas/AssetScan"
},
"organization": {
"type": "string",
"nullable": true
},
"asset_phase": {
"type": "string",
"nullable": true
},
"contract_end_date": {
"type": "string",
"nullable": true
},
"site_credential_stats": {
"$ref": "#/components/schemas/AssetSiteCredStats"
},
"access_issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetAccessIssues"
}
},
"description": {
"type": "string",
"nullable": true
},
"preset": {
"$ref": "#/components/schemas/AssetPreset"
},
"custom_policy": {
"$ref": "#/components/schemas/AssetCustomPolicy"
},
"sentinel_features": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetSentinelFeatures"
}
},
"allowed_hosts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetHost"
}
},
"sentinel_feature_override": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetSentinelFeatures"
}
},
"lh_bad": {
"type": "string",
"nullable": true
},
"current_scan": {
"$ref": "#/components/schemas/AssetScan"
},
"vuln_policy": {
"$ref": "#/components/schemas/AssetVulnPolicy"
},
"last_completed_scan": {
"$ref": "#/components/schemas/AssetScan"
},
"wsi_score": {
"type": "string",
"nullable": true
},
"site_credentials": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetSiteCredential"
}
},
"id": {
"type": "number"
},
"assessment_complete_date": {
"type": "string",
"nullable": true
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetGroup"
}
},
"form_train_selenium_scripts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetSeleniumScripts"
}
},
"business_logic_assessment": {
"$ref": "#/components/schemas/AssetBLA"
},
"wsi_global_rank": {
"type": "string",
"nullable": true
},
"vuln_stats": {
"$ref": "#/components/schemas/AssetVulnStats"
},
"asset_scan_status": {
"type": "string",
"nullable": true
},
"scan_status": {
"type": "array",
"items": {
"type": "string"
}
},
"activation_date": {
"type": "string",
"nullable": true
},
"active_admin": {
"type": "boolean"
},
"active_consult": {
"type": "boolean"
},
"active_user": {
"type": "boolean"
},
"bla_cred_updated_by": {
"type": "string",
"nullable": true
},
"bla_cred_updated_date": {
"type": "string",
"nullable": true
},
"create_date": {
"type": "number"
},
"discovery": {
"type": "boolean"
},
"enable_bla_creds": {
"type": "boolean"
},
"enable_scan_creds": {
"type": "boolean"
},
"href": {
"type": "string"
},
"industry": {
"type": "string"
},
"satellite": {
"type": "boolean"
},
"scan_cred_updated_by": {
"type": "string",
"nullable": true
},
"scan_cred_updated_date": {
"type": "string",
"nullable": true
},
"scan_rate_limit": {
"type": "number"
},
"service_level": {
"type": "string"
},
"site_url": {
"type": "string"
},
"speed": {
"type": "number"
},
"visibility": {
"type": "string"
},
"weight": {
"type": "number"
},
"global_rank": {
"type": "number",
"nullable": true
},
"market_rank": {
"type": "string",
"nullable": true
},
"satellite_id": {
"type": "string",
"nullable": true
},
"last_scan_duration": {
"type": "number",
"nullable": true
},
"appliance": {
"nullable": true,
"properties": {
"href": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"last_scan_completed": {
"type": "string",
"nullable": true
},
"autoremediation": {
"type": "number",
"nullable": true
},
"user_error_reason": {
"type": "string",
"nullable": true
},
"has_schedule": {
"type": "number",
"nullable": true
},
"language": {
"type": "string",
"nullable": true
},
"created_t": {
"type": "string",
"nullable": true
},
"compliance": {
"type": "number",
"nullable": true
}
}
},
"AssetSiteSingle": {
"properties": {
"href": {
"type": "string"
},
"asset_type": {
"type": "string"
},
"asset": {
"$ref": "#/components/schemas/AssetSite"
}
}
}
}
},
"x-explorer-enabled": false
}
```