Get file system configuration
get
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/configuration
Rest API to file system configuration
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Root Schema : fileserverConfig
Type:
object
Describes a file system configuration
Show Source
-
defaultGroupHomeRights: array
defaultGroupHomeRights
Assigned rights to a group's default home folder (/home/groups/{group}
-
defaultUserHomeRights: array
defaultUserHomeRights
Assigned rights to a user's default home folder (/home/users/{user}
-
Quota(required): object
Quota
Provides the overall storage usage and thresholds.
Nested Schema : defaultGroupHomeRights
Type:
array
Assigned rights to a group's default home folder (/home/groups/{group}
Allowed Values:
Show Source
[
"read",
"write",
"list",
"delete",
"createDir",
"deleteDir",
"renameDir",
"propagateRightsToSubfolders",
"all"
]
-
Array of:
string
Allowed Values:
[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ]
Assigned rights to a group's default home folder (/home/groups/{group}
Nested Schema : defaultUserHomeRights
Type:
array
Assigned rights to a user's default home folder (/home/users/{user}
Allowed Values:
Show Source
[
"read",
"write",
"list",
"delete",
"createDir",
"deleteDir",
"renameDir",
"propagateRightsToSubfolders",
"all"
]
-
Array of:
string
Allowed Values:
[ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ]
Assigned rights to a user's default home folder (/home/users/{user}
Nested Schema : Quota
Type:
object
Provides the overall storage usage and thresholds.
Show Source
-
available(required): string
Read Only:
true
Available storage -
cutoffQuota: number
Defines a max threshold percentage, above which no further uploads are allowed until files are removed.
-
exceededCutoffQuota: boolean
Read Only:
true
-
exceededWarningQuota: boolean
Read Only:
true
-
size(required): string
Read Only:
true
Max allocated size of the file system -
used(required): string
Read Only:
true
Current usage -
usedPercentage: number
Read Only:
true
Current usage -
warningQuota: number
Defines a warning threshold percentage, indicating that system is nearing its max threshold.
401 Response
Unauthorized
404 Response
Services not found
500 Response
Internal Server Error