API Reference

Vast API Gatekeeper

Resources & Endpoints

Get list of volumes

Return used storage information for all volumes.

GET
https://aker.infra.katapult.io/v1/volumes

If successful, this endpoint will return a 200 OK status.

Potential Errors

The following errors may occur during this request.

Details HTTP status

vast_error

Received an unexpected response from VAST API

 500 Internal Server Error

vast_timeout

Request to Vast API timed out

 504 Gateway Timeout

volume_not_found

No volume was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    volumes: [ Volume {
        id: VolumeId
        path: String?
        allowed_hosts: [ IPv4Address? ]
        posix_acl: Boolean?
        size_limit: Integer?
        inode_limit: Integer?
    } ]
}