Help Center/ Host Security Service/ API Reference/ API Description/ Container Images/ Querying the List of Malicious Files of Tenants
Updated on 2026-04-03 GMT+08:00

Querying the List of Malicious Files of Tenants

Function

This API is used to query tenant malicious files.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/image/malwares

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project that a server belongs.

An enterprise project can be configured only after the enterprise project function is enabled.

Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission.

image_type

Yes

String

Image type. Its value can be:

  • registry: repository image

  • **cicd **: CI/CD image

file_name

No

String

File name. Fuzzy search is supported.

limit

No

Integer

The default value is 10.

offset

No

Integer

Default value: 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

region

Yes

String

Region ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of global malicious files

data_list

Array of GlobalMalwareInfo objects

Total number of vulnerabilities.

Table 5 GlobalMalwareInfo

Parameter

Type

Description

file_name

String

File name

file_path

String

Directory

size

Long

File size

latest_scan_time

Long

Last scanned, in ms.

description

String

File description

image_type

String

Repository image type. The options are as follows:

  • SwrPrivate: SWR private image

  • SwrShared: SWR shared repository

  • SwrEnterprise: SWR enterprise repository

  • Harbor: Harbor repository

  • Jfrog: JFrog repository

  • Other: other repository

namespace

String

Organization name

image_name

String

Image Name

image_version

String

Image tag name

image_id

String

Image ID

instance_id

String

ID of an SWR Enterprise Edition instance.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "file_name" : "xxx",
    "file_path" : "xxx",
    "size" : 12,
    "latest_scan_time" : 253,
    "description" : "xxx",
    "image_type" : "SwrPrivate",
    "namespace" : "xxx",
    "image_name" : "xxx",
    "image_version" : "xxx",
    "image_id" : "xxx",
    "instance_id" : "xxx"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.