v1

latestSwagger 2.02026-07-172964242.9 KB

System

List tasks

Lists tasks across all scopes with optional filtering by scope and entity ID.

get/v1/tasks

Query parameters

scope'database' | 'host'

Optional scope to filter tasks (database or host).

entity_idstring

A user-specified identifier. Must be 1-36 characters, contain only lower-cased letters and hyphens, start and end with a letter or number, and not contain consecutive hyphens.

after_task_idstring uuid

ID of the task to start from.

limitinteger

Maximum number of tasks to return.

Sort order for the tasks.

Response

OK response.

Example response

{
  "tasks": [
    {
      "completed_at": "2025-06-18T17:54:36Z",
      "created_at": "2025-06-18T17:54:28Z",
      "database_id": "storefront",
      "entity_id": "storefront",
      "instance_id": "storefront-n1-689qacsi",
      "scope": "database",
      "status": "completed",
      "task_id": "0197842d-9082-7496-b787-77bd2e11809f",
      "type": "node_backup"
    },
    {
      "completed_at": "2025-06-18T17:54:36Z",
      "created_at": "2025-06-18T17:54:28Z",
      "entity_id": "host-1",
      "host_id": "host-1",
      "scope": "host",
      "status": "completed",
      "task_id": "0197842d-9082-7496-b787-77bd2e11809f",
      "type": "remove_host"
    }
  ]
}