\VolumesAPI

All URIs are relative to https://api.machines.dev/v1

Method	HTTP request	Description
CreateVolumeSnapshot	Post /apps/{app_name}/volumes/{volume_id}/snapshots	Create Snapshot
VolumeDelete	Delete /apps/{app_name}/volumes/{volume_id}	Destroy Volume
VolumesCreate	Post /apps/{app_name}/volumes	Create Volume
VolumesExtend	Put /apps/{app_name}/volumes/{volume_id}/extend	Extend Volume
VolumesGetById	Get /apps/{app_name}/volumes/{volume_id}	Get Volume
VolumesList	Get /apps/{app_name}/volumes	List Volumes
VolumesListSnapshots	Get /apps/{app_name}/volumes/{volume_id}/snapshots	List Snapshots
VolumesUpdate	Put /apps/{app_name}/volumes/{volume_id}	Update Volume

CreateVolumeSnapshot

CreateVolumeSnapshot(ctx, appName, volumeId).Execute()

Create Snapshot

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/OutboundSpade/FlyMachines"
)

func main() {
	appName := "appName_example" // string | Fly App Name
	volumeId := "volumeId_example" // string | Volume ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.VolumesAPI.CreateVolumeSnapshot(context.Background(), appName, volumeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VolumesAPI.CreateVolumeSnapshot``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appName	string	Fly App Name
volumeId	string	Volume ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateVolumeSnapshotRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumeDelete

Volume VolumeDelete(ctx, appName, volumeId).Execute()

Destroy Volume

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/OutboundSpade/FlyMachines"
)

func main() {
	appName := "appName_example" // string | Fly App Name
	volumeId := "volumeId_example" // string | Volume ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.VolumesAPI.VolumeDelete(context.Background(), appName, volumeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VolumesAPI.VolumeDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `VolumeDelete`: Volume
	fmt.Fprintf(os.Stdout, "Response from `VolumesAPI.VolumeDelete`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appName	string	Fly App Name
volumeId	string	Volume ID

Other Parameters

Other parameters are passed through a pointer to a apiVolumeDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Volume

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumesCreate

Volume VolumesCreate(ctx, appName).Request(request).Execute()

Create Volume

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/OutboundSpade/FlyMachines"
)

func main() {
	appName := "appName_example" // string | Fly App Name
	request := *openapiclient.NewCreateVolumeRequest() // CreateVolumeRequest | Request body

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.VolumesAPI.VolumesCreate(context.Background(), appName).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VolumesAPI.VolumesCreate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `VolumesCreate`: Volume
	fmt.Fprintf(os.Stdout, "Response from `VolumesAPI.VolumesCreate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appName	string	Fly App Name

Other Parameters

Other parameters are passed through a pointer to a apiVolumesCreateRequest struct via the builder pattern

Name	Type	Description	Notes

request | CreateVolumeRequest | Request body |

Return type

Volume

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumesExtend

ExtendVolumeResponse VolumesExtend(ctx, appName, volumeId).Request(request).Execute()

Extend Volume

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/OutboundSpade/FlyMachines"
)

func main() {
	appName := "appName_example" // string | Fly App Name
	volumeId := "volumeId_example" // string | Volume ID
	request := *openapiclient.NewExtendVolumeRequest() // ExtendVolumeRequest | Request body

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.VolumesAPI.VolumesExtend(context.Background(), appName, volumeId).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VolumesAPI.VolumesExtend``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `VolumesExtend`: ExtendVolumeResponse
	fmt.Fprintf(os.Stdout, "Response from `VolumesAPI.VolumesExtend`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appName	string	Fly App Name
volumeId	string	Volume ID

Other Parameters

Other parameters are passed through a pointer to a apiVolumesExtendRequest struct via the builder pattern

Name	Type	Description	Notes

request | ExtendVolumeRequest | Request body |

Return type

ExtendVolumeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumesGetById

Volume VolumesGetById(ctx, appName, volumeId).Execute()

Get Volume

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/OutboundSpade/FlyMachines"
)

func main() {
	appName := "appName_example" // string | Fly App Name
	volumeId := "volumeId_example" // string | Volume ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.VolumesAPI.VolumesGetById(context.Background(), appName, volumeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VolumesAPI.VolumesGetById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `VolumesGetById`: Volume
	fmt.Fprintf(os.Stdout, "Response from `VolumesAPI.VolumesGetById`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appName	string	Fly App Name
volumeId	string	Volume ID

Other Parameters

Other parameters are passed through a pointer to a apiVolumesGetByIdRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Volume

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumesList

[]Volume VolumesList(ctx, appName).Summary(summary).Execute()

List Volumes

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/OutboundSpade/FlyMachines"
)

func main() {
	appName := "appName_example" // string | Fly App Name
	summary := true // bool | Only return summary info about volumes (omit blocks, block size, etc) (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.VolumesAPI.VolumesList(context.Background(), appName).Summary(summary).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VolumesAPI.VolumesList``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `VolumesList`: []Volume
	fmt.Fprintf(os.Stdout, "Response from `VolumesAPI.VolumesList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appName	string	Fly App Name

Other Parameters

Other parameters are passed through a pointer to a apiVolumesListRequest struct via the builder pattern

Name	Type	Description	Notes

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

Return type

[]Volume

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumesListSnapshots

[]VolumeSnapshot VolumesListSnapshots(ctx, appName, volumeId).Execute()

List Snapshots

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/OutboundSpade/FlyMachines"
)

func main() {
	appName := "appName_example" // string | Fly App Name
	volumeId := "volumeId_example" // string | Volume ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.VolumesAPI.VolumesListSnapshots(context.Background(), appName, volumeId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VolumesAPI.VolumesListSnapshots``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `VolumesListSnapshots`: []VolumeSnapshot
	fmt.Fprintf(os.Stdout, "Response from `VolumesAPI.VolumesListSnapshots`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appName	string	Fly App Name
volumeId	string	Volume ID

Other Parameters

Other parameters are passed through a pointer to a apiVolumesListSnapshotsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]VolumeSnapshot

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VolumesUpdate

Volume VolumesUpdate(ctx, appName, volumeId).Request(request).Execute()

Update Volume

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/OutboundSpade/FlyMachines"
)

func main() {
	appName := "appName_example" // string | Fly App Name
	volumeId := "volumeId_example" // string | Volume ID
	request := *openapiclient.NewUpdateVolumeRequest() // UpdateVolumeRequest | Request body

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.VolumesAPI.VolumesUpdate(context.Background(), appName, volumeId).Request(request).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `VolumesAPI.VolumesUpdate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `VolumesUpdate`: Volume
	fmt.Fprintf(os.Stdout, "Response from `VolumesAPI.VolumesUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appName	string	Fly App Name
volumeId	string	Volume ID

Other Parameters

Other parameters are passed through a pointer to a apiVolumesUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

request | UpdateVolumeRequest | Request body |

Return type

Volume

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Collapse file tree

Files

VolumesAPI.md

Latest commit

History

VolumesAPI.md

File metadata and controls

\VolumesAPI

CreateVolumeSnapshot

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

VolumeDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

VolumesCreate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

VolumesExtend

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

VolumesGetById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

VolumesList

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

VolumesListSnapshots

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

VolumesUpdate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers