Updated on 2026-08-10 GMT+08:00

Updating the Third-Party Plug-in List of a Specified ID

Function

This API is used to update the third-party plug-in list with a specified ID.

Calling Method

For details, see Calling APIs.

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
codeartscheck:task:update	Write	task *	-	-	-
codeartscheck:task:update	Write	-	codeartscheck:ProjectId	-	-

URI

PUT /v2/plugins

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Template ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
[items]	No	Array of ThirdPlugin objects	Definition Third-party tool list. Range N/A

**Table 3** ThirdPlugin
Parameter	Mandatory	Type	Description
command	No	String	Definition: Command to be executed. Value range: 1 to 1,024 characters.
id	No	String	Definition: Configuration template ID. The configuration template ID is required for modifying the configuration information. Each CodeArts Check task and its branch tasks have the same unique configuration template ID. Value range: 1 to 128 characters.
pluginName	No	String	Definition: Third-party plug-in name. Value range: 1 to 128 characters.
reportPath	No	String	Definition: Report path specified by the third-party plug-in. Value range: 1 to 1,024 characters.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	String	Definition: Successful response. Value range: OK

Example Requests

Update the third-party plug-in list whose ID is 897acf5exxx48a5013cd.

PUT https://{endpoint}/v2/plugins?id=897acf5exxx48a5013cd

Example Responses

Status code: 200

Third-party plug-in configuration.

{
  "result" : "success"
}

Status Codes

Status Code	Description
200	Third-party plug-in configuration.

Error Codes

See Error Codes.

Parent Topic: Task Management