/show/directories - Kinetica Docs

URL: http://<db.host>:<db.port>/show/directories

Shows information about directories in KiFS. Can be used to show a single directory, or all directories.

Input Parameter Description

string

The KiFS directory name to show. If empty, shows all directories.The default value is ”.

map of string to strings

Optional parameters.The default value is an empty map ( {} ).

Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

String

‘OK’ or ‘ERROR’

String

Empty if success or an error message

String

‘show_directories_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

This embedded JSON represents the result of the /show/directories endpoint:

Show data_str

array of strings

KiFS directory names.

array of strings

User that created each directory for the respective directories in output parameter directories.

array of longs

The creation time for each directory in milliseconds since epoch, for the respective directories in output parameter directories.

array of longs

The data usage each directory in bytes, for the respective directories in output parameter directories.

array of longs

The data limit for each directory in bytes, for the respective directories in output parameter directories.

array of strings

Highest level of permission the calling user has for the respective directories in output parameter directories. Will be empty if no permissions. If a user has been granted both read and write permissions, ‘directory_write’ will be listed.

map of string to strings

Additional information.

Empty string in case of an error.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description