Help Center/ Server Migration Service/ API Reference(ME-Abu Dhabi Region)/ APIs V3.0/ Source Server Management/ Deleting Source Server Records in Batches
Updated on 2022-08-05 GMT+08:00
View PDF
Share

Deleting Source Server Records in Batches

Function

This API is used to delete source server records in batches. Once the record of a source server is deleted, you can add a new record for the source server on the SMS console only by restarting the Agent installed on the source server.

URI

POST /v3/sources/delete

Request

Table 1 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1 character

Maximum length: 16,384 characters
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

Specifies the IDs of all source servers to be deleted.

Response

None

Example Request

Delete the records of source servers whose IDs are ec2a894f-0d92-47c5-ac22-168ef61d399b and 5f13089f-799f-4f33-b3e1-c499397dfdf8.

POST https://{endpoint}/v3/sources/delete

{
  "ids" : [ "ec2a894f-0d92-47c5-ac22-168ef61dxxxx", "5f13089f-799f-4f33-b3e1-c499397dxxxx" ]
}

Example Response

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Source Server Management