Path parameters

  • id integer Required

    VPS ID number

Responses

  • 200 application/json

    The VPS Information

    Hide response attributes Show response attributes object
    • serviceInfo object Required
      Hide serviceInfo attributes Show serviceInfo attributes object
      • vps_id string

        VPS ID

      • vps_custid string

        Customer ID

      • vps_server string

        Server ID

      • vps_ip string

        IP address of the VPS

      • vps_ipv6

        IPv6 address of the VPS

      • vps_vzid string

        VPS Virtuozzo ID

      • vps_currency string

        Currency used for billing

      • vps_type string

        VPS type

      • vps_order_date string

        Date of VPS order

      • vps_status string

        VPS status

      • vps_invoice string

        VPS invoice number

      • vps_coupon string

        VPS coupon code

      • vps_extra string

        Additional information about the VPS

      • vps_hostname string

        VPS hostname

      • vps_server_status string

        Status of the VPS server

      • vps_comment string

        Comment associated with the VPS

      • vps_slices string

        Number of VPS slices

      • vps_vnc string

        VNC address

      • vps_vnc_port string

        VNC port

      • vps_rootpass string

        Root password of the VPS

      • vps_mac string

        MAC address of the VPS

      • vps_os string

        Operating system of the VPS

      • vps_version string

        Version of the operating system

      • vps_location string

        Location of the VPS

      • vps_platform string

        Virtualization platform

      • vps_diskused string

        Amount of disk space used

      • vps_diskmax string

        Maximum disk space available

    • billingDetails object Required
      Hide billingDetails attributes Show billingDetails attributes object
      • service_last_invoice_date string

        Last invoice date

      • service_payment_status string

        Payment status

      • service_frequency string

        Billing frequency

      • next_date string

        Next billing date

      • service_next_invoice_date string

        Next invoice date

      • service_currency string

        Currency used for billing

      • service_currency_symbol string

        Currency symbol

      • service_coupon string

        Billing coupon code

      • service_cost_info string

        Cost information

      • service_extra object
        Hide service_extra attributes Show service_extra attributes object
        • spice integer

          Spice

        • snapshots array[object]
          Hide snapshots attributes Show snapshots attributes object
          • name string
          • used integer
          • date integer
      • service_extra_json string

        Additional information in JSON format

    • custCurrency string Required
    • custCurrencySymbol string Required
    • serviceMaster object Required
      Hide serviceMaster attributes Show serviceMaster attributes object
      • vps_id string

        VPS ID

      • vps_name string

        VPS name

      • vps_ip string

        IP address of the VPS

      • vps_type string

        VPS type

      • vps_hdsize string

        Hard drive size

      • vps_hdfree string

        Free hard drive space

      • vps_bits string

        Bits

      • vps_load string

        CPU load

      • vps_ram string

        RAM

      • vps_cpu_model string

        CPU model

      • vps_cpu_mhz string

        CPU frequency in MHz

      • vps_location string

        Location of the VPS

      • vps_last_update string

        Last update date

      • vps_raid_building string

        RAID building status

      • vps_kernel string

        Kernel version

      • vps_available string

        Available

      • vps_cores string

        Number of CPU cores

      • vps_iowait string

        I/O wait

      • vps_raid_status string

        RAID status

      • vps_mounts string

        Mounts

      • vps_server_max string

        Maximum number of servers

      • vps_server_max_slices string

        Maximum number of server slices

      • vps_drive_type string

        Drive type

      • vps_order string

        Order number

    • package string Required
    • os_template string
    • serviceExtra object Required
      Hide serviceExtra attributes Show serviceExtra attributes object
      • spice integer

        Spice

      • snapshots array[object]
        Hide snapshots attributes Show snapshots attributes object
        • name string
        • used integer
        • date integer
    • extraInfoTables object Required
      Hide extraInfoTables attribute Show extraInfoTables attribute object
      • ip_info object
        Hide ip_info attributes Show ip_info attributes object
        • title string

          Title of the table

        • rows array[object]
          Hide rows attributes Show rows attributes object
          • desc string

            Description

          • value string

            Value

    • module string Required
    • token string Required
    • cp_data object Required
      Hide cp_data attributes Show cp_data attributes object
      • name string
      • cost integer
    • da_data object Required
      Hide da_data attribute Show da_data attribute object
      • free object
        Hide free attributes Show free attributes object
        • name string
        • sub_name string
        • cost integer
        • img_disabled string
        • img_active string
    • plesk12_data object Required
      Hide plesk12_data attributes Show plesk12_data attributes object
      • admin object
        Hide admin attributes Show admin attributes object
        • id integer
        • name string
        • sub_name string
        • cost integer
      • pro object
        Hide pro attributes Show pro attributes object
        • id integer
        • name string
        • sub_name string
        • cost integer
      • host object
        Hide host attributes Show host attributes object
        • id integer
        • name string
        • sub_name string
        • cost integer
    • serviceAddons object Required
      Hide serviceAddons attributes Show serviceAddons attributes object
      • has_cpanel boolean
      • has_directadmin boolean
      • has_fantastico boolean
      • has_softaculous boolean
      • has_hdspace boolean
      • dedicated_ip boolean
      • extra_ips array[string]
      • extra_ips6 array[string]
      • unpaid_ips array[string]
      • ips array[string]
      • ips6 array[string]
      • cpanel_id integer
      • cost integer
      • ids array[string]
      • rdata array[string]
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • code string Required
    • message string Required
GET /vps/{id}
curl \
 --request GET 'https://my.interserver.net/apiv2/vps/{id}' \
 --header "X-API-KEY: $API_KEY"
Response examples (200)
{
  "serviceInfo": {
    "vps_id": "85872",
    "vps_custid": "223513",
    "vps_server": "2439",
    "vps_ip": "1.2.3.4",
    "vps_vzid": "vps85872",
    "vps_currency": "USD",
    "vps_type": "33",
    "vps_order_date": "2022-12-26T20:14:59.000Z",
    "vps_status": "active",
    "vps_invoice": "20130799",
    "vps_coupon": "3646",
    "vps_extra": "{\"spice\":5903,\"snapshots\":[{\"name\":\"third\",\"used\":36490445,\"date\":1692095220},{\"name\":\"second\",\"used\":40894464,\"date\":1692181620},{\"name\":\"first\",\"used\":54735668,\"date\":1692268020}]}",
    "vps_hostname": "vps85872",
    "vps_server_status": "running",
    "vps_comment": "my-web-2",
    "vps_slices": "16",
    "vps_vnc": "8.7.6.5",
    "vps_vnc_port": "5902",
    "vps_rootpass": "mypassword",
    "vps_mac": "00:16:3e:27:59:b2",
    "vps_os": "ubuntu-22.04",
    "vps_version": "ubuntu",
    "vps_location": "1",
    "vps_platform": "kvm",
    "vps_diskused": "0",
    "vps_diskmax": "0"
  },
  "client_links": [
    {
      "label": "string",
      "link": "string",
      "icon": "string",
      "icon_text": "string",
      "help_text": "string"
    }
  ],
  "billingDetails": {
    "service_last_invoice_date": "July 26, 2023",
    "service_payment_status": "Paid",
    "service_frequency": "Monthly",
    "next_date": "2023-08-26T09:41:12.000Z",
    "service_next_invoice_date": "August 26, 2023",
    "service_currency": "USD",
    "service_currency_symbol": "$",
    "service_coupon": "TheCouponIUsed",
    "service_cost_info": "0.00",
    "service_extra": {
      "spice": 5903,
      "snapshots": [
        {
          "name": "string",
          "used": 42,
          "date": 42
        }
      ]
    },
    "service_extra_json": "{\"spice\":5903,\"snapshots\":[{\"name\":\"third\",\"used\":36490445,\"date\":1692095220},{\"name\":\"second\",\"used\":40894464,\"date\":1692181620},{\"name\":\"first\",\"used\":54735668,\"date\":1692268020}]}"
  },
  "custCurrency": "string",
  "custCurrencySymbol": "string",
  "serviceMaster": {
    "vps_id": "2439",
    "vps_name": "Mystaging",
    "vps_ip": "10.11.12.13",
    "vps_type": "14",
    "vps_hdsize": "1856",
    "vps_hdfree": "1559",
    "vps_bits": "64",
    "vps_load": "0.17",
    "vps_ram": "263998228",
    "vps_cpu_model": "Intel(R) Xeon(R) CPU E5-2678 v3 @ 2.50GHz",
    "vps_cpu_mhz": "1198.86",
    "vps_location": "1",
    "vps_last_update": "2023-08-17T22:19:04.000Z",
    "vps_raid_building": "0",
    "vps_kernel": "5.4.0-121-generic",
    "vps_available": "0",
    "vps_cores": "48",
    "vps_iowait": "0.09",
    "vps_raid_status": "OK: zfs:all pools are healthy",
    "vps_mounts": "udev:125:0:125:/dev,/dev/md1:91:53:38:/,securityfs:0:0:0:/sys/kernel/security,cgroup2:0:0:0:/sys/fs/cgroup/unified,pstore:0:0:0:/sys/fs/pstore,efivarfs:0:0:0:/sys/firmware/efi/efivars,systemd-1:0:0:0:/proc/sys/fs/binfmt_misc,hugetlbfs:0:0:0:/dev/hugepages",
    "vps_server_max": "50",
    "vps_server_max_slices": "80",
    "vps_drive_type": "SSD",
    "vps_order": "36978"
  },
  "package": "string",
  "os_template": "string",
  "serviceExtra": {
    "spice": 5903,
    "snapshots": [
      {
        "name": "string",
        "used": 42,
        "date": 42
      }
    ]
  },
  "extraInfoTables": {
    "ip_info": {
      "title": "IP Information",
      "rows": [
        {
          "desc": "string",
          "value": "string"
        }
      ]
    }
  },
  "module": "string",
  "token": "string",
  "da_link": 42,
  "sr_link": 42,
  "cp_data": {
    "name": "string",
    "cost": 42
  },
  "da_data": {
    "free": {
      "name": "string",
      "sub_name": "string",
      "cost": 42,
      "img_disabled": "string",
      "img_active": "string"
    }
  },
  "plesk12_data": {
    "admin": {
      "id": 42,
      "name": "string",
      "sub_name": "string",
      "cost": 42
    },
    "pro": {
      "id": 42,
      "name": "string",
      "sub_name": "string",
      "cost": 42
    },
    "host": {
      "id": 42,
      "name": "string",
      "sub_name": "string",
      "cost": 42
    }
  },
  "serviceAddons": {
    "has_cpanel": true,
    "has_directadmin": true,
    "has_fantastico": true,
    "has_softaculous": true,
    "has_hdspace": true,
    "dedicated_ip": true,
    "extra_ips": [
      "string"
    ],
    "extra_ips6": [
      "string"
    ],
    "unpaid_ips": [
      "string"
    ],
    "ips": [
      "string"
    ],
    "ips6": [
      "string"
    ],
    "cpanel_id": 42,
    "cost": 42,
    "ids": [
      "string"
    ],
    "rdata": [
      "string"
    ]
  }
}
Response examples (401)
{
  "code": "string",
  "message": "string"
}