Volumes

Retrieve available Volume offers

To be attached to an instance, volumes should be linked to the same CloudProvider and the same region as the Pod selected. Get all informations about Volumes into this section

Access this endpoint to explore available volume offers, which is crucial when planning storage needs for your instances.

GET/gpu-cloud/volumes/offers

Header parameters

Response

200403404

Return all available volume offers

Body

application/json

cloudProvider*CloudProviderResponse (object)

minSizeInGb*number

Example: 10

pricePerGbPerHour*string

Example: "0.0001"

regions*array of array

Request

JavaScriptCurlPython

const response = await fetch('/gpu-cloud/volumes/offers', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200403404

[
  {
    "cloudProvider": {
      "_id": "668f9d8df664e3c028ce5de9",
      "displayName": "SESTERCE_IMW"
    },
    "minSizeInGb": 10,
    "pricePerGbPerHour": "0.0001",
    "regions": [
      "us-east-1",
      "us-east-2"
    ]
  }
]

Create a new Volume

This endpoint is used when you need to create new Volume to add a persistent storage solution to your instance, ensuring to keep your dataset stored even after the instance stops.

POST/gpu-cloud/volumes

Header parameters

Body

application/json

cloudProvider*string

Example: "668f9d8df664e3c028ce5de9"

region*string

Example: "us-east-1"

name*string

Example: "my-volume"

sizeInGb*number

Example: 10

Response

201403404

Return the created volume

Body

application/json

_id*string

Example: "668f9d8df664e3c028ce5de9"

user*string

Example: "668f9d8df664e3c028ce5de9"

name*string

Example: "my-volume"

sizeInGb*number

Example: 10

cloudProvider*CloudProviderResponse (object)

region*string

Example: "us-east-1"

createdAt*string

Example: "2023-08-08T12:34:56.789Z"

updatedAt*string

Example: "2023-08-08T12:34:56.789Z"

Request

JavaScriptCurlPython

const response = await fetch('/gpu-cloud/volumes', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cloudProvider": "668f9d8df664e3c028ce5de9",
      "region": "us-east-1",
      "name": "my-volume",
      "sizeInGb": 10
    }),
});
const data = await response.json();

Response

201403404

{
  "_id": "668f9d8df664e3c028ce5de9",
  "user": "668f9d8df664e3c028ce5de9",
  "name": "my-volume",
  "sizeInGb": 10,
  "cloudProvider": {
    "_id": "668f9d8df664e3c028ce5de9",
    "displayName": "SESTERCE_IMW"
  },
  "region": "us-east-1",
  "createdAt": "2023-08-08T12:34:56.789Z",
  "updatedAt": "2023-08-08T12:34:56.789Z"
}

Get the list of Volumes created

Use this endpoint to get an overview of your active volumes, useful for monitoring storage usage and planning expansions.

GET/gpu-cloud/volumes

Header parameters

Response

200403404

Return all volumes

Body

application/json

_id*string

Example: "668f9d8df664e3c028ce5de9"

user*string

Example: "668f9d8df664e3c028ce5de9"

name*string

Example: "my-volume"

sizeInGb*number

Example: 10

cloudProvider*CloudProviderResponse (object)

region*string

Example: "us-east-1"

createdAt*string

Example: "2023-08-08T12:34:56.789Z"

updatedAt*string

Example: "2023-08-08T12:34:56.789Z"

Request

JavaScriptCurlPython

const response = await fetch('/gpu-cloud/volumes', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200403404

[
  {
    "_id": "668f9d8df664e3c028ce5de9",
    "user": "668f9d8df664e3c028ce5de9",
    "name": "my-volume",
    "sizeInGb": 10,
    "cloudProvider": {
      "_id": "668f9d8df664e3c028ce5de9",
      "displayName": "SESTERCE_IMW"
    },
    "region": "us-east-1",
    "createdAt": "2023-08-08T12:34:56.789Z",
    "updatedAt": "2023-08-08T12:34:56.789Z"
  }
]

Get details of a specific Volume

Get specific details about a particular volume when you need to verify its configuration or status.

GET/gpu-cloud/volumes/{id}

Path parameters

id*string

Header parameters

Response

200403404

Return volume by ID

Body

application/json

_id*string

Example: "668f9d8df664e3c028ce5de9"

user*string

Example: "668f9d8df664e3c028ce5de9"

name*string

Example: "my-volume"

sizeInGb*number

Example: 10

cloudProvider*CloudProviderResponse (object)

region*string

Example: "us-east-1"

createdAt*string

Example: "2023-08-08T12:34:56.789Z"

updatedAt*string

Example: "2023-08-08T12:34:56.789Z"

Request

JavaScriptCurlPython

const response = await fetch('/gpu-cloud/volumes/{id}', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200403404

{
  "_id": "668f9d8df664e3c028ce5de9",
  "user": "668f9d8df664e3c028ce5de9",
  "name": "my-volume",
  "sizeInGb": 10,
  "cloudProvider": {
    "_id": "668f9d8df664e3c028ce5de9",
    "displayName": "SESTERCE_IMW"
  },
  "region": "us-east-1",
  "createdAt": "2023-08-08T12:34:56.789Z",
  "updatedAt": "2023-08-08T12:34:56.789Z"
}

Delete a Volume

Use this endpoint to delete volumes that are no longer needed, optimizing storage usage and reducing costs.

Ensure data backup before deleting volumes to prevent data loss.

DELETE/gpu-cloud/volumes/{id}

Path parameters

id*string

Header parameters

Response

204403404

Volume deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('/gpu-cloud/volumes/{id}', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

403404

{
  "statusCode": 403,
  "timestamp": "2023-08-08T12:34:56.789Z",
  "path": "/gpu-cloud/volumes/:id",
  "message": "API key invalid"
}