Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Files

List Site Files

List all files/directories in a specific directory

get/v1/sites/{id}/file_manager/files

Path parameters

idinteger required

site id

Query parameters

pathstring

Path to list files/directories under - relative to the document root of the site

searchstring

Search for files/directories matching this string

pageinteger required

Page of results to include (default = 1)

per_pageinteger required

How many results to include in each page (default = 10)

sort'created_at' | 'ctime' | 'mtime' | 'name' | 'size' | 'type' | 'updated_at'

Property of the file to sort by

direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "created_at": "2023-12-14 3:11PM",
      "ctime": 1713495598,
      "updated_at": "2023-12-14 3:11PM",
      "mtime": 1714411276,
      "name": "styles.css",
      "mode": "0600",
      "type": "file",
      "human_size": "4 KB",
      "size": 4096,
      "path": "wp-content"
    }
  ]
}