Sign in
Hosting: Files

List website files and directories

List files and directories under a website's document root.

Use directory to browse a subdirectory relative to the document root. Symlinked entries are listed but never traversed into or resolved.

get/api/hosting/v1/accounts/{username}/domains/{domain}/files

Path parameters

usernamestring required
Example:u123456789
domainstring required
Example:mydomain.tld

Domain name

Query parameters

directorystring
Example:blog

Directory path to check

max_depthinteger nullable
Example:5

How many directory levels deep to recurse.

max_itemsinteger nullable
Example:500

Max number of entries to return in this page.

offsetinteger nullable

Number of entries to skip. Page with offset + item count until reaching total_items.

file_typesstring[]

Filter by entry type, e.g. file,directory. Omit for all types.

[
  "file",
  "directory"
]

Response

Success response

pathstring required

Listed directory, relative to the document root.

total_itemsinteger required

Total number of entries matching the listing, across all pages.

total_items_current_pageinteger required

Number of entries in this page.

offsetinteger required

Number of entries skipped before this page.

Example response

{
  "path": "wp-content",
  "items": [
    {
      "name": "index.php",
      "path": "wp-content/index.php",
      "type": "file",
      "size_bytes": 512
    }
  ],
  "total_items": 42,
  "total_items_current_page": 20
}

Changes

Changed in 2 of the 89 revisions of this API.21

  • 78a0ad53c9da2See the full diff
    • ▲

      query request parameter file_types list-of-types was narrowed by removing types string

      request-parameter-list-of-types-narrowed

    • ▲

      for the query request parameter file_types, the type/format was changed from / to array/

      request-parameter-type-changed

  • a451d9fc77131See the full diff
    • ○

      endpoint added

      endpoint-added