Skip to main content
GET
/
partner
/
vulnerability
/
assets
Assets list with vulnerability counts
curl --request GET \
  --url https://api.example.com/partner/vulnerability/assets
[
  {
    "TargetId": "<string>",
    "IP": "<string>",
    "Icon": "<string>",
    "ScanId": 123,
    "ScanType": "<string>",
    "agentIsOnline": true,
    "AssetName": "<string>",
    "AssetId": "<string>",
    "AssetIp": "<string>",
    "OSName": "<string>",
    "TotalNumberOfVulnerabilities": 123,
    "NumberOfCriticalVulnerabilities": 123,
    "NumberOfHighVulnerabilities": 123,
    "NumberOfMediumVulnerabilities": 123,
    "NumberOfLowVulnerabilities": 123,
    "NumberOfInformationalVulnerabilities": 123,
    "AssetScore": "<string>",
    "HasAgentInstalled": true,
    "AgentIsOnline": true,
    "Tags": "<string>",
    "FingerPrint": "<string>",
    "FinishTime": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.cyrisma.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

Query Parameters

​
assetType
string
The **assetType** query parameter determines which asset types are returned by the API. 

When:
- **assetType=internal**, the response includes assets with **Internal Authenticated** and **Internal Unauthenticated** vulnerabilities.
- **assetType=external**, the response includes assets with **External – IP Addresses** and **External – Web Application URLs** vulnerabilities.

Response

OK

​
TargetId
string | null

Unique identifier for the target asset.

​
IP
string | null

IP address of the asset.

​
Icon
string | null

Icon representing the asset.

​
ScanId
integer<int32>

Identifier of the scan in which the asset was included.

​
ScanType
string | null
read-only

Type of vulnerability scan performed on the asset.

​
agentIsOnline
boolean

Indicates whether the agent on the asset is currently online.

​
AssetName
string | null
read-only

Name of the asset.

​
AssetId
string | null
read-only

Id of the asset.

​
AssetIp
string | null
read-only

IP address of the asset.

​
OSName
string | null
read-only

Operating System of the asset.

​
TotalNumberOfVulnerabilities
integer<int32>
read-only

Total number of vulnerabilities identified for this asset.

​
NumberOfCriticalVulnerabilities
integer<int32>
read-only

Number of vulnerabilities with Critical severity identified for this asset.

​
NumberOfHighVulnerabilities
integer<int32>
read-only

Number of vulnerabilities with High severity identified for this asset.

​
NumberOfMediumVulnerabilities
integer<int32>
read-only

Number of vulnerabilities with Medium severity identified for this asset.

​
NumberOfLowVulnerabilities
integer<int32>
read-only

Number of vulnerabilities with Low severity identified for this asset.

​
NumberOfInformationalVulnerabilities
integer<int32>
read-only

Number of vulnerabilities with Informational severity identified for this asset.

​
AssetScore
string | null
read-only

The asset score indicating the overall risk level of the asset.

​
HasAgentInstalled
boolean
read-only

Indicates whether an agent is currently installed on the asset.

​
AgentIsOnline
boolean
read-only

Indicates whether this asset is online.

​
Tags
string | null
read-only

Tags associated with this asset.

​
FingerPrint
string | null
read-only

The asset fingerprint for this asset.

​
FinishTime
string<date-time>
read-only

The date and time when the asset was last scanned.