Help Center/ Host Security Service/ API Reference/ API Description/ Server Installation and Configuration/ Obtaining the Configuration Switch Status
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Obtaining the Configuration Switch Status

Function

This API is used to obtain the configuration switch status.

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}/setting/switches/{code}

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

code

Yes

String

Configuration type.

  • malware_sample_high_detect: sensitive malware detection mode

  • image_pay_per_scan: pay-per-use image scan switch

  • image_popup: pay-per-use image scan pop-up window switch

  • image_free_to_pay_popup: switch of the pop-up window for transferring from free to paid image scan

  • display_unprotected_host: Show unprotected servers.
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.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

enabled

Boolean

Enabled/Disabled

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "enabled" : true
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Server Installation and Configuration