Skip to content

List active lifecycle tasks

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

List queued and running guest lifecycle tasks, optionally filtered by guest type and positive guest ID

guestType
string
Allowed values: vm jail jail-template vm-template

Guest type

guestId
integer
>= 1

Positive guest ID

Success

Media typeapplication/json
object
data
Array<object>
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"
}

Bad Request

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

Unauthorized

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

Forbidden

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

Internal Server Error

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