user APIs

Delete a directory

Delete a directory and any children it contains for the logged in user

delete/user/dirs

Request

Base URL
/api/v2 (relative, and the document was published on a file host, not at the API’s origin)
Auth
- HTTP bearer
- or API key in header X-SFTPGO-API-KEY
TypeScript
https://skmtc.dev/kanton-bern/apis/sftpgo/docs/user/dirs/delete.ts
A function with typed inputs. Its response is checked against the schema.

pathstring required

Path to the folder to delete. It must be URL encoded, for example the path "my dir/àdir" must be sent as "my%20dir%2F%C3%A0dir"

successful operation

messagestring

message, can be empty

errorstring

error description if any

No recorded changes to this operation across all 1 revision of this API.