NodeRings Docs

Create Node

POST
/v1/node
Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

name?string
platformId?string
regionId?string
cpuOverallocatePercent?integer
Formatint32
memoryOverallocatePercent?integer
Formatint32
storageOverallocatePercent?integer
Formatint32
vmidSeed?integer
Formatint32
maintenanceMode?boolean
vmStorageDestination?string
backupStorageDestination?string
backupStorageCompression?string

Proxmox vzdump --compress (must not be UNSPECIFIED on create/update node).

Default"BACKUP_STORAGE_COMPRESSION_UNSPECIFIED"
Value in"BACKUP_STORAGE_COMPRESSION_UNSPECIFIED" | "BACKUP_STORAGE_COMPRESSION_NONE" | "BACKUP_STORAGE_COMPRESSION_LZO" | "BACKUP_STORAGE_COMPRESSION_GZIP" | "BACKUP_STORAGE_COMPRESSION_ZSTD"
networkBridge?string

Node provisioning settings (server-side defaults applied when omitted) Proxmox Linux bridge for VM primary NIC. Default: vmbr0.

networkName?string

Proxmox net device key for primary NIC (net0, net1, ...). Default: net0.

networkVlanId?integer

802.1Q VLAN tag on primary NIC (Proxmox tag=); 0 = untagged.

Formatint32
networkModel?string

Proxmox NIC model for primary NIC. Default: virtio.

computeType?string

Compute product for this node. Unspecified/omitted = shared (default).

Default"NODE_COMPUTE_TYPE_UNSPECIFIED"
Value in"NODE_COMPUTE_TYPE_UNSPECIFIED" | "NODE_COMPUTE_TYPE_SHARED" | "NODE_COMPUTE_TYPE_DEDICATED"
topologyPaste?string

Raw topology paste (output of the documented lscpu/sysfs command block). Required when compute_type is dedicated; ignored otherwise.

Response Body

application/json

curl -X POST "https://api.nrings.io/v1/node" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}" \  -H "Content-Type: application/json" \  -d '{  "name": "string",  "platformId": "string",  "regionId": "string",  "cpuOverallocatePercent": 0,  "memoryOverallocatePercent": 0,  "storageOverallocatePercent": 0,  "vmidSeed": 0,  "maintenanceMode": false,  "vmStorageDestination": "string",  "backupStorageDestination": "string",  "backupStorageCompression": "BACKUP_STORAGE_COMPRESSION_UNSPECIFIED",  "networkBridge": "string",  "networkName": "string",  "networkVlanId": 0,  "networkModel": "string",  "computeType": "NODE_COMPUTE_TYPE_UNSPECIFIED",  "topologyPaste": "string"}'
{
  "success": true
}