Sign in

v1

latestSwagger 2.02026-07-172964242.9 KB
Database

Cancel a database task

Cancels a running or pending task for a database.

get/v1/databases/{database_id}/tasks/{task_id}/cancel

Path parameters

database_idstring required

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.

task_idstring required

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.

Response

OK response.

completed_atstring date-time

The time when the task was completed.

created_atstring date-time required

The time when the task was created.

database_idstring

The database ID of the task.

entity_idstring required

The entity ID (database_id or host_id) that this task belongs to.

errorstring

The error message if the task failed.

host_idstring

The ID of the host that the task is running on.

instance_idstring

The ID of the instance that the task is operating on.

node_namestring

The name of the node that the task is operating on.

parent_idstring uuid

The parent task ID of the task.

scope'database' | 'host' required

The scope of the task (database or host).

status'pending' | 'running' | 'completed' | 'canceled' | 'canceling' | 'failed' | 'unknown' required

The status of the task.

task_idstring uuid required

The unique ID of the task.

typestring required

The type of the task.

Example response

{
  "completed_at": "2025-06-18T16:52:35Z",
  "created_at": "2025-06-18T16:52:05Z",
  "database_id": "storefront",
  "entity_id": "storefront",
  "scope": "database",
  "status": "completed",
  "task_id": "019783f4-75f4-71e7-85a3-c9b96b345d77",
  "type": "create"
}