Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Security Reports/ Managing Security Reports
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Managing Security Reports

Function

This API is used to manage a security report.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/sa/reports/{report_id}/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

report_id

Yes

String

Report ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

report_content

No

String

Base64 code of the report.

email_title

No

String

Email subject.

email_to

No

String

Recipient email address.

email_cc

No

String

CC recipient email address.

email_content

No

String

Email content.

report_file_type

No

String

Attachment type.

action

Yes

String

The API action can be send or download.

report_page

No

String

Base64-encoded content of the security report.

page_config

No

PageConfigPx object

Margin of the security report.
Table 4 PageConfigPx

Parameter

Mandatory

Type

Description

width

No

Integer

Width of the security report.

height

No

Integer

Height of the security report.

margin

No

MarginInfo object

Margin of the security report.
Table 5 MarginInfo

Parameter

Mandatory

Type

Description

top

No

Integer

Top margin of the security report.

left

No

Integer

Left margin of the security report.

bottom

No

Integer

Bottom margin of the security report.

right

No

Integer

Right margin of the security report.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

file

Object

download file

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Downloaded file.

400

xx

Error Codes

See Error Codes.

Parent topic: Security Reports