Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

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.

{
    "required":[
        "Quota"
    ],
    "type":"object",
    "properties":{
        "defaultUserHomeRights":{
            "type":"array",
            "description":"Assigned rights to a user's default home folder (/home/users/{user}",
            "items":{
                "type":"string",
                "description":"Assigned rights to a user's default home folder (/home/users/{user}",
                "enum":[
                    "read",
                    "write",
                    "list",
                    "delete",
                    "createDir",
                    "deleteDir",
                    "renameDir",
                    "propagateRightsToSubfolders",
                    "all"
                ]
            },
            "enum":[
                "read",
                "write",
                "list",
                "delete",
                "createDir",
                "deleteDir",
                "renameDir",
                "propagateRightsToSubfolders",
                "all"
            ]
        },
        "defaultGroupHomeRights":{
            "type":"array",
            "description":"Assigned rights to a group's default home folder (/home/groups/{group}",
            "items":{
                "type":"string",
                "description":"Assigned rights to a group's default home folder (/home/groups/{group}",
                "enum":[
                    "read",
                    "write",
                    "list",
                    "delete",
                    "createDir",
                    "deleteDir",
                    "renameDir",
                    "propagateRightsToSubfolders",
                    "all"
                ]
            },
            "enum":[
                "read",
                "write",
                "list",
                "delete",
                "createDir",
                "deleteDir",
                "renameDir",
                "propagateRightsToSubfolders",
                "all"
            ]
        },
        "Quota":{
            "$ref":"#/components/schemas/Quota"
        }
    },
    "description":"Describes a file system configuration",
    "xml":{
        "name":"fileserverConfig"
    }
}

Nested Schema : defaultGroupHomeRights

Type: array

Assigned rights to a group's default home folder (/home/groups/{group}

Allowed Values: [ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ]

Show Source

• 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}

{
    "type":"array",
    "description":"Assigned rights to a group's default home folder (/home/groups/{group}",
    "items":{
        "type":"string",
        "description":"Assigned rights to a group's default home folder (/home/groups/{group}",
        "enum":[
            "read",
            "write",
            "list",
            "delete",
            "createDir",
            "deleteDir",
            "renameDir",
            "propagateRightsToSubfolders",
            "all"
        ]
    },
    "enum":[
        "read",
        "write",
        "list",
        "delete",
        "createDir",
        "deleteDir",
        "renameDir",
        "propagateRightsToSubfolders",
        "all"
    ]
}

Nested Schema : defaultUserHomeRights

Type: array

Assigned rights to a user's default home folder (/home/users/{user}

Allowed Values: [ "read", "write", "list", "delete", "createDir", "deleteDir", "renameDir", "propagateRightsToSubfolders", "all" ]

Show Source

• 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}

{
    "type":"array",
    "description":"Assigned rights to a user's default home folder (/home/users/{user}",
    "items":{
        "type":"string",
        "description":"Assigned rights to a user's default home folder (/home/users/{user}",
        "enum":[
            "read",
            "write",
            "list",
            "delete",
            "createDir",
            "deleteDir",
            "renameDir",
            "propagateRightsToSubfolders",
            "all"
        ]
    },
    "enum":[
        "read",
        "write",
        "list",
        "delete",
        "createDir",
        "deleteDir",
        "renameDir",
        "propagateRightsToSubfolders",
        "all"
    ]
}

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.

{
    "required":[
        "available",
        "size",
        "used"
    ],
    "type":"object",
    "properties":{
        "cutoffQuota":{
            "type":"number",
            "description":"Defines a max threshold percentage, above which no further uploads are allowed until files are removed."
        },
        "warningQuota":{
            "type":"number",
            "description":"Defines a warning threshold percentage, indicating that system is nearing its max threshold."
        },
        "used":{
            "type":"string",
            "description":"Current usage",
            "readOnly":true
        },
        "usedPercentage":{
            "type":"number",
            "description":"Current usage ",
            "readOnly":true
        },
        "size":{
            "type":"string",
            "description":"Max allocated size of the file system",
            "readOnly":true
        },
        "available":{
            "type":"string",
            "description":"Available storage",
            "readOnly":true
        },
        "exceededWarningQuota":{
            "type":"boolean",
            "readOnly":true
        },
        "exceededCutoffQuota":{
            "type":"boolean",
            "readOnly":true
        }
    },
    "description":"Provides the overall storage usage and thresholds."
}

401 Response

Unauthorized

404 Response

Services not found

500 Response

Internal Server Error

Back to Top