Help Center/KooDrive/API Reference（Carrier）/API/Configuration Management/Modifying Configurations
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Modifying Configurations

Function

Modify module configuration information.

URI

PATCH /koodrive/ose/v1/backup/device/{deviceId}/config

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

deviceId

Yes

String

Definition:

Device ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

This field stores the access token.

Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission.

Constraints:

The format is bearer+access token.

Range:

For details about how to obtain an access token, see the corresponding developer guide.

Default Value:

N/A

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app ID authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Signature time, which is used for app ID authentication.

Constraints:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

Default Value:

N/A

Definition:

Signature time, which is used for app ID authentication.

Constraints:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

Default Value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

moduleCode

Yes

String

Definition:

Module code.

Constraints:

100–102

Range:

100: folder backup 101: album backup 102: address book backup

Default Value:

N/A

configName

Yes

String

Definition:

Configuration name.

Constraints:

^[a-zA-Z0-9_]{1,32}$

Range:

The maximum length is 32.

Default Value:

N/A

currentConfigValue

Yes

String

Definition:

Current configuration value.

Constraints:

^[a-zA-Z0-9_]{1,32}$

Range:

The maximum length is 32.

Default Value:

N/A

newConfigValue

Yes

String

Definition:

New configuration value.

Constraints:

^[a-zA-Z0-9_]{1,32}$

Range:

The maximum length is 32.

Default Value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

Integer

Status code.

msg

String

Status description.

data

SimpleConfigInfo object

Configuration information.

Table 5 SimpleConfigInfo

Parameter

Type

Description

deviceId

String

Device ID.

moduleCode

String

Module code.

configName

String

Configuration name.

configValue

String

Configuration value.

Example Requests

Example request for modifying module configuration information.

/koodrive/ose/v1/backup/device/1842812272691451648/config

Authorization:Bearer+60f4ccc7b1********3dd9a68068
{
    "moduleCode": "102",
    "configName": "backend_backup_switch",
    "currentConfigValue": "101test2value",
    "newConfigValue": "101test2value2"
}

Example Responses

Status code: 200

Response body for modifying module configuration information.

{
  "data" : {
    "deviceId" : "1842812272691451648",
    "moduleCode" : "102",
    "configName" : "backend_backup_switch",
    "configValue" : "101test2value2"
  },
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Response body for modifying module configuration information.