Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ Access Analyzer/ Archive Rules/ Applying Archiving Rules
Updated on 2026-07-22 GMT+08:00
View PDF
Share

Applying Archiving Rules

Function

This API is used to apply archiving rules retroactively to archive existing findings that meet the archive rule criteria.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

AccessAnalyzer:archiveRule:apply

Write

archiveRule *

-

-

-

URI

POST /v5/analyzers/{analyzer_id}/archive-rules/{archive_rule_id}/apply

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

analyzer_id

Yes

String

Definition:

Unique identifier of an analyzer.

You can call the ListAnalyzers API to obtain the analyzer ID. The response parameters of this API return an analyzer list. The id field of each analyzer object is the analyzer ID.

Range:

1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

archive_rule_id

Yes

String

Definition:

Unique identifier of an archive rule.

You can call the ListArchiveRules API to retrieve the list of archive rules created for a specified analyzer. The response of this API contains an archive rule list. Each archive rule object in the list contains a unique id field, which is the archive rule ID.

Range:

1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

None

Response Parameters

Status code: 200

OK

None

Example Requests

Applying archiving rules retroactively to archive existing findings that meet the archive rule criteria

POST https://{hostname}/v5/analyzers/{analyzer_id}/archive-rules/{archive_rule_id}/apply

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Archive Rules