Help Center/ Server Migration Service/ API Reference (Kuala Lumpur Region)/ APIs V3.0/ Source Server Management/ Deleting a Source Server Record with a Specified ID
Updated on 2022-08-02 GMT+08:00
View PDF
Share

Deleting a Source Server Record with a Specified ID

Function

This API is used to delete the record of a source server with a specified ID from the SMS console. 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

DELETE /v3/sources/{source_id}

Table 1 Path parameter

Parameter

Mandatory

Type

Description

source_id

Yes

String

Specifies 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

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

Response

None

Example Request

Delete 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

OK

Error Codes

See Error Codes.

Parent topic: Source Server Management