Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Project/ Updating Project Watermark Settings
Updated on 2026-04-28 GMT+08:00

Updating Project Watermark Settings

Function

This API is used to update project watermark settings.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PUT https://{hostURL}/v4/projects/{project_id}/watermark

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

You can obtain the unique project identifier, 32-character UUID, by calling the API used to query the project list.

Value range:

32 characters

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

Mandatory.

Range

1–100,000 characters.

Default Value

N/A.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

watermark

No

Boolean

Definition

Watermark status.

  • true: enabled.

  • false: disabled.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

watermark

Boolean

Definition

Watermark status.

  • true: enabled.

  • false: disabled.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

PUT https://{endpoint}/v4/projects/86548fcf4dc944afb96d07bc9839e45c/watermark

{
  "watermark" : false
}

Example Responses

Status code: 200

Project watermark settings.

{
  "watermark" : false
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status code: 404

Not Found

{
  "error_code" : "CH.004404",
  "error_msg" : "The project does not exist or has been deleted."
}

Status Codes

Status Code

Description

200

Project watermark settings.

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.