v1

latestOpenAPI 3.0.2Apache 2.02026-07-1739106293.5 KB
File Storage

List all files in the workspace

Lists all user-uploaded files that are stored at the back-end.

get/files

Query parameters

limitinteger

This parameter enables pagination for the endpoint and specifies the maximum number of elements that arrays in the top-level object (e.g. collections, processes, batch jobs, secondary services, log entries, etc.) are allowed to contain. The links array MUST NOT be paginated like the resources, but instead contain links related to the paginated resources or the pagination itself (e.g. a link to the next page). If the parameter is not provided or empty, all elements are returned.

Pagination is OPTIONAL: back-ends or clients may not support it. Therefore, it MUST be implemented in a way that clients not supporting pagination get all resources regardless. Back-ends not supporting pagination MUST return all resources.

If the response is paginated, the links array MUST be used to communicate the links for browsing the pagination with predefined rel types. See the links array schema for supported rel types. Back-end implementations can, unless specified otherwise, use any kind of pagination technique, depending on what is supported best by their infrastructure: page-based, offset-based, token-based or something else. The clients SHOULD use whatever is specified in the links with the corresponding rel types.

Response

Flattened file tree with path relative to the user's root directory and some basic properties such as the file size and the timestamp of the last modification. All properties except the name are optional. Folders MUST NOT be listed separately so each element in the list MUST be a downloadable file.

Example response

{
  "files": [
    {
      "path": "folder/file.txt",
      "size": 1024,
      "modified": "2018-01-03T10:55:29Z"
    }
  ],
  "links": [
    {
      "rel": "related",
      "href": "https://openeo.example",
      "type": "text/html",
      "title": "openEO"
    }
  ]
}