API Reference

Vast API Gatekeeper

Resources & Endpoints

Create a volume

Creates a volume with given attributes.

POST
https://localhost:8080/v2/vast/{backend}/volumes

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

backend Required

Backend Lookup None

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

backend_connection_failed

Request to backend API failed to establish a connection

 504 Gateway Timeout

backend_error

Received an unexpected response from backend API

 500 Internal Server Error

backend_not_found

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

 404 Not Found

backend_timeout

Request to backend 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?
    }
}