Updated on 2023-06-25 GMT+08:00

Adding or Modifying Application Configurations

Function

This API is used to add or modify application configurations.

Application configurations refer to common environment variables of an application. Components deployed in the application inherit these environment variables.

URI

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

Table 1 Path parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Tenant's project ID.

application_id

String

Yes

Application ID.

Request

Table 2 Request parameters

Parameter

Type

Mandatory

Description

environment_id

String

Yes

Environment ID.

configuration

Object

Yes

Application configurations, such as public environment variables. See Table 3.

Table 3 configuration parameter

Parameter

Type

Mandatory

Description

env

Array of objects

Yes

Environment variables of the application. See Table 4.

If the names of multiple environment variables are the same, only the last environment variable takes effect.

Table 4 env parameters

Parameter

Type

Mandatory

Description

name

String

Yes

Name of the environment variable.

The value contains 1 to 64 characters consisting of letters, digits, underscores (_), hyphens (-), and dots (.), and cannot start with a digit.

value

String

Yes

Value of the environment variable.

Response

Table 5 Response parameters

Parameter

Type

Description

application_id

String

Application ID.

environment_id

String

Environment ID.

configuration

Object

Application configurations. See Table 6.

Table 6 configuration parameter

Parameter

Type

Description

env

Array of objects

Environment variables. See Table 7.

Table 7 env parameters

Parameter

Type

Description

name

String

Name of the environment variable.

value

String

Value of the environment variable.

Example

Example request

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

Example response

{
    "application_id": "06cf2fda-af45-44b4-9e22-6294c4804515", 
    "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567", 
    "configuration": {
        "env": [
            {
                "name": "app-env", 
                "value": "env"
            }
        ]
    }
}

Status Code

Table 8 Status codes

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

Error code must be in the format of SVCSTG.00100.[Error_ID]. Example: SVCSTG.00100400. See Error Codes of Application Management APIs.