openapi: 3.1.0 info: title: Fluence Billing Storage API description: "# Introduction\n\nThe Fluence API gives programmatic access to the decentralized Fluence compute marketplace, letting you find, rent, and\nmanage compute resources without the web UI. Integrate Fluence directly into your applications and automated workflows.\n\nBase URL: `https://api.fluence.dev`\n\nThe documentation starts with a high-level overview of design and technology, followed by endpoint reference details.\nFor additional user guides, see the [Fluence Documentation](https://fluence.dev/docs/build/overview).\n\n## Requests\n\nSend HTTPS requests to the Fluence API. All request and response bodies are JSON.\n\n- Set `Content-Type: application/json` for POST, PUT, and PATCH calls.\n- All examples assume the default `Accept: application/json` header.\n\n### Example\n\n```bash\ncurl -X POST https://api.fluence.dev/v1/public_ips \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: X-API-KEY \" \\\n -d '{\n \"addressType\": \"V4\",\n \"clusterId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"my-public-ip\"\n }'\n```\n\n### HTTP request methods\n\nThe interface responds to different methods depending on the action required.\n\n| Method | Description |\n|--------|----------------------------------------------------------------------------------------------------|\n| GET | Retrieves resource information. These requests are read-only and won't modify any resources. |\n| POST | Usually used to create new resources. Include all required attributes in the request body as JSON. |\n| PATCH | Update specific attributes of a resource. |\n| PUT | Updates an entire resource by replacing it with the provided data, regardless of current values. |\n| DELETE | Removes resources. |\n\n## Responses\n\nSuccessful requests return `2xx` status codes and a JSON object. \n\nIf an error occurs, Fluence returns an `4xx` or `5xx` status code and a JSON object describing the problem.\n\n### Response codes\n\n| Code | Description |\n|------|--------------------------------------------------------------------------------|\n| 2xx | **Success** - The request was successfully received, understood, and processed |\n| 4xx | **Client Error** - The request contains invalid syntax or cannot be fulfilled |\n| 400 | Bad request - Invalid parameters or malformed JSON |\n| 401 | Unauthorized - API key missing or invalid |\n| 403 | Forbidden - Authenticated but not allowed |\n| 404 | Not found - Resource does not exist |\n| 422 | Unprocessable Entity - Well-formed request but cannot be processed |\n| 500 | Internal server error - Unexpected error on our side. |\n\n### Error Response Format\n\nWhen an error occurs, the response includes a status message and a body in JSON format with an `error` field with\nadditional information. For example:\n\n```bash\n HTTP/1.1 403 Forbidden\n {\n \"error\": \"Auth failed. No such API Key\",\n }\n```\n\n## Authentication\n\nAll endpoints require a jwt token supplied as a Bearer token in the `Authorization` header or an API key provided as the value of the `X-API-KEY` header. For example:\n\n```bash\ncurl -H 'Authorization: Bearer my_authentication_token'\n```\n\n```bash\ncurl -H 'Authorization: X-API-KEY my_api_key'\n```\n\n### Managing API Keys\n\nCreate and manage keys in\nthe [Fluence Console › Settings › API Keys](https://console.fluence.network/settings/api-keys).\n\n- **Read-only keys** – retrieve information only\n- **Full-access keys** – manage all resources\n\n> **Important**: API keys are only displayed once during creation for security reasons. Store them safely - if a key is\n> lost, expired or compromised, you'll need to delete it and create a new one.\n\n### Key Security\n\nAPI keys function as complete authentication credentials, similar to a username/password combination. Therefore:\n\n- Keep your keys secure and never share them\n- Use HTTPS for all API requests\n- Rotate keys periodically\n- Set appropriate expiration dates when creating keys\n- Delete compromised keys immediately\n\n## Cloud-init\n\nOptional `cloudInit.userData` on `POST /v2/vms` lets you bootstrap the VM with a\n[cloud-init](https://cloudinit.readthedocs.io/) configuration. The payload is\nforwarded to the VM backend verbatim; vodopad does not parse or validate the\ncontent beyond a 16 KiB byte cap.\n\n```bash\ncurl -X POST https://api.fluence.dev/v2/vms \\\n -H \"Authorization: X-API-KEY \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"clusterId\": \"...\",\n \"name\": \"demo\",\n \"configurationId\": \"...\",\n \"bootDisk\": { \"...\": \"...\" },\n \"sshKeys\": [\"...\"],\n \"cloudInit\": {\n \"userData\": \"#cloud-config\\nruncmd:\\n - echo hello\\n\"\n }\n }'\n```\n\nNotes:\n\n- **Create-only.** `userData` is meaningful only on `POST /v2/vms`. `PATCH` requests have no `userData` field; sending one is dropped during JSON deserialization.\n- **Ephemeral.** The content is stored only until the VM transitions to `Launched` (or `Failed` on create-deadline, or `Terminating`/`Terminated` on termination), then erased in the same transaction as the status change. After that, listing or fetching the VM returns a non-null `cloudInit` object (no fields) as a permanent marker but never the original content.\n- **Length limit.** Maximum 16 KiB enforced as a **byte count** (UTF-8 multi-byte characters are counted by their byte size, not code-point count). Oversize requests are rejected with `400 Bad Request`.\n- **Privacy.** The content is never echoed back through any API endpoint. With request-body debug logging enabled (`RUST_LOG=vodopad::api::server=debug` or `sqlx=debug`), `userData` will appear in logs — see Operator notes below.\n- **Backend rejection.** Malformed userData (e.g. invalid YAML) is detected by the VM backend during provisioning and surfaces as a `Failed` VM status, not a synchronous `400`.\n\n### Operator notes\n\n- The side-table `crd.user_virtual_machine_cloud_init` keeps a row per VM that ever had cloud-init. After successful handoff to the VM backend (status `Launching` or `Launched`) — or upon terminal cleanup (`Failed` from create-deadline timeout, or `Terminating`/`Terminated` from termination) — the row's `user_data` column is set to `NULL` in the same transaction as the status change. The row itself stays as a permanent \"had cloud-init\" marker — its existence is the source of truth for the non-null `cloudInit` object on the response.\n- WAL/audit logs and `pg_dump` backups can preserve the **pre-wipe** state (raw `user_data` bytes) until they roll over. Treat these artefacts as carrying potentially-sensitive material; restrict access and retention accordingly.\n- Do not enable `RUST_LOG=vodopad::api::server=debug` in production — the request/response body logger (`buffer_and_print` in `api/server.rs`) writes every UTF-8 body verbatim to `tracing::debug!` with no path-based redaction, and runs *before* validation, so even rejected oversize `userData` payloads end up in the log.\n- Do not set `RUST_LOG=sqlx=debug` in production — sqlx debug logs can include bind values, which would expose `userData` for in-flight queries.\n" contact: name: Cloudless Labs license: name: AGPL-3 identifier: AGPL-3 version: 0.10.0 security: - api_key: [] tags: - name: Storage description: Endpoints to create, view, update and delete storage resources paths: /v1/storages: get: tags: - Storage operationId: get_users_storages parameters: - name: ids in: query required: false schema: type: array items: $ref: '#/components/schemas/UserStorageId' - name: name in: query description: Case-insensitive ILIKE match on name; '%' and '_' in the value act as SQL wildcards (any-sequence / any-single-char), not literal characters. required: false schema: type: string example: my-vm - name: storageType in: query required: false schema: $ref: '#/components/schemas/StorageType' - name: status in: query description: 'Keep only storages whose status is in this set. Repeat the parameter using bracket notation (`status[0]=ready&status[1]=new`); a single `status=ready` is also accepted. An empty set applies no filtering.' required: false schema: type: array items: $ref: '#/components/schemas/UserStorageStatusDto' - name: excludeStatus in: query description: 'Drop storages whose status is in this set (`excludeStatus[0]=removed`). Combined with `status`, the result is the intersection. An empty set applies no filtering.' required: false schema: type: array items: $ref: '#/components/schemas/UserStorageStatusDto' - name: excludeAttached in: query description: 'When `true`, exclude storages attached to any VM (as a boot disk or a data disk), returning only unattached ones. Absent or `false` applies no filtering.' required: false schema: type: boolean - name: sort in: query required: false schema: $ref: '#/components/schemas/SortFieldDto' - name: order in: query required: false schema: $ref: '#/components/schemas/SortOrderDto' - name: page in: query required: false schema: type: integer format: u-int64 minimum: 0 - name: perPage in: query required: false schema: type: integer format: u-int64 minimum: 0 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse_UserStorageDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: bad_request error: Wrong parameters '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unauthorized error: Auth token invalid or missing '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: forbidden error: Not allowed to call this endpoint '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unprocessable_entity error: Unable to process the entity '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: internal_server_error error: Unexpected server error security: - access_jwt_token: - storage:read - api_key: - storage:read post: tags: - Storage operationId: create_users_storage requestBody: description: Create a new user storage content: application/json: schema: $ref: '#/components/schemas/CreateUserStorageRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserStorageDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: bad_request error: Wrong parameters '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unauthorized error: Auth token invalid or missing '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: forbidden error: Not allowed to call this endpoint '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unprocessable_entity error: Unable to process the entity '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: internal_server_error error: Unexpected server error security: - access_jwt_token: - storage:write - api_key: - storage:write /v1/storages/default_images: get: tags: - Storage operationId: get_default_images responses: '200': description: List of default OS images content: application/json: schema: $ref: '#/components/schemas/CollectionResponse_DefaultImageDto' /v1/storages/delete: post: tags: - Storage operationId: delete_users_storages requestBody: description: Storages ids to remove content: application/json: schema: $ref: '#/components/schemas/UserStorageIdsDto' required: true responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/UserStorageDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: bad_request error: Wrong parameters '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unauthorized error: Auth token invalid or missing '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: forbidden error: Not allowed to call this endpoint '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unprocessable_entity error: Unable to process the entity '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: internal_server_error error: Unexpected server error security: - access_jwt_token: - storage:write - api_key: - storage:write /v1/storages/types: get: tags: - Storage operationId: get_storage_types responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CollectionResponse_StorageTypeInfoDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: bad_request error: Wrong parameters '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unauthorized error: Auth token invalid or missing '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: forbidden error: Not allowed to call this endpoint '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unprocessable_entity error: Unable to process the entity '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: internal_server_error error: Unexpected server error security: - access_jwt_token: - storage:read - api_key: - storage:read /v1/storages/{storage_id}: get: tags: - Storage operationId: get_users_storage parameters: - name: storage_id in: path description: The ID of the user storage to fetch required: true schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserStorageDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: bad_request error: Wrong parameters '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unauthorized error: Auth token invalid or missing '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: forbidden error: Not allowed to call this endpoint '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unprocessable_entity error: Unable to process the entity '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: internal_server_error error: Unexpected server error security: - access_jwt_token: - storage:read - api_key: - storage:read delete: tags: - Storage operationId: delete_users_storage parameters: - name: storage_id in: path description: The ID of the user storage to remove required: true schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserStorageDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: bad_request error: Wrong parameters '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unauthorized error: Auth token invalid or missing '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: forbidden error: Not allowed to call this endpoint '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unprocessable_entity error: Unable to process the entity '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: internal_server_error error: Unexpected server error security: - access_jwt_token: - storage:write - api_key: - storage:write patch: tags: - Storage operationId: update_users_storage parameters: - name: storage_id in: path description: The ID of the user storage to update required: true schema: type: string format: uuid requestBody: description: Update an existing user storage content: application/json: schema: $ref: '#/components/schemas/UpdateUserStorageRequest' required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserStorageDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: bad_request error: Wrong parameters '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unauthorized error: Auth token invalid or missing '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: forbidden error: Not allowed to call this endpoint '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: unprocessable_entity error: Unable to process the entity '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: code: internal_server_error error: Unexpected server error security: - access_jwt_token: - storage:write - api_key: - storage:write components: schemas: StorageRoleDto: type: string enum: - BOOT - DATA NewStorageType: type: string enum: - NVME CreateUserStorageRequest: type: object required: - clusterId - name - storageType - volumeGb - replicated properties: clusterId: $ref: '#/components/schemas/ClusterId' name: type: string osImage: type: - string - 'null' example: https://example.com/image.qcow2 replicated: type: boolean storageType: $ref: '#/components/schemas/NewStorageType' volumeGb: type: integer format: u-int32 minimum: 0 PaginatedResponse_UserStorageDto: type: object required: - items - pagination properties: items: type: array items: type: object required: - id - userId - clusterId - name - storageType - status - role - volumeGb - replicated - attachedTo - createdAt properties: allowedActions: type: array items: $ref: '#/components/schemas/StorageActionDto' description: 'Operations currently legal for this storage''s `status`, derived from the same guards as request validation.' attachedTo: type: array items: $ref: '#/components/schemas/UserVmId' clusterId: $ref: '#/components/schemas/ClusterId' createdAt: type: string format: date-time id: $ref: '#/components/schemas/UserStorageId' image: oneOf: - type: 'null' - $ref: '#/components/schemas/StorageImageDto' initUrl: type: - string - 'null' lastPaidAt: type: - string - 'null' format: date-time name: type: string paidUntil: type: - string - 'null' format: date-time priceHourlyUsd: type: - string - 'null' description: 'Request-time hourly price snapshot in USD, serialized as a string; absent when the catalog has no active price for this resource. A UI estimate, not the amount billed.' example: '0.05' priceMonthlyUsd: type: - string - 'null' description: 'Request-time monthly price snapshot in USD (`hourly × 730`), serialized as a string. See `price_hourly_usd`.' example: '36.50' readySince: type: - string - 'null' format: date-time removedAt: type: - string - 'null' format: date-time replicated: type: boolean role: $ref: '#/components/schemas/StorageRoleDto' status: $ref: '#/components/schemas/UserStorageStatusDto' storageType: $ref: '#/components/schemas/StorageTypeDto' userId: $ref: '#/components/schemas/UserId' volumeGb: type: integer format: u-int64 minimum: 0 pagination: $ref: '#/components/schemas/PaginationInfo' ErrorCode: type: string description: 'Stable, machine-readable error code carried by every non-2xx response. Clients should branch on `code` rather than parsing the human-readable `error` string. Status-derived variants cover any error that does not supply a more specific code; semantic variants are set explicitly at the construction site (see `VodopadError::code`).' enum: - bad_request - unauthorized - forbidden - not_found - conflict - unprocessable_entity - not_acceptable - insufficient_balance - service_unavailable - internal_server_error UserStorageStatusDto: type: string enum: - new - created - ready - updating - failed - removing - removed CollectionResponse_StorageTypeInfoDto: type: object required: - items properties: items: type: array items: type: object required: - storageType - bootDisk - minVolumeGb - maxBandwidthReadMib - maxBandwidthWriteMib - maxIopsRead - maxIopsWrite properties: bootDisk: type: boolean maxBandwidthReadMib: type: integer format: u-int64 minimum: 0 maxBandwidthWriteMib: type: integer format: u-int64 minimum: 0 maxIopsRead: type: integer format: u-int64 minimum: 0 maxIopsWrite: type: integer format: u-int64 minimum: 0 minVolumeGb: type: integer format: u-int64 minimum: 0 storageType: $ref: '#/components/schemas/StorageTypeDto' UserVmId: type: string format: uuid CollectionResponse_DefaultImageDto: type: object required: - items properties: items: type: array items: type: object required: - id - name - distribution - slug - downloadUrl - iconUrl - username - createdAt - updatedAt properties: createdAt: type: string example: '2024-01-01T00:00:00Z' distribution: type: string example: Ubuntu downloadUrl: type: string example: https://cloud-images.ubuntu.com/releases/24.04/release/ubuntu-24.04-server-cloudimg-amd64.img iconUrl: type: string example: https://f2nrfq3ufzjj08qq.public.blob.vercel-storage.com/images_icons/ubuntu-icon-fvmHzDIRMkyrxr21oEBTo0IV0emlv5.svg id: type: string example: da1e99153be74618820a164eebcbdc66 name: type: string example: 24.04 (LTS) x64 slug: type: string example: ubuntu-24-04-x64 updatedAt: type: string example: '2024-01-01T00:00:00Z' username: type: string example: ubuntu ErrorBody: type: object required: - error - code properties: code: $ref: '#/components/schemas/ErrorCode' description: The stable, machine-readable error code. error: type: string description: The human-readable error message. ClusterId: type: string format: uuid StorageImageDto: type: object description: 'Slim reference to the OS image a storage was created from. Present only when the storage''s `init_url` matches a catalog image; absent for custom URLs and data disks.' required: - id - name - slug - distribution properties: distribution: type: string example: Ubuntu id: type: string example: da1e99153be74618820a164eebcbdc66 name: type: string example: 24.04 (LTS) x64 slug: type: string example: ubuntu-24-04-x64 UserStorageId: type: string format: uuid StorageActionDto: type: string description: 'Wire representation of [`StorageAction`] — the operations exposed via `UserStorageDto.allowedActions`.' enum: - update - delete - attachToVm SortOrderDto: type: string enum: - asc - desc UserId: type: string format: uuid StorageType: type: string enum: - HDD - SSD - NVMe UpdateUserStorageRequest: type: object properties: name: type: - string - 'null' volumeGb: type: - integer - 'null' format: u-int32 minimum: 0 UserStorageDto: type: object required: - id - userId - clusterId - name - storageType - status - role - volumeGb - replicated - attachedTo - createdAt properties: allowedActions: type: array items: $ref: '#/components/schemas/StorageActionDto' description: 'Operations currently legal for this storage''s `status`, derived from the same guards as request validation.' attachedTo: type: array items: $ref: '#/components/schemas/UserVmId' clusterId: $ref: '#/components/schemas/ClusterId' createdAt: type: string format: date-time id: $ref: '#/components/schemas/UserStorageId' image: oneOf: - type: 'null' - $ref: '#/components/schemas/StorageImageDto' initUrl: type: - string - 'null' lastPaidAt: type: - string - 'null' format: date-time name: type: string paidUntil: type: - string - 'null' format: date-time priceHourlyUsd: type: - string - 'null' description: 'Request-time hourly price snapshot in USD, serialized as a string; absent when the catalog has no active price for this resource. A UI estimate, not the amount billed.' example: '0.05' priceMonthlyUsd: type: - string - 'null' description: 'Request-time monthly price snapshot in USD (`hourly × 730`), serialized as a string. See `price_hourly_usd`.' example: '36.50' readySince: type: - string - 'null' format: date-time removedAt: type: - string - 'null' format: date-time replicated: type: boolean role: $ref: '#/components/schemas/StorageRoleDto' status: $ref: '#/components/schemas/UserStorageStatusDto' storageType: $ref: '#/components/schemas/StorageTypeDto' userId: $ref: '#/components/schemas/UserId' volumeGb: type: integer format: u-int64 minimum: 0 PaginationInfo: type: object required: - totalRecords - filteredRecords - totalPages - currentPage - perPage properties: currentPage: type: integer format: u-int64 minimum: 0 filteredRecords: type: integer format: u-int64 minimum: 0 perPage: type: integer format: u-int64 minimum: 0 totalPages: type: integer format: u-int32 minimum: 0 totalRecords: type: integer format: u-int64 minimum: 0 UserStorageIdsDto: type: object required: - ids properties: ids: type: array items: $ref: '#/components/schemas/UserStorageId' SortFieldDto: type: string description: Field to order list results by. `status` sorts by the status label text, not a lifecycle order. enum: - createdAt - name - status StorageTypeDto: type: string enum: - HDD - SSD - NVME securitySchemes: access_jwt_token: type: http scheme: bearer bearerFormat: JWT description: JWT token issued by Fluence api_key: type: apiKey in: header name: X-API-KEY