API Reference

Vast API Gatekeeper

Resources & Endpoints

Update or create a volume

Update or create the specified valume.

PUT
https://localhost:8080/v2/vast/{backend}/volumes/{volume}

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

backend Required

Backend Lookup None

volume Required

Volume Lookup None

allowed_hosts Required

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

 IPv4Address Array None

size_limit Required

Hard size limit for volume in bytes.

 Integer None

inode_limit Required

Hard limit for number of inodes volume can use.

 Integer None

posix_acl Required

Should volume use POSIX ACL permissions?

 Boolean None

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

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?
    }
}