Skip to main content

Browse a server-side directory

GET 

/api/browse_path

Lists the contents of a directory on the server's filesystem, for populating a file/folder picker on file_path config fields. These fields hold paths on the host running the integration engine (source directories, certificates, etc.), not paths on the browsing client, so this browses the server's disk rather than using a client-side file input.

Every failure below is reported in the error field of a 200 rather than raised: the picker is a browser, and an unreadable directory is an ordinary thing to browse into. An exception here reaches the client as Starlette's plain-text "Internal Server Error", which the JSON-parsing API client can only surface as a syntax error.

Request

Responses

Directory listing for the resolved path, or an error message if it couldn't be listed.