hosting

GET /v1/sites/{siteId}/files

List one folder of the site, inside its WordPress root.

All hosting endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/files \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The file editor's folder view. path is relative to the WordPress root (empty is the root). ⛔ .., absolute paths and links pointing outside the root are refused; wp-config.php, .user.ini, php.ini and the editor's backup folder are never listed or opened. Requires sites.view and sites.panel_access. Fleet only.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).
path (query)stringNoThe folder, relative to the WordPress root.

Response

NameTypeRequiredWhat it is
okbooleanYes—
errorstringNo—
pathstringNo—
entriesobject[]No—
truncatedbooleanNo—
contentstringNo—
bytesintegerNo—
sha256stringNo—
backupstringNoWhere the previous file was copied

Errors this endpoint can return

401 · 403 · 404 · 422 · 503