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

Modifying a Server

Function

Modifies a server.

  • The servers in the maintenance status are unavailable for new user accesses.

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:server:update

    Write

    server *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

URI

PATCH /v1/{project_id}/app-servers/{server_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

server_id

Yes

String

Unique ID of a server.

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

Server name. Requirements:

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

  2. Contains 1 to 64 characters.

description

No

String

Server description.

maintain_status

No

Boolean

Server maintenance status identifier. Options:

true: Add a tag.

false: Remove a tag.

Response Parameters

Status code: 200

Successful.

Status code: 400

Table 4 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 5 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 6 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 7 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 8 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 9 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 10 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-servers/25b1dd14-0c84-4558-aa57-03a6c54b8e75

{
  "name" : "APS-TEST"
}

Example Responses

Status code: 200

Successful.

null

Status Codes

Status Code

Description

200

Successful.

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.

500

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

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Server Management