Help Center> CodeArts Deploy> API Reference> APIs> Managing Environments> Editing an Environment in an Application
Updated on 2024-07-05 GMT+08:00
Online Debugging
CLI Examples
View PDF

Editing an Environment in an Application

Function

This API is used to edit an environment in an application.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/applications/{application_id}/environments/{environment_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID

Minimum: 32

Maximum: 32

environment_id

Yes

String

Environment ID

Minimum: 32

Maximum: 32

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Possible values: application/json;charset=utf-8 application/json

Default: application/json;charset=utf-8

Enumeration values:

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

Yes

String

User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Minimum: 0

Maximum: 20000
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Environment name

Minimum: 3

Maximum: 128

description

No

String

Environment description

Minimum: 0

Maximum: 500

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Request success or failure status

id

String

Environment ID

Example Requests

https://{endpoint}/v1/applications/8ddf0566c1784da29faac80516fa8425/environments/54e5b8b0d10148cc96142ac9d6c1c1f6

{
  "description" : "description",
  "name" : "newEnvironmentName"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "id" : "54e5b8b0d10148cc96142ac9d6c1c1f6"
}

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.

Parent topic: Managing Environments