Get virtual machines

Retrieve all available virtual machines. Use this endpoint to view available VPS instances.

Get virtual machines

get

Retrieve all available virtual machines.

Use this endpoint to view available VPS instances.

Authorizations

AuthorizationstringRequired

API Token authentication

Responses

200

Success response

application/json

Array of VPS.V1.VirtualMachine.VirtualMachineResource

idintegerOptional

Virtual machine ID

Example: 17923

firewall_group_idinteger · nullableOptional

Active firewall ID, null if disabled

subscription_idstring · nullableOptional

Subscription ID

Example: Azz353Uhl1xC54pR0

data_center_idinteger · nullableOptional

Data center ID

Example: 521

planstring · nullableOptional

VPS plan name

Example: KVM 4

hostnamestringOptionalExample: srv17923.hstgr.cloud

statestring · enumOptionalExample: runningPossible values:

actions_lockstring · enumOptionalExample: unlockedPossible values:

cpusintegerOptional

CPUs count assigned to virtual machine

Example: 4

memoryintegerOptional

Memory available to virtual machine (in megabytes)

Example: 8192

diskintegerOptional

Virtual machine disk size (in megabytes)

Example: 51200

bandwidthintegerOptional

Monthly internet traffic available to virtual machine (in megabytes)

Example: 1073741824

ns1string · nullableOptional

Primary DNS resolver

Example: 1.1.1.1

ns2string · nullableOptional

Secondary DNS resolver

Example: 8.8.8.8

ipv4one of · nullableOptional

IPv4 address of virtual machine

ipv6one of · nullableOptional

IPv6 address of virtual machine, null if not assigned

templateone of · nullableOptional

OS template installed in virtual machine

created_atstring · date-timeOptionalExample: 2024-09-05T07:25:36.00000Z

401

Unauthenticated response

application/json

500

Error response

application/json

get/api/vps/v1/virtual-machines

GET /api/vps/v1/virtual-machines HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 17923,
    "firewall_group_id": null,
    "subscription_id": "Azz353Uhl1xC54pR0",
    "data_center_id": 521,
    "plan": "KVM 4",
    "hostname": "srv17923.hstgr.cloud",
    "state": "running",
    "actions_lock": "unlocked",
    "cpus": 4,
    "memory": 8192,
    "disk": 51200,
    "bandwidth": 1073741824,
    "ns1": "1.1.1.1",
    "ns2": "8.8.8.8",
    "ipv4": [
      {
        "id": 52347,
        "address": "213.331.273.15",
        "ptr": "something.domain.tld"
      }
    ],
    "ipv6": [
      {
        "id": 52347,
        "address": "213.331.273.15",
        "ptr": "something.domain.tld"
      }
    ],
    "template": {
      "id": 6523,
      "name": "Ubuntu 20.04 LTS",
      "description": "Ubuntu 20.04 LTS",
      "documentation": "https://docs.ubuntu.com"
    },
    "created_at": "2024-09-05T07:25:36.00000Z"
  }
]