Transfer Action Provider: Stat File or Directory

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

Synchronous / Asynchronous: Synchronous

The Stat File or Directory action provider uses the Globus Transfer API’s get file status resource to get information about a path on a Globus collection. Both the endpoint_id describing the collection and the path are required.

For determining whether an entity is a file or directory, check the type field in the response.

{
  "endpoint_id": "6c54cade-bde5-45c1-bdea-f4bd71dba2cc",
  "path": "/home/share/godata/"
}

{
  "action_id": "FJmGKabcdefgh",
  "completion_time": "2024-02-28 15:23:00.269995+00:00",
  "creator_id": "urn:globus:auth:identity:12341234-abcd-abcd-abcd-123412341234",
  "details": {
    "DATA_TYPE": "file",
    "group": "tutorial",
    "last_modified": "2023-12-18 16:52:50+00:00",
    "link_group": null,
    "link_last_modified": null,
    "link_size": null,
    "link_target": null,
    "link_user": null,
    "name": "godata",
    "permissions": "0755",
    "size": 4096,
    "type": "dir",
    "user": "tutorial"
  },
  "display_status": "SUCCEEDED",
  "label": null,
  "manage_by": [],
  "monitor_by": [],
  "release_after": "P30D",
  "start_time": "2024-02-28 15:22:58.772247+00:00",
  "status": "SUCCEEDED"
}

{
  "__COMMENT": "The stat output will be stored in `$.stat_result.details`",
  "stat": {
    "Type": "Action",
    "ActionUrl": "https://transfer.actions.globus.org/stat",
    "Parameters": {
      "endpoint_id.$": "$.endpoint_id",
      "path.$": "$.path"
    },
    "ResultPath": "$.stat_result"
  }
}