URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/create/directory

Creates a new directory in KiFS. The new directory serves as a location in which the user can upload files using /upload/files.

Input Parameter Description

Name Type Description
directory_name string Name of the directory in KiFS to be created.
options map of string to strings

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

Supported Parameters (keys) Parameter Description
create_home_directory When set, a home directory is created for the user name provided in the value. The input parameter directory_name must be an empty string in this case. The user must exist.
data_limit The maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.

If true, does not return an error if the directory already exists The default value is false. The supported values are:

  • true
  • false

Output Parameter Description

The GPUdb 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:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'create_directory_response' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /create/directory endpoint:

Name Type Description
directory_name string Value of input parameter directory_name.
info map of string to strings Additional information.

Empty string in case of an error.