Get

/capacity/

This endpoint queries a tenant for capacity details for a path on the tenant and its direct child paths.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Query parameters

path

string

Specifies a path. The query response includes details of the specified path and its direct child paths. By default, this is the root path.

type

string

Selects which capacity type is returned as sort_key in the response. Default: usable.

Valid values[ "usable", "logical", "unique" ]

tenant_id

integer

Specifies for which tenant to return a response. By default, this is the default tenant.

Responses

200

Capacity details of a path and its children

object

details

Array of array

An array of tuples representing path capacity breakdown. Each item is an array containing exactly two elements: Element [0] is the path (string), and Element [1] is the capacity metrics details object (see PathCapacityDetails definition).

Array

keys

Array of string

Keys available for data sorting

string

root_data

Array of integer

The amount of capacity used by the directory according to three capacity types: usable, unique, and logical, returned in that order.

integer (int64)

small_folders

Array of array

Details of small folders. Structured as an array of tuples: [path_string, PathCapacityDetails_object].

Array

sort_key

string

Key used for data sorting

time

string

Request timestamp

Query a Tenant for Capacity Details