Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Application Configuration Management/ Modifying an Application Configuration
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying an Application Configuration

Function

Modifying an Application Configuration

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v2/{project_id}/apic/instances/{instance_id}/apps/{app_id}/configs/{app_config_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

app_id

Yes

String

Application ID

app_config_id

Yes

String

Application configuration ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

config_type

Yes

String

Application configuration type.

  • variable: template variable

  • password: password

  • certificate: certificate

config_value

No

String

Application configuration value:

  • config_type = variable: config_value is the value of a template variable.

  • config_type = password: config_value indicates the password.

  • config_type = certificate: In an API for creating or modifying application configurations, config_value is optional. In a custom backend function, config_value must contain a certificate for which public_key and private_key are mandatory, and passphrase is optional. The format is as follows: "{\"public_key\": ",\"private_key\":\"\",\"passphrase\":\"\"}"

description

No

String

Description of an application configuration.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Application configuration ID.

app_id

String

Application ID

config_type

String

Application configuration type.

config_name

String

Application configuration name.

config_value

String

Application configuration value.

update_time

String

Time when the application configuration was updated.

description

String

Description of an application configuration.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Modify the configuration type as password.

{
  "config_type" : "password"
}

Example Responses

Status code: 200

OK

{
  "app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d",
  "config_name" : "app-config-demo",
  "config_type" : "password",
  "config_value" : "******",
  "description" : "",
  "id" : "a8bf4963c54544be81d5af4cc4630bde",
  "update_time" : "2020-09-07T07:10:07.601494336Z"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3081",
  "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.