The Server Object holds all data revolving around a server.
Field | Type | Example | Description |
---|---|---|---|
id |
| "aaaaaaaaaaabbbbbbbbbbbbb" | The unique ID for the server. |
name |
| "My awesome server" | The name of the server. |
host |
| 0 | The host that the server is residing on. |
ipv4 |
| "10.0.0.1" | The IPV4 address of the server. |
size |
| "nibble-1024" | The size ID of the server. |
sizeDescription |
| "nibble-1024" | The size of the server in a more readable format. |
image |
| "10000" | The ID of the image or app that the server has installed. |
imageDescription |
| "Ubuntu 18.04" | The description of the image installed on the server. |
created |
| "2020-01-01T08:00:00.000Z" | The creation date of the server. |
rate |
| 21 | The hourly rate of the server that will be deducted from your account balance every hour. |
bandwidthUsed |
| 1000 | The amount of bandwidth used by the server. Represented in |
bandwidthAllowance |
| 2000000000000 | The amount of bandwidth the server has included in its plan. Represented in |
status |
| "ok" / "launching" / "restarting" / "rebuilding" / "error" / "stopped" | The status of the server. |
errorText |
| Associated error text if server failed to create. | |
backupsEnabled |
| true | If the server has backups enabled. |
abuse |
| false | If the server has been the subject of an abuse report. |
diskGB |
| 25 | The size of the server's disk in |
protection |
| The protection object stores details on the protection status of the server. |