Help Center/ Host Security Service/ API Reference/ API Description/ IaC Risks/ Obtaining the IAC File List
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Obtaining the IAC File List

Function

This API is used to obtain the IAC file list.

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}/container/iac/files

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

offset

Yes

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

N/A

limit

Yes

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

scan_type

Yes

String

Definition

Scan mode.

Constraints

N/A

Range

  • manual_scan: manual scan

  • cicd_scan: cicd scan

Default Value

N/A

file_id

No

String

Definition

File ID.

Constraints

N/A

Range

The value contains 1 to 64 characters.

Default Value

N/A

file_name

No

String

Definition

File name

Constraints

N/A

Range

The value can contain 1 to 512 characters.

Default Value

N/A

file_type

No

String

Definition

File type.

Constraints

N/A

Range

  • dockerfile: Dockerfile file

  • k8s_yaml: Kubernetes YAML file

Default Value

N/A

risky

No

Boolean

Definition

Are there any risks?

Constraints

N/A

Range

  • true: yes

  • false: no

Default Value

N/A

cicd_id

No

String

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

cicd_name

No

String

Definition

CI/CD name.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total files.

data_list

Array of data_list objects

IAC file list
Table 5 data_list

Parameter

Type

Description

file_id

String

Definition

File ID.

Constraints

N/A

Range

The value contains 1 to 64 characters.

Default Value

N/A

file_name

String

Definition

File name

Constraints

N/A

Range

The value can contain 1 to 512 characters.

Default Value

N/A

file_type

String

Definition

File type.

Constraints

N/A

Range

  • dockerfile: Dockerfile file

  • k8s_yaml: Kubernetes YAML file

Default Value

N/A

risky

Boolean

Definition

Are there any risks?

Constraints

N/A

Range

  • true: yes

  • false: no

Default Value

N/A

risk_num

Integer

Number of risk items

first_scan_time

Long

First scanned

last_scan_time

Long

Last scanned

upload_file_time

Long

File Upload Time

cicd_id

String

Definition

CICD ID

Constraints

N/A

Range

The value contains 1 to 128 characters.

Default Value

N/A

cicd_name

String

Definition

CI/CD name

Constraints

N/A

Range

The value contains 1 to 128 characters.

Default Value

N/A

scan_type

String

Definition

Scan mode.

Constraints

N/A

Range

  • manual_scan: manual scan

  • cicd_scan: cicd scan

Default Value

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 4,
  "data_list" : [ {
    "file_id" : "d8xxxx05-8xx5-4xx0-9xx6-c3dbxxxxxxac",
    "file_name" : "fileName",
    "file_type" : "k8s_yaml",
    "risky" : true,
    "risk_num" : 10,
    "first_scan_time" : 1745311451000,
    "last_scan_time" : 1745311451000,
    "upload_file_time" : 1745311451000
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: IaC Risks