UpdateAppTag - Update application tag
Applicable versions | Central edition, region edition |
Endpoint and authorization
- Obtain the endpoint: Replace
{domain}in the API request syntax with the endpoint. - Obtain a personal access token
- Obtain the organization ID: Required for the central edition only. You can obtain your organization ID from the Basic Information page in the organization management console.
Product | Resource | Required permission |
application delivery | application tag | read/write |
Request syntax
Central edition
PUT https://{domain}/oapi/v1/appstack/organizations/{organizationId}/appTags/updateTagRegion edition
PUT https://{domain}/oapi/v1/appstack/appTags/updateTagRequest headers
Parameter | Type | Required | Description | Example |
x-yunxiao-token | string | Yes | The personal access token. | pt-0fh3****0fbG_35af****0484 |
Request parameters
Parameter | Type | Position | Required | Description | Example |
organizationId | string | path |
| The organization ID. | ec766e63aee3437d9a51f334d6exe671 |
name | string | query | Yes | The name of the application tag to update. | mytag |
| - | object | body | No | ||
| color | string | body | No | The color of the application tag. The supported values are: #66acab (teal), #7b9ab4 (blue-gray), #698cd4 (bright blue), #4676e5 (strong blue), #5c68c1 (dark blue-violet), #9f76dA (purple), #6bAe3f (green), #ae9e6b (earthy yellow), #a7bc60 (light green), #ae785e (brown), #eb933e (orange), and #d75644 (red). If this parameter is not specified, the tag retains its original color. | #66acab |
| name | string | body | Yes | The new name for the application tag. To keep the name unchanged, specify the current name. | newName |
Request examples
Central edition
curl -X 'PUT' \
'https://{domain}/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exe671/appTags/updateTag?name=mytag' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"color": "#66acab",
"name": "newName"
}'Region edition
curl -X 'PUT' \
'https://{domain}/oapi/v1/appstack/appTags/updateTag?name=mytag' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"color": "#66acab",
"name": "newName"
}'Response parameters
Parameter | Type | Description | Example |
| - | object | ||
| frontendStyle | string | The style properties for the frontend. This object currently only includes the color. | {"color":"#66acab"} |
| name | string | The name of the application tag. | mytag |
Response example
{
"frontendStyle": "{\"color\":\"#66acab\"}",
"name": "mytag"
}Error codes
Refer to the Error Code Center for a list of API error codes.