Searching assets

May 15, 2024

ID 270022

GET /api/v1/kuma/assets

Information about the software of assets is not stored in OSMP and is not shown in the response.

Access: General administrator, Tenant administrator, Tier 2 analyst, Tier 1 analyst, Junior analyst, Access to NCIRCC, Access to CII, Observer.

Query parameters

Name

Data type

Mandatory

Description

Value example

page

number

No

Page number. Starts with 1. The page size is 250 entries. If the parameter is not specified, the default value is 1.

1

id

string

No

Asset ID. If the parameter is specified several times, then a list is generated and the logical OR operator is applied.

00000000-0000-0000-0000-000000000000

tenantID

string

No

Asset tenant ID. If the parameter is specified several times, then a list is generated and the logical OR operator is applied. If the user does not have the required role in the specified tenant, then this tenant is ignored.

00000000-0000-0000-0000-000000000000

name

string

No

Asset name. Case-insensitive regular expression (PCRE).

asset

^My asset$

fqdn

string

No

Asset FQDN. Case-insensitive regular expression (PCRE).

example.com

ip

string

No

Asset IP address. Case-insensitive regular expression (PCRE).

10.10

^192.168.1.2$

mac

string

No

Asset MAC address. Case-insensitive regular expression (PCRE).

^00:0a:95:9d:68:16$

Response

HTTP code: 200

Format: JSON

type Response []Asset

 

type Asset struct {

    ID                     string              `json:"id"`

    TenantID               string              `json:"tenantID"`

    TenantName             string              `json:"tenantName"`

    Name                   string              `json:"name"`

    FQDN                   string              `json:"fqdn"`

    IPAddresses            []string            `json:"ipAddresses"`

    MACAddresses           []string            `json:"macAddresses"`

    Owner                  string              `json:"owner"`

    OS                     *OS                 `json:"os"`

    Software               []Software          `json:"software"`

    Vulnerabilities        []Vulnerability     `json:"vulnerabilities"`

    KICSRisks              []*assets.KICSRisk  `json:"kicsVulns"`

    KSC                    *KSCFields          `json:"ksc"`

    Created                string              `json:"created"`

    Updated                string              `json:"updated"`

}

 

type KSCFields struct {

    NAgentID          string `json:"nAgentID"`

    KSCInstanceID     string `json:"kscInstanceID"`

    KSCMasterHostname string `json:"kscMasterHostname"`

    LastVisible       string `json:"lastVisible"`

}

 

type OS struct {

    Name    string `json:"name"`

    Version uint64 `json:"version"`

}

 

type Software struct {

    Name    string `json:"name"`

    Version string `json:"version"`

    Vendor  string `json:"vendor"`

}

 

type Vulnerability struct {

    KasperskyID           string   `json:"kasperskyID"`

    ProductName           string   `json:"productName"`

    DescriptionURL        string   `json:"descriptionURL"`

    RecommendedMajorPatch string   `json:"recommendedMajorPatch"`

    RecommendedMinorPatch string   `json:"recommendedMinorPatch"`

    SeverityStr           string   `json:"severityStr"`

    Severity              uint64   `json:"severity"`

    CVE                   []string `json:"cve"`

    ExploitExists         bool     `json:"exploitExists"`

    MalwareExists         bool     `json:"malwareExists"`

}

 

type assets.KICSRisk struct {

    ID              int64    `json:"id"`

    Name            string   `json:"name"`

    Category        string   `json:"category"`

    Description     string   `json:"description"`

    DescriptionUrl  string   `json:"descriptionUrl"`

    Severity        int      `json:"severity"`

    Cvss            float64  `json:"cvss"`

}

Possible errors

HTTP code

Description

Message field value

Details field value

400

Invalid value of the "page" parameter

invalid query parameter value

page

500

Any other internal error

variable

variable

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.