Volumes | Foundry Documentation

Get Volumes

Get all storage volumes for a project

get

/v2/volumes

Authorizations

Query parameters

projectstringrequired

regionstring | nullable

Example: us-central1-a

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.mlfoundry.com/v2/volumes?project=text' \
  --header 'Authorization: Bearer fkey_<key>'

200

422

[
  {
    "fid": "vol_abc123456",
    "name": "text",
    "region": "us-central1-a",
    "created_at": "2024-01-01T00:00:00Z",
    "capacity_gb": 2000,
    "project": "proj_abc123456",
    "interface": "Block",
    "bids": [
      "bid_abc123456"
    ],
    "reservations": [
      "res_abc123456"
    ]
  }
]

Successful Response

Create Volume

Create a new storage volume.

post

/v2/volumes

Authorizations

Body

namestring · max: 64required

Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$

projectstringrequired

Example: proj_abc123456

disk_interfacestring · enumrequired

Options: Block, File

regionstringrequired

Example: us-central1-a

size_gbintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.mlfoundry.com/v2/volumes' \
  --header 'Authorization: Bearer fkey_<key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "project": "proj_abc123456",
    "disk_interface": "Block",
    "region": "us-central1-a",
    "size_gb": 1
  }'

201

422

{
  "fid": "vol_abc123456",
  "name": "text",
  "region": "us-central1-a",
  "created_at": "2024-01-01T00:00:00Z",
  "capacity_gb": 2000,
  "project": "proj_abc123456",
  "interface": "Block",
  "bids": [
    "bid_abc123456"
  ],
  "reservations": [
    "res_abc123456"
  ]
}

Successful Response

Delete Volume

Delete a storage volume. Note that this will immediately delete the volume and make it irretrievable. This can only be done if the volume is not in use.

delete

/v2/volumes/{volume_fid}

Authorizations

Path parameters

volume_fidstringrequired

Example: vol_abc123456

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.mlfoundry.com/v2/volumes/{volume_fid}' \
  --header 'Authorization: Bearer fkey_<key>'

204

422

No body

Successful Response