Remove machine

DELETE 
/api/v1/machines/remove/:machineIdOrAlias

This API endpoint remove the machine identified by the provided machineId or machine alias. This operation also removes data associated with machine such as, telemetry, tags, certificates, etc. The machine cannot be deleted if it contains an active networking node.

Request

Path Parameters

machineIdOrAlias stringrequired

The machineId - unique id of the machine, alias - machine alias

Responses

200

Success response

application/json

Schema

Schema

success boolean
message string
status string
statusCode int32
errorCode string
subErrors object[]
payload boolean

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": true
}

Remove machine example

Remove machine response example

{
  "success": true,
  "message": "Machine removed successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": true
}

Loading...