Help Center/ Host Security Service/ API Reference/ API Description/ Dynamic Port Honeypot/ Enabling Protection for New Servers by Default
Updated on 2026-04-03 GMT+08:00

Enabling Protection for New Servers by Default

Function

This API is used to enable protection for new servers by default.

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

PUT /v5/{project_id}/honeypot-port/default-config

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID. (This field has been deprecated.)

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.

enable

Yes

Boolean

Definition

Whether it is enabled.

Constraints

N/A

Range

-true**

-false**

Default Value

false

linux_policy_id

No

String

Definition

Linux policy ID. (This field has been discarded.)

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

windows_policy_id

No

String

Definition

Windows policy ID. (This field has been discarded.)

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Enable protection for new servers by default.

PUT https://{endpoint}/v5/{project_id}/honeypot-port/default-config?enterprise_project_id=all_granted_eps&enable=false&linux_policy_id=006ae332-2c4a-429a-b90c-f5f53ec10002

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.