Return restoration tasks list

This function lists the tasks in the restoration queue.

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/restore_queue_state

Request samples

whmapi1 --output=jsonpretty \
  restore_queue_state

Response samples

application/json

{"data": {"active": [{"options": {"give_ip": 1,
"mail_config": 1,
"mysql": 1,
"subdomains": 1
},
"restore_point": "2019-10-21T00:00:00.000Z",
"user": "username"
}
],
"completed": [{"options": {"give_ip": 1,
"mail_config": 0,
"mysql": 1,
"subdomains": 0
},
"restore_point": "2019-10-22T00:00:00.000Z",
"user": "username"
}
],
"is_active": 1,
"pending": [{"options": {"give_ip": 0,
"mail_config": 1,
"mysql": 0,
"subdomains": 1
},
"restore_point": "2019-10-23T00:00:00.000Z",
"user": "username"
}
]
},
"metadata": {"command": "restore_queue_state",
"reason": "OK",
"result": 1,
"version": 1
}
}