Help Center/ KooDrive/ API Reference（Carrier）/ API/ Backup Scopes/ Deleting Backup Scopes
Updated on 2026-04-16 GMT+08:00
View PDF
Share

Deleting Backup Scopes

Function

Delete backup scopes of modules in batches.

URI

DELETE /koodrive/ose/v1/backup/device/{deviceId}/scope

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

scopeIdList

Yes

Array of strings

Definition:

Scope ID list.

Constraints:

The maximum length of the set is 100.

Range:

N/A

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.

scopeIdList

Array of strings

Backup scope that is successfully deleted.

failedScopeList

ScopeDeleteFailedInfo object

Backup scope that fails to be deleted.
Table 5 ScopeDeleteFailedInfo

Parameter

Type

Description

scopeId

String

Scope ID.

errorCode

String

Error code.

msg

String

Error message.

Example Requests

Request example for deleting backup scopes of modules in batches.

/koodrive/ose/v1/backup/device/1842812272691451648/scope

Authorization:Bearer+60f4ccc7b1********3dd9a68068
{
  "scopeIdList": [
    "123",
    123,
    345,
    "1760265745989677300VW5TYWZlSW50ZWdlcg==",
    "1752777931588940000VW5TYWZlSW50ZWdlcg==",
    "1752990708303704300VW5TYWZlSW50ZWdlcg==",
    "1842846715527366700VW5TYWZlSW50ZWdlcg=="
  ]
}

Example Responses

Status code: 200

Response body for deleting backup scopes of modules in batches.

{
  "scopeIdList" : [ "1842846715527366528" ],
  "failedScopeList" : [ {
    "scopeId" : "123",
    "errorCode" : "15000424",
    "msg" : "Request to repeatedly delete scopeId."
  }, {
    "scopeId" : "123",
    "errorCode" : "15000418",
    "msg" : "The backup scope does not exist."
  }, {
    "scopeId" : "345",
    "errorCode" : "15000418",
    "msg" : "The backup scope does not exist."
  }, {
    "scopeId" : "1760265745989677312",
    "errorCode" : "15000418",
    "msg" : "The backup scope does not exist."
  }, {
    "scopeId" : "1752777931588940032",
    "errorCode" : "15000418",
    "msg" : "The backup scope does not exist."
  }, {
    "scopeId" : "1752990708303704321",
    "errorCode" : "15000418",
    "msg" : "The backup scope does not exist."
  } ],
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Response body for deleting backup scopes of modules in batches.
Parent topic: Backup Scopes