Updated on 2026-01-12 GMT+08:00

Updating the Extension Icon

Function

This API is used to update the extension icon.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{domain_id}/common/upload-plugin-icon

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 contains 32 characters, including only letters and digits.

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

plugin_name

Yes

String

Definition:

Extension name.

Constraints:

Enter only spaces, letters, digits, hyphens (-), underscores (_), and periods (.).

Value range:

Max. 50 characters.

Default value:

N/A

Request Parameters

Table 3 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 4 FormData parameters

Parameter

Mandatory

Type

Description

upload_file

Yes

File

Definition:

Icon file. Only PNG, JPEG, and JPG files are supported. Max. file size: 512 KB. 128 × 128 pixels are recommended.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

-

String

Definition:

Whether the calling is successful.

Value range:

  • true: The calling is successful.

  • false: The calling fails.

Status code: 400

Table 6 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/common/upload-plugin-icon?plugin_name=apie_test

Example Responses

Status code: 200

OK

https://devops.xxx.xxx.cn/devmarket/plugin/new/my-test-pluginBGqH6-470e9155144d40e98503e806a52d96c9-ScreenShot_20250421165905.PNG

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.