FlyMachineClient.Volumes (fly_machine_client v0.1.0)

API client for managing Fly.io volumes.

Summary

Functions

Create a volume for a specific app.

Create a snapshot for a specific volume within an app.

Delete a specific volume within an app by volume ID.

Extend a volume's size within an app.

Get details about a specific volume by its ID within an app.

List all volumes associated with a specific app.

List all snapshots for a specific volume within an app.

Update a volume's configuration.

Functions

create(app_name, params, opts \\ [])

@spec create(app_name :: String.t(), params :: map(), FlyMachineClient.options()) ::
  FlyMachineClient.response()

Create a volume for a specific app.

create_snapshot(app_name, volume_id, opts \\ [])

@spec create_snapshot(
  app_name :: String.t(),
  volume_id :: String.t(),
  FlyMachineClient.options()
) :: FlyMachineClient.response()

Create a snapshot for a specific volume within an app.

delete(app_name, volume_id, opts \\ [])

@spec delete(
  app_name :: String.t(),
  volume_id :: String.t(),
  FlyMachineClient.options()
) ::
  FlyMachineClient.response()

Delete a specific volume within an app by volume ID.

extend(app_name, volume_id, size_gb, opts \\ [])

@spec extend(
  app_name :: String.t(),
  volume_id :: String.t(),
  size_gb :: integer(),
  FlyMachineClient.options()
) :: FlyMachineClient.response()

Extend a volume's size within an app.

get(app_name, volume_id, opts \\ [])

@spec get(app_name :: String.t(), volume_id :: String.t(), FlyMachineClient.options()) ::
  FlyMachineClient.response()

Get details about a specific volume by its ID within an app.

list(app_name, opts \\ [], client_opts \\ [])

@spec list(app_name :: String.t(), opts :: keyword(), FlyMachineClient.options()) ::
  FlyMachineClient.response()

List all volumes associated with a specific app.

list_snapshots(app_name, volume_id, opts \\ [])

@spec list_snapshots(
  app_name :: String.t(),
  volume_id :: String.t(),
  FlyMachineClient.options()
) :: FlyMachineClient.response()

List all snapshots for a specific volume within an app.

update(app_name, volume_id, params, opts \\ [])

@spec update(
  app_name :: String.t(),
  volume_id :: String.t(),
  params :: map(),
  FlyMachineClient.options()
) :: FlyMachineClient.response()

Update a volume's configuration.