Cell API · Dashboard
Volumes & GPU
Create and grow persistent volumes, inspect GPU offers, and operate GPU instances.
Base URL: https://api.hubfly.space. Use a Dashboard bearer token authorized for the project. Replace :projectId in each path with the Dashboard project ID. JSON routes use Content-Type: application/json.
How to use these endpoints
- Create a volume for persistent container data or inspect GPU offers for accelerated workloads.
- Attach and configure resources through the matching container or GPU operation.
- Read resource state and billing details after a change; resize volumes upward only.
Read a volume
curl "https://api.hubfly.space/api/v1/projects/$PROJECT_ID/volumes/$VOLUME_ID" \
-H "Authorization: Bearer $HUBFLY_TOKEN"The response uses the standard Dashboard envelope: ok, data, and meta on success. On failure, use the returned error code and message to decide whether to correct the request or retry. The exact schema and response codes for each operation are below.
Endpoint reference
Dashboard endpoints (19)
These JSON routes are served by the Hubfly space Dashboard API and use Dashboard project authorization.
GETGet GPU wallet and instance summaryDetails +/api/v1/projects/:projectId/gpu
Returns a combined panel for a project's GPU usage: the caller's GPU wallet balance summary alongside a list of all GPU instances visible in the project.
- Requires the caller to have access to the project.
- No special permission beyond project membership is required to view.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "projectId": { "type": "string" }, "wallet": { "type": "object", "properties": { "balanceUsd": { "type": "number" }, "hasVastApiKey": { "type": "boolean" }, "pendingTransfers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "amountUsd": { "type": "number" }, "createdAt": { "type": "string", "description": "Date string" }, "status": { "type": "string", "enum": [ "failed", "succeeded", "pending_approval" ] } }, "required": [ "id", "amountUsd", "createdAt", "status" ], "additionalProperties": false } } }, "required": [ "balanceUsd", "hasVastApiKey", "pendingTransfers" ], "additionalProperties": false }, "instances": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "ownerUserId": { "type": "string" }, "ownerName": { "type": "string", "nullable": true }, "manageable": { "type": "boolean" }, "provider": { "const": "vast", "type": "string" }, "providerInstanceId": { "type": "string" }, "providerOfferId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "deleted", "provisioning", "unknown", "stopped", "paused", "running", "error", "deleting", "starting", "stopping", "syncing" ] }, "configuration": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "resources": { "type": "object", "properties": { "gpuName": { "type": "string" }, "gpuCount": { "type": "number" }, "cpuCores": { "type": "number" }, "ramGb": { "type": "number" }, "diskGb": { "type": "number" }, "diskUsedGb": { "type": "number" } }, "required": [ "gpuName", "gpuCount", "cpuCores", "ramGb", "diskGb", "diskUsedGb" ], "additionalProperties": false }, "networking": { "type": "object", "properties": { "publicIp": { "type": "string", "nullable": true }, "publicPort": { "type": "number", "nullable": true }, "sshHost": { "type": "string", "nullable": true }, "sshPort": { "type": "number", "nullable": true }, "ports": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "jupyterToken": { "type": "string", "nullable": true }, "jupyterHostPort": { "type": "number", "nullable": true }, "jupyterUrl": { "type": "string", "nullable": true } }, "required": [ "publicIp", "publicPort", "sshHost", "sshPort", "ports", "jupyterToken", "jupyterHostPort", "jupyterUrl" ], "additionalProperties": false }, "providerHourlyPrice": { "type": "number" }, "markupMultiplier": { "type": "number" }, "billableHourlyPrice": { "type": "number" }, "currency": { "type": "string" }, "lastSyncedAt": { "type": "string", "description": "Date string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "projectId", "ownerUserId", "ownerName", "manageable", "provider", "providerInstanceId", "providerOfferId", "name", "status", "configuration", "resources", "networking", "providerHourlyPrice", "markupMultiplier", "billableHourlyPrice", "currency", "lastSyncedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "projectId", "wallet", "instances" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "projectId": "string", "wallet": { "balanceUsd": 0, "hasVastApiKey": true, "pendingTransfers": [ { "id": "string", "amountUsd": 0, "createdAt": "string", "status": "failed" } ] }, "instances": [ { "id": "string", "projectId": "string", "ownerUserId": "string", "ownerName": "string", "manageable": true, "provider": "string", "providerInstanceId": "string", "providerOfferId": "string", "name": "string", "status": "pending", "configuration": null, "resources": { "gpuName": "string", "gpuCount": 0, "cpuCores": 0, "ramGb": 0, "diskGb": 0, "diskUsedGb": 0 }, "networking": { "publicIp": "string", "publicPort": 0, "sshHost": "string", "sshPort": 0, "ports": null, "jupyterToken": "string", "jupyterHostPort": 0, "jupyterUrl": "string" }, "providerHourlyPrice": 0, "markupMultiplier": 0, "billableHourlyPrice": 0, "currency": "string", "lastSyncedAt": "string", "createdAt": "string", "updatedAt": "string" } ] }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTRent a GPU instance from a marketplace offerDetails +/api/v1/projects/:projectId/gpu/instances/create
Provisions a new GPU instance for the project by renting a specific marketplace offer using the selected template and disk size.
- Requires container:create permission on the project.
- The caller's GPU wallet must have a positive balance, or the request is rejected before renting begins.
- The requested disk size must not exceed the offer's maximum disk size.
- The resulting instance is bound to this project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
offerId | string | Yes |
templateHashId | string | Yes |
disk | number | Yes |
offerDiskGb | number | Yes |
name | string | No |
configuration | object | No |
Complete request schema
{
"type": "object",
"properties": {
"offerId": {
"type": "string"
},
"templateHashId": {
"type": "string"
},
"disk": {
"type": "number"
},
"offerDiskGb": {
"type": "number"
},
"name": {
"type": "string"
},
"configuration": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"const": false,
"type": "boolean"
},
{
"const": true,
"type": "boolean"
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"const": false,
"type": "boolean"
},
{
"const": true,
"type": "boolean"
}
],
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"const": false,
"type": "boolean"
},
{
"const": true,
"type": "boolean"
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"const": false,
"type": "boolean"
},
{
"const": true,
"type": "boolean"
}
],
"nullable": true
}
}
],
"nullable": true
}
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"const": false,
"type": "boolean"
},
{
"const": true,
"type": "boolean"
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"const": false,
"type": "boolean"
},
{
"const": true,
"type": "boolean"
}
],
"nullable": true
}
}
],
"nullable": true
}
}
}
],
"nullable": true
}
}
},
"required": [
"offerId",
"templateHashId",
"disk",
"offerDiskGb"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "ownerUserId": { "type": "string" }, "ownerName": { "type": "string", "nullable": true }, "manageable": { "type": "boolean" }, "provider": { "const": "vast", "type": "string" }, "providerInstanceId": { "type": "string" }, "providerOfferId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "deleted", "provisioning", "unknown", "stopped", "paused", "running", "error", "deleting", "starting", "stopping", "syncing" ] }, "configuration": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "resources": { "type": "object", "properties": { "gpuName": { "type": "string" }, "gpuCount": { "type": "number" }, "cpuCores": { "type": "number" }, "ramGb": { "type": "number" }, "diskGb": { "type": "number" }, "diskUsedGb": { "type": "number" } }, "required": [ "gpuName", "gpuCount", "cpuCores", "ramGb", "diskGb", "diskUsedGb" ], "additionalProperties": false }, "networking": { "type": "object", "properties": { "publicIp": { "type": "string", "nullable": true }, "publicPort": { "type": "number", "nullable": true }, "sshHost": { "type": "string", "nullable": true }, "sshPort": { "type": "number", "nullable": true }, "ports": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "jupyterToken": { "type": "string", "nullable": true }, "jupyterHostPort": { "type": "number", "nullable": true }, "jupyterUrl": { "type": "string", "nullable": true } }, "required": [ "publicIp", "publicPort", "sshHost", "sshPort", "ports", "jupyterToken", "jupyterHostPort", "jupyterUrl" ], "additionalProperties": false }, "providerHourlyPrice": { "type": "number" }, "markupMultiplier": { "type": "number" }, "billableHourlyPrice": { "type": "number" }, "currency": { "type": "string" }, "lastSyncedAt": { "type": "string", "description": "Date string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "projectId", "ownerUserId", "ownerName", "manageable", "provider", "providerInstanceId", "providerOfferId", "name", "status", "configuration", "resources", "networking", "providerHourlyPrice", "markupMultiplier", "billableHourlyPrice", "currency", "lastSyncedAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectId": "string", "ownerUserId": "string", "ownerName": "string", "manageable": true, "provider": "string", "providerInstanceId": "string", "providerOfferId": "string", "name": "string", "status": "pending", "configuration": null, "resources": { "gpuName": "string", "gpuCount": 0, "cpuCores": 0, "ramGb": 0, "diskGb": 0, "diskUsedGb": 0 }, "networking": { "publicIp": "string", "publicPort": 0, "sshHost": "string", "sshPort": 0, "ports": null, "jupyterToken": "string", "jupyterHostPort": 0, "jupyterUrl": "string" }, "providerHourlyPrice": 0, "markupMultiplier": 0, "billableHourlyPrice": 0, "currency": "string", "lastSyncedAt": "string", "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList hourly billing usage for a GPU instanceDetails +/api/v1/projects/:projectId/gpu/instances/:gpuInstanceId/billing
Returns up to the last 168 hourly billing usage entries (roughly one week) for a specific GPU instance, including usage quantity and cost per hour bucket.
- Requires general read access to the project.
- Returns a 404 if the GPU instance does not belong to the specified project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
gpuInstanceId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "eventType": { "const": "hourly", "type": "string" }, "totalCents": { "type": "number" }, "hours": { "type": "number" }, "startedAt": { "type": "string" }, "endedAt": { "type": "string" } }, "required": [ "id", "eventType", "totalCents", "hours", "startedAt", "endedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "id": "string", "eventType": "string", "totalCents": 0, "hours": 0, "startedAt": "string", "endedAt": "string" } ], "meta": { "requestId": "string", "timestamp": "string" } }
PUTRefresh a GPU instance's binding recordDetails +/api/v1/projects/:projectId/gpu/instances/:gpuInstanceId/binding
Returns the current state of a GPU instance's binding after verifying access.
- Requires container:update permission and ownership of the instance within the project.
- The requested binding scope value is currently accepted but not applied — the call re-fetches existing state rather than changing the binding.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
gpuInstanceId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
scope | project | global | Yes |
Complete request schema
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"project",
"global"
]
}
},
"required": [
"scope"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "ownerUserId": { "type": "string" }, "ownerName": { "type": "string", "nullable": true }, "manageable": { "type": "boolean" }, "provider": { "const": "vast", "type": "string" }, "providerInstanceId": { "type": "string" }, "providerOfferId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "deleted", "provisioning", "unknown", "stopped", "paused", "running", "error", "deleting", "starting", "stopping", "syncing" ] }, "configuration": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "resources": { "type": "object", "properties": { "gpuName": { "type": "string" }, "gpuCount": { "type": "number" }, "cpuCores": { "type": "number" }, "ramGb": { "type": "number" }, "diskGb": { "type": "number" }, "diskUsedGb": { "type": "number" } }, "required": [ "gpuName", "gpuCount", "cpuCores", "ramGb", "diskGb", "diskUsedGb" ], "additionalProperties": false }, "networking": { "type": "object", "properties": { "publicIp": { "type": "string", "nullable": true }, "publicPort": { "type": "number", "nullable": true }, "sshHost": { "type": "string", "nullable": true }, "sshPort": { "type": "number", "nullable": true }, "ports": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "jupyterToken": { "type": "string", "nullable": true }, "jupyterHostPort": { "type": "number", "nullable": true }, "jupyterUrl": { "type": "string", "nullable": true } }, "required": [ "publicIp", "publicPort", "sshHost", "sshPort", "ports", "jupyterToken", "jupyterHostPort", "jupyterUrl" ], "additionalProperties": false }, "providerHourlyPrice": { "type": "number" }, "markupMultiplier": { "type": "number" }, "billableHourlyPrice": { "type": "number" }, "currency": { "type": "string" }, "lastSyncedAt": { "type": "string", "description": "Date string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "projectId", "ownerUserId", "ownerName", "manageable", "provider", "providerInstanceId", "providerOfferId", "name", "status", "configuration", "resources", "networking", "providerHourlyPrice", "markupMultiplier", "billableHourlyPrice", "currency", "lastSyncedAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectId": "string", "ownerUserId": "string", "ownerName": "string", "manageable": true, "provider": "string", "providerInstanceId": "string", "providerOfferId": "string", "name": "string", "status": "pending", "configuration": null, "resources": { "gpuName": "string", "gpuCount": 0, "cpuCores": 0, "ramGb": 0, "diskGb": 0, "diskUsedGb": 0 }, "networking": { "publicIp": "string", "publicPort": 0, "sshHost": "string", "sshPort": 0, "ports": null, "jupyterToken": "string", "jupyterHostPort": 0, "jupyterUrl": "string" }, "providerHourlyPrice": 0, "markupMultiplier": 0, "billableHourlyPrice": 0, "currency": "string", "lastSyncedAt": "string", "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTStart, stop, or destroy a GPU instanceDetails +/api/v1/projects/:projectId/gpu/instances/:gpuInstanceId/control
Sends a start, stop, or destroy command to a GPU instance and updates its status accordingly.
- Requires container:control permission and instance ownership within the project.
- Destroying an instance is irreversible and permanently removes it.
- Destroying an instance typically also removes any data stored on its local disk.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
gpuInstanceId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
action | start | stop | destroy | Yes |
Complete request schema
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"start",
"stop",
"destroy"
]
}
},
"required": [
"action"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "ownerUserId": { "type": "string" }, "ownerName": { "type": "string", "nullable": true }, "manageable": { "type": "boolean" }, "provider": { "const": "vast", "type": "string" }, "providerInstanceId": { "type": "string" }, "providerOfferId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "deleted", "provisioning", "unknown", "stopped", "paused", "running", "error", "deleting", "starting", "stopping", "syncing" ] }, "configuration": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "resources": { "type": "object", "properties": { "gpuName": { "type": "string" }, "gpuCount": { "type": "number" }, "cpuCores": { "type": "number" }, "ramGb": { "type": "number" }, "diskGb": { "type": "number" }, "diskUsedGb": { "type": "number" } }, "required": [ "gpuName", "gpuCount", "cpuCores", "ramGb", "diskGb", "diskUsedGb" ], "additionalProperties": false }, "networking": { "type": "object", "properties": { "publicIp": { "type": "string", "nullable": true }, "publicPort": { "type": "number", "nullable": true }, "sshHost": { "type": "string", "nullable": true }, "sshPort": { "type": "number", "nullable": true }, "ports": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "jupyterToken": { "type": "string", "nullable": true }, "jupyterHostPort": { "type": "number", "nullable": true }, "jupyterUrl": { "type": "string", "nullable": true } }, "required": [ "publicIp", "publicPort", "sshHost", "sshPort", "ports", "jupyterToken", "jupyterHostPort", "jupyterUrl" ], "additionalProperties": false }, "providerHourlyPrice": { "type": "number" }, "markupMultiplier": { "type": "number" }, "billableHourlyPrice": { "type": "number" }, "currency": { "type": "string" }, "lastSyncedAt": { "type": "string", "description": "Date string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "projectId", "ownerUserId", "ownerName", "manageable", "provider", "providerInstanceId", "providerOfferId", "name", "status", "configuration", "resources", "networking", "providerHourlyPrice", "markupMultiplier", "billableHourlyPrice", "currency", "lastSyncedAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectId": "string", "ownerUserId": "string", "ownerName": "string", "manageable": true, "provider": "string", "providerInstanceId": "string", "providerOfferId": "string", "name": "string", "status": "pending", "configuration": null, "resources": { "gpuName": "string", "gpuCount": 0, "cpuCores": 0, "ramGb": 0, "diskGb": 0, "diskUsedGb": 0 }, "networking": { "publicIp": "string", "publicPort": 0, "sshHost": "string", "sshPort": 0, "ports": null, "jupyterToken": "string", "jupyterHostPort": 0, "jupyterUrl": "string" }, "providerHourlyPrice": 0, "markupMultiplier": 0, "billableHourlyPrice": 0, "currency": "string", "lastSyncedAt": "string", "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTCopy data directly between two GPU instancesDetails +/api/v1/projects/:projectId/gpu/instances/:gpuInstanceId/copy
Initiates a direct data copy from a source GPU instance to a destination GPU instance, copying either the whole disk or a workspace path depending on instance type.
- Requires container:control permission.
- The destination instance must already be stopped or paused before the copy can start.
- Source and destination must be different instances owned by the caller in the same project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
gpuInstanceId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
sourceId | string | Yes |
destinationId | string | Yes |
srcPath | string | No |
dstPath | string | No |
Complete request schema
{
"type": "object",
"properties": {
"sourceId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"srcPath": {
"type": "string"
},
"dstPath": {
"type": "string"
}
},
"required": [
"sourceId",
"destinationId"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "const": true, "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "success": true }, "meta": { "requestId": "string", "timestamp": "string" } }
GETGet GPU instance details and live statusDetails +/api/v1/projects/:projectId/gpu/instances/:gpuInstanceId
Returns full details for a single GPU instance, including project and owner metadata, resource/networking info, and pricing.
- Requires the caller to have access to the project that owns the instance.
- If the caller owns the instance and it isn't deleted, the response attempts to include freshly refreshed status.
- Falls back silently to the last known status if a live refresh isn't available.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
gpuInstanceId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "projectName": { "type": "string" }, "boundProjectId": { "type": "string" }, "bindingScope": { "const": "project", "type": "string" }, "id": { "type": "string" }, "projectId": { "type": "string" }, "ownerUserId": { "type": "string" }, "ownerName": { "type": "string", "nullable": true }, "manageable": { "type": "boolean" }, "provider": { "const": "vast", "type": "string" }, "providerInstanceId": { "type": "string" }, "providerOfferId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "deleted", "provisioning", "unknown", "stopped", "paused", "running", "error", "deleting", "starting", "stopping", "syncing" ] }, "configuration": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "resources": { "type": "object", "properties": { "gpuName": { "type": "string" }, "gpuCount": { "type": "number" }, "cpuCores": { "type": "number" }, "ramGb": { "type": "number" }, "diskGb": { "type": "number" }, "diskUsedGb": { "type": "number" } }, "required": [ "gpuName", "gpuCount", "cpuCores", "ramGb", "diskGb", "diskUsedGb" ], "additionalProperties": false }, "networking": { "type": "object", "properties": { "publicIp": { "type": "string", "nullable": true }, "publicPort": { "type": "number", "nullable": true }, "sshHost": { "type": "string", "nullable": true }, "sshPort": { "type": "number", "nullable": true }, "ports": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "jupyterToken": { "type": "string", "nullable": true }, "jupyterHostPort": { "type": "number", "nullable": true }, "jupyterUrl": { "type": "string", "nullable": true } }, "required": [ "publicIp", "publicPort", "sshHost", "sshPort", "ports", "jupyterToken", "jupyterHostPort", "jupyterUrl" ], "additionalProperties": false }, "providerHourlyPrice": { "type": "number" }, "markupMultiplier": { "type": "number" }, "billableHourlyPrice": { "type": "number" }, "currency": { "type": "string" }, "lastSyncedAt": { "type": "string", "description": "Date string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "projectName", "boundProjectId", "bindingScope", "id", "projectId", "ownerUserId", "ownerName", "manageable", "provider", "providerInstanceId", "providerOfferId", "name", "status", "configuration", "resources", "networking", "providerHourlyPrice", "markupMultiplier", "billableHourlyPrice", "currency", "lastSyncedAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "projectName": "string", "boundProjectId": "string", "bindingScope": "string", "id": "string", "projectId": "string", "ownerUserId": "string", "ownerName": "string", "manageable": true, "provider": "string", "providerInstanceId": "string", "providerOfferId": "string", "name": "string", "status": "pending", "configuration": null, "resources": { "gpuName": "string", "gpuCount": 0, "cpuCores": 0, "ramGb": 0, "diskGb": 0, "diskUsedGb": 0 }, "networking": { "publicIp": "string", "publicPort": 0, "sshHost": "string", "sshPort": 0, "ports": null, "jupyterToken": "string", "jupyterHostPort": 0, "jupyterUrl": "string" }, "providerHourlyPrice": 0, "markupMultiplier": 0, "billableHourlyPrice": 0, "currency": "string", "lastSyncedAt": "string", "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
GETFetch recent console logs for a GPU instanceDetails +/api/v1/projects/:projectId/gpu/instances/:gpuInstanceId/logs
Returns the last ~1000 lines of daemon logs for a GPU instance, parsed into timestamped, leveled log entries.
- Requires container:logs permission and that the caller owns the instance within the project.
- May retry briefly if the log content isn't immediately ready.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
gpuInstanceId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "timestamp": { "type": "string" }, "level": { "type": "string" }, "message": { "type": "string" } }, "required": [ "id", "timestamp", "level", "message" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "id": "string", "timestamp": "string", "level": "string", "message": "string" } ], "meta": { "requestId": "string", "timestamp": "string" } }
GETSearch available GPU marketplace offersDetails +/api/v1/projects/:projectId/gpu/offers
Searches for rentable, on-demand, verified GPU offers available for the project, returning up to the requested limit (default 15) of normalized offers.
- Requires container:create permission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
limit | query | No | number | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "providerOfferId": { "type": "string" }, "gpuName": { "type": "string" }, "gpuCount": { "type": "number" }, "tflops": { "type": "number" }, "gpuVramGb": { "type": "number" }, "cpuCores": { "type": "number" }, "cpuRamGb": { "type": "number" }, "ramGb": { "type": "number" }, "diskGb": { "type": "number" }, "regionLabel": { "type": "string" }, "providerHourlyPrice": { "type": "number" }, "billableHourlyPrice": { "type": "number" }, "markupMultiplier": { "type": "number" }, "raw": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } } }, "required": [ "providerOfferId", "gpuName", "gpuCount", "tflops", "gpuVramGb", "cpuCores", "cpuRamGb", "ramGb", "diskGb", "regionLabel", "providerHourlyPrice", "billableHourlyPrice", "markupMultiplier", "raw" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "providerOfferId": "string", "gpuName": "string", "gpuCount": 0, "tflops": 0, "gpuVramGb": 0, "cpuCores": 0, "cpuRamGb": 0, "ramGb": 0, "diskGb": 0, "regionLabel": "string", "providerHourlyPrice": 0, "billableHourlyPrice": 0, "markupMultiplier": 0, "raw": null } ], "meta": { "requestId": "string", "timestamp": "string" } }
POSTRefresh status of all project GPU instancesDetails +/api/v1/projects/:projectId/gpu/sync
Refreshes and returns current status for every non-deleted GPU instance owned by the caller in the project.
- Requires container:create permission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|
Complete request schema
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "ownerUserId": { "type": "string" }, "ownerName": { "type": "string", "nullable": true }, "manageable": { "type": "boolean" }, "provider": { "const": "vast", "type": "string" }, "providerInstanceId": { "type": "string" }, "providerOfferId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "deleted", "provisioning", "unknown", "stopped", "paused", "running", "error", "deleting", "starting", "stopping", "syncing" ] }, "configuration": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "resources": { "type": "object", "properties": { "gpuName": { "type": "string" }, "gpuCount": { "type": "number" }, "cpuCores": { "type": "number" }, "ramGb": { "type": "number" }, "diskGb": { "type": "number" }, "diskUsedGb": { "type": "number" } }, "required": [ "gpuName", "gpuCount", "cpuCores", "ramGb", "diskGb", "diskUsedGb" ], "additionalProperties": false }, "networking": { "type": "object", "properties": { "publicIp": { "type": "string", "nullable": true }, "publicPort": { "type": "number", "nullable": true }, "sshHost": { "type": "string", "nullable": true }, "sshPort": { "type": "number", "nullable": true }, "ports": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } }, "jupyterToken": { "type": "string", "nullable": true }, "jupyterHostPort": { "type": "number", "nullable": true }, "jupyterUrl": { "type": "string", "nullable": true } }, "required": [ "publicIp", "publicPort", "sshHost", "sshPort", "ports", "jupyterToken", "jupyterHostPort", "jupyterUrl" ], "additionalProperties": false }, "providerHourlyPrice": { "type": "number" }, "markupMultiplier": { "type": "number" }, "billableHourlyPrice": { "type": "number" }, "currency": { "type": "string" }, "lastSyncedAt": { "type": "string", "description": "Date string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "projectId", "ownerUserId", "ownerName", "manageable", "provider", "providerInstanceId", "providerOfferId", "name", "status", "configuration", "resources", "networking", "providerHourlyPrice", "markupMultiplier", "billableHourlyPrice", "currency", "lastSyncedAt", "createdAt", "updatedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "id": "string", "projectId": "string", "ownerUserId": "string", "ownerName": "string", "manageable": true, "provider": "string", "providerInstanceId": "string", "providerOfferId": "string", "name": "string", "status": "pending", "configuration": null, "resources": { "gpuName": "string", "gpuCount": 0, "cpuCores": 0, "ramGb": 0, "diskGb": 0, "diskUsedGb": 0 }, "networking": { "publicIp": "string", "publicPort": 0, "sshHost": "string", "sshPort": 0, "ports": null, "jupyterToken": "string", "jupyterHostPort": 0, "jupyterUrl": "string" }, "providerHourlyPrice": 0, "markupMultiplier": 0, "billableHourlyPrice": 0, "currency": "string", "lastSyncedAt": "string", "createdAt": "string", "updatedAt": "string" } ], "meta": { "requestId": "string", "timestamp": "string" } }
GETList recommended GPU instance templatesDetails +/api/v1/projects/:projectId/gpu/templates
Retrieves recommended GPU instance templates (image, disk requirements, SSH/Jupyter support, etc.), de-duplicated and sorted by popularity.
- Requires container:create permission on the project.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "hashId": { "type": "string" }, "name": { "type": "string" }, "image": { "type": "string" }, "recommendedDiskGb": { "type": "number", "nullable": true }, "jupyterDirect": { "type": "boolean" }, "sshDirect": { "type": "boolean" }, "useSsh": { "type": "boolean" }, "createdCount": { "type": "number" }, "raw": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } }, { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" }, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "const": false, "type": "boolean" }, { "const": true, "type": "boolean" } ], "nullable": true } } ], "nullable": true } } } ], "nullable": true } } }, "required": [ "id", "hashId", "name", "image", "recommendedDiskGb", "jupyterDirect", "sshDirect", "useSsh", "createdCount", "raw" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "id": "string", "hashId": "string", "name": "string", "image": "string", "recommendedDiskGb": 0, "jupyterDirect": true, "sshDirect": true, "useSsh": true, "createdCount": 0, "raw": null } ], "meta": { "requestId": "string", "timestamp": "string" } }
POSTCreate a new block storage volumeDetails +/api/v1/projects/:projectId/volumes/create
Provisions a new persistent block storage volume in the project's region with the requested size, driver, performance mode, and optional backup/encryption settings.
- Requires volume:manage permission on the project.
- Volume names must be unique within the project.
- If the volume can't be finalized after being created, it is automatically cleaned up to avoid leaving an orphaned resource.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
name | string | Yes |
description | string | No |
sizeGb | number | Yes |
driver | string | No |
labels | object | No |
performanceMode | standard | balanced | high_performance | No |
backupEnabled | boolean | No |
backupSchedule | monthly | daily | weekly | No |
encryptionEnabled | boolean | No |
encryptionType | aes-256 | luks | No |
readOnly | boolean | No |
Complete request schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"sizeGb": {
"type": "number"
},
"driver": {
"const": "local",
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"performanceMode": {
"type": "string",
"enum": [
"standard",
"balanced",
"high_performance"
]
},
"backupEnabled": {
"type": "boolean"
},
"backupSchedule": {
"type": "string",
"enum": [
"monthly",
"daily",
"weekly"
]
},
"encryptionEnabled": {
"type": "boolean"
},
"encryptionType": {
"type": "string",
"enum": [
"aes-256",
"luks"
]
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"name",
"sizeGb"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "sizeGb": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "creating", "error", "deleting", "resizing", "attached" ] }, "runtimeId": { "type": "string" }, "createdAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "projectId", "name", "sizeGb", "status", "runtimeId", "createdAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectId": "string", "name": "string", "sizeGb": "string", "status": "available", "runtimeId": "string", "createdAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
GETGet volume details, cost, and mount infoDetails +/api/v1/projects/:projectId/volumes/:volumeId
Returns full details for a single volume, including its region, current size, computed hourly/monthly cost based on size and performance mode, and the containers it is currently mounted to.
- Requires general read access to the project.
- The response also indicates whether the caller has permission to manage the volume.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
volumeId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "projectName": { "type": "string" }, "region": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "location": { "type": "string" } }, "required": [ "id", "name", "location" ], "additionalProperties": false }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "runtimeId": { "type": "string" }, "sizeGb": { "type": "string" }, "hourlyCost": { "type": "string" }, "monthlyCost": { "type": "string" }, "driver": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "performanceMode": { "type": "string", "enum": [ "standard", "balanced", "high_performance" ] }, "backupEnabled": { "type": "boolean" }, "backupSchedule": { "type": "string", "nullable": true }, "encryptionEnabled": { "type": "boolean" }, "encryptionType": { "type": "string", "nullable": true }, "readOnly": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "creating", "error", "deleting", "resizing", "attached" ] }, "mounts": { "type": "array", "items": { "type": "object", "properties": { "containerId": { "type": "string" }, "containerName": { "type": "string" }, "mountPoint": { "type": "string" }, "readOnly": { "type": "boolean" } }, "required": [ "containerId", "containerName", "mountPoint", "readOnly" ], "additionalProperties": false } }, "canManage": { "type": "boolean" }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "projectId", "projectName", "region", "name", "description", "runtimeId", "sizeGb", "hourlyCost", "monthlyCost", "driver", "labels", "performanceMode", "backupEnabled", "backupSchedule", "encryptionEnabled", "encryptionType", "readOnly", "status", "mounts", "canManage", "createdAt", "updatedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "projectId": "string", "projectName": "string", "region": { "id": "string", "name": "string", "location": "string" }, "name": "string", "description": "string", "runtimeId": "string", "sizeGb": "string", "hourlyCost": "string", "monthlyCost": "string", "driver": "string", "labels": null, "performanceMode": "standard", "backupEnabled": true, "backupSchedule": "string", "encryptionEnabled": true, "encryptionType": "string", "readOnly": true, "status": "available", "mounts": [ { "containerId": "string", "containerName": "string", "mountPoint": "string", "readOnly": true } ], "canManage": true, "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
PUTReplace a volume's labelsDetails +/api/v1/projects/:projectId/volumes/:volumeId/labels
Updates the labels attached to a volume, merging caller-supplied custom labels with system-managed labels (project, owner, name, performance mode, encryption).
- Requires volume:manage permission.
- If the update can't be fully saved after labels are applied, the endpoint attempts to roll back to the previous labels.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
volumeId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
labels | object | Yes |
Complete request schema
{
"type": "object",
"properties": {
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"labels"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "labels" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "labels": null }, "meta": { "requestId": "string", "timestamp": "string" } }
DELETEDelete a block storage volume permanentlyDetails +/api/v1/projects/:projectId/volumes/:volumeId/remove
Permanently deletes a volume and destroys any data stored on it.
- This action is irreversible.
- Requires volume:manage permission; allowed even while the project is hibernating.
- The volume must first be unmounted from all containers, or the request is rejected with a conflict.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
volumeId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "const": true, "type": "boolean" }, "projectId": { "type": "string" } }, "required": [ "success", "projectId" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "success": true, "projectId": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTGrow a volume to a larger sizeDetails +/api/v1/projects/:projectId/volumes/:volumeId/resize
Resizes a volume's underlying storage to a new, strictly larger target size in GB.
- Requires volume:manage permission.
- The volume must currently be in an available or attached state.
- Shrinking a volume is not supported; a target size smaller than or equal to the current size is rejected.
- If the resize fails, the volume reverts to its previous status.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
volumeId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
targetSizeGb | number | Yes |
Complete request schema
{
"type": "object",
"properties": {
"targetSizeGb": {
"type": "number"
}
},
"required": [
"targetSizeGb"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "previousSizeGb": { "type": "string" }, "sizeGb": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "creating", "error", "deleting", "resizing", "attached" ] } }, "required": [ "previousSizeGb", "sizeGb", "status" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "previousSizeGb": "string", "sizeGb": "string", "status": "available" }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTRefresh a volume's status from the runtimeDetails +/api/v1/projects/:projectId/volumes/:volumeId/runtime
Inspects the volume's actual live state (size, status) and updates the stored record to match.
- Requires general read access to the project.
- Has no effect if the volume is currently mid-resize or mid-deletion.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
volumeId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|
Complete request schema
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "runtimeId": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "creating", "error", "deleting", "resizing", "attached" ] }, "sizeGb": { "type": "number" }, "usedBytes": { "type": "number" }, "allocatedBytes": { "type": "number" }, "iopsRead": { "type": "number" }, "iopsWrite": { "type": "number" }, "throughputReadBps": { "type": "number" }, "throughputWriteBps": { "type": "number" }, "encrypted": { "type": "boolean" }, "performanceMode": { "type": "string", "enum": [ "standard", "balanced", "high_performance" ] } }, "required": [ "runtimeId", "status", "sizeGb", "usedBytes", "allocatedBytes", "iopsRead", "iopsWrite", "throughputReadBps", "throughputWriteBps", "encrypted", "performanceMode" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "runtimeId": "string", "status": "available", "sizeGb": 0, "usedBytes": 0, "allocatedBytes": 0, "iopsRead": 0, "iopsWrite": 0, "throughputReadBps": 0, "throughputWriteBps": 0, "encrypted": true, "performanceMode": "standard" }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTCreate a temporary file browser session for a volumeDetails +/api/v1/projects/:projectId/volumes/:volumeId/session
Generates a short-lived (one hour) authenticated URL to a web-based file browser allowing upload, edit, and delete access to the volume's contents.
- Requires volume:manage permission.
- Requires the project's account balance to be positive.
- The volume must currently be mounted and accessible, or the request fails.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
volumeId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|
Complete request schema
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "url": { "type": "string" }, "expiresAt": { "type": "string" }, "error": { "type": "string" } }, "required": [ "success" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "success": true, "url": "string", "expiresAt": "string", "error": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTMove a volume to a different projectDetails +/api/v1/projects/:projectId/volumes/:volumeId/transfer
Reassigns a volume's ownership from its current project to a different target project in the same region, updating its labels to reflect the new project.
- Requires volume:manage permission on both the source and target projects.
- The volume must not currently be mounted to any container.
- The target project must be in the same region.
- Returns a conflict if the target project already has a volume with the same name.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
volumeId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
targetProjectId | string | Yes |
Complete request schema
{
"type": "object",
"properties": {
"targetProjectId": {
"type": "string"
}
},
"required": [
"targetProjectId"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "projectId": { "type": "string" } }, "required": [ "projectId" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "projectId": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }