Updated on 2025-10-24 GMT+08:00

Modify an Application

Function

This API is used to adjust an application's name or description as required after the application is created.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    coc:application:update

    Write

    application *

    -

    -

    -

URI

PUT /v1/applications/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition:

Application ID.

Constraints:

N/A

Value range:

The value is user-defined. The value contains 24 characters.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition:

Application name.

Constraints:

The value consists of letters, digits, hyphens (-), and underscores (_).

Value Range:

The value is a string with 3 to 50 characters.

Default value:

N/A

description

No

String

Definition:

Description.

Constraints:

N/A

Value Range:

The value can be customized and contains 1 to 256 characters.

Default value:

N/A

is_collection

No

Boolean

Definition:

Whether to add it to favorites.

Constraints:

N/A

Value Range:

  • true: The application is successfully added to favorites and can be viewed in My Favorites.

  • false: not added to favorites.

Default value:

By default, it is not added to favorites.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

String

Definition:

ID of the application you want to modify.

Value Range:

N/A

Example Requests

This API is used to change the application name.

PUT https://{Endpoint}/v1/applications/{id}

{
  "name" : "Crf_Large-scale application 1144",
  "description" : "test"
}

Example Responses

Status code: 200

An application is modified.

{
  "data" : "67e3b885ef614c77c8b76f49"
}

Status Codes

Status Code

Description

200

An application is modified.

Error Codes

See Error Codes.