Folders

Load a folder by site name and URI

Changed on

Retrieves a folder by its URI path within the specified site.

get/api/v1/folder/sitename/{siteName}/uri/{uri}

Request

Path parameters

siteNamestring required

Site hostname the folder lives on (e.g. 'demo.dotcms.com').

uristring required

Folder path within the site, as a plain path — e.g. 'application/themes/travel' (a leading slash is optional and added if missing). Embedded slashes are allowed (they select nested folders). Pass the raw path; do NOT percent-encode the slashes (a pre-encoded '%2F...' will not match).

Response

Folder retrieved successfully

i18nMessagesMapobject
permissionsstring[]

Changes

    • breaking

      added the pattern .+ to the path request parameter uri

    • info

      api tag Folders added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status