/space

Get the total and available space for the filesystem, drives or partitions (logical or physical) that host one or more queried paths. This endpoint should not be used for cloud storage.

Requirements
  • Available as of Enterprise Server version 3.6.0.
Access Control
  • HTTP Basic Auth
    Provide Node API credentials or an access key ID and secret.
URL
POST https://{domain}:9092/space

Sample Request
curl -i -u user:secret -X POST https://{domain}:9092/space \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -d @request_body.json

Where request_body.json contains the following:
{
    "paths" : [
        {
            "path" : "path1"
        },
            "path" : "path2"
        }
    ]
}

Headers
Header Name Required Description Values
Content-Type Optional The format of the request data. application/json
Accept Optional The format of the response data. application/json
Request Body
Element Required Type Description
paths Required JSON An array of paths.
path Required String The path name. Space information is returned for the mount point of the path.
Sample Response
HTTP/1.1 200 OK
Cache: no-cache
Connection: close
Content-Type: application/json; charset=utf-8

{
    "paths" : [
        {
            "path" : "/Users/aspera",
            "bytes_total" : 500068036608,
            "bytes_free" : 453562322944,
            "percent_free" : 90.70
        }
    ]
}

Status Codes and Errors
Code Description Notes
200 OK Success
400 Bad Request Error Request contains a formatting or syntax error.
500 Internal Server Error Error The server configuration is invalid.
Response
Element Type Description
paths JSON Array of space information for the queried paths.
path String The path name that was queried.
bytes_total Unsigned integer The total space in bytes of the mount point of the path.
bytes_free Unsigned integer The free space in bytes of the mount point of the path.
percent_free Float The percentage of the total space that is available.
Video player

Video

×