Help Center> RES> API Reference> API> Workspace> Updating a Workspace
View PDF

Updating a Workspace

Function

This API is used to update the workspace information. Only the description can be updated.

URI

PUT /v2.0/{project_id}/workspaces/{workspace_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.

workspace_id

Yes

String

Workspace ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Content type. The value is application/json.

X-Auth-Token

Yes

String

User token. For details on how to obtain the user token, see Obtaining a User Token Through Password Authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Workspace name, which is a string of 1 to 64 characters and contains digits, letters, underscores (_), and hyphens (-). It cannot end with a hyphen (-).

Minimum: 1

Maximum: 64

description

No

String

Description

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

is_success

Boolean

Whether the request is successful

message

String

Response message

error_code

String

Error code (This parameter is not returned when the request is successful.)

Example Requests

This API is used to modify the workspace description.

/v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx

{
  "description" : "modify the workspace description",
  "name" : "workspace"
}

Example Responses

Status code: 200

OK

{
  "is_success" : true,
  "message" : "Succeed to update workspace. "
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Workspace