Updating Basic Information of an Extension

Function

This API is used to update basic information of an extension.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{domain_id}/agent-plugin/update-info

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for . Constraints: N/A Value range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
unique_id	No	String	Definition: Extension UUID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
icon_url	No	String	Definition: Extension icon URL. Constraints: N/A Value range: N/A Default value: N/A
runtime_attribution	No	String	Definition: Running attribute. Constraints: N/A Value range: agent: agent-based running. agentless: agentless running. Default value: N/A
plugin_name	Yes	String	Definition: Unique identifier of the extension. Constraints: N/A Value range: N/A Default value: N/A
display_name	Yes	String	Definition: Displayed extension name. Constraints: N/A Value range: N/A Default value: N/A
business_type	Yes	String	Definition: Extension service type. Constraints: N/A Range: Build. Gate. Deploy. Test. Normal. Default value: N/A
business_type_display_name	Yes	String	Definition: Displayed service type of the extension. Constraints: N/A Value range: N/A Default value: N/A
description	No	String	Definition: Extension description. Constraints: N/A Value range: N/A Default value: N/A
is_private	No	Integer	Definition: Whether the extension is private. Constraints: N/A Value range: N/A Default value: N/A
region	No	String	Definition: Region. Constraints: N/A Value range: N/A Default value: N/A
maintainers	No	String	Definition: Maintainer. Constraints: N/A Value range: N/A Default value: N/A
plugin_composition_type	No	String	Definition: Whether a group consists of multiple steps. Constraints: N/A Value range: single: single-step extension. multi: multi-step extension. Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
-	Boolean	Definition: Whether the calling is successful. Value range: true: The calling is successful. false: The calling fails.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

Example Requests

 POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/update-info

{
  "plugin_name" : "apie_test",
  "display_name" : "apie_test",
  "business_type" : "Normal",
  "description" : "1111",
  "maintainers" : "",
  "business_type_display_name" : "General",
  "icon_url" : ""
}