fly-io Volumes API
Operations for managing persistent storage volumes that can be attached to Fly Machines. Volumes provide durable block storage that persists across Machine restarts.
fly-io Volumes API is one of 9 APIs that fly-io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Volumes. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 8 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against 2 base URLs: https://{provider_base_url}, https://api.fly.io.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
fly-io Volumes API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (flySharedSecret).
It accepts HTTP bearer tokens (oauthBearerAuth).
An API key is passed in the header as X-Fly-Signature (webhookHmac).
By default, every request must be authenticated.
flySharedSecret— Shared secret provided by Fly.io to the extension provider. Fly.io includes this secret in an Authorization Bearer header on all requests to the provider's API…oauthBearerAuth— Fly.io OAuth access token obtained from the token exchange endpoint.webhookHmac— HMAC-SHA256 signature of the raw request body, computed using the webhook signing secret. Recipients must verify this signature before processing the payload.
Paths & Operations 8
Across 4 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Operations for managing persistent storage volumes that can be attached to Fly Machines. Volumes provide durable block storage that persists across Machine restarts.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Volume (12 properties), CreateVolumeRequest (7 properties), VolumeSnapshot (5 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from fly-io 8
Other APIs fly-io publishes across the network.