Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Sites

List Site Tasks

Get a list of all the tasks for a site

get/v1/sites/{id}/tasks

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

task_idstring uuid

ID of this task

Example:01d680d5-de78-4e26-a380-5f7ad2c0877f
task_type'automated_restore' | 'backup' | 'clone_site' | 'cloud_backup_create' | 'cloud_backup_restore' | 'publish' | 'restore' | 'staging'

Type of task

task_status'DONE' | 'ERROR' | 'NEW' | 'PROGRESS'

Current state/status of the task

pageinteger

Page of results to include (default = 1)

per_pageinteger

Results per page

Example:10
sort'id' | 'perc' | 'task_status' | 'task_type' | 'updated'
direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "cloned_site_id": 1234567890,
      "template_replacements": [
        {
          "key": "__CONTACT_EMAIL__",
          "value": "hello@rocket.net"
        }
      ]
    }
  ]
}