folders

Find folders by name

Returns the folder with the given name if it exists.

get/folders/{name}

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/folders/:name/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

confidential_datainteger

If set to 1 confidential data will not be hidden. This means that the response will contain the key and additional data for secrets. If a master key is not set or an external KMS is used, the data returned are enough to get the secrets in cleartext. Ignored if the * permission is not granted.

Response

successful operation

idinteger

namestring

unique name for this virtual folder

mapped_pathstring

absolute filesystem path to use as virtual folder

descriptionstring

optional description

used_quota_sizeinteger

used_quota_filesinteger

last_quota_updateinteger

Last quota update as unix timestamp in milliseconds

usersstring[]

list of usernames associated with this virtual folder

Example response

{
  "filesystem": {
    "s3config": {
      "key_prefix": "folder/subfolder/"
    },
    "gcsconfig": {
      "key_prefix": "folder/subfolder/"
    },
    "azblobconfig": {
      "key_prefix": "folder/subfolder/"
    },
    "sftpconfig": {
      "buffer_size": 2
    }
  }
}

Changes

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