Updated on 2024-09-04 GMT+08:00

Deleting a Source Server Record

Function

This API is used to delete the record of a source server with a specified ID from the SMS console. Once the information about a source server is deleted, you can add the information about the source server to the SMS console again only by restarting the migration Agent on the source server.

Calling Method

For details, see Calling APIs.

URI

DELETE /v3/sources/{source_id}

Table 1 Path parameter

Parameter

Mandatory

Type

Description

source_id

Yes

String

The ID of the source server displayed on the SMS console.

Minimum length: 0 characters

Maximum length: 255 characters

Request

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

Response

None

Example Request

This example deletes the record of source server whose ID is 1a6d1e0b-62e5-4376-b59f-ff2fd569xxxx.

DELETE https://{endpoint}/v3/sources/1a6d1e0b-62e5-4376-b59f-ff2fd569xxxx

Example Response

None

Status Codes

Status Code

Description

200

Response returned.

Error Codes

For details, see Error Codes.