# Verda Cloud Public API - **OpenAPI Version:** `3.1.0` - **API Version:** `v1` # Introduction Verda Cloud (formerly DataCrunch) API allows you to deploy, control instances & more via external code. ## Open API schema Download OpenAPI 3.1.0 schema here: [/v1/openapi.json](/v1/openapi.json) The API is a RESTful API over HTTPS, all requests & responses use JSON as the data exchange format. ## Official SDKs The following SDK packages maintained by Verda Cloud and use this API: - **Python SDK**: - **Go SDK**: - **Terraform** and **OpenTofu** provider: # Quick Start Guide We use [OAuth 2.0 Client Credentials](https://oauth.net/2/grant-types/client-credentials/) authentication scheme. You can generate credentials via the console UI for external applications to use Verda API. The credentials are used to generate Access & Refresh tokens. All requests to this API must be authenticated using the Access token, except for a few open endpoints. Access tokens have a short lifespan, and can be regenerated using the Refresh token. ## 1. Get Credentials from the Verda Cloud Dashboard Go to the Project page => **Keys** => **Cloud API Credentials** section and click on **Create**. These credentials will be used like a username & password for your application. Store the client secret safely - like a password. ## 2. Generate Access Token An Access Token is needed to be sent with any API call for authentication. The Access Token has a limited lifetime and is expired after a while as defined in `expires_in`. It is used as a [bearer token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#bearer) ### To get an access token, call the token endpoint with the credentials obtained in step 1: ```json { "method": "post", "url": "https://api.verda.com/v1/oauth2/token", "headers": { "Content-Type": "application/json" }, "body": { "grant_type": "client_credentials", "client_id": "", "client_secret": "" } } ``` A valid response would look similar to this: ```json { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJoZXkiOiJ5b3UgYWN1YWxseSBjaGVja2VkIHRoaXM_In0.0RjcdKQ1NJP9gbRyXITE6LFFLwKGzeeshuubnkkfkb8", "token_type": "Bearer", "expires_in": 3600, "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3b3ciOiJhbmQgdGhpcyB0b28_In0.AC5gk-o-MOptUgrouEErlhr8WT3Hg_RR6px6A0I7ZEk", "scope": "cloud-api-v1" } ``` `access_token` is the token value, to be used in the next step. `expires_in` is the duration in seconds until the token is expired. `refresh_token` can be used to create a new access token if expired. When an Access Token expires, create a new one using the refresh token: ```json { "method": "post", "url": "https://api.verda.com/v1/oauth2/token", "headers": { "Content-Type": "application/json" }, "body": { "grant_type": "refresh_token", "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3b3ciOiJhbmQgdGhpcyB0b28_In0.AC5gk-o-MOptUgrouEErlhr8WT3Hg_RR6px6A0I7ZEk" } } ``` The response will include a new token. ## 3. Make REST API Calls That's it, you are ready to use the API, don't forget to add the Access Token to your calls: Let's call the `/balance` endpoint. Add the Access Token value to the `Authorization` header, preceded by the "Bearer" string and a space: ```json { "method": "get", "url": "https://api.verda.com/v1/balance", "headers": { "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJoZXkiOiJ5b3UgYWN1YWxseSBjaGVja2VkIHRoaXM_In0.0RjcdKQ1NJP9gbRyXITE6LFFLwKGzeeshuubnkkfkb8" } } ``` # Rate Limits Authenticated public API requests are rate limited per project in 60 second windows. ## Limits enforced - **Project limit**: 500 requests per minute for all authenticated API requests made for the same project - **Endpoint limit**: 60 requests per minute for the same project, HTTP method, and request path combination The endpoint limit key includes the full request path. Route-specific endpoint policies override the regular endpoint limit for the matching request path. ## Headers Rate limit information is returned in response headers on authenticated requests: - `RateLimit-Policy`: configured limits and window - `RateLimit`: current remaining quota and reset time per limit If a limit is exceeded, the API will return HTTP `429 Too Many Requests` and also include a `Retry-After` header with the number of seconds until requests are allowed again. ### Example of successful response with rate limits policy specified ```curl curl -X GET --verbose https://api.verda.com/v1/instances HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: 213 RateLimit-Policy: "project";q=500;w=60, "endpoint";q=60;w=60 RateLimit: "project";r=486;t=37, "endpoint";r=48;t=37 {...} ``` ### Example of throttled response ```curl curl -X GET --verbose https://api.verda.com/v1/instances HTTP/1.1 429 Too Many Requests Content-Type: application/json; charset=utf-8 Content-Length: 11 RateLimit-Policy: "project";q=500;w=60, "endpoint";q=50;w=60 RateLimit: "project";r=419;t=44, "endpoint";r=0;t=49 Retry-After: 49 ``` # Pagination Some endpoints support pagination using the `page` and `pageSize` query parameters. For backward compatibility, pagination does not change the JSON response payload format. Instead, clients request a page with query parameters and read pagination metadata from response headers. ## Request and response format - `page`: `1` - `pageSize`: `10` (can be extended to a maximum of 100 records per page) When pagination is available, the response includes these headers: - `X-Page`: current page number - `X-Page-Size`: current page size - `X-Total-Count`: total number of matching items Example request: ```bash GET /v1/scripts?page=1&pageSize=100 ``` Example response: ```http HTTP/1.1 200 OK Content-Type: application/json Content-Length: 11111 X-Page: 1 X-Page-Size: 100 X-Total-Count: 10000 [{ "id": "2b1af58-7537-4edb-ba81-82cee082c5e9", "name": "My startup script" }] ``` # Errors Error response body has following schema: | Key | Info | | ------- | ---------------------------------------- | | code | Error type | | message | Textual description of the error details | ## Error types | Code | Description | Matching HTTP error code | | --------------------- | ------------------------------------------------------------------------------- | ------------------------ | | invalid\_request | Invalid request, usually an input error - missing or invalid property etc. | 400 | | unauthorized\_request | Access token is missing or invalid | 401 | | insufficient\_funds | Not enough funds to perform the action | 402 | | forbidden\_action | Can't perform the current action | 403 | | not\_found | Resource not found, or invalid path | 404 | | rate\_limit\_exceeded | Too many requests for the current project or endpoint window | 429 | | server\_error | Error on datacrunch's side | 500 | | service\_unavailable | Not enough resources at the moment, try again later or use a different resource | 503 | # Changelog ## 2026-03-30 Startup script quota and pagination Total number of startup scripts in a project now limited by a per-user quota with a default of `100` scripts and a hard maximum of `1000`. `GET /v1/scripts` now supports pagination via the `page` and `pageSize` query parameters. For backward compatibility, the response payload shape is unchanged and pagination metadata is returned in headers instead. See the [Pagination](#pagination) section for details. ## 2026-03-20 Scope-based access control for API tokens API tokens created via the OAuth 2.0 Client Credentials flow are now issued with the scope `cloud-api-v1` and restricted to documented Public API endpoints only. Previously, these tokens could access internal endpoints not intended for external use. If you are using API tokens for any undocumented endpoints, those requests will now return `403 Forbidden` with `"Insufficient scope"`. Only the endpoints listed in this API documentation are accessible with API tokens. ## 2026-03-20 Long term periods endpoints `GET /v1/long-term/periods` is now **deprecated**. Use the dedicated endpoints instead: - [GET /v1/long-term/periods/instances](/v1/docs#tag/Long-Term/GET/v1/long-term/periods/instances) — long term periods for instances - [GET /v1/long-term/periods/clusters](/v1/docs#tag/Long-Term/GET/v1/long-term/periods/clusters) — long term periods for clusters Improved OpenAPI documentation for all long term period endpoints with detailed property descriptions and examples. ## 2026-03-19 Property `location_code` is now required The location\_code property is now required in the request body when creating instances, clusters, and volumes via the Public API. Requests that omit it will receive an HTTP 400 Bad Request response instead of silently defaulting to FIN-01. This brings the API in line with the SDK, where specifying a region has always been mandatory. Breakdown of API changes: | Description | Endpoint | Schema change | | ---------------------------------------------------------- | -------------------- | ----------------------------------------------- | | [Deploy instance](#tag/instances/POST/v1/instances) | `POST /v1/instances` | `{ /* required */ location_code: string, ... }` | | [Deploy cluster](#tag/clusters/POST/v1/clusters) | `POST /v1/clusters` | `{ /* required */ location_code: string, ... }` | | [Create block volume or SFS](#tag/volumes/POST/v1/volumes) | `POST /v1/volumes` | `{ /* required */ location_code: string, ... }` | ## 2026-03-19 OpenAPI spec auth fix Fixed the OpenAPI specification incorrectly requiring bearer authentication on public endpoints (`/v1/instance-types`, `/v1/cluster-types`, `/v1/container-types`, `/v1/long-term/periods`). These endpoints are publicly accessible and no longer show an authentication requirement in the spec. ## 2026-03-16 Volume response improvements `GET /v1/volumes/{id}` now includes `is_permanently_deleted` and `deleted_at` fields when the volume is in `deleted` status. These fields are omitted for active volumes. The OpenAPI schema for this endpoint now uses `oneOf` to distinguish between the active-volume and deleted-volume response shapes. ## 2026-03-12 Improved instance action and volume deletion responses Bulk instance actions (`PUT /v1/instances`) now return structured per-action results. Each result includes the instance `id`, a `status` (`success` or `error`), and an `error` message when applicable. When all actions succeed the response is `202 Accepted`; when some fail, you receive a `207 Multi-Status` with individual outcomes. A single-instance action that is already in the requested state now returns `204 No Content` instead of an error. Volume deletion (`DELETE /v1/volumes/{id}`) now returns `204 No Content` when the volume is already deleted, making the operation idempotent. OpenAPI schema fields that accept both a single UUID string and an array of UUIDs (`id`, `ssh_key_ids`, `volume_ids`) are now documented with `oneOf` for accurate client generation. ## 2026-03-11 API rate limits Introduced rate limits to our Public API to ensure the stability of our API and platform for everyone. Rate limits are restrictions our API enforces on how frequently a user or client can make requests to our services within a given timeframe. Please take a look at our API documentation section ["Rate limits"](https://api.verda.com/v1/docs#description/rate-limits). ## 2026-02-03 Spot instance volume policy When creating a spot instance, it is now possible to specify a removal policy for the OS volume and any additional volumes created alongside it. Use the `on_spot_discontinue` field: [POST /v1/instances](/v1/docs#tag/instances/POST/v1/instances) ```js POST v1/instances { "instance_type": "CPU.4V.16G", "image": "ubuntu-24.04", "ssh_key_ids": ["442e6a59-26c2-4cea-a619-39762c0d2385"], "hostname": "test-instance", "location_code": "FIN-03", "is_spot": true, "os_volume": { "name": "test-instance-os-volume", "size": 55, // If "delete_permanently", the volume will be deleted when the spot instance is discontinued "on_spot_discontinue": "keep_detached" | "move_to_trash" | "delete_permanently" } } ``` ## 2026-02-03 Delete volumes permanently when deleting an instance When deleting an instance, you can now specify whether its volumes should be moved to deleted storage (default) or deleted permanently: [PUT /v1/instances](/v1/docs#tag/instances/PUT/v1/instances) ```js PUT v1/instances { "action": "delete", "id": "442e6a59-26c2-4cea-a619-39762c0d2385", "volume_ids": ["5e9e63a9-fc3b-427b-b259-0c77dce61090"], // Will delete the instance and volumes permanently "delete_permanently": true } ``` ## Servers - **URL:** `http://localhost:3010` ## Operations ### Get access token - **Method:** `POST` - **Path:** `/v1/oauth2/token` - **Tags:** Authentication Get access token for public API using client credentials or refresh token.You can manage your credentials at , under the **Keys** => **Cloud API credentials** section. #### Request Body ##### Content-Type: application/json **One of:** - **`client_id` (required)** `string` - **`client_secret` (required)** `string` - **`grant_type` (required)** `string`, possible values: `"client_credentials", "refresh_token"` * **`grant_type` (required)** `string`, possible values: `"client_credentials", "refresh_token"` * **`refresh_token` (required)** `string` **Example:** ```json { "grant_type": "client_credentials", "client_id": "6a51jsgnISg6JOyE7wYZh", "client_secret": "TvSBFujsqloJb4Jbcezths1OPK9my3zodM3zot9Fn5" } ``` #### Responses ##### Status: 200 Valid credentials ###### Content-Type: application/json - **`access_token` (required)** `string` — Access token value - **`expires_in` (required)** `number` — Token expiration time in seconds - **`refresh_token` (required)** `string` — Refresh token value - **`scope` (required)** `string` — Access scope - **`token_type` (required)** `string` — Token type **Example:** ```json { "access_token": "eyJhbGciOiJIUzI1NiI...", "token_type": "Bearer", "expires_in": 3600, "refresh_token": "OU4O2BwA690cKg2OfGS8pgIfGSTD2vJ...", "scope": "cloud-api-v1" } ``` ##### Status: 400 Invalid request ###### Content-Type: application/json - **`code` (required)** `string`, possible values: `"invalid_request", "unauthorized_request", "insufficient_funds", "forbidden_action", "not_found", "conflict", "server_error", "service_unavailable"` - **`message` (required)** `string` — Error message **Example:** ```json { "code": "invalid_request", "message": "" } ``` ##### Status: 401 Unauthorized ###### Content-Type: application/json - **`code` (required)** `string`, possible values: `"invalid_request", "unauthorized_request", "insufficient_funds", "forbidden_action", "not_found", "conflict", "server_error", "service_unavailable"` - **`message` (required)** `string` — Error message **Example:** ```json { "code": "invalid_request", "message": "" } ``` ### Get project balance - **Method:** `GET` - **Path:** `/v1/balance` - **Tags:** Balance #### Responses ##### Status: 200 Returns the project balance ###### Content-Type: application/json - **`amount` (required)** `number` — Project balance - **`currency` (required)** `string`, possible values: `"usd", "eur"`, default: `"usd"` — Currency type **Example:** ```json { "amount": 1000, "currency": "usd" } ``` ### Get images types for instances - **Method:** `GET` - **Path:** `/v1/images` - **Tags:** Images, OS Images #### Responses ##### Status: 200 Returns available image types for instances ###### Content-Type: application/json **Array of:** - **`category` (required)** `string` — Image category - **`details` (required)** `array` — Image details **Items:** `string` - **`id` (required)** `string` — Image id - **`image_type` (required)** `string` — Image type - **`is_cluster` (required)** `boolean` — Is cluster - **`is_default` (required)** `boolean` — Is default image - **`name` (required)** `string` — Image name **Example:** ```json [ { "id": "535abf76-5853-4fed-bd5d-a77c89fd1b49", "image_type": "ubuntu-24.04", "name": "Ubuntu 24.04", "is_default": false, "details": [ "Ubuntu 24.04", "Minimal Image" ], "category": "ubuntu", "is_cluster": false } ] ``` ##### Status: 404 Instance type not found ### Get images types for cluster - **Method:** `GET` - **Path:** `/v1/images/cluster` - **Tags:** Images, Clusters #### Responses ##### Status: 200 Returns available image types for cluster ###### Content-Type: application/json **Array of:** - **`category` (required)** `string` — Image category - **`details` (required)** `array` — Image details **Items:** `string` - **`id` (required)** `string` — Image id - **`image_type` (required)** `string` — Image type - **`is_cluster` (required)** `boolean` — Is cluster - **`is_default` (required)** `boolean` — Is default image - **`name` (required)** `string` — Image name **Example:** ```json [ { "id": "535abf76-5853-4fed-bd5d-a77c89fd1b49", "image_type": "ubuntu-24.04", "name": "Ubuntu 24.04", "is_default": false, "details": [ "Ubuntu 24.04", "Minimal Image" ], "category": "ubuntu", "is_cluster": false } ] ``` ##### Status: 404 Instance type not found ### Get all volumes - **Method:** `GET` - **Path:** `/v1/volumes` - **Tags:** Volumes #### Responses ##### Status: 200 Returns a list of all volumes ### Rate limits This endpoint is rate limited to 120 requests per minute per project. ###### Content-Type: application/json **Array of:** - **`base_hourly_cost` (required)** `number` — Volume base hourly cost - **`contract` (required)** `string` — Volume contract type - **`create_directory_command` (required)** `string` — Create directory command - **`created_at` (required)** `string` — Volume creation date - **`currency` (required)** `string`, possible values: `"usd", "eur"` — Volume currency - **`filesystem_to_fstab_command` (required)** `string` — Filesystem to fstab command - **`id` (required)** `string` — Volume ID - **`instance_id` (required)** `string` — Instance ID - **`instances` (required)** `array` — Instance info the volume is attached to **Items:** `string` - **`is_os_volume` (required)** `boolean` — Is OS volume - **`location` (required)** `string` — Volume location - **`long_term` (required)** `object` — Long term contract details - **`monthly_price` (required)** `number` — Volume monthly price - **`mount_command` (required)** `string` — Mount command - **`name` (required)** `string` — Volume name - **`pseudo_path` (required)** `string` — Volume pseudo path. Unique identifier for your filesystem - **`size` (required)** `number` — Volume size in GB - **`ssh_key_ids` (required)** `array` — Array of SSH key IDs that are linked to the volume if it is an OS volume **Items:** `string` - **`status` (required)** `string`, possible values: `"ordered", "attached", "attaching", "detached", "deleted", "cloning", "detaching", "deleting", "restoring", "created", "exported", "canceled", "canceling"` — Volume status - **`target` (required)** `string` — Volume target - **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type **Example:** ```json [ { "id": "3222ba7a-ced8-4ccc-b601-4f0060f80c90", "instance_id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "instances": [ { "id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "auto_rental_extension": null, "ip": "123.123.123.123", "instance_type": "4A100.88V", "status": "running", "os_volume_id": "455e490b-8040-4921-81b6-95fb4b382d4a", "hostname": "hazy-star-swims-fin-01" } ], "name": "OS-NVMe-84Ca37Jf", "created_at": "2024-07-08T19:19:54.247Z", "status": "attached", "size": 100, "is_os_volume": true, "target": "vda", "type": "NVMe", "location": "FIN-01", "ssh_key_ids": [ "ae7a7633-bb74-43d8-9761-27bc342bcde0" ], "pseudo_path": "volume-84Ca37Jf", "create_directory_command": "mkdir -p /mnt/volume", "mount_command": "mount -t nfs -o nconnect=16 nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume", "filesystem_to_fstab_command": "grep -qxF 'nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume nfs defaults 0 0' /etc/fstab || echo 'nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume nfs defaults 0 0' | sudo tee -a /etc/fstab", "contract": "LONG_TERM", "base_hourly_cost": 0.0273972602739726, "monthly_price": 20, "currency": "eur", "long_term": { "end_date": "2025-01-08T19:34:16.663Z", "long_term_period": "3 months", "discount_percentage": 14, "auto_rental_extension": false, "next_period_price": 49.93356, "current_period_price": 49.93356 } } ] ``` ### Create volume - **Method:** `POST` - **Path:** `/v1/volumes` - **Tags:** Volumes #### Request Body ##### Content-Type: application/json - **`location_code` (required)** `string` — Location code - **`name` (required)** `string` — Volume name - **`size` (required)** `number` — Volume size in GB - **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type - **`instance_id`** `string` — Instance ID to attach the volume to - **`instance_ids`** `array` — Array of instance IDs to attach the volume to **Items:** `string` **Example:** ```json { "type": "NVMe", "location_code": "FIN-01", "size": 50, "instance_id": "81185a89-6d32-46f6-898a-d0a9851a992f", "instance_ids": [ "482fbde5-a840-41c8-b733-71147ffca79d", "323e07fa-817b-43f2-87ae-89f257296985" ], "name": "my-volume" } ``` #### Responses ##### Status: 202 Volume ID ###### Content-Type: application/json ##### Status: 403 One or more of the specified instances is not shut down ### Perform action on a volume or multiple volumes - **Method:** `PUT` - **Path:** `/v1/volumes` - **Tags:** Volumes #### Request Body ##### Content-Type: application/json - **`action` (required)** `string`, possible values: `"attach", "detach", "delete", "rename", "resize", "restore", "clone", "cancel", "create", "export", "transfer"` — Action to perform on the volume(s) The \`clone\` action returns its destination volume ID: \`{"id":"..."}\`. Send a \`cancel\` action with that same ID to interrupt a cross-datacenter clone. - **`id` (required)** `object` — Volume ID(s) to perform the action on. Single volume id or an array of volume ids - **`instance_id`** `string` — Instance ID to attach the volume to, if the action is attach - **`instance_ids`** `array` — Array of instance IDs to attach the volume to, if the action is attach **Items:** `string` - **`is_permanent`** `boolean` — If deleting volume(s), delete them permanently - **`location_code`** `string` — Target location code if cloning the volume - **`name`** `string` — New volume name - **`size`** `number` — New volume size in GB. Can't be lower than current size - **`type`** `string` — Target volume type **Example:** ```json { "action": "detach", "id": [ "f8e9793a-f8bb-44e7-a602-e1b5d92b5935" ], "size": 100, "instance_id": "61615c9b-4822-4fac-b42d-dbd328c61183", "instance_ids": [ "5b5a7189-749a-4f50-8374-482046de8e43", "53f3accc-aeaa-499c-b771-e3be1f38f886" ], "name": "volume-name", "type": "NVMe", "is_permanent": true, "location_code": "FIN-01" } ``` #### Responses ##### Status: 202 ### Get all volumes that are in trash - **Method:** `GET` - **Path:** `/v1/volumes/trash` - **Tags:** Volumes #### Responses ##### Status: 200 Returns a list of all volumes in trash ###### Content-Type: application/json **Array of:** - **`base_hourly_cost` (required)** `number` — Volume base hourly cost - **`contract` (required)** `string` — Volume contract type - **`created_at` (required)** `string` — Volume creation date - **`currency` (required)** `string`, possible values: `"usd", "eur"` — Volume currency - **`deleted_at` (required)** `string` — Volume deletion date - **`id` (required)** `string` — Volume ID - **`instance_id` (required)** `string` — Instance ID - **`instances` (required)** `array` — Instance info the volume is attached to **Items:** `string` - **`is_os_volume` (required)** `boolean` — Is OS volume - **`is_permanently_deleted` (required)** `boolean` — Is volume permanently deleted - **`location` (required)** `string` — Volume location - **`monthly_price` (required)** `number` — Volume monthly price - **`name` (required)** `string` — Volume name - **`size` (required)** `number` — Volume size in GB - **`ssh_key_ids` (required)** `array` — Array of SSH key IDs that are linked to the volume if it is an OS volume **Items:** `string` - **`status` (required)** `string`, possible values: `"ordered", "attached", "attaching", "detached", "deleted", "cloning", "detaching", "deleting", "restoring", "created", "exported", "canceled", "canceling"` — Volume status - **`target` (required)** `string` — Volume target - **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type **Example:** ```json [ { "id": "3222ba7a-ced8-4ccc-b601-4f0060f80c90", "instance_id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "instances": [ { "id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "auto_rental_extension": null, "ip": "123.123.123.123", "instance_type": "4A100.88V", "status": "running", "os_volume_id": "455e490b-8040-4921-81b6-95fb4b382d4a", "hostname": "hazy-star-swims-fin-01" } ], "name": "OS-NVMe-84Ca37Jf", "created_at": "2024-07-08T19:19:54.247Z", "status": "attached", "size": 100, "is_os_volume": true, "target": "vda", "type": "NVMe", "location": "FIN-01", "ssh_key_ids": [ "ae7a7633-bb74-43d8-9761-27bc342bcde0" ], "contract": "LONG_TERM", "base_hourly_cost": 0.0273972602739726, "monthly_price": 20, "currency": "eur", "deleted_at": "2025-01-10T11:35:47.633Z", "is_permanently_deleted": false } ] ``` ### Get volume by id - **Method:** `GET` - **Path:** `/v1/volumes/{volume_id}` - **Tags:** Volumes #### Responses ##### Status: 200 Returns volume details ###### Content-Type: application/json **One of:** - **`base_hourly_cost` (required)** `number` — Volume base hourly cost - **`contract` (required)** `string` — Volume contract type - **`create_directory_command` (required)** `string` — Create directory command - **`created_at` (required)** `string` — Volume creation date - **`currency` (required)** `string`, possible values: `"usd", "eur"` — Volume currency - **`filesystem_to_fstab_command` (required)** `string` — Filesystem to fstab command - **`id` (required)** `string` — Volume ID - **`instance_id` (required)** `string` — Instance ID - **`instances` (required)** `array` — Instance info the volume is attached to **Items:** `string` - **`is_os_volume` (required)** `boolean` — Is OS volume - **`location` (required)** `string` — Volume location - **`long_term` (required)** `object` — Long term contract details - **`monthly_price` (required)** `number` — Volume monthly price - **`mount_command` (required)** `string` — Mount command - **`name` (required)** `string` — Volume name - **`pseudo_path` (required)** `string` — Volume pseudo path. Unique identifier for your filesystem - **`size` (required)** `number` — Volume size in GB - **`ssh_key_ids` (required)** `array` — Array of SSH key IDs that are linked to the volume if it is an OS volume **Items:** `string` - **`status` (required)** `string`, possible values: `"ordered", "attached", "attaching", "detached", "deleted", "cloning", "detaching", "deleting", "restoring", "created", "exported", "canceled", "canceling"` — Volume status - **`target` (required)** `string` — Volume target - **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type * **`base_hourly_cost` (required)** `number` — Volume base hourly cost * **`contract` (required)** `string` — Volume contract type * **`created_at` (required)** `string` — Volume creation date * **`currency` (required)** `string`, possible values: `"usd", "eur"` — Volume currency * **`deleted_at` (required)** `string` — Volume deletion date * **`id` (required)** `string` — Volume ID * **`instance_id` (required)** `string` — Instance ID * **`instances` (required)** `array` — Instance info the volume is attached to **Items:** `string` * **`is_os_volume` (required)** `boolean` — Is OS volume * **`is_permanently_deleted` (required)** `boolean` — Is volume permanently deleted * **`location` (required)** `string` — Volume location * **`monthly_price` (required)** `number` — Volume monthly price * **`name` (required)** `string` — Volume name * **`size` (required)** `number` — Volume size in GB * **`ssh_key_ids` (required)** `array` — Array of SSH key IDs that are linked to the volume if it is an OS volume **Items:** `string` * **`status` (required)** `string`, possible values: `"ordered", "attached", "attaching", "detached", "deleted", "cloning", "detaching", "deleting", "restoring", "created", "exported", "canceled", "canceling"` — Volume status * **`target` (required)** `string` — Volume target * **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type **Example:** ```json { "id": "3222ba7a-ced8-4ccc-b601-4f0060f80c90", "instance_id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "instances": [ { "id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "auto_rental_extension": null, "ip": "123.123.123.123", "instance_type": "4A100.88V", "status": "running", "os_volume_id": "455e490b-8040-4921-81b6-95fb4b382d4a", "hostname": "hazy-star-swims-fin-01" } ], "name": "OS-NVMe-84Ca37Jf", "created_at": "2024-07-08T19:19:54.247Z", "status": "attached", "size": 100, "is_os_volume": true, "target": "vda", "type": "NVMe", "location": "FIN-01", "ssh_key_ids": [ "ae7a7633-bb74-43d8-9761-27bc342bcde0" ], "pseudo_path": "volume-84Ca37Jf", "create_directory_command": "mkdir -p /mnt/volume", "mount_command": "mount -t nfs -o nconnect=16 nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume", "filesystem_to_fstab_command": "grep -qxF 'nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume nfs defaults 0 0' /etc/fstab || echo 'nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume nfs defaults 0 0' | sudo tee -a /etc/fstab", "contract": "LONG_TERM", "base_hourly_cost": 0.0273972602739726, "monthly_price": 20, "currency": "eur", "long_term": { "end_date": "2025-01-08T19:34:16.663Z", "long_term_period": "3 months", "discount_percentage": 14, "auto_rental_extension": false, "next_period_price": 49.93356, "current_period_price": 49.93356 } } ``` ### Delete volume by id - **Method:** `DELETE` - **Path:** `/v1/volumes/{volume_id}` - **Tags:** Volumes #### Request Body ##### Content-Type: application/json - **`is_permanent`** `boolean`, default: `false` — If true, the volume will be removed permanently **Example:** ```json { "is_permanent": false } ``` #### Responses ##### Status: 202 ### Get volume types - **Method:** `GET` - **Path:** `/v1/volume-types` - **Tags:** Volume Types #### Responses ##### Status: 200 Returns the list of available volume types ###### Content-Type: application/json **Array of:** - **`burst_bandwidth` (required)** `number` — Burst bandwidth - **`continuous_bandwidth` (required)** `number` — Continuous bandwidth - **`internal_network_speed` (required)** `number` — Internal network speed - **`iops` (required)** `string` — IOPS - **`is_shared_fs` (required)** `boolean` — Is shared file system - **`price` (required)** `object` — Price details - **`throughput_gbps` (required)** `number` — Throughput in GB/s - **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type **Example:** ```json [ { "type": "NVMe", "price": { "price_per_month_per_gb": 0.2, "cps_per_gb": 7.6103500761035e-8, "currency": "usd" }, "is_shared_fs": false, "burst_bandwidth": 2500, "continuous_bandwidth": 2000, "internal_network_speed": 50, "iops": "100k", "throughput_gbps": 4 } ] ``` ### Get instances - **Method:** `GET` - **Path:** `/v1/instances` - **Tags:** Instances Return all instances of the project, or all instances with a specific status (optional) ### Rate limits This endpoint is rate limited to 120 requests per minute per project. #### Responses ##### Status: 200 Instance or a list of instances ###### Content-Type: application/json **Array of:** - **`contract` (required)** `string`, possible values: `"LONG_TERM", "PAY_AS_YOU_GO", "SPOT"` - **`cpu` (required)** `object` - **`created_at` (required)** `string` - **`description` (required)** `string` - **`gpu` (required)** `object` - **`gpu_memory` (required)** `object` - **`hostname` (required)** `string` - **`id` (required)** `string` - **`image` (required)** `string` - **`instance_type` (required)** `string` - **`ip` (required)** `string` - **`is_spot` (required)** `boolean` - **`jupyter_token` (required)** `string` - **`location` (required)** `string` - **`memory` (required)** `object` - **`os_name` (required)** `string` - **`os_volume_id` (required)** `string` - **`price_per_hour` (required)** `number` - **`pricing` (required)** `string`, possible values: `"DYNAMIC_PRICE", "FIXED_PRICE"` - **`ssh_key_ids` (required)** `array` **Items:** `string` - **`startup_script_id` (required)** `string` - **`status` (required)** `string`, possible values: `"running", "provisioning", "offline", "discontinued", "unknown", "ordered", "notfound", "new", "error", "deleting", "validating", "no_capacity", "installation_failed"` - **`storage` (required)** `object` - **`volume_ids` (required)** `array` **Items:** `string` **Example:** ```json [ { "id": "569de3fb-8c76-4ed4-9ce6-aef4b59df7b0", "ip": "1.2.3.4", "status": "running", "created_at": "2023-07-15T14:10:26.654Z", "cpu": { "description": "176 CPU", "number_of_cores": 176 }, "gpu": { "description": "8x A100", "number_of_gpus": 8 }, "gpu_memory": { "description": "80GB GPU RAM", "size_in_gigabytes": 80 }, "memory": { "description": "640GB RAM", "size_in_gigabytes": 640 }, "storage": { "description": "dynamic" }, "hostname": "hazy-star-swims-fin-01", "description": "ubuntu-22-04-cuda-12-0-docker-fin-01", "location": "FIN-01", "price_per_hour": 2.481, "is_spot": false, "instance_type": "8A100.176V", "image": "ubuntu-22-04-cuda-12-0-docker", "os_name": "Ubuntu 22.04", "startup_script_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea", "ssh_key_ids": [ "dd50b622-1c36-48c2-a485-f4d4937a3ea1" ], "os_volume_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea", "jupyter_token": "b9e6d8517db3a722ccfb309ca599a35f", "contract": "PAY_AS_YOU_GO", "pricing": "FIXED_PRICE", "volume_ids": [ "95cec4c3-af69-42eb-a790-fcacebfdfcea", "dd50b622-1c36-48c2-a485-f4d4937a3ea1" ] } ] ``` ### Deploy instance - **Method:** `POST` - **Path:** `/v1/instances` - **Tags:** Instances Deploy a new instance. Before deploying an instance, you need to add at least ssh key to be able to access your instance. Instance types can be listed using the `GET /instance-types` endpoint. Available images can be listed using the `GET /images` endpoint, using the `image_type` value from the result. Existing detached OS volumes could be used as an image, put the volume ID as the `image` value. It's also possible to define new volumes that will be created and attached to the new instance. New volumes location will be the same as the instance. Existing detached volumes can be attached to the deployed instance by adding their IDs to the `existing_volumes` property. #### Request Body ##### Content-Type: application/json - **`description` (required)** `string` - **`hostname` (required)** `string` - **`image` (required)** `string` — OS image specification for the created instance. There are two options: 1. OS image type. For a list of supported images, check \`GET /images\` endpoint, \`"image\_type"\` property. To set the name and size, use \`"os\_volume"\` property. 2. Previously customized OS volume ID. (To create an OS volume, first make an instance with existing \`"image"\` type. To customize the volume content, ssh into that instance. Finally, delete the instance but keep the volume.) - **`instance_type` (required)** `string` - **`location_code` (required)** `string` — Location code for the instance and any newly created volumes - **`contract`** `string`, possible values: `"LONG_TERM", "PAY_AS_YOU_GO", "SPOT"` - **`coupon`** `string` - **`existing_volumes`** `array` — IDs of additional existing detached volumes to attach to this new instance when its created. (To configure instance \*\*OS\*\* volume, use \`"image"\` and \`"os\_volume"\` properties.) **Items:** `string` - **`is_spot`** `boolean` — Create a spot instance. Spot instances may be evicted by Verda at any time without warning. - **`os_volume`** `object` — Newly created OS volume name and size (in GB). Use when \`"image"\` property is an OS image type. Object properties: \* \`name\` - Name of the OS volume \* \`size\` - Size of the OS volume in GB \* \`on\_spot\_discontinue\` - Removal policy for the OS volume for spot instances. Optional, by default, nothing is deleted. Allowed values: \`keep\_detached\` (default behavior), \`move\_to\_trash\` (will be deleted after 96 hours and counts towards the storage volume quota), \`delete\_permanently\` (will be deleted immediately). - **`pricing`** `string`, possible values: `"DYNAMIC_PRICE", "FIXED_PRICE"` — This field is deprecated as DYNAMIC\_PRICE is removed. Only FIXED\_PRICE is supported now. - **`ssh_key_ids`** `object` - **`startup_script_id`** `string` - **`volumes`** `array` — Additional (\*\*non-OS\*\*) volumes to create and attach to this new instance. (To configure \*\*OS\*\* volume, use \`"image"\` and \`"os\_volume"\` properties.) **Items:** - **`name` (required)** `string` - **`size` (required)** `number` - **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` - **`on_spot_discontinue`** `string`, possible values: `"keep_detached", "move_to_trash", "delete_permanently"` — Optional, by default, nothing is deleted. Should we automatically delete, if instance is deleted because of spot? Allowed values: \* \`keep\_detached\` (default behavior, volume will be detached), \* \`move\_to\_trash\` (will be deleted after 96 hours and counts towards the storage volume quota), \* \`delete\_permanently\` (will be deleted immediately). **Example:** ```json { "instance_type": "1H100.80S.30V", "image": "ubuntu-22.04-cuda-12.4-docker", "ssh_key_ids": [ "3896acf4-bbc4-466f-b755-a9d278fb58ab" ], "startup_script_id": "a1dc55a5-492d-4a5e-abe2-0c0111343834", "hostname": "my-instance-hostname", "description": "", "location_code": "FIN-01", "os_volume": { "name": "custom-os-volume-name", "size": 100, "on_spot_discontinue": "keep_detached" }, "is_spot": true, "coupon": "COUPON-CODE-2026", "volumes": [ { "name": "additional-volume-name", "size": 1000, "type": "NVMe" } ], "existing_volumes": [ "fbfdf756-daf7-430d-ad80-70f29850f355" ], "contract": "PAY_AS_YOU_GO" } ``` #### Responses ##### Status: 202 Instance ID ###### Content-Type: application/json ### Perform action on an instance or multiple instances - **Method:** `PUT` - **Path:** `/v1/instances` - **Tags:** Instances Perform an action on a single or multiple instances. Note: to `hibernate` an instance, you must first `shutdown` it. All instance volumes would be detached and the instance will be deleted. **Important**: To remove an instance and stop charging your account, you must `delete` it. Using `shutdown` will keep charging your account. When deleting an instance, you can specify which of its' attached volumes will be deleted by providing `volume_ids` array. Any attached volumes that are not specified in the array would be detached. Note: If not providing a `volume_ids` array, only the OS volume will be deleted and the rest detached. #### Request Body ##### Content-Type: application/json - **`action` (required)** `string`, possible values: `"boot", "start", "shutdown", "delete", "discontinue", "hibernate", "configure_spot", "force_shutdown", "delete_stuck", "deploy", "transfer"` - **`id` (required)** `object` — Instance ID or list of instance IDs - **`delete_permanently`** `boolean`, default: `false` — Delete the volumes permanently. Only applicable for delete (or discontinue) action, when volume IDs to delete are also provided. - **`volume_ids`** `array` — Volume IDs to delete. Specify empty array to indicate no volumes should be deleted (previously known as "hibernate") **Items:** `string` **Example:** ```json { "action": "boot", "id": [ "bcd70ff1-952a-443f-976a-ac667868af8b" ], "volume_ids": [ "f6a24ee3-625c-45e7-a5f1-cfe4a10a1959" ], "delete_permanently": false } ``` #### Responses ##### Status: 202 All actions completed successfully ###### Content-Type: application/json **Array of:** - **`action` (required)** `string`, possible values: `"boot", "start", "shutdown", "delete", "discontinue", "hibernate", "configure_spot", "force_shutdown", "delete_stuck", "deploy", "transfer"` — Action that was requested - **`instanceId` (required)** `string`, format: `uuid` — Instance ID - **`status` (required)** `string`, possible values: `"success", "error"` — Whether the action succeeded or failed - **`error`** `string` — Error message if the action failed - **`statusCode`** `number` — HTTP status code of the error **Example:** ```json [ { "instanceId": "", "action": "boot", "status": "success", "error": "", "statusCode": 400 } ] ``` ##### Status: 204 Instance is already in the requested state (single action only) ##### Status: 207 Some actions failed - returns per-action results with individual statuses and errors ###### Content-Type: application/json **Array of:** - **`action` (required)** `string`, possible values: `"boot", "start", "shutdown", "delete", "discontinue", "hibernate", "configure_spot", "force_shutdown", "delete_stuck", "deploy", "transfer"` — Action that was requested - **`instanceId` (required)** `string`, format: `uuid` — Instance ID - **`status` (required)** `string`, possible values: `"success", "error"` — Whether the action succeeded or failed - **`error`** `string` — Error message if the action failed - **`statusCode`** `number` — HTTP status code of the error **Example:** ```json [ { "instanceId": "", "action": "boot", "status": "success", "error": "", "statusCode": 400 } ] ``` ##### Status: 400 Invalid request or action not allowed (single action only) ##### Status: 404 Instance not found (single action only) ### Get instance types - deprecated ⚠️ Deprecated - **Method:** `GET` - **Path:** `/v1/instances/types` - **Tags:** Instances #### Responses ##### Status: 200 ### Get instance by id - **Method:** `GET` - **Path:** `/v1/instances/{instance_id}` - **Tags:** Instances #### Responses ##### Status: 200 Instance details ###### Content-Type: application/json - **`contract` (required)** `string`, possible values: `"LONG_TERM", "PAY_AS_YOU_GO", "SPOT"` - **`cpu` (required)** `object` - **`created_at` (required)** `string` - **`description` (required)** `string` - **`gpu` (required)** `object` - **`gpu_memory` (required)** `object` - **`hostname` (required)** `string` - **`id` (required)** `string` - **`image` (required)** `string` - **`instance_type` (required)** `string` - **`ip` (required)** `string` - **`is_spot` (required)** `boolean` - **`jupyter_token` (required)** `string` - **`location` (required)** `string` - **`memory` (required)** `object` - **`os_name` (required)** `string` - **`os_volume_id` (required)** `string` - **`price_per_hour` (required)** `number` - **`pricing` (required)** `string`, possible values: `"DYNAMIC_PRICE", "FIXED_PRICE"` - **`ssh_key_ids` (required)** `array` **Items:** `string` - **`startup_script_id` (required)** `string` - **`status` (required)** `string`, possible values: `"running", "provisioning", "offline", "discontinued", "unknown", "ordered", "notfound", "new", "error", "deleting", "validating", "no_capacity", "installation_failed"` - **`storage` (required)** `object` - **`volume_ids` (required)** `array` **Items:** `string` **Example:** ```json { "id": "569de3fb-8c76-4ed4-9ce6-aef4b59df7b0", "ip": "1.2.3.4", "status": "running", "created_at": "2023-07-15T14:10:26.654Z", "cpu": { "description": "176 CPU", "number_of_cores": 176 }, "gpu": { "description": "8x A100", "number_of_gpus": 8 }, "gpu_memory": { "description": "80GB GPU RAM", "size_in_gigabytes": 80 }, "memory": { "description": "640GB RAM", "size_in_gigabytes": 640 }, "storage": { "description": "dynamic" }, "hostname": "hazy-star-swims-fin-01", "description": "ubuntu-22-04-cuda-12-0-docker-fin-01", "location": "FIN-01", "price_per_hour": 2.481, "is_spot": false, "instance_type": "8A100.176V", "image": "ubuntu-22-04-cuda-12-0-docker", "os_name": "Ubuntu 22.04", "startup_script_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea", "ssh_key_ids": [ "dd50b622-1c36-48c2-a485-f4d4937a3ea1" ], "os_volume_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea", "jupyter_token": "b9e6d8517db3a722ccfb309ca599a35f", "contract": "PAY_AS_YOU_GO", "pricing": "FIXED_PRICE", "volume_ids": [ "95cec4c3-af69-42eb-a790-fcacebfdfcea", "dd50b622-1c36-48c2-a485-f4d4937a3ea1" ] } ``` ### Check instance type availability - deprecated ⚠️ Deprecated - **Method:** `GET` - **Path:** `/v1/instances/availability/{instanceType}` - **Tags:** Instances #### Responses ##### Status: 200 ### Perform action - deprecated ⚠️ Deprecated - **Method:** `POST` - **Path:** `/v1/instances/action` - **Tags:** Instances #### Request Body ##### Content-Type: application/json - **`action` (required)** `string`, possible values: `"boot", "start", "shutdown", "delete", "discontinue", "hibernate", "configure_spot", "force_shutdown", "delete_stuck", "deploy", "transfer"` - **`id` (required)** `object` — Instance ID or list of instance IDs - **`delete_permanently`** `boolean`, default: `false` — Delete the volumes permanently. Only applicable for delete (or discontinue) action, when volume IDs to delete are also provided. - **`volume_ids`** `array` — Volume IDs to delete. Specify empty array to indicate no volumes should be deleted (previously known as "hibernate") **Items:** `string` **Example:** ```json { "action": "boot", "id": [ "bcd70ff1-952a-443f-976a-ac667868af8b" ], "volume_ids": [ "f6a24ee3-625c-45e7-a5f1-cfe4a10a1959" ], "delete_permanently": false } ``` #### Responses ##### Status: 202 ### Get instance types - **Method:** `GET` - **Path:** `/v1/instance-types` - **Tags:** Instance Types #### Responses ##### Status: 200 ###### Content-Type: application/json **Array of:** - **`best_for` (required)** `array` — Use cases for instance type **Items:** `string` - **`cpu` (required)** `object` — CPU details - **`currency` (required)** `string`, possible values: `"usd", "eur"` — Currency type - **`description` (required)** `string` — Instance type description - **`display_name` (required)** `string` — Display name - **`gpu` (required)** `object` — GPU details - **`gpu_memory` (required)** `object` — GPU memory details - **`id` (required)** `string` — Instance type ID - **`instance_type` (required)** `string` — Instance type - **`manufacturer` (required)** `string` — Manufacturer - **`max_dynamic_price` (required)** `string` — Ceiling value for dynamic price - **`memory` (required)** `object` — Memory details - **`model` (required)** `string` — GPU model - **`name` (required)** `string` — GPU model name - **`p2p` (required)** `string` — P2P details - **`price_per_hour` (required)** `string` — Price per hour - **`spot_price` (required)** `string` — Spot price per hour - **`storage` (required)** `object` — Storage details - **`supported_os` (required)** `array` — Supported OS image types **Items:** `string` - **`deploy_warning`** `string` — Deploy warning - **`dynamic_price`** `string` — Current dynamic price - **`serverless_price`** `string` — Current serverless price - **`serverless_spot_price`** `string` — Current serverless spot price **Example:** ```json [ { "best_for": [ "Giant ML models", "Multi-GPU training", "FP64 calculations", "NVLINK" ], "cpu": { "description": "22 CPU", "number_of_cores": 22 }, "deploy_warning": "Make sure your VM is running on latest Nvidia Driver 525.100+ or newer", "description": "Dedicated Hardware Instance", "gpu": { "description": "1x H100 SXM5 80GB", "number_of_gpus": 1 }, "gpu_memory": { "description": "80GB GPU RAM", "size_in_gigabytes": 80 }, "id": "c01dd00d-0000-4972-ae4e-d429115d055b", "instance_type": "1H100.80S.22V", "memory": { "description": "187GB RAM", "size_in_gigabytes": 187 }, "model": "H100", "name": "H100 SXM5 80GB", "p2p": "600 GB/s", "price_per_hour": "3.17", "spot_price": "0.31", "serverless_price": "1.75", "serverless_spot_price": "0.87", "storage": { "description": "dynamic" }, "currency": "usd", "manufacturer": "NVIDIA", "display_name": "NVIDIA H100 SXM5 80GB", "supported_os": [ "ubuntu-22.04-cuda-12.3", "ubuntu-24.04" ] } ] ``` ### Get daily dynamic price history (only the last price update per day) - Not supported anymore ⚠️ Deprecated - **Method:** `GET` - **Path:** `/v1/instance-types/price-history` - **Tags:** Instance Types #### Responses ##### Status: 200 ### Get all instance type availabilities for all locations - **Method:** `GET` - **Path:** `/v1/instance-availability` - **Tags:** Instance Availability #### Responses ##### Status: 200 Returns the instance type availabilities for all locations ###### Content-Type: application/json **Array of:** - **`availabilities` (required)** `array` — Array of available instance types **Items:** `string` - **`location_code` (required)** `string` — Location code **Example:** ```json [ { "location_code": "FIN-01", "availabilities": [ "1H100.80S.22V", "2H100.80S.60V", "4H100.80S.176V", "8H100.80S.352V" ] } ] ``` ### Get instance type availability - **Method:** `GET` - **Path:** `/v1/instance-availability/{instance_type}` - **Tags:** Instance Availability #### Responses ##### Status: 200 Returns the instance type availability ###### Content-Type: application/json `boolean` **Example:** ```json true ``` ### Get SSH keys - **Method:** `GET` - **Path:** `/v1/sshkeys` - **Tags:** SSH Keys #### Responses ##### Status: 200 Returns a list of the project's SSH keys ###### Content-Type: application/json **Array of:** - **`id` (required)** `string` — SSH key id - **`key` (required)** `string`, format: `date-time` — Public SSH key - **`name` (required)** `string` — Name of the SSH key **Example:** ```json [ { "id": "f7b3b3b3-1b3b-4b3b-8b3b-3b3b3b3b3b3b", "name": "my-key", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD..." } ] ``` ### Add new SSH key - **Method:** `POST` - **Path:** `/v1/sshkeys` - **Tags:** SSH Keys #### Request Body ##### Content-Type: application/json - **`key` (required)** `string` — Public SSH key - **`name` (required)** `string` — Name of the SSH key **Example:** ```json { "name": "my-key", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD..." } ``` #### Responses ##### Status: 201 Returns the ID of the newly created SSH key ###### Content-Type: application/json ### Delete ssh keys - **Method:** `DELETE` - **Path:** `/v1/sshkeys` - **Tags:** SSH Keys #### Request Body ##### Content-Type: application/json - **`keys` (required)** `string` **Example:** ```json { "keys": [ "aab6c9ee-f1a5-4aad-9189-df8ac97b87ac" ] } ``` #### Responses ##### Status: 200 ### Get SSH keys - **Method:** `GET` - **Path:** `/v1/ssh-keys` - **Tags:** SSH Keys #### Responses ##### Status: 200 Returns a list of the project's SSH keys ###### Content-Type: application/json **Array of:** - **`id` (required)** `string` — SSH key id - **`key` (required)** `string`, format: `date-time` — Public SSH key - **`name` (required)** `string` — Name of the SSH key **Example:** ```json [ { "id": "f7b3b3b3-1b3b-4b3b-8b3b-3b3b3b3b3b3b", "name": "my-key", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD..." } ] ``` ### Add new SSH key - **Method:** `POST` - **Path:** `/v1/ssh-keys` - **Tags:** SSH Keys #### Request Body ##### Content-Type: application/json - **`key` (required)** `string` — Public SSH key - **`name` (required)** `string` — Name of the SSH key **Example:** ```json { "name": "my-key", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD..." } ``` #### Responses ##### Status: 201 Returns the ID of the newly created SSH key ###### Content-Type: application/json ### Delete ssh keys - **Method:** `DELETE` - **Path:** `/v1/ssh-keys` - **Tags:** SSH Keys #### Request Body ##### Content-Type: application/json - **`keys` (required)** `string` **Example:** ```json { "keys": [ "aab6c9ee-f1a5-4aad-9189-df8ac97b87ac" ] } ``` #### Responses ##### Status: 200 ### Get single SSH key by ID - **Method:** `GET` - **Path:** `/v1/sshkeys/{sshKeyId}` - **Tags:** SSH Keys #### Responses ##### Status: 200 Returns the SSH key ###### Content-Type: application/json - **`id` (required)** `string` — SSH key id - **`key` (required)** `string`, format: `date-time` — Public SSH key - **`name` (required)** `string` — Name of the SSH key **Example:** ```json { "id": "f7b3b3b3-1b3b-4b3b-8b3b-3b3b3b3b3b3b", "name": "my-key", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD..." } ``` ### Delete single SSH key by ID - **Method:** `DELETE` - **Path:** `/v1/sshkeys/{sshKeyId}` - **Tags:** SSH Keys #### Responses ##### Status: 200 ### Get single SSH key by ID - **Method:** `GET` - **Path:** `/v1/ssh-keys/{sshKeyId}` - **Tags:** SSH Keys #### Responses ##### Status: 200 Returns the SSH key ###### Content-Type: application/json - **`id` (required)** `string` — SSH key id - **`key` (required)** `string`, format: `date-time` — Public SSH key - **`name` (required)** `string` — Name of the SSH key **Example:** ```json { "id": "f7b3b3b3-1b3b-4b3b-8b3b-3b3b3b3b3b3b", "name": "my-key", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD..." } ``` ### Delete single SSH key by ID - **Method:** `DELETE` - **Path:** `/v1/ssh-keys/{sshKeyId}` - **Tags:** SSH Keys #### Responses ##### Status: 200 ### Get startup scripts - **Method:** `GET` - **Path:** `/v1/scripts` - **Tags:** Startup Scripts #### Responses ##### Status: 200 Returns a list of the project's startup scripts ###### Content-Type: application/json **Array of:** - **`id` (required)** `string` — Script ID - **`name` (required)** `string` — Script name - **`script` (required)** `string` — Script content **Example:** ```json [ { "id": "e8d2fa11-c44c-49c4-b5d5-4b2abf848b60", "name": "My startup script", "script": "#!/bin/bash\n\necho hello world" } ] ``` ### Add new startup script - **Method:** `POST` - **Path:** `/v1/scripts` - **Tags:** Startup Scripts #### Request Body ##### Content-Type: application/json - **`name` (required)** `string` — Script name - **`script` (required)** `string` — Script content **Example:** ```json { "name": "My startup script", "script": "#!/bin/bash\n\necho hello world" } ``` #### Responses ##### Status: 201 Returns the ID of the newly created script ###### Content-Type: application/json ### Delete startup scripts - **Method:** `DELETE` - **Path:** `/v1/scripts` - **Tags:** Startup Scripts #### Request Body ##### Content-Type: application/json - **`scripts` (required)** `string` **Example:** ```json { "scripts": [ "da2a9f2d-1a52-4146-b8bc-ca7095bc0a2d" ] } ``` #### Responses ##### Status: 200 ### Get single startup script by ID - **Method:** `GET` - **Path:** `/v1/scripts/{scriptId}` - **Tags:** Startup Scripts #### Responses ##### Status: 200 Return startup script with specific ID ###### Content-Type: application/json - **`id` (required)** `string` — Script ID - **`name` (required)** `string` — Script name - **`script` (required)** `string` — Script content **Example:** ```json { "id": "e8d2fa11-c44c-49c4-b5d5-4b2abf848b60", "name": "My startup script", "script": "#!/bin/bash\n\necho hello world" } ``` ### Delete single startup script by ID - **Method:** `DELETE` - **Path:** `/v1/scripts/{scriptId}` - **Tags:** Startup Scripts #### Responses ##### Status: 200 ### Returns a list of available locations - **Method:** `GET` - **Path:** `/v1/locations` - **Tags:** Locations #### Responses ##### Status: 200 Returns a list of available locations ###### Content-Type: application/json **Array of:** - **`code` (required)** `string` — Datacenter location code - **`country_code` (required)** `string` — Country code - **`name` (required)** `string` — Location name **Example:** ```json [ { "code": "FIN-01", "name": "Finland 1", "country_code": "FI" } ] ``` ### Get long term periods ⚠️ Deprecated - **Method:** `GET` - **Path:** `/v1/long-term/periods` - **Tags:** Long Term #### Responses ##### Status: 200 Returns the long term periods ###### Content-Type: application/json **Array of:** - **`code` (required)** `string` — Long term period code - **`discount_percentage` (required)** `number` — Discount percentage - **`is_enabled` (required)** `boolean` — Is long term period enabled - **`name` (required)** `string` — Long term period name - **`unit_name` (required)** `string`, possible values: `"hour", "day", "week", "month", "year"` — Time unit name - **`unit_value` (required)** `number` — Time unit value **Example:** ```json [ { "code": "3_MONTHS", "name": "3 months", "is_enabled": true, "unit_name": "month", "unit_value": 3, "discount_percentage": 14 } ] ``` ### Get long term periods for instances - **Method:** `GET` - **Path:** `/v1/long-term/periods/instances` - **Tags:** Long Term #### Responses ##### Status: 200 Returns the long term periods for instances ###### Content-Type: application/json **Array of:** - **`code` (required)** `string` — Long term period code - **`discount_percentage` (required)** `number` — Discount percentage - **`is_enabled` (required)** `boolean` — Is long term period enabled - **`name` (required)** `string` — Long term period name - **`unit_name` (required)** `string`, possible values: `"hour", "day", "week", "month", "year"` — Time unit name - **`unit_value` (required)** `number` — Time unit value **Example:** ```json [ { "code": "3_MONTHS", "name": "3 months", "is_enabled": true, "unit_name": "month", "unit_value": 3, "discount_percentage": 14 } ] ``` ### Get long term periods for clusters - **Method:** `GET` - **Path:** `/v1/long-term/periods/clusters` - **Tags:** Long Term #### Responses ##### Status: 200 Returns the long term periods for clusters ###### Content-Type: application/json **Array of:** - **`code` (required)** `string` — Long term period code - **`discount_percentage` (required)** `number` — Discount percentage - **`is_enabled` (required)** `boolean` — Is long term period enabled - **`name` (required)** `string` — Long term period name - **`unit_name` (required)** `string`, possible values: `"hour", "day", "week", "month", "year"` — Time unit name - **`unit_value` (required)** `number` — Time unit value **Example:** ```json [ { "code": "3_MONTHS", "name": "3 months", "is_enabled": true, "unit_name": "month", "unit_value": 3, "discount_percentage": 14 } ] ``` ### Get container types - **Method:** `GET` - **Path:** `/v1/container-types` - **Tags:** Container Types #### Responses ##### Status: 200 ###### Content-Type: application/json **Array of:** - **`cpu` (required)** `object` — CPU details - **`currency` (required)** `string`, possible values: `"usd", "eur"` — Currency type - **`gpu` (required)** `object` — GPU details - **`gpu_memory` (required)** `object` — GPU memory details - **`id` (required)** `string` — Instance type ID - **`instance_type` (required)** `string` — Instance type - **`manufacturer` (required)** `string` — Manufacturer - **`memory` (required)** `object` — Memory details - **`model` (required)** `string` — GPU model - **`name` (required)** `string` — GPU model name - **`serverless_price` (required)** `string` — Current serverless price - **`serverless_spot_price` (required)** `string` — Current serverless spot price **Example:** ```json [ { "id": "60006000-6000-47af-8ff0-600060006004", "model": "RTX PRO 6000", "name": "RTX PRO 6000 96GB", "instance_type": "8RTXPRO6000.224V", "cpu": { "description": "224 CPU", "number_of_cores": 224 }, "gpu": { "description": "8x RTX PRO 6000 96GB", "number_of_gpus": 8 }, "gpu_memory": { "description": "768GB GPU RAM", "size_in_gigabytes": 768 }, "memory": { "description": "680GB RAM", "size_in_gigabytes": 680 }, "serverless_price": "1.529", "serverless_spot_price": "0.7645", "currency": "usd", "manufacturer": "NVIDIA" } ] ``` ## Schemas ### GetAccessTokenDto - **Type:**`object` * **`client_id` (required)** `string` * **`client_secret` (required)** `string` * **`grant_type` (required)** `string`, possible values: `"client_credentials", "refresh_token"` **Example:** ```json { "grant_type": "client_credentials", "client_id": "6a51jsgnISg6JOyE7wYZh", "client_secret": "TvSBFujsqloJb4Jbcezths1OPK9my3zodM3zot9Fn5" } ``` ### RefreshAccessTokenPublicApiDto - **Type:**`object` * **`grant_type` (required)** `string`, possible values: `"client_credentials", "refresh_token"` * **`refresh_token` (required)** `string` **Example:** ```json { "grant_type": "refresh_token", "refresh_token": "OU4O2BwA690cKg2OfGS8pgIfGSTD2vJ..." } ``` ### GetAccessTokenResponseDto - **Type:**`object` * **`access_token` (required)** `string` — Access token value * **`expires_in` (required)** `number` — Token expiration time in seconds * **`refresh_token` (required)** `string` — Refresh token value * **`scope` (required)** `string` — Access scope * **`token_type` (required)** `string` — Token type **Example:** ```json { "access_token": "eyJhbGciOiJIUzI1NiI...", "token_type": "Bearer", "expires_in": 3600, "refresh_token": "OU4O2BwA690cKg2OfGS8pgIfGSTD2vJ...", "scope": "cloud-api-v1" } ``` ### PublicApiErrorResponseDto - **Type:**`object` * **`code` (required)** `string`, possible values: `"invalid_request", "unauthorized_request", "insufficient_funds", "forbidden_action", "not_found", "conflict", "server_error", "service_unavailable"` * **`message` (required)** `string` — Error message **Example:** ```json { "code": "invalid_request", "message": "" } ``` ### BalanceResponseDto - **Type:**`object` * **`amount` (required)** `number` — Project balance * **`currency` (required)** `string`, possible values: `"usd", "eur"`, default: `"usd"` — Currency type **Example:** ```json { "amount": 1000, "currency": "usd" } ``` ### Os - **Type:**`object` * **`category` (required)** `string` — Image category * **`details` (required)** `array` — Image details **Items:** `string` * **`id` (required)** `string` — Image id * **`image_type` (required)** `string` — Image type * **`is_cluster` (required)** `boolean` — Is cluster * **`is_default` (required)** `boolean` — Is default image * **`name` (required)** `string` — Image name **Example:** ```json { "id": "535abf76-5853-4fed-bd5d-a77c89fd1b49", "image_type": "ubuntu-24.04", "name": "Ubuntu 24.04", "is_default": false, "details": [ "Ubuntu 24.04", "Minimal Image" ], "category": "ubuntu", "is_cluster": false } ``` ### ActivityVolumeDto - **Type:**`object` * **`created_at` (required)** `string` * **`gb` (required)** `number` * **`id` (required)** `string` * **`is_shared_fs` (required)** `boolean` * **`location_code` (required)** `string` * **`name` (required)** `string` * **`template_type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` **Example:** ```json { "id": "1fd8df3c-7fe8-476c-91e1-c1a93b26bf62", "name": "volume-1", "created_at": "2026-03-17T14:15:52.872Z", "gb": 100, "is_shared_fs": false, "template_type": "NVMe", "location_code": "FIN-01" } ``` ### ActivityComputeDto - **Type:**`object` * **`compute_type` (required)** `string` * **`hostname` (required)** `string` * **`id` (required)** `string` * **`is_cluster` (required)** `boolean` * **`ip`** `string` * **`location_code`** `string` * **`os_volume_id`** `string` **Example:** ```json { "id": "424b2eb3-1531-43b9-82fd-0a3aa323ced7", "hostname": "example-fin-01", "compute_type": "4A100.88V", "is_cluster": false, "ip": "1.2.3.4", "os_volume_id": "4e542939-45cc-4b0c-bda9-6b70ff36dfee", "location_code": "FIN-01" } ``` ### GetActivityJournalResponseDto - **Type:**`object` * **`action_code` (required)** `string`, possible values: `"create", "start", "start:complete", "shutdown:complete", "shutdown", "delete", "delete:complete", "attach", "attach:complete", "detach", "detach:complete", "clone", "resize", "rename", "restore", "transfer", "trash", "trash:complete", "configure_spot", "cancel", "provisioning", "running"` — Action that was performed on the object. * **`id` (required)** `string` — Event ID, unique within the project. Please note that it is not UUID but a combined string to identify the event. * **`location_code` (required)** `string` — Datacenter location code where the event happened or this object is located. * **`object_id` (required)** `string` — ID of the object that the event is related to. * **`object_type` (required)** `string`, possible values: `"compute", "volume"` — Object type that the event is related to. * **`project_id` (required)** `string` — ID of the project that the event is related to. * **`timestamp` (required)** `string` — When the event happened. * **`actor_email`** `string` — Email of the actor that performed the action. * **`actor_id`** `string` — ID of the actor that performed the action. For some actions, such as spot discontinue, the actor is not available and assumed to be system. * **`compute`** `object` — Detailed compute object, if the object type is a compute. * **`error_message`** `string` — For error events, the error message * **`parent_id`** `string` — For some events, for example attach volume during instance provisioning, the ID of the parent event. * **`properties`** `object` — Additional properties of the event. * **`request_ip`** `string` — IP address of the request that caused the event. * **`request_origin`** `string` — Origin of the request that caused the event. For example, public API, Console UI, or undefined for the internal system. * **`service`** `string` — For some events, the internal service that caused the event. * **`source_compute`** `object` — Associated source compute object * **`source_compute_id`** `string` — For some events, the ID of the source compute. * **`source_volume`** `object` — Associated source volume object * **`source_volume_id`** `string` — For some events, the ID of the source volume. * **`target_compute`** `object` — Associated target compute object * **`target_compute_id`** `string` — For some events, the ID of the target compute. * **`target_location_code`** `string` — For cross-datacenter events, the location code of the target location. * **`target_volume`** `object` — Associated target volume object * **`target_volume_id`** `string` — For some events, the ID of the target volume. * **`volume`** `object` — Associated volume object, if the object is a volume. **Example:** ```json { "id": "instance-log-123", "object_id": "bb3775a7-4149-4691-95d7-69888a27b09f", "object_type": "compute", "action_code": "start", "actor_id": "75788485-8fd9-4c81-8319-fe1778b4353e", "actor_email": "user@datacrunch.io", "project_id": "662eb72a-90ef-4d36-82ac-bb5dee3c85a1", "timestamp": "2026-03-17T14:15:52.872Z", "location_code": "FIN-01", "request_origin": "public-api-v1", "request_ip": "127.0.0.1", "error_message": "GPU_QUOTA_EXCEEDED", "parent_id": "compute-log-123", "service": "VolumeProvider", "target_location_code": "ICE-01", "volume": { "id": "1fd8df3c-7fe8-476c-91e1-c1a93b26bf62", "name": "volume-1", "created_at": "2026-03-17T14:15:52.872Z", "gb": 100, "is_shared_fs": false, "template_type": "NVMe", "location_code": "FIN-01" }, "compute": { "id": "424b2eb3-1531-43b9-82fd-0a3aa323ced7", "hostname": "example-fin-01", "compute_type": "4A100.88V", "is_cluster": false, "ip": "1.2.3.4", "os_volume_id": "4e542939-45cc-4b0c-bda9-6b70ff36dfee", "location_code": "FIN-01" }, "target_volume_id": "4e37dfa6-796a-4077-8dd3-4c1457a444c7", "target_volume": { "id": "1fd8df3c-7fe8-476c-91e1-c1a93b26bf62", "name": "volume-1", "created_at": "2026-03-17T14:15:52.872Z", "gb": 100, "is_shared_fs": false, "template_type": "NVMe", "location_code": "FIN-01" }, "target_compute_id": "be087e40-c261-4433-924f-9572cdf92b91", "target_compute": { "id": "424b2eb3-1531-43b9-82fd-0a3aa323ced7", "hostname": "example-fin-01", "compute_type": "4A100.88V", "is_cluster": false, "ip": "1.2.3.4", "os_volume_id": "4e542939-45cc-4b0c-bda9-6b70ff36dfee", "location_code": "FIN-01" }, "source_volume_id": "da768c7b-c752-41ab-98dd-8f9b75008d9e", "source_volume": { "id": "1fd8df3c-7fe8-476c-91e1-c1a93b26bf62", "name": "volume-1", "created_at": "2026-03-17T14:15:52.872Z", "gb": 100, "is_shared_fs": false, "template_type": "NVMe", "location_code": "FIN-01" }, "source_compute_id": "5195972f-6de5-4aae-a232-955e6dcb488d", "source_compute": { "id": "424b2eb3-1531-43b9-82fd-0a3aa323ced7", "hostname": "example-fin-01", "compute_type": "4A100.88V", "is_cluster": false, "ip": "1.2.3.4", "os_volume_id": "4e542939-45cc-4b0c-bda9-6b70ff36dfee", "location_code": "FIN-01" }, "properties": { "delete_reason": "evicted_by_on_demand" } } ``` ### GetVolumePublicResponseDto - **Type:**`object` * **`base_hourly_cost` (required)** `number` — Volume base hourly cost * **`contract` (required)** `string` — Volume contract type * **`create_directory_command` (required)** `string` — Create directory command * **`created_at` (required)** `string` — Volume creation date * **`currency` (required)** `string`, possible values: `"usd", "eur"` — Volume currency * **`filesystem_to_fstab_command` (required)** `string` — Filesystem to fstab command * **`id` (required)** `string` — Volume ID * **`instance_id` (required)** `string` — Instance ID * **`instances` (required)** `array` — Instance info the volume is attached to **Items:** `string` * **`is_os_volume` (required)** `boolean` — Is OS volume * **`location` (required)** `string` — Volume location * **`long_term` (required)** `object` — Long term contract details * **`monthly_price` (required)** `number` — Volume monthly price * **`mount_command` (required)** `string` — Mount command * **`name` (required)** `string` — Volume name * **`pseudo_path` (required)** `string` — Volume pseudo path. Unique identifier for your filesystem * **`size` (required)** `number` — Volume size in GB * **`ssh_key_ids` (required)** `array` — Array of SSH key IDs that are linked to the volume if it is an OS volume **Items:** `string` * **`status` (required)** `string`, possible values: `"ordered", "attached", "attaching", "detached", "deleted", "cloning", "detaching", "deleting", "restoring", "created", "exported", "canceled", "canceling"` — Volume status * **`target` (required)** `string` — Volume target * **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type **Example:** ```json { "id": "3222ba7a-ced8-4ccc-b601-4f0060f80c90", "instance_id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "instances": [ { "id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "auto_rental_extension": null, "ip": "123.123.123.123", "instance_type": "4A100.88V", "status": "running", "os_volume_id": "455e490b-8040-4921-81b6-95fb4b382d4a", "hostname": "hazy-star-swims-fin-01" } ], "name": "OS-NVMe-84Ca37Jf", "created_at": "2024-07-08T19:19:54.247Z", "status": "attached", "size": 100, "is_os_volume": true, "target": "vda", "type": "NVMe", "location": "FIN-01", "ssh_key_ids": [ "ae7a7633-bb74-43d8-9761-27bc342bcde0" ], "pseudo_path": "volume-84Ca37Jf", "create_directory_command": "mkdir -p /mnt/volume", "mount_command": "mount -t nfs -o nconnect=16 nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume", "filesystem_to_fstab_command": "grep -qxF 'nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume nfs defaults 0 0' /etc/fstab || echo 'nfs.fin-01.datacrunch.io:volume-88eb67d0 /mnt/volume nfs defaults 0 0' | sudo tee -a /etc/fstab", "contract": "LONG_TERM", "base_hourly_cost": 0.0273972602739726, "monthly_price": 20, "currency": "eur", "long_term": { "end_date": "2025-01-08T19:34:16.663Z", "long_term_period": "3 months", "discount_percentage": 14, "auto_rental_extension": false, "next_period_price": 49.93356, "current_period_price": 49.93356 } } ``` ### GetVolumeInTrashPublicResponseDto - **Type:**`object` * **`base_hourly_cost` (required)** `number` — Volume base hourly cost * **`contract` (required)** `string` — Volume contract type * **`created_at` (required)** `string` — Volume creation date * **`currency` (required)** `string`, possible values: `"usd", "eur"` — Volume currency * **`deleted_at` (required)** `string` — Volume deletion date * **`id` (required)** `string` — Volume ID * **`instance_id` (required)** `string` — Instance ID * **`instances` (required)** `array` — Instance info the volume is attached to **Items:** `string` * **`is_os_volume` (required)** `boolean` — Is OS volume * **`is_permanently_deleted` (required)** `boolean` — Is volume permanently deleted * **`location` (required)** `string` — Volume location * **`monthly_price` (required)** `number` — Volume monthly price * **`name` (required)** `string` — Volume name * **`size` (required)** `number` — Volume size in GB * **`ssh_key_ids` (required)** `array` — Array of SSH key IDs that are linked to the volume if it is an OS volume **Items:** `string` * **`status` (required)** `string`, possible values: `"ordered", "attached", "attaching", "detached", "deleted", "cloning", "detaching", "deleting", "restoring", "created", "exported", "canceled", "canceling"` — Volume status * **`target` (required)** `string` — Volume target * **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type **Example:** ```json { "id": "3222ba7a-ced8-4ccc-b601-4f0060f80c90", "instance_id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "instances": [ { "id": "a77da7c4-bc9d-4ccc-8871-7896c29b7e9e", "auto_rental_extension": null, "ip": "123.123.123.123", "instance_type": "4A100.88V", "status": "running", "os_volume_id": "455e490b-8040-4921-81b6-95fb4b382d4a", "hostname": "hazy-star-swims-fin-01" } ], "name": "OS-NVMe-84Ca37Jf", "created_at": "2024-07-08T19:19:54.247Z", "status": "attached", "size": 100, "is_os_volume": true, "target": "vda", "type": "NVMe", "location": "FIN-01", "ssh_key_ids": [ "ae7a7633-bb74-43d8-9761-27bc342bcde0" ], "contract": "LONG_TERM", "base_hourly_cost": 0.0273972602739726, "monthly_price": 20, "currency": "eur", "deleted_at": "2025-01-10T11:35:47.633Z", "is_permanently_deleted": false } ``` ### CreateVolumePublicDto - **Type:**`object` * **`location_code` (required)** `string` — Location code * **`name` (required)** `string` — Volume name * **`size` (required)** `number` — Volume size in GB * **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type * **`instance_id`** `string` — Instance ID to attach the volume to * **`instance_ids`** `array` — Array of instance IDs to attach the volume to **Items:** `string` **Example:** ```json { "type": "NVMe", "location_code": "FIN-01", "size": 50, "instance_id": "81185a89-6d32-46f6-898a-d0a9851a992f", "instance_ids": [ "482fbde5-a840-41c8-b733-71147ffca79d", "323e07fa-817b-43f2-87ae-89f257296985" ], "name": "my-volume" } ``` ### PerformVolumeActionPublicDto - **Type:**`object` * **`action` (required)** `string`, possible values: `"attach", "detach", "delete", "rename", "resize", "restore", "clone", "cancel", "create", "export", "transfer"` — Action to perform on the volume(s) The \`clone\` action returns its destination volume ID: \`{"id":"..."}\`. Send a \`cancel\` action with that same ID to interrupt a cross-datacenter clone. * **`id` (required)** `object` — Volume ID(s) to perform the action on. Single volume id or an array of volume ids * **`instance_id`** `string` — Instance ID to attach the volume to, if the action is attach * **`instance_ids`** `array` — Array of instance IDs to attach the volume to, if the action is attach **Items:** `string` * **`is_permanent`** `boolean` — If deleting volume(s), delete them permanently * **`location_code`** `string` — Target location code if cloning the volume * **`name`** `string` — New volume name * **`size`** `number` — New volume size in GB. Can't be lower than current size * **`type`** `string` — Target volume type **Example:** ```json { "action": "detach", "id": [ "f8e9793a-f8bb-44e7-a602-e1b5d92b5935" ], "size": 100, "instance_id": "61615c9b-4822-4fac-b42d-dbd328c61183", "instance_ids": [ "5b5a7189-749a-4f50-8374-482046de8e43", "53f3accc-aeaa-499c-b771-e3be1f38f886" ], "name": "volume-name", "type": "NVMe", "is_permanent": true, "location_code": "FIN-01" } ``` ### DeleteVolumePublicDto - **Type:**`object` * **`is_permanent`** `boolean`, default: `false` — If true, the volume will be removed permanently **Example:** ```json { "is_permanent": false } ``` ### VolumeType - **Type:**`object` * **`burst_bandwidth` (required)** `number` — Burst bandwidth * **`continuous_bandwidth` (required)** `number` — Continuous bandwidth * **`internal_network_speed` (required)** `number` — Internal network speed * **`iops` (required)** `string` — IOPS * **`is_shared_fs` (required)** `boolean` — Is shared file system * **`price` (required)** `object` — Price details * **`throughput_gbps` (required)** `number` — Throughput in GB/s * **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` — Volume type **Example:** ```json { "type": "NVMe", "price": { "price_per_month_per_gb": 0.2, "cps_per_gb": 7.6103500761035e-8, "currency": "usd" }, "is_shared_fs": false, "burst_bandwidth": 2500, "continuous_bandwidth": 2000, "internal_network_speed": 50, "iops": "100k", "throughput_gbps": 4 } ``` ### GetInstanceResponsePublicApiDto - **Type:**`object` * **`contract` (required)** `string`, possible values: `"LONG_TERM", "PAY_AS_YOU_GO", "SPOT"` * **`cpu` (required)** `object` * **`created_at` (required)** `string` * **`description` (required)** `string` * **`gpu` (required)** `object` * **`gpu_memory` (required)** `object` * **`hostname` (required)** `string` * **`id` (required)** `string` * **`image` (required)** `string` * **`instance_type` (required)** `string` * **`ip` (required)** `string` * **`is_spot` (required)** `boolean` * **`jupyter_token` (required)** `string` * **`location` (required)** `string` * **`memory` (required)** `object` * **`os_name` (required)** `string` * **`os_volume_id` (required)** `string` * **`price_per_hour` (required)** `number` * **`pricing` (required)** `string`, possible values: `"DYNAMIC_PRICE", "FIXED_PRICE"` * **`ssh_key_ids` (required)** `array` **Items:** `string` * **`startup_script_id` (required)** `string` * **`status` (required)** `string`, possible values: `"running", "provisioning", "offline", "discontinued", "unknown", "ordered", "notfound", "new", "error", "deleting", "validating", "no_capacity", "installation_failed"` * **`storage` (required)** `object` * **`volume_ids` (required)** `array` **Items:** `string` **Example:** ```json { "id": "569de3fb-8c76-4ed4-9ce6-aef4b59df7b0", "ip": "1.2.3.4", "status": "running", "created_at": "2023-07-15T14:10:26.654Z", "cpu": { "description": "176 CPU", "number_of_cores": 176 }, "gpu": { "description": "8x A100", "number_of_gpus": 8 }, "gpu_memory": { "description": "80GB GPU RAM", "size_in_gigabytes": 80 }, "memory": { "description": "640GB RAM", "size_in_gigabytes": 640 }, "storage": { "description": "dynamic" }, "hostname": "hazy-star-swims-fin-01", "description": "ubuntu-22-04-cuda-12-0-docker-fin-01", "location": "FIN-01", "price_per_hour": 2.481, "is_spot": false, "instance_type": "8A100.176V", "image": "ubuntu-22-04-cuda-12-0-docker", "os_name": "Ubuntu 22.04", "startup_script_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea", "ssh_key_ids": [ "dd50b622-1c36-48c2-a485-f4d4937a3ea1" ], "os_volume_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea", "jupyter_token": "b9e6d8517db3a722ccfb309ca599a35f", "contract": "PAY_AS_YOU_GO", "pricing": "FIXED_PRICE", "volume_ids": [ "95cec4c3-af69-42eb-a790-fcacebfdfcea", "dd50b622-1c36-48c2-a485-f4d4937a3ea1" ] } ``` ### OsVolumeDto - **Type:**`object` * **`name` (required)** `string` * **`size` (required)** `number` * **`on_spot_discontinue`** `string`, possible values: `"keep_detached", "move_to_trash", "delete_permanently"` — Optional, by default, nothing is deleted. Should we automatically delete, if instance is deleted because of spot? Allowed values: \* \`keep\_detached\` (default behavior, volume will be detached), \* \`move\_to\_trash\` (will be deleted after 96 hours and counts towards the storage volume quota), \* \`delete\_permanently\` (will be deleted immediately). **Example:** ```json { "name": "custom-os-volume-name", "size": "100", "on_spot_discontinue": "keep_detached" } ``` ### VolumeDto - **Type:**`object` * **`name` (required)** `string` * **`size` (required)** `number` * **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` * **`on_spot_discontinue`** `string`, possible values: `"keep_detached", "move_to_trash", "delete_permanently"` — Optional, by default, nothing is deleted. Should we automatically delete, if instance is deleted because of spot? Allowed values: \* \`keep\_detached\` (default behavior, volume will be detached), \* \`move\_to\_trash\` (will be deleted after 96 hours and counts towards the storage volume quota), \* \`delete\_permanently\` (will be deleted immediately). **Example:** ```json { "name": "custom-os-volume-name", "size": "100", "on_spot_discontinue": "keep_detached", "type": "HDD" } ``` ### DeployInstancePublicDto - **Type:**`object` * **`description` (required)** `string` * **`hostname` (required)** `string` * **`image` (required)** `string` — OS image specification for the created instance. There are two options: 1. OS image type. For a list of supported images, check \`GET /images\` endpoint, \`"image\_type"\` property. To set the name and size, use \`"os\_volume"\` property. 2. Previously customized OS volume ID. (To create an OS volume, first make an instance with existing \`"image"\` type. To customize the volume content, ssh into that instance. Finally, delete the instance but keep the volume.) * **`instance_type` (required)** `string` * **`location_code` (required)** `string` — Location code for the instance and any newly created volumes * **`contract`** `string`, possible values: `"LONG_TERM", "PAY_AS_YOU_GO", "SPOT"` * **`coupon`** `string` * **`existing_volumes`** `array` — IDs of additional existing detached volumes to attach to this new instance when its created. (To configure instance \*\*OS\*\* volume, use \`"image"\` and \`"os\_volume"\` properties.) **Items:** `string` * **`is_spot`** `boolean` — Create a spot instance. Spot instances may be evicted by Verda at any time without warning. * **`os_volume`** `object` — Newly created OS volume name and size (in GB). Use when \`"image"\` property is an OS image type. Object properties: \* \`name\` - Name of the OS volume \* \`size\` - Size of the OS volume in GB \* \`on\_spot\_discontinue\` - Removal policy for the OS volume for spot instances. Optional, by default, nothing is deleted. Allowed values: \`keep\_detached\` (default behavior), \`move\_to\_trash\` (will be deleted after 96 hours and counts towards the storage volume quota), \`delete\_permanently\` (will be deleted immediately). * **`pricing`** `string`, possible values: `"DYNAMIC_PRICE", "FIXED_PRICE"` — This field is deprecated as DYNAMIC\_PRICE is removed. Only FIXED\_PRICE is supported now. * **`ssh_key_ids`** `object` * **`startup_script_id`** `string` * **`volumes`** `array` — Additional (\*\*non-OS\*\*) volumes to create and attach to this new instance. (To configure \*\*OS\*\* volume, use \`"image"\` and \`"os\_volume"\` properties.) **Items:** - **`name` (required)** `string` - **`size` (required)** `number` - **`type` (required)** `string`, possible values: `"HDD", "NVMe", "HDD_Shared", "NVMe_Shared", "NVMe_Local_Storage", "NVMe_Shared_Cluster", "NVMe_OS_Cluster"` - **`on_spot_discontinue`** `string`, possible values: `"keep_detached", "move_to_trash", "delete_permanently"` — Optional, by default, nothing is deleted. Should we automatically delete, if instance is deleted because of spot? Allowed values: \* \`keep\_detached\` (default behavior, volume will be detached), \* \`move\_to\_trash\` (will be deleted after 96 hours and counts towards the storage volume quota), \* \`delete\_permanently\` (will be deleted immediately). **Example:** ```json { "instance_type": "1H100.80S.30V", "image": "ubuntu-22.04-cuda-12.4-docker", "ssh_key_ids": [ "3896acf4-bbc4-466f-b755-a9d278fb58ab" ], "startup_script_id": "a1dc55a5-492d-4a5e-abe2-0c0111343834", "hostname": "my-instance-hostname", "description": "", "location_code": "FIN-01", "os_volume": { "name": "custom-os-volume-name", "size": 100, "on_spot_discontinue": "keep_detached" }, "is_spot": true, "coupon": "COUPON-CODE-2026", "volumes": [ { "name": "additional-volume-name", "size": 1000, "type": "NVMe" } ], "existing_volumes": [ "fbfdf756-daf7-430d-ad80-70f29850f355" ], "contract": "PAY_AS_YOU_GO" } ``` ### PerformInstanceActionPublicDto - **Type:**`object` * **`action` (required)** `string`, possible values: `"boot", "start", "shutdown", "delete", "discontinue", "hibernate", "configure_spot", "force_shutdown", "delete_stuck", "deploy", "transfer"` * **`id` (required)** `object` — Instance ID or list of instance IDs * **`delete_permanently`** `boolean`, default: `false` — Delete the volumes permanently. Only applicable for delete (or discontinue) action, when volume IDs to delete are also provided. * **`volume_ids`** `array` — Volume IDs to delete. Specify empty array to indicate no volumes should be deleted (previously known as "hibernate") **Items:** `string` **Example:** ```json { "action": "boot", "id": [ "bcd70ff1-952a-443f-976a-ac667868af8b" ], "volume_ids": [ "f6a24ee3-625c-45e7-a5f1-cfe4a10a1959" ], "delete_permanently": false } ``` ### InstanceActionResultDto - **Type:**`object` * **`action` (required)** `string`, possible values: `"boot", "start", "shutdown", "delete", "discontinue", "hibernate", "configure_spot", "force_shutdown", "delete_stuck", "deploy", "transfer"` — Action that was requested * **`instanceId` (required)** `string`, format: `uuid` — Instance ID * **`status` (required)** `string`, possible values: `"success", "error"` — Whether the action succeeded or failed * **`error`** `string` — Error message if the action failed * **`statusCode`** `number` — HTTP status code of the error **Example:** ```json { "instanceId": "", "action": "boot", "status": "success", "error": "", "statusCode": 400 } ``` ### GetClusterResponsePublicApiDto - **Type:**`object` * **`cluster_type` (required)** `string` * **`contract` (required)** `string`, possible values: `"LONG_TERM", "PAY_AS_YOU_GO"` — Contract type used for this cluster * **`cpu` (required)** `object` * **`created_at` (required)** `string` * **`description` (required)** `string` * **`gpu` (required)** `object` * **`gpu_memory` (required)** `object` * **`hostname` (required)** `string` * **`id` (required)** `string` * **`image` (required)** `string` — OS image used to deploy the cluster nodes * **`ip` (required)** `string` — Jump host IP address * **`location` (required)** `string` * **`memory` (required)** `object` * **`os_name` (required)** `string` * **`price_per_hour` (required)** `number` * **`ssh_key_ids` (required)** `array` — SSH key IDs used to access the cluster jump host **Items:** `string` * **`status` (required)** `string`, possible values: `"running", "provisioning", "offline", "discontinued", "unknown", "ordered", "notfound", "new", "error", "deleting", "validating", "no_capacity", "installation_failed"` * **`auto_rental_extension`** `boolean` — Deprecated: use extension\_settings instead. * **`extension_settings`** `string`, possible values: `"auto_renew", "pay_as_you_go", "end_contract"` — Extension settings for long-term contracts * **`long_term_period`** `string` — Long-term rental period for this cluster, e.g. 1 week etc. * **`shared_volumes`** `array` — Shared volumes attached to this cluster. There is always one shared volume mounted as /home. **Items:** `string` * **`startup_script_id`** `string` * **`turn_to_pay_as_you_go`** `boolean` — Deprecated: use extension\_settings instead. * **`worker_nodes`** `array` — Worker nodes of this cluster. You can access them from the jump host by executing \`ssh \\` **Items:** `string` **Example:** ```json { "id": "a968a4df-075e-4375-aad0-4400ca187f41", "ip": "1.2.3.4", "status": "running", "created_at": "2023-07-15T14:10:26.654Z", "cpu": { "description": "176 CPU", "number_of_cores": 176 }, "gpu": { "description": "8x A100", "number_of_gpus": 8 }, "gpu_memory": { "description": "80GB GPU RAM", "size_in_gigabytes": 80 }, "memory": { "description": "640GB RAM", "size_in_gigabytes": 640 }, "hostname": "hazy-star-swims-fin-01", "description": "ubuntu-22-04-cuda-12-0-docker-fin-01", "location": "FIN-01", "price_per_hour": 2.481, "cluster_type": "16H200", "image": "ubuntu-22-04-cuda-12-0-docker", "os_name": "Ubuntu 22.04", "startup_script_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea", "ssh_key_ids": [ "dd50b622-1c36-48c2-a485-f4d4937a3ea1" ], "contract": "LONG_TERM", "extension_settings": "auto_renew", "long_term_period": "1 week", "worker_nodes": [ { "id": "1", "hostname": "worker-1", "public_ip": "1.2.3.4", "private_ip": "1.2.3.4", "status": "running" } ], "shared_volumes": [ { "id": "1", "name": "shared-volume-1", "mount_point": "/home", "size_in_gigabytes": 100 } ] } ``` ### SharedVolumeDto - **Type:**`object` * **`name` (required)** `string` — Name of the shared cluster volume * **`size` (required)** `number` — Size of the shared cluster volume in GB **Example:** ```json { "name": "SFS-pmAna3o2", "size": 30000 } ``` ### ExistingSharedVolumeDto - **Type:**`object` * **`id` (required)** `string` — Existing shared volume ID **Example:** ```json { "id": "d6a8fb2c-2b05-4957-aef5-670f4a3281a5" } ``` ### DeployClusterPublicDto - **Type:**`object` * **`cluster_type` (required)** `string` — Cluster instance type. Can be listed using the \`GET /v1/cluster-types\` endpoint. * **`description` (required)** `string` * **`hostname` (required)** `string` * **`image` (required)** `string` — OS image specification for the cluster. For a list of supported images, check \`GET /v1/images/cluster\` endpoint, \`"image\_type"\` property. * **`location_code` (required)** `string` — Location code for the cluster and its shared volume * **`shared_volume` (required)** `object` — Shared cluster volume (SFS) specification. Clusters have one shared volume mounted as /home. The OS volume is ephemeral and created automatically by the system. * **`auto_rental_extension`** `boolean` — Deprecated: use extension\_settings instead. Enable automatic rental extension for long-term contracts. * **`contract`** `string`, possible values: `"PAY_AS_YOU_GO", "LONG_TERM"` — Contract type. For clusters, only PAY\_AS\_YOU\_GO currently supported. * **`existing_volumes`** `array` — Existing shared volumes to attach to the cluster. Should be in the same location as the cluster. Must be previously created and attached to the cluster. **Items:** - **`id` (required)** `string` — Existing shared volume ID * **`extension_settings`** `string`, possible values: `"auto_renew", "pay_as_you_go", "end_contract"` — Extension settings for long-term contracts. Takes priority over auto\_rental\_extension and turn\_to\_pay\_as\_you\_go. * **`ssh_key_ids`** `object` — SSH key IDs to attach to the cluster. Required if image is an OS image type. * **`startup_script_id`** `string` — Startup script ID to run on cluster initialization * **`turn_to_pay_as_you_go`** `boolean` — Deprecated: use extension\_settings instead. Automatically convert to pay-as-you-go after the long-term period ends. **Example:** ```json { "cluster_type": "16H200", "image": "ubuntu-22.04-cuda-12.4-cluster", "ssh_key_ids": [ "31150b48-86f3-4bbe-bc84-8bdd5b489869" ], "startup_script_id": "c686ad76-97e5-4848-b619-c364ace6c2dd", "hostname": "dark-vm-shrinks-fin-01", "description": "ubuntu-22-04-cuda-12-4-16b200-fin-01", "location_code": "FIN-01", "contract": "PAY_AS_YOU_GO", "extension_settings": "auto_renew", "shared_volume": { "name": "cluster-volume-name", "size": 30000 }, "existing_volumes": [] } ``` ### DeployClusterResponsePublicApiDto - **Type:**`object` * **`id` (required)** `string` **Example:** ```json { "id": "9db66dcb-173c-4b0c-9b6a-69ec0ad99b24" } ``` ### PerformClusterActionPublicDto - **Type:**`object` * **`action` (required)** `string`, possible values: `"discontinue"` * **`id` (required)** `string` — Cluster ID **Example:** ```json { "action": "discontinue", "id": "67e39bff-61bd-4d8e-8267-00604c24decb" } ``` ### PerformClusterActionsBulkDto - **Type:**`object` * **`actions` (required)** `array` — Array of cluster actions, one per each cluster **Items:** - **`action` (required)** `string`, possible values: `"discontinue"` - **`id` (required)** `string` — Cluster ID **Example:** ```json { "actions": [ { "action": "discontinue", "id": "c735333f-fff6-4385-ac8f-bdd07c1b8f7a" }, { "action": "discontinue", "id": "941fab61-c618-4dd8-bc9b-b60531ac98bf" } ] } ``` ### InstanceType - **Type:**`object` * **`best_for` (required)** `array` — Use cases for instance type **Items:** `string` * **`cpu` (required)** `object` — CPU details * **`currency` (required)** `string`, possible values: `"usd", "eur"` — Currency type * **`description` (required)** `string` — Instance type description * **`display_name` (required)** `string` — Display name * **`gpu` (required)** `object` — GPU details * **`gpu_memory` (required)** `object` — GPU memory details * **`id` (required)** `string` — Instance type ID * **`instance_type` (required)** `string` — Instance type * **`manufacturer` (required)** `string` — Manufacturer * **`max_dynamic_price` (required)** `string` — Ceiling value for dynamic price * **`memory` (required)** `object` — Memory details * **`model` (required)** `string` — GPU model * **`name` (required)** `string` — GPU model name * **`p2p` (required)** `string` — P2P details * **`price_per_hour` (required)** `string` — Price per hour * **`spot_price` (required)** `string` — Spot price per hour * **`storage` (required)** `object` — Storage details * **`supported_os` (required)** `array` — Supported OS image types **Items:** `string` * **`deploy_warning`** `string` — Deploy warning * **`dynamic_price`** `string` — Current dynamic price * **`serverless_price`** `string` — Current serverless price * **`serverless_spot_price`** `string` — Current serverless spot price **Example:** ```json { "best_for": [ "Giant ML models", "Multi-GPU training", "FP64 calculations", "NVLINK" ], "cpu": { "description": "22 CPU", "number_of_cores": 22 }, "deploy_warning": "Make sure your VM is running on latest Nvidia Driver 525.100+ or newer", "description": "Dedicated Hardware Instance", "gpu": { "description": "1x H100 SXM5 80GB", "number_of_gpus": 1 }, "gpu_memory": { "description": "80GB GPU RAM", "size_in_gigabytes": 80 }, "id": "c01dd00d-0000-4972-ae4e-d429115d055b", "instance_type": "1H100.80S.22V", "memory": { "description": "187GB RAM", "size_in_gigabytes": 187 }, "model": "H100", "name": "H100 SXM5 80GB", "p2p": "600 GB/s", "price_per_hour": "3.17", "spot_price": "0.31", "serverless_price": "1.75", "serverless_spot_price": "0.87", "storage": { "description": "dynamic" }, "currency": "usd", "manufacturer": "NVIDIA", "display_name": "NVIDIA H100 SXM5 80GB", "supported_os": [ "ubuntu-22.04-cuda-12.3", "ubuntu-24.04" ] } ``` ### InstanceAvailabilityResponseDto - **Type:**`object` * **`availabilities` (required)** `array` — Array of available instance types **Items:** `string` * **`location_code` (required)** `string` — Location code **Example:** ```json { "location_code": "FIN-01", "availabilities": [ "1H100.80S.22V", "2H100.80S.60V", "4H100.80S.176V", "8H100.80S.352V" ] } ``` ### ClusterAvailabilityResponseDto - **Type:**`object` * **`availabilities` (required)** `array` — Array of available cluster types **Items:** `string` * **`location_code` (required)** `string` — Location code **Example:** ```json { "location_code": "FIN-01", "availabilities": [ "16H200", "32H200" ] } ``` ### GetKeysResponseDto - **Type:**`object` * **`id` (required)** `string` — SSH key id * **`key` (required)** `string`, format: `date-time` — Public SSH key * **`name` (required)** `string` — Name of the SSH key **Example:** ```json { "id": "f7b3b3b3-1b3b-4b3b-8b3b-3b3b3b3b3b3b", "name": "my-key", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD..." } ``` ### AddKeyDto - **Type:**`object` * **`key` (required)** `string` — Public SSH key * **`name` (required)** `string` — Name of the SSH key **Example:** ```json { "name": "my-key", "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD..." } ``` ### DeleteKeysPublicDto - **Type:**`object` * **`keys` (required)** `string` **Example:** ```json { "keys": [ "aab6c9ee-f1a5-4aad-9189-df8ac97b87ac" ] } ``` ### GetScriptResponseDto - **Type:**`object` * **`id` (required)** `string` — Script ID * **`name` (required)** `string` — Script name * **`script` (required)** `string` — Script content **Example:** ```json { "id": "e8d2fa11-c44c-49c4-b5d5-4b2abf848b60", "name": "My startup script", "script": "#!/bin/bash\n\necho hello world" } ``` ### AddScriptDto - **Type:**`object` * **`name` (required)** `string` — Script name * **`script` (required)** `string` — Script content **Example:** ```json { "name": "My startup script", "script": "#!/bin/bash\n\necho hello world" } ``` ### DeleteScriptsDto - **Type:**`object` * **`scripts` (required)** `string` **Example:** ```json { "scripts": [ "da2a9f2d-1a52-4146-b8bc-ca7095bc0a2d" ] } ``` ### Location - **Type:**`object` * **`code` (required)** `string` — Datacenter location code * **`country_code` (required)** `string` — Country code * **`name` (required)** `string` — Location name **Example:** ```json { "code": "FIN-01", "name": "Finland 1", "country_code": "FI" } ``` ### LongTermPeriodResponseDto - **Type:**`object` * **`code` (required)** `string` — Long term period code * **`discount_percentage` (required)** `number` — Discount percentage * **`is_enabled` (required)** `boolean` — Is long term period enabled * **`name` (required)** `string` — Long term period name * **`unit_name` (required)** `string`, possible values: `"hour", "day", "week", "month", "year"` — Time unit name * **`unit_value` (required)** `number` — Time unit value **Example:** ```json { "code": "3_MONTHS", "name": "3 months", "is_enabled": true, "unit_name": "month", "unit_value": 3, "discount_percentage": 14 } ``` ### ClusterType - **Type:**`object` * **`cluster_type` (required)** `string` — Instance type * **`cpu` (required)** `object` — CPU details * **`currency` (required)** `string`, possible values: `"usd", "eur"` — Currency type * **`gpu` (required)** `object` — GPU details * **`gpu_memory` (required)** `object` — GPU memory details * **`id` (required)** `string` — Instance type ID * **`manufacturer` (required)** `string` — Manufacturer * **`memory` (required)** `object` — Memory details * **`model` (required)** `string` — GPU model * **`name` (required)** `string` — GPU model name * **`node_details` (required)** `array` — Node details **Items:** `string` * **`price_per_hour` (required)** `string` — Price per hour * **`supported_os` (required)** `array` — Supported OS image types **Items:** `string` **Example:** ```json { "id": "c01dd00d-0000-4972-ae4e-d429115d055b", "model": "B200 Cluster", "name": "H100 SXM5 80GB", "cluster_type": "16H200", "cpu": { "description": "22 CPU", "number_of_cores": 22 }, "gpu": { "description": "1x H100 SXM5 80GB", "number_of_gpus": 1 }, "gpu_memory": { "description": "80GB GPU RAM", "size_in_gigabytes": 80 }, "memory": { "description": "187GB RAM", "size_in_gigabytes": 187 }, "price_per_hour": "3.17", "currency": "usd", "manufacturer": "NVIDIA", "node_details": [ { "GPU VRAM": "1536 GB" }, { "AMD Turin CPU": "128 cores" }, { "InfiniBand": "3200 Gbit/s" }, { "Ethernet": "100 Gbit/s" }, { "Uplink": "5 Gbit/s" } ], "supported_os": [ "ubuntu-22.04-cuda-12.3", "ubuntu-24.04" ] } ``` ### ContainerType - **Type:**`object` * **`cpu` (required)** `object` — CPU details * **`currency` (required)** `string`, possible values: `"usd", "eur"` — Currency type * **`gpu` (required)** `object` — GPU details * **`gpu_memory` (required)** `object` — GPU memory details * **`id` (required)** `string` — Instance type ID * **`instance_type` (required)** `string` — Instance type * **`manufacturer` (required)** `string` — Manufacturer * **`memory` (required)** `object` — Memory details * **`model` (required)** `string` — GPU model * **`name` (required)** `string` — GPU model name * **`serverless_price` (required)** `string` — Current serverless price * **`serverless_spot_price` (required)** `string` — Current serverless spot price **Example:** ```json { "id": "60006000-6000-47af-8ff0-600060006004", "model": "RTX PRO 6000", "name": "RTX PRO 6000 96GB", "instance_type": "8RTXPRO6000.224V", "cpu": { "description": "224 CPU", "number_of_cores": 224 }, "gpu": { "description": "8x RTX PRO 6000 96GB", "number_of_gpus": 8 }, "gpu_memory": { "description": "768GB GPU RAM", "size_in_gigabytes": 768 }, "memory": { "description": "680GB RAM", "size_in_gigabytes": 680 }, "serverless_price": "1.529", "serverless_spot_price": "0.7645", "currency": "usd", "manufacturer": "NVIDIA" } ```