The server object holds all data revolving around a server.

Field

Type

Example

Description

id

String

"aaaaaaaaaaabbbbbbbbbbbbb"

The unique ID for the server.

name

String

"My awesome server"

The name of the server.

host

Integer

0

The host that the server is residing on.

ipv4

String

"10.0.0.1"

The IPV4 address of the server.

size

String

"nibble-1024"

The size ID of the server.

sizeDescription

String

"nibble-1024"

The size of the server in a more readable format.

image

String

"10000"

The ID of the image or app that the server has installed.

imageDescription

String

"Ubuntu 18.04"

The description of the image installed on the server.

created

Date (Unix Timestamp)

"2020-01-01T08:00:00.000Z"

The creation date of the server.

rate

Integer

21

The hourly rate of the server that will be deducted from your account balance every hour.

bandwidthUsed

Integer

1000

The amount of bandwidth used by the server.

Represented in bytes.

bandwidthAllowance

Integer

2000000000000

The amount of bandwidth the server has included in its plan.

Represented in bytes.

status

String

"ok" / "launching" / "restarting" / "rebuilding" / "error" / "stopped"

The status of the server.

errorText

String

Associated error text if server failed to create.

backupsEnabled

Bool

true

If the server has backups enabled.

abuse

Bool

false

If the server has been the subject of an abuse report.

diskGB

Integer

25

The size of the server's disk in GB.

protection

Object

"protection": {
  "enabled": true,
  "proxy": {
    "ip": "40.40.40.40",
    "region": "bvm-lux",
    "ports": null,
    "target": "25.25.25.25"
  }
}

The protection object stores details on the protection status of the server.

protection.enabled Is a boolean used to indicate if protection is enabled.

protection.proxy The proxy object stores details of the protected server.

protection.proxy.ip Is the IP address of the proxy server.

protection.proxy.region Is the region the proxy server.

protection.proxy.ports Is a list of Port Objects which represent the enabled ports of the proxy server.

protection.proxy.target Is the IP address of the server to be protected.