Volumes

Get Volumes

get

Get all storage volumes for a project

Authorizations
Query parameters
projectstringRequired
regionstring | nullableOptionalExample: us-central1-a
Responses
200
Successful Response
application/json
get
GET /v2/volumes HTTP/1.1
Host: api.mlfoundry.com
Authorization: Bearer fkey_<key>
Accept: */*

[
  {
    "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"
    ]
  }
]

Create Volume

post

Create a new storage volume.

Authorizations
Body
namestring · max: 64RequiredPattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
projectstringRequiredExample: proj_abc123456
disk_interfacestring · enumRequiredPossible values:
regionstringRequiredExample: us-central1-a
size_gbintegerRequired
Responses
201
Successful Response
application/json
post
POST /v2/volumes HTTP/1.1
Host: api.mlfoundry.com
Authorization: Bearer fkey_<key>
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "name": "text",
  "project": "proj_abc123456",
  "disk_interface": "Block",
  "region": "us-central1-a",
  "size_gb": 1
}
{
  "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"
  ]
}

Delete Volume

delete

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.

Authorizations
Path parameters
volume_fidstringRequiredExample: vol_abc123456
Responses
204
Successful Response
delete
DELETE /v2/volumes/{volume_fid} HTTP/1.1
Host: api.mlfoundry.com
Authorization: Bearer fkey_<key>
Accept: */*

No content
PreviousSSH KeysNextInstances