Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Application Group Management/ Modifying an Application Group
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Modifying an Application Group

Function

Modifies an application group.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:appGroup:update

    Write

    appGroup *

    -

    -

    -

    serverGroup

    -

URI

PATCH /v1/{project_id}/app-groups/{app_group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

app_group_id

Yes

String

Application group ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Application group name. Requirements:

  1. Contains letters, digits, underscores (_), and hyphens (-).

  2. Contains 1 to 64 characters.

app_server_group_id

No

String

Application server group ID. A server group can be bound only when it is not set.

description

No

String

Application group description.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Application group ID.

name

String

Application group name.

app_server_group_id

String

Application server group ID.

app_server_group_name

String

Application server group name.

description

String

Application group description.

authorization_type

String

Authorization type.

  • APP (not supported): Application-based authorization.

  • APP_GROUP (default): Application group-based authorization.

tenant_id

String

Tenant ID.

app_type

String

Server group application type:

SESSION_DESKTOP_APP: Session desktop application.

COMMON_APP: Common application.

create_at

String

Publish time.

app_count

Integer

Number of applications.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 409

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-groups/575772274859184145

{
  "name" : "Open Test for the API for Modifying an Application Group",
  "app_server_group_id" : "2ad44c6d-b829-4e89-a44a-5f25577f7788",
  "description" : "AAAA"
}

Example Responses

Status code: 200

Response to a successful request.

{
  "id" : "575772274859184145",
  "name" : "Open Test for the API for Modifying an Application Group",
  "app_server_group_id" : "d75cce49-413a-4102-8cfa-c4328f5cac6f",
  "description" : "AAAA",
  "authorization_type" : "APP_GROUP",
  "tenant_id" : "a4da8115c9d8464ead3a38309130523f",
  "create_at" : "2023-06-06T14:14:02.246Z"
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

409

The requested resource format is not supported.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.