Skip to content
SYLVE

Get the active lifecycle task for a guest

GET
/tasks/lifecycle/active/{guestType}/{guestId}
curl --request GET \
  --url https://sylve.lan:8181/api/tasks/lifecycle/active/vm/1 \
  --header 'Authorization: <Authorization>'

Return the newest queued or running lifecycle task for one guest; successful data is null when no task is active

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
guestType
required
string
Allowed values: vm jail jail-template vm-template

Guest type

guestId
required
integer
>= 1

Positive guest ID

Responses

Section titled “Responses”

200

Section titled “200”

Success; data may be null

Media typeapplication/json
object
data
object
action
string
createdAt
string
error
string
finishedAt
string
guestId
integer
guestType
string
id
integer
message
string
overrideRequested
boolean
payload
string
requestedBy
string
source
string
startedAt
string
status
string
updatedAt
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "action": "example",
    "createdAt": "example",
    "error": "example",
    "finishedAt": "example",
    "guestId": 1,
    "guestType": "example",
    "id": 1,
    "message": "example",
    "overrideRequested": true,
    "payload": "example",
    "requestedBy": "example",
    "source": "example",
    "startedAt": "example",
    "status": "example",
    "updatedAt": "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"
}

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"
}