Updated on 2023-11-28 GMT+08:00

Updating the Plug-in Icon

Function

Updating the Plug-in Icon

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

TenantID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

plugin_name

No

String

Plug-in

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Table 4 FormData parameters

Parameter

Mandatory

Type

Description

upload_file

Yes

File

Icon File

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error Message

error_code

String

Error code.

Example Requests

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/common/upload-plugin-icon?plugin_name=apie_test

Example Responses

Status code: 200

Icon path.

/api/v1/ce8df55870164338a72d7e828a966a2a/common/get-plugin-icon?object_key=apie_test-3 a9aa612ab8747898c8b2832561d6751-2023-08-03141751.png-ce8df55870164338a72d7e828a966a2a&icon_type=plugin

Status Codes

Status Code

Description

200

Icon path.

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.