API Reference

Vast API Gatekeeper

Resources & Endpoints

Get volume info

Return information about a volume.

GET
https://aker.infra.katapult.io/v2/intelliflash/{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

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_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.

{
    volume: Volume {
        id: VolumeId
        path: String?
        allowed_hosts: [ IPv4Address? ]
        size_limit: Integer?
        used_bytes: Integer?
    }
}