API Reference

Vast API Gatekeeper

Resources & Endpoints

Create a volume

Creates a volume for given options.

POST
https://localhost:8080/v1/volumes

If successful, this endpoint will return a 201 Created status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

id Required

The unique alphanumeric ID of the volume.

 VolumeId None

allowed_hosts

Array of IPv4 addresses which are allowed to access the volume.

 IPv4Address Array []

size_limit

Hard size limit for volume in bytes.

 Integer 5000000000000

inode_limit

Hard limit for number of inodes volume can use.

 Integer 100000000

posix_acl

Should volume use POSIX ACL permissions?

 Boolean false

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_already_exists

A volume with specified ID already exists

 409 Conflict

Returned Object

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

{
    volume: Volume {
        id: VolumeId
        path: String?
        allowed_hosts: [ IPv4Address? ]
        posix_acl: Boolean?
        size_limit: Integer?
        inode_limit: Integer?
        used_bytes: Integer?
        used_inodes: Integer?
        quota_state: String?
    }
}