Bare-Metal Server

Get all servers

GET https://www.allnodes.com/api/v1/server

This endpoint allows to get list of all your servers.

Headers

Name
Type
Description

Authorization*

string

Bearer TOKEN

{
  servers: [
    {
      id: number;
      alias: string;
      hostname: string | null;
      platform: 'epyc' | 'threadripper' | 'ryzen';
      cpu: {
        name: string;
        cores: number;
        threads: number;
        baseClockMhz: number;
        boostClockMhz: number;
        type: 'SINGLE' | 'DUAL';
      } 
      motherboard: {
        name: string;
        dimmCount: number;
      }
      ram: {
        ddrVersion: 'DDR5';
        totalSizeGb: number;
        stickSizeGb: number;
        stickCount: number;
        speedMts: number;
        isECC: boolean;
      }
      ssd: [
        {
          pcieVersion: '4.0' | '5.0';
          sizeGb: number;
          name: string;
          slotType: 'M2' | 'U2'; 
          count: number;
        }
      ]
      connectivity: {
        speedGbit: number;
      }
      traffic: {
        amountTb: number;
      }
      ipAddresses: string[];
      psu: 'SINGLE' | 'DUAL';
      powerStatus: string | null;
      ipmi: boolean;
      os: {
        name: string;
        version: string | null;
      }
      bios?: {
        model: string;
        value: string;
        serial: string;
      }
      location: {
        country: string;
        city: string;
      }
      priceMonthlyUSD: number;
      priceHourlyUSD: number;
      prepaidTill: string | null;
      createdAt: string;
      readyAt: string;
    } 
  ]  
}

Get all available Instant servers

GET https://www.allnodes.com/api/v1/server/hosting/instant

This endpoint allows to get list of all available to host Instant servers.

Headers

Name
Type
Description

Authorization*

string

Bearer TOKEN

Get all available Instant server upgrades

GET https://www.allnodes.com/api/v1/server/hosting/instant/upgrades

This endpoint allows to get list of all available upgrades for Instant server.

Headers

Name
Type
Description

Authorization*

string

Bearer TOKEN

Get all available Instant server installation profiles

GET https://www.allnodes.com/api/v1/server/hosting/instant/:id/profiles

This endpoint allows to get list of all available installation profiles (OS) for Instant server.

Path Parameters

Name
Type
Description

id*

string

ID can be extracted from the “Get all available Instant servers” call

Headers

Name
Type
Description

Authorization*

string

Bearer TOKEN

Host an Instant server

POST https://www.allnodes.com/api/v1/server/hosting/instant

This endpoint allows to host an Instant server.

Headers

Name
Type
Description

Authorization*

string

Bearer TOKEN

Body

Name
Type
Description

instantServerId

string

ID of an Instant server you want to host. You can get this value from the "Get all available Instant servers" API

prepaidType

"onDemand" |

"oneMonth" |

"threeMonths" |

"sixMonths" |

"oneYear"

Defines the prepaid billing period for the server. This value represents the initial payment option: onDemand — no upfront payment, usage is billed hourly. oneMonth, threeMonths, sixMonths, oneYear — prepaid plans with a fixed monthly price and discounts depending on the selected period

instantServerPriceMonthlyUSD

number

The monthly price in USD that must exactly match the priceMonthlyUSD value from the selected prepaidType in the "Get all available Instant servers" API

solanaPackage

boolean

Whether to enable the Solana Package Traffic Upgrade for this server.

  • true — Solana traffic package will be added.

  • false — no Solana traffic upgrade

additionalIpCount

number

Number of additional IPv4 addresses to attach to the server.

  • The server includes 1 IPv4 address by default.

  • You can request up to 11 additional IPv4 addresses.

  • Maximum total IPv4 addresses per server: 12

osInstallation

object

Configuration object describing the operating system and installation parameters that will be automatically installed on the server

osInstallation.profileId

number

ID of the operating system installation profile.

You can obtain this value from the "Get all available Instant server installation profiles" API

osInstallation.hostname

string

Hostname to be set on the server during OS installation.

This field is required only if the selected installation profile has allowSetHostname = true If the profile does not allow setting a hostname, this field must be omitted

osInstallation.rootPassword

string

Root user password for the operating system.

This field is required only if the selected installation profile has allowSetRootPassword = true If the profile does not allow setting a root password, this field must be omitted

osInstallation.diskLayoutId

number

ID of the disk layout to use during OS installation. Available disk layout IDs can be obtained from the diskLayouts list of the selected installation profile

osInstallation.sshKeyIds

number[]

List of SSH key IDs that will be added to the server during OS installation.

  • SSH key IDs can be obtained from the "Get all SSH Keys" API.

  • This field must be provided only if the selected installation profile has allowSshKeys = true.

  • If SSH keys are not allowed by the profile, this field must be omitted

Last updated