Skip to main content

/i/tasks/delete

Endpoint​

/i/tasks/delete

Overview​

Deletes a task record and associated stored results.

Authentication​

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions​

  • Requires write access to feature core for the target app.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)Dashboard API authentication key.
auth_tokenStringYes (or use api_key)Dashboard auth token.
app_idStringYesApp ID used for write-permission validation.
task_idStringYesTask ID to delete.

Examples​

Example 1: Delete task​

/i/tasks/delete?
api_key=YOUR_API_KEY&
app_id=6991c75b024cb89cdc04efd2&
task_id=17f0f6c3a2c42cbced96d4a01f88f9a7f45bc7a5

Response​

Success Response​

{
"result": "Success"
}

Response Fields​

FieldTypeDescription
resultString"Success" after delete flow callback.

Error Responses​

Status Code: 400 Bad Request

{
"result": "Missing parameter \"task_id\""
}

Behavior​

Behavior Modes​

ModeTriggerProcessing PathResponse Shape
Task foundtask_id exists in long_tasksDeletes task result data, removes task document, emits audit log.Wrapped string { "result": "Success" }
Task missingtask_id not found or delete returns errorCallback error is not surfaced by route handler; response still returns success.Wrapped string { "result": "Success" }

Impact on Other Data​

  • Removes task metadata and may delete GridFS task result file.
  • Removes any additional task-type-specific result artifacts.

Operational Considerations​

  • Delete is destructive and cannot be undone.
  • If task has subtask links, related subtasks are also removed by task manager logic.
Implementation details

Audit & System Logs

ActionTriggerPayload
task_manager_task_deletedAfter delete callback in route handlerDeleted task document when available (undefined when task is not found).

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersAuthentication and permission validationReads member identity and app-level write permissions.
countly.long_tasksTask metadata storageDeletes task document(s).
countly_fs.task_resultsStored task outputDeletes GridFS result file when task uses GridFS storage.