Help Center> ServiceStage> API Reference> Application Management V3 APIs> Application> Modifying Application Configurations Based on the Application ID
Updated on 2023-08-07 GMT+08:00

Modifying Application Configurations Based on the Application ID

Function

This API is used to modify application configurations based on the application ID.

URI

PUT /v3/{project_id}/cas/applications/{application_id}/configuration

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

application_id

Yes

String

Application ID. See Obtaining All Applications.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type or format.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

environment_id

Yes

String

Environment ID. See Obtaining All Environments.

configuration

Yes

Object

Environment variable configuration. See Table 4.

Table 4 configuration parameter

Parameter

Mandatory

Type

Description

env

Yes

Array of objects

Environment variable. See Table 5.

Table 5 env parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Variable name.

value

Yes

String

Variable value.

Response

Table 6 Response parameters

Parameter

Type

Description

application_id

String

Application ID.

environment_id

String

Environment ID.

configuration

Object

Environment variable configuration. See Table 7.

Table 7 configuration parameter

Parameter

Type

Description

env

Array of object

Environment variable. See Table 8.

Table 8 env parameters

Parameter

Type

Description

name

String

Variable name.

value

String

Variable value.

Example Request

Modify the environment whose ID is 0fa75dfe-0d32-4bc1-848b-8008cf3f2567 by changing the name to app-env and the value to env.

{
  "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567",
  "configuration": {
    "env": [
      {
        "name": "app-env",
        "value": "env"
      }
    ]
  }
}

Example Response

{
      "application_id": "fdd7889d-eef8-4db1-befc-7037b02d949e",
      "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567",
      "configuration": {
        "env": [
          {
            "name": "app-env",
            "value": "env"
          }
        ]
      }
}

Status Code

Table 9 Status codes

HTTP Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

The error code format is SVCSTG.00100.[Error_ID], for example, SVCSTG.00100400. For details, see ServiceStage Error Codes.