Return autocomplete file and directory names

This function returns any files and directories that begin with a specified string.

Important:

When you disable the File Storage role, the system disables this function.

Authorizations:
query Parameters
path
required
string

The prefix of the paths to complete.

Example: path=public
dirsonly
integer
Default: 0

Whether to include only directories in the output.

  • 1Only include directories.
  • 0 — Include directories and files.
Enum: 1 0
html
integer
Default: 1

Whether to return HTML-encoded results.

  • 1 — Return HTML-encoded output.
  • 0 — Return plaintext output.
Enum: 0 1
Example: html=1
list_all
integer
Default: 1

Whether to return all files and directories inside the specified directory. If you set this parameter's value to 1, you must set the path parameter's value to a full directory path.

  • 1 — Return all files and directories inside the specified directory.
  • 0 — Return partial file and directory name matches.
Enum: 1 0

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Fileman \
  autocompletedir \
  path='public'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "autocompletedir",
  • "module": "Fileman",
  • "result": {
    • "data": [
      • {
        • "file": "public_ftp"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}