Transfer Action Provider: Delete

URL: https://transfer.actions.globus.org/delete

Synchronous / Asynchronous: Asynchronous

The Delete action provider uses the Globus Transfer API’s task resources to submit an asynchronous deletion of data on a endpoint/collection. The input includes both the collection ids and file paths within the collection that are to be deleted.

{
  "DATA": [
    {
      "path": "dir/"
    },
    {
      "path": "file.txt"
    }
  ],
  "endpoint": "6c54cade-bde5-45c1-bdea-f4bd71dba2cc",
  "recursive": true
}

{
  "action_id": "HSkabcdefghi",
  "completion_time": "2023-06-28T15:49:38.418647+00:00",
  "creator_id": "urn:globus:auth:identity:12341234-abcd-abcd-abcd-123412341234",
  "details": {
    "DATA_TYPE": "task",
    "bytes_checksummed": 0,
    "bytes_transferred": 0,
    "canceled_by_admin": null,
    "canceled_by_admin_message": null,
    "command": "API 0.10",
    "completion_time": null,
    "deadline": "2023-06-29T15:49:40+00:00",
    "delete_destination_extra": false,
    "destination_endpoint": null,
    "destination_endpoint_display_name": null,
    "destination_endpoint_id": null,
    "directories": 0,
    "effective_bytes_per_second": 0,
    "encrypt_data": false,
    "event_list": [],
    "fail_on_quota_errors": false,
    "fatal_error": null,
    "faults": 0,
    "files": 1,
    "files_skipped": 0,
    "files_transferred": 0,
    "filter_rules": null,
    "history_deleted": false,
    "is_ok": true,
    "is_paused": false,
    "label": "For Action id HSkabcdefghi",
    "nice_status": "OK",
    "nice_status_details": null,
    "nice_status_expires_in": -1,
    "nice_status_short_description": "OK",
    "owner_id": "12341234-abcd-abcd-abcd-123412341234",
    "preserve_timestamp": false,
    "recursive_symlinks": null,
    "request_time": "2023-06-28T15:49:40+00:00",
    "skip_source_errors": false,
    "source_endpoint": "u_eyljfjd6jfg67nm6zp6gly4qpu#e09c6728-80a0-11ee-bddb-c52a29481bea",
    "source_endpoint_display_name": "Globus Tutorial Collection 1",
    "source_endpoint_id": "6c54cade-bde5-45c1-bdea-f4bd71dba2cc",
    "status": "ACTIVE",
    "subtasks_canceled": 0,
    "subtasks_expired": 0,
    "subtasks_failed": 0,
    "subtasks_pending": 2,
    "subtasks_retrying": 0,
    "subtasks_skipped_errors": 0,
    "subtasks_succeeded": 0,
    "subtasks_total": 2,
    "symlinks": 0,
    "sync_level": null,
    "task_id": "12341234-abcd-abcd-abcd-123412341234",
    "type": "DELETE",
    "username": "u_abcd",
    "verify_checksum": false
  },
  "display_status": "ACTIVE",
  "label": null,
  "manage_by": [],
  "monitor_by": [],
  "release_after": "P30D",
  "start_time": "2023-06-28 15:49:38.418630+00:00",
  "status": "ACTIVE"
}

{
  "__COMMENT": "The delete task id will be `$.delete_result.details.task_id`",
  "delete": {
    "Type": "Action",
    "ActionUrl": "https://transfer.actions.globus.org/delete",
    "Parameters": {
      "endpoint.$": "$.endpoint_id",
      "recursive": true,
      "DATA": [
        {
          "path.$": "$.path"
        }
      ]
    },
    "ResultPath": "$.delete_result"
  }
}