Skip to content
SYLVE

Purge an orphaned Virtual Machine registration

DELETE
/vm/{rid}/registration
curl --request DELETE \
  --url 'https://sylve.lan:8181/api/vm/1/registration?deletemacs=true' \
  --header 'Authorization: <Authorization>'

Remove stale VM registration and runtime metadata by RID while preserving datasets

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
rid
required
integer
>= 1

Virtual Machine RID

Query Parameters

Section titled “Query Parameters”
deletemacs
boolean
default: true

Delete unused VM MAC objects

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
deletedMacObjectIds
Array<integer>
retainedDatasets
Array<string>
retainedMacObjectIds
Array<integer>
warnings
Array<string>
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "deletedMacObjectIds": [
      1
    ],
    "retainedDatasets": [
      "example"
    ],
    "retainedMacObjectIds": [
      1
    ],
    "warnings": [
      "example"
    ]
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}