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

Header parameters

x-api-keystringRequired

The API Key secret should be sent through this header to authenticate the request.

Responses

200

Return all available volume offers

application/json

minSizeInGbnumberRequiredExample: 10

pricePerGbPerHourstringRequiredExample: 0.0001

403

API key invalid

application/json

404

API key not found

application/json

get/gpu-cloud/volumes/offers

GET /gpu-cloud/volumes/offers HTTP/1.1
x-api-key: text
Accept: */*

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

Header parameters

x-api-keystringRequired

The API Key secret should be sent through this header to authenticate the request.

Body

cloudProviderstringRequiredExample: 668f9d8df664e3c028ce5de9

regionstringRequiredExample: us-east-1

namestringRequiredExample: my-volume

sizeInGbnumberRequiredExample: 10

Responses

201

Return the created volume

application/json

_idstringRequiredExample: 668f9d8df664e3c028ce5de9

userstringRequiredExample: 668f9d8df664e3c028ce5de9

namestringRequiredExample: my-volume

sizeInGbnumberRequiredExample: 10

regionstringRequiredExample: us-east-1

createdAtstringRequiredExample: 2023-08-08T12:34:56.789Z

updatedAtstringRequiredExample: 2023-08-08T12:34:56.789Z

403

API key invalid

application/json

404

API key not found

application/json

post/gpu-cloud/volumes

POST /gpu-cloud/volumes HTTP/1.1
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "cloudProvider": "668f9d8df664e3c028ce5de9",
  "region": "us-east-1",
  "name": "my-volume",
  "sizeInGb": 10
}

{
  "_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

Header parameters

x-api-keystringRequired

The API Key secret should be sent through this header to authenticate the request.

Responses

200

Return all volumes

application/json

_idstringRequiredExample: 668f9d8df664e3c028ce5de9

userstringRequiredExample: 668f9d8df664e3c028ce5de9

namestringRequiredExample: my-volume

sizeInGbnumberRequiredExample: 10

regionstringRequiredExample: us-east-1

createdAtstringRequiredExample: 2023-08-08T12:34:56.789Z

updatedAtstringRequiredExample: 2023-08-08T12:34:56.789Z

403

API key invalid

application/json

404

API key not found

application/json

get/gpu-cloud/volumes

GET /gpu-cloud/volumes HTTP/1.1
x-api-key: text
Accept: */*

[
  {
    "_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

Path parameters

idstringRequired

Header parameters

x-api-keystringRequired

The API Key secret should be sent through this header to authenticate the request.

Responses

200

Return volume by ID

application/json

_idstringRequiredExample: 668f9d8df664e3c028ce5de9

userstringRequiredExample: 668f9d8df664e3c028ce5de9

namestringRequiredExample: my-volume

sizeInGbnumberRequiredExample: 10

regionstringRequiredExample: us-east-1

createdAtstringRequiredExample: 2023-08-08T12:34:56.789Z

updatedAtstringRequiredExample: 2023-08-08T12:34:56.789Z

403

API key invalid

application/json

404

Not found

application/json

get/gpu-cloud/volumes/{id}

GET /gpu-cloud/volumes/{id} HTTP/1.1
x-api-key: text
Accept: */*

{
  "_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

Path parameters

idstringRequired

Header parameters

x-api-keystringRequired

The API Key secret should be sent through this header to authenticate the request.

Responses

204

Volume deleted successfully

No content

403

API key invalid

application/json

404

Not found

application/json

delete/gpu-cloud/volumes/{id}

DELETE /gpu-cloud/volumes/{id} HTTP/1.1
x-api-key: text
Accept: */*

No content