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

Updating a Security Report

Function

This API is used to update a security report.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/sa/reports/{report_id}

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

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

report_name

Yes

String

Report name.

report_period

No

String

Report period. The options are weekly, daily, annual, and monthly.

report_range

No

report_range object

Data scope.

language

No

String

Language.

notification_task

No

String

Notification task ID.

layout_id

No

String

Layout ID.

report_id

No

String

Report ID.

report_rule_infos

No

Array of ReportRuleRequest objects

report rules

title

No

String

Email subject.

to

No

String

Recipient.

cc

No

String

Cc recipient.

subject

No

String

Remarks.

content

No

String

Email content.

report_file_type

No

String

Report type. Image, PDF, and HTML are supported.

frequency

No

String

Report sending frequency. The options are daily, monthly, and weekly.

binding_wizard

Yes

String

Report content.

timezone

No

String

Information.
Table 4 report_range

Parameter

Mandatory

Type

Description

start

Yes

String

Start time.

end

Yes

String

End time.
Table 5 ReportRuleRequest

Parameter

Mandatory

Type

Description

rule

No

String

Cron expression of the report sending task.

ruleEnd

No

String

End time for starting the report sending task.

start_time

No

start_time object

Start time of the report statistical period.

end_time

No

end_time object

End time of the report statistical period.
Table 6 start_time

Parameter

Mandatory

Type

Description

day

No

Integer

Date of the report statistical period. -1: the previous day; 0: the current day.

week

No

Integer

Date of the report statistical period. -1: the previous week; 0: the current week.

month

No

Integer

Date of the report statistical period. -1: the previous month; 0: the current month.

time

No

String

Start time of the report statistical period. The time is in the format of hour:minute:second.
Table 7 end_time

Parameter

Mandatory

Type

Description

day

No

Integer

Date of the report statistical period. -1: the previous day; 0: the current day.

week

No

Integer

Date of the report statistical period. -1: the previous week; 0: the current week.

month

No

Integer

Date of the report statistical period. -1: the previous month; 0: the current month.

time

No

String

End time of the report statistical period. The time is in the format of hour:minute:second.

Response Parameters

Status code: 200

Table 8 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

Status code: 400

Table 9 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.
Table 10 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

Request succeeded.

400

Request failed.

Error Codes

See Error Codes.

Parent topic: Security Reports