FlexVM

OpenAPI documentation for the i3D.net FlexVM API.

Get all your FlexVM Clouds

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

descriptionstringOptional

An optional free-form description of your Cloud.

Example: This Cloud is meant for acceptance tests.

idstring · uuidRead-onlyRequired

Cloud UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

Cloud name.

Example: My private cloud

sitestringRequired

The i3D site (location) in which the Cloud is located. One of: frmtl1, nlrtm1.

Example: frmtl1

instance_typestringRequired

The FlexMetal instance type shared by every node in the Cloud.

Example: bm9.hmm.gpu.4rtx4000.64

created_atstring · date-timeRead-onlyRequired

When the Cloud was created (RFC3339).

Example: 2026-06-01T12:45:14Z

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/flexVM/clouds

GET /v3/flexVM/clouds HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "description": "This Cloud is meant for acceptance tests.",
    "id": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "My private cloud",
    "site": "frmtl1",
    "instance_type": "bm9.hmm.gpu.4rtx4000.64",
    "created_at": "2026-06-01T12:45:14Z"
  }
]

Create a new FlexVM Cloud

post

Authorizations

PRIVATE-TOKENstringRequired

Body

descriptionstringOptional

An optional free-form description of your Cloud.

Example: This Cloud is meant for acceptance tests.

idstring · uuidRead-onlyRequired

Cloud UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

Cloud name.

Example: My private cloud

sitestringRequired

The i3D site (location) in which the Cloud is located. One of: frmtl1, nlrtm1.

Example: frmtl1

instance_typestringRequired

The FlexMetal instance type shared by every node in the Cloud.

Example: bm9.hmm.gpu.4rtx4000.64

created_atstring · date-timeRead-onlyRequired

When the Cloud was created (RFC3339).

Example: 2026-06-01T12:45:14Z

Responses

201

Created

application/json

descriptionstringOptional

An optional free-form description of your Cloud.

Example: This Cloud is meant for acceptance tests.

idstring · uuidRead-onlyRequired

Cloud UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

Cloud name.

Example: My private cloud

sitestringRequired

The i3D site (location) in which the Cloud is located. One of: frmtl1, nlrtm1.

Example: frmtl1

instance_typestringRequired

The FlexMetal instance type shared by every node in the Cloud.

Example: bm9.hmm.gpu.4rtx4000.64

created_atstring · date-timeRead-onlyRequired

When the Cloud was created (RFC3339).

Example: 2026-06-01T12:45:14Z

400

Invalid request body

403

Invalid credentials

409

Conflict

422

Unprocessable content

500

Internal Server Error

application/json

post/v3/flexVM/clouds

POST /v3/flexVM/clouds HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "description": "This Cloud is meant for acceptance tests.",
  "name": "My private cloud",
  "site": "frmtl1",
  "instance_type": "bm9.hmm.gpu.4rtx4000.64"
}

{
  "description": "This Cloud is meant for acceptance tests.",
  "id": "019256ab-1554-73a7-b091-f024b0a724ea",
  "name": "My private cloud",
  "site": "frmtl1",
  "instance_type": "bm9.hmm.gpu.4rtx4000.64",
  "created_at": "2026-06-01T12:45:14Z"
}

Get a specific FlexVM Cloud

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

Responses

200

application/json

descriptionstringOptional

An optional free-form description of your Cloud.

Example: This Cloud is meant for acceptance tests.

idstring · uuidRead-onlyRequired

Cloud UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

Cloud name.

Example: My private cloud

sitestringRequired

The i3D site (location) in which the Cloud is located. One of: frmtl1, nlrtm1.

Example: frmtl1

instance_typestringRequired

The FlexMetal instance type shared by every node in the Cloud.

Example: bm9.hmm.gpu.4rtx4000.64

created_atstring · date-timeRead-onlyRequired

When the Cloud was created (RFC3339).

Example: 2026-06-01T12:45:14Z

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

get/v3/flexVM/clouds/{cloudUuid}

GET /v3/flexVM/clouds/{cloudUuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

{
  "description": "This Cloud is meant for acceptance tests.",
  "id": "019256ab-1554-73a7-b091-f024b0a724ea",
  "name": "My private cloud",
  "site": "frmtl1",
  "instance_type": "bm9.hmm.gpu.4rtx4000.64",
  "created_at": "2026-06-01T12:45:14Z"
}

Delete a FlexVM Cloud

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

Responses

204

No Content

No content

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

delete/v3/flexVM/clouds/{cloudUuid}

DELETE /v3/flexVM/clouds/{cloudUuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get all your FlexVM Cloud Nodes

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

idstringRead-onlyRequired

Cloud Node UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

Cloud Node name.

Example: proxmox-dev-1

serialstringRequired

Cloud Node serial number. Known once the Node has been allocated.

Example: 3W2GN83

statusstringRead-onlyRequired

The status of the Node.

created
requested
bootstrapping
running
failed
deleting
deleted

Example: running

created_atstringRead-onlyRequired

When the Node was created (RFC3339).

Example: 2026-06-01T12:45:14Z

deleted_atstring · nullableRead-onlyOptional

When the Node was deleted (RFC3339). Null while the Node still exists.

Example: 2026-06-15T09:30:00Z

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

get/v3/flexVM/clouds/{cloudUuid}/nodes

GET /v3/flexVM/clouds/{cloudUuid}/nodes HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "cloud": "019256ab-1554-73a7-b091-f024b0a724ea",
    "id": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "proxmox-dev-1",
    "serial": "3W2GN83",
    "status": "running",
    "created_at": "2026-06-01T12:45:14Z",
    "deleted_at": "2026-06-15T09:30:00Z"
  }
]

Add a new Node to your FlexVM Cloud

post

Scale your Private Cloud by adding a bare metal Node. The Node uses the Cloud's instance type and location; no request body is required.

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

Responses

201

Created

application/json

idstringRead-onlyRequired

Cloud Node UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

Cloud Node name.

Example: proxmox-dev-1

serialstringRequired

Cloud Node serial number. Known once the Node has been allocated.

Example: 3W2GN83

statusstringRead-onlyRequired

The status of the Node.

created
requested
bootstrapping
running
failed
deleting
deleted

Example: running

created_atstringRead-onlyRequired

When the Node was created (RFC3339).

Example: 2026-06-01T12:45:14Z

deleted_atstring · nullableRead-onlyOptional

When the Node was deleted (RFC3339). Null while the Node still exists.

Example: 2026-06-15T09:30:00Z

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

post/v3/flexVM/clouds/{cloudUuid}/nodes

POST /v3/flexVM/clouds/{cloudUuid}/nodes HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

{
  "cloud": "019256ab-1554-73a7-b091-f024b0a724ea",
  "id": "019256ab-1554-73a7-b091-f024b0a724ea",
  "name": "proxmox-dev-1",
  "serial": "3W2GN83",
  "status": "running",
  "created_at": "2026-06-01T12:45:14Z",
  "deleted_at": "2026-06-15T09:30:00Z"
}

Get a specific FlexVM Cloud Node

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

nodeUuidstringRequired

Responses

200

application/json

idstringRead-onlyRequired

Cloud Node UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

Cloud Node name.

Example: proxmox-dev-1

serialstringRequired

Cloud Node serial number. Known once the Node has been allocated.

Example: 3W2GN83

statusstringRead-onlyRequired

The status of the Node.

created
requested
bootstrapping
running
failed
deleting
deleted

Example: running

created_atstringRead-onlyRequired

When the Node was created (RFC3339).

Example: 2026-06-01T12:45:14Z

deleted_atstring · nullableRead-onlyOptional

When the Node was deleted (RFC3339). Null while the Node still exists.

Example: 2026-06-15T09:30:00Z

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

get/v3/flexVM/clouds/{cloudUuid}/nodes/{nodeUuid}

GET /v3/flexVM/clouds/{cloudUuid}/nodes/{nodeUuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

{
  "cloud": "019256ab-1554-73a7-b091-f024b0a724ea",
  "id": "019256ab-1554-73a7-b091-f024b0a724ea",
  "name": "proxmox-dev-1",
  "serial": "3W2GN83",
  "status": "running",
  "created_at": "2026-06-01T12:45:14Z",
  "deleted_at": "2026-06-15T09:30:00Z"
}

Remove a Node from your FlexVM Cloud

delete

Scale down your Private Cloud by removing a Node. Rejected with 409 while the Node still hosts VMs or is not in a deletable state.

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

nodeUuidstringRequired

Responses

202

Accepted

No content

403

Invalid credentials

404

Not Found

409

Conflict — the Node still hosts active VMs (node_has_vms) or is not in a deletable state (node_not_running)

422

Unprocessable content

500

Internal Server Error

application/json

delete/v3/flexVM/clouds/{cloudUuid}/nodes/{nodeUuid}

DELETE /v3/flexVM/clouds/{cloudUuid}/nodes/{nodeUuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get all available FlexVM Instance Types

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

idstringRead-onlyRequired

FlexVM Instance Type UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRead-onlyRequired

The name of the instance type.

Example: vm.gpu.1rtx4000.15c.248g

vcpuinteger · integerRead-onlyRequired

The number of vCPU resources.

Example: 4

memoryinteger · integerRead-onlyRequired

The amount of memory in MB.

Example: 4096

diskinteger · integerRead-onlyRequired

The size of the OS disk in GB.

Example: 256

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

get/v3/flexVM/instanceTypes

GET /v3/flexVM/instanceTypes HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "vm.gpu.1rtx4000.15c.248g",
    "vcpu": 4,
    "memory": 4096,
    "disk": 256,
    "pciDevices": [
      {
        "type": "gpu",
        "spec": "rtx4000"
      }
    ]
  }
]

Get all available FlexVM Images

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

idstring · uuidRead-onlyOptional

Image UUID.

Example: 019d298c-e460-7b09-b48b-c55b3100bf54

namestringRead-onlyRequired

Image name.

Example: ubuntu-2404-server-amd64

osstringRead-onlyRequired

The name of the OS that the image represents.

Example: Ubuntu LTS 24.04

os_typestringRead-onlyRequired

The OS type the image represents. Can be "linux" or "windows"

Example: linux

403

Invalid credentials

404

Not Found

500

Internal Server Error

application/json

get/v3/flexVM/images

GET /v3/flexVM/images HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "019d298c-e460-7b09-b48b-c55b3100bf54",
    "name": "ubuntu-2404-server-amd64",
    "os": "Ubuntu LTS 24.04",
    "os_type": "linux"
  }
]

Get all your FlexVMs within the given Cloud

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

Query parameters

statusstringRequired

Filter by status [provisioning, created, starting, running, stopping, stopped, paused, failed, deleting, deleted]

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

idstringRead-onlyRequired

Cloud VM UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

VM name. This will also be the OS's hostname. Must be lower-case, allowed characters: [a-z0-9-.]

Example: development.ubuntu-2404

descriptionstringOptional

An optional free-form description of your VM.

Example: DB1 VM

statusstringRead-onlyRequired

The status of the VM.

provisioning

created

starting

running

stopping

stopped

paused

failed

deleting

deleted

Example: running

created_atstringRead-onlyRequired

VM creation timestamp.

deleted_atstringOptional

VM deletion timestamp.

tagsstring[]Read-onlyRequired

Tags attached to the VM at create time. Empty array if untagged.

Example: ["env:build","project:odyssey"]

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

get/v3/flexVM/clouds/{cloudUuid}/vms

GET /v3/flexVM/clouds/{cloudUuid}/vms?status=text HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "development.ubuntu-2404",
    "description": "DB1 VM",
    "instance_type": "vm.gpu.1rtx4000.15c.248g",
    "image": "vm.gpu.1rtx4000.15c.248g",
    "status": "running",
    "ips": [
      {
        "address": "1.2.3.4",
        "public": "true"
      }
    ],
    "cloud": "019256ab-1554-73a7-b091-f024b0a724ea",
    "node": "019256ab-1554-73a7-b091-f024b0a724ea",
    "created_at": "text",
    "deleted_at": "text",
    "tags": [
      "env:build",
      "project:odyssey"
    ]
  }
]

Create a new FlexVM

post

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

Body

descriptionstringOptional

An optional free-form description of your VM.

Example: DB1 VM

image_namestringOptional

The image name to create the VM from.

Example: ubuntu-2404-server-amd64

instance_type_namestringOptional

The instance type name to base the VM on.

Example: vm.gpu.1rtx4000.15c.248g

namestringRequired

VM name. This will also be the OS's hostname. Must be lower-case, allowed characters: [a-z0-9-.]

Example: development.ubuntu-2404

ssh_keysstring[]Optional

Provide your public SSH key(s). For non-Windows images, exactly one of ssh_keys or user_data must be specified: a request that sets neither is rejected with a 422. Windows images do not use SSH keys, so both ssh_keys and user_data are optional for them. A request that sets both is always rejected with a 422, regardless of OS. When user_data is provided instead, configure SSH access through it.

Example:

ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBHo8IaPkQ6UnDZvi4F4RBSouRa6Gtysdg2EF+SIXheVF2SGBQ2uH7RfDjXRfvq4VpHJrKYs4kWfNoHQg8ZG6PH4= ecdsa-key-20240131

tagsstring[]Optional

Free-form labels (e.g. project:odyssey, env:build) used for grouping in the monthly usage report. Set at VM create only — values must be non-empty strings up to 128 chars.

Example: ["project:odyssey","env:build"]

Responses

201

Created

application/json

idstringRead-onlyRequired

Cloud VM UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

VM name. This will also be the OS's hostname. Must be lower-case, allowed characters: [a-z0-9-.]

Example: development.ubuntu-2404

descriptionstringOptional

An optional free-form description of your VM.

Example: DB1 VM

statusstringRead-onlyRequired

The status of the VM.

provisioning

created

starting

running

stopping

stopped

paused

failed

deleting

deleted

Example: running

created_atstringRead-onlyRequired

VM creation timestamp.

deleted_atstringOptional

VM deletion timestamp.

tagsstring[]Read-onlyRequired

Tags attached to the VM at create time. Empty array if untagged.

Example: ["env:build","project:odyssey"]

400

Invalid request body

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

post/v3/flexVM/clouds/{cloudUuid}/vms

POST /v3/flexVM/clouds/{cloudUuid}/vms HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 739

{
  "description": "DB1 VM",
  "image_name": "ubuntu-2404-server-amd64",
  "instance_type_name": "vm.gpu.1rtx4000.15c.248g",
  "name": "development.ubuntu-2404",
  "ssh_keys": [
    "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBHo8IaPkQ6UnDZvi4F4RBSouRa6Gtysdg2EF+SIXheVF2SGBQ2uH7RfDjXRfvq4VpHJrKYs4kWfNoHQg8ZG6PH4= ecdsa-key-20240131"
  ],
  "user_data": {
    "data": "#cloud-config\nhostname: my-custom-vm-hostname\nmanage_etc_hosts: true\nfqdn: my-custom-vm-hostname\nuser: my-custom-user\nssh_authorized_keys:\n  - ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIHwdgjY0AlmkeLknBpoVmJg/quNSifyBHEK1MREpV4Ri john.doe@i3d.net\nchpasswd:\n  expire: False\nusers:\n  - default\npackage_upgrade: true",
    "is_base64": false
  },
  "tags": [
    "project:odyssey",
    "env:build"
  ]
}

{
  "id": "019256ab-1554-73a7-b091-f024b0a724ea",
  "name": "development.ubuntu-2404",
  "description": "DB1 VM",
  "instance_type": "vm.gpu.1rtx4000.15c.248g",
  "image": "vm.gpu.1rtx4000.15c.248g",
  "status": "running",
  "ips": [
    {
      "address": "1.2.3.4",
      "public": "true"
    }
  ],
  "cloud": "019256ab-1554-73a7-b091-f024b0a724ea",
  "node": "019256ab-1554-73a7-b091-f024b0a724ea",
  "created_at": "text",
  "deleted_at": "text",
  "tags": [
    "env:build",
    "project:odyssey"
  ]
}

Get a specific FlexVM within the given Cloud

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

vmUuidstringRequired

Responses

200

application/json

idstringRead-onlyRequired

Cloud VM UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

VM name. This will also be the OS's hostname. Must be lower-case, allowed characters: [a-z0-9-.]

Example: development.ubuntu-2404

descriptionstringOptional

An optional free-form description of your VM.

Example: DB1 VM

statusstringRead-onlyRequired

The status of the VM.

provisioning

created

starting

running

stopping

stopped

paused

failed

deleting

deleted

Example: running

created_atstringRead-onlyRequired

VM creation timestamp.

deleted_atstringOptional

VM deletion timestamp.

tagsstring[]Read-onlyRequired

Tags attached to the VM at create time. Empty array if untagged.

Example: ["env:build","project:odyssey"]

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

get/v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid}

GET /v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

{
  "id": "019256ab-1554-73a7-b091-f024b0a724ea",
  "name": "development.ubuntu-2404",
  "description": "DB1 VM",
  "instance_type": "vm.gpu.1rtx4000.15c.248g",
  "image": "vm.gpu.1rtx4000.15c.248g",
  "status": "running",
  "ips": [
    {
      "address": "1.2.3.4",
      "public": "true"
    }
  ],
  "cloud": "019256ab-1554-73a7-b091-f024b0a724ea",
  "node": "019256ab-1554-73a7-b091-f024b0a724ea",
  "created_at": "text",
  "deleted_at": "text",
  "tags": [
    "env:build",
    "project:odyssey"
  ]
}

Delete a FlexVM

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

vmUuidstringRequired

Responses

202

Accepted

No content

403

Invalid credentials

404

Not Found

409

Conflict

422

Unprocessable content

500

Internal Server Error

application/json

delete/v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid}

DELETE /v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Execute a FlexVM command

post

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

cloudUuidstringRequired

vmUuidstringRequired

Body

commandstringRequired

The command to execute on the VM. Must be one of: start, stop, reboot, or reset.

Example: start

Responses

202

Accepted

No content

403

Invalid credentials

404

Not Found

422

Unprocessable content

500

Internal Server Error

application/json

post/v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid}/commands

POST /v3/flexVM/clouds/{cloudUuid}/vms/{vmUuid}/commands HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "command": "start"
}

No content

Get the monthly usage report for the caller's organization

get

Authorizations

PRIVATE-TOKENstringRequired

Query parameters

startstringOptional

Inclusive start of the reporting period (ISO 8601, UTC). Must be provided together with end. When neither is provided, the period defaults to the current calendar month.

endstringOptional

Exclusive end of the reporting period (ISO 8601, UTC). Must be provided together with start. When neither is provided, the period defaults to the first instant of the next calendar month.

Responses

200

application/json

total_nodesinteger · integerRead-onlyRequired

Total nodes across all clouds for the organization.

Example: 25

total_active_vmsinteger · integerRead-onlyRequired

Total VMs currently active (not deleted) across all clouds.

Example: 38

400

Bad request — start and end must be provided together, or the period is invalid

403

Invalid credentials

422

Unprocessable content

500

Internal Server Error

application/json

get/v3/flexVM/reports/monthly

GET /v3/flexVM/reports/monthly HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

{
  "period": {
    "start": "2026-03-01T00:00:00Z",
    "end": "2026-04-01T00:00:00Z"
  },
  "total_nodes": 25,
  "total_active_vms": 38,
  "clouds": [
    {
      "id": "019cb8c4-25dc-7aac-8023-407f05529118",
      "site": "frmtl1",
      "instance_type": "bm9.hmm.gpu.4rtx4000.64",
      "nodes": 10,
      "active_vms": 12,
      "period_usage": {
        "total_vms_created": 847,
        "total_vms_released": 835,
        "total_vm_hours": 4321,
        "total_vms_failed": 12
      },
      "name": "My private cloud",
      "description": "This Cloud is meant for acceptance tests.",
      "created_at": "2026-06-01T12:45:14Z"
    }
  ],
  "by_tag": [
    {
      "tag": "project:odyssey",
      "active_vms": 8,
      "total_vms_created": 620,
      "total_vms_released": 612,
      "total_vm_hours": 2880
    }
  ],
  "vms": [
    {
      "vm_id": "019d1a2b-3c4d-7e8f-9012-3456789abcde",
      "name": "ac-build-agent-001",
      "status": "running",
      "plan": "vm.gpu.1rtx4000.15c.248g",
      "image": "ubuntu-2404-base",
      "cloud_id": "019cb8c4-25dc-7aac-8023-407f05529118",
      "site": "frmtl1",
      "tags": [
        "project:odyssey",
        "env:build"
      ],
      "created_at": "2026-03-01T08:00:00Z",
      "released_at": "2026-03-14T04:30:00Z",
      "vm_hours": 360
    }
  ]
}

Get the organization-wide capacity snapshot

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

nodesinteger · integerRead-onlyRequired

Total number of nodes in scope.

Example: 25

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/flexVM/reports/capacity

GET /v3/flexVM/reports/capacity HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

{
  "nodes": 25,
  "node_groups": [
    {
      "instance_type": "bm9.hmm.gpu.4rtx4000.64",
      "quantity": 25
    }
  ],
  "resources": {
    "vcpu": {
      "total": 100,
      "in_use": 30,
      "available": 70
    },
    "memory": {
      "total": 100,
      "in_use": 30,
      "available": 70
    },
    "pci_devices": [
      {
        "type": "gpu",
        "total": 100,
        "in_use": 20,
        "available": 80
      }
    ]
  }
}

List capacity per Cloud for the caller's organization

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

application/json

descriptionstringOptional

An optional free-form description of the Cloud.

Example: This Cloud is meant for acceptance tests.

idstring · uuidRead-onlyRequired

Cloud UUID.

Example: 019256ab-1554-73a7-b091-f024b0a724ea

namestringRequired

Cloud name.

Example: My private cloud

sitestringRequired

The i3D site (location) in which the Cloud is located.

Example: nlrtm1

instance_typestringRequired

The FlexMetal instance type shared by every node in the Cloud.

Example: bm9.hmm.gpu.4rtx4000.64

created_atstring · date-timeRead-onlyRequired

When the Cloud was created (RFC3339).

Example: 2026-06-01T12:45:14Z

nodesinteger · integerRead-onlyRequired

Total number of nodes in the Cloud.

Example: 25

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/flexVM/capacity

GET /v3/flexVM/capacity HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "description": "This Cloud is meant for acceptance tests.",
    "id": "019256ab-1554-73a7-b091-f024b0a724ea",
    "name": "My private cloud",
    "site": "nlrtm1",
    "instance_type": "bm9.hmm.gpu.4rtx4000.64",
    "created_at": "2026-06-01T12:45:14Z",
    "nodes": 25,
    "node_groups": [
      {
        "instance_type": "bm9.hmm.gpu.4rtx4000.64",
        "quantity": 25
      }
    ],
    "resources": {
      "vcpu": {
        "total": 100,
        "in_use": 30,
        "available": 70
      },
      "memory": {
        "total": 100,
        "in_use": 30,
        "available": 70
      },
      "pci_devices": [
        {
          "type": "gpu",
          "total": 100,
          "in_use": 20,
          "available": 80
        }
      ]
    }
  }
]

PreviousGame NextFlexMetal

Last updated 1 month ago

Was this helpful?