MAmachines
Volumes

List Volumes

Changed on

List all volumes associated with a specific app.

get/v1/apps/{app_name}/volumes

Request

  • Base URL
    https://api.machines.dev
  • URL
    https://api.machines.dev/v1/apps/{app_name}/volumes
  • Auth
    HTTP bearer

Path parameters

app_namestring required

Fly App Name

Query parameters

summaryboolean

Only return summary info about volumes (omit blocks, block size, etc)

cursorstring

Value of the fly-next-cursor response header from the previous page. Requires limit.

limitinteger

The number of volumes to fetch (must be between 1 and 1000). Providing a limit enables pagination. This limit is advisory; responses may be shorter, or even empty, even when more volumes remain.

Response

OK

attached_alloc_idstring
attached_machine_idstring
auto_backup_enabledboolean
block_sizeinteger
blocksinteger
blocks_availinteger
blocks_freeinteger
bytes_totalinteger
bytes_usedinteger
created_atstring
encryptedboolean
fstypestring
host_featuresstring[]
host_status'ok' | 'unknown' | 'unreachable'
idstring
namestring
regionstring
required_host_featuresstring[]
size_gbinteger
snapshot_retentioninteger
statestring
type'local' | 'cache'
zonestring

Changes

  • 4a82f51548c8Revision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

    • info

      added the non-success response with the status

  • b1988c8e4bd9Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status