Help Center/ Host Security Service/ API Reference/ API Description/ Application Protection/ Querying the Status of Application Protection
Updated on 2026-04-03 GMT+08:00

Querying the Status of Application Protection

Function

This API is used to query the status of application protection on a single server.

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}/rasp/{host_id}/status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

host_id

Yes

String

host id

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.

app_type

No

String

Application type. The value can be:

  • java: Java application protection.

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition

Application protection status.

Constraints

N/A

Range

The options are as follows:

  • app_install_processing: The protection is being enabled.

  • app_protected: The protection is successful.

  • app_install_failed: Protection failed (installation failed).

  • app_not_configure: not protected

  • app_partially_protected: partially protected

  • app_all_failed: Protection failed.

  • app_uninstall_processing: uninstalling

Default Value

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "status" : true
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.