serverista
Core Resources

Servers

Deploy, configure, and manage your virtual and dedicated servers on Serverista.

Get all server

List all servers including VM and Dedicated Servers in the current account

Accepts: application/json
Returns: application/json

Parameters

no parameters

Response

array of Server

Reference Type:  Server

unique_id
integer
Unique internal identifier for the server.
example: 123456
created_at
string
Timestamp when the server was created.
example: 2025-10-01T12:30:00Z
ip
string
The public or private IP address assigned to the server.
example: 192.168.1.10
user_id
integer
Identifier of the user who created or manages this server.
example: 12
vm_id
integer
Virtual Machine ID in the underlying infrastructure (optional).
example: 98765
account_id
integer
Identifier of the account that owns this server.
example: 5
firewall_enabled
boolean
Indicates whether the server's firewall is enabled.
example: true
updated_at
string
Timestamp when the server was last updated.
example: 2025-10-31T18:22:00Z
data
array of KeyValue
Reference Type: KeyValue

Key-value metadata related to the server.
example: {"name":"OS","value":"Ubuntu 24.04 LTS"}
id
integer
Unique identifier of the server.
example: 101
plan
object of Plan
Reference Type: Plan

The plan details associated with this server.
security_groups
array of SecurityGroup
Reference Type: SecurityGroup

List of security groups associated with this server.
example: {SecurityGroup}
status
string
Current operational status of the server (e.g., running, stopped, provisioning).
example: running
status_date
string
Timestamp of the most recent status change.
example: 2025-10-31T15:04:05Z
user_defined_name
string
Custom name defined by the user for this server.
example: production-web-01
order_id
integer
Identifier of the order related to this server.
example: 43
plan_id
integer
Identifier of the plan associated with this server.
example: 2
tags
array of Tag
Reference Type: Tag

GET /v1/servers
curl -X GET https://api.serverista.com/v1/servers \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response
[
{
  "account_id": 123,
  "created_at": "example_created_at",
  "data": [
    {
      "...": null
    }
  ],
  "firewall_enabled": true,
  "id": 123,
  "ip": "example_ip",
  "order_id": 123,
  "plan": {
    "...": null
  },
  "plan_id": 123,
  "security_groups": [
    {
      "...": null
    }
  ],
  "status": "example_status",
  "status_date": "example_status_date",
  "tags": [
    {
      "...": null
    }
  ],
  "unique_id": 123,
  "updated_at": "example_updated_at",
  "user_defined_name": "example_user_defined_name",
  "user_id": 123,
  "vm_id": 123
}
]

Create a server

Create a server (VM or Dedicated Server) given the configurations

Accepts: application/json
Returns: application/json

Parameters

Request Body
body
CreateServer
Reference Type: CreateServer

Server create payload

Response

array of Server

Reference Type:  Server

firewall_enabled
boolean
Indicates whether the server's firewall is enabled.
example: true
plan_id
integer
Identifier of the plan associated with this server.
example: 2
status
string
Current operational status of the server (e.g., running, stopped, provisioning).
example: running
status_date
string
Timestamp of the most recent status change.
example: 2025-10-31T15:04:05Z
created_at
string
Timestamp when the server was created.
example: 2025-10-01T12:30:00Z
data
array of KeyValue
Reference Type: KeyValue

Key-value metadata related to the server.
example: {"name":"OS","value":"Ubuntu 24.04 LTS"}
id
integer
Unique identifier of the server.
example: 101
plan
object of Plan
Reference Type: Plan

The plan details associated with this server.
security_groups
array of SecurityGroup
Reference Type: SecurityGroup

List of security groups associated with this server.
example: {SecurityGroup}
vm_id
integer
Virtual Machine ID in the underlying infrastructure (optional).
example: 98765
account_id
integer
Identifier of the account that owns this server.
example: 5
ip
string
The public or private IP address assigned to the server.
example: 192.168.1.10
tags
array of Tag
Reference Type: Tag

unique_id
integer
Unique internal identifier for the server.
example: 123456
user_defined_name
string
Custom name defined by the user for this server.
example: production-web-01
user_id
integer
Identifier of the user who created or manages this server.
example: 12
order_id
integer
Identifier of the order related to this server.
example: 43
updated_at
string
Timestamp when the server was last updated.
example: 2025-10-31T18:22:00Z
POST /v1/servers
curl -X POST https://api.serverista.com/v1/servers \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response
[
{
  "account_id": 123,
  "created_at": "example_created_at",
  "data": [
    {
      "...": null
    }
  ],
  "firewall_enabled": true,
  "id": 123,
  "ip": "example_ip",
  "order_id": 123,
  "plan": {
    "...": null
  },
  "plan_id": 123,
  "security_groups": [
    {
      "...": null
    }
  ],
  "status": "example_status",
  "status_date": "example_status_date",
  "tags": [
    {
      "...": null
    }
  ],
  "unique_id": 123,
  "updated_at": "example_updated_at",
  "user_defined_name": "example_user_defined_name",
  "user_id": 123,
  "vm_id": 123
}
]

Perform management action

Perform a management action on a specific server such as start, delete and other operations

Accepts: application/json
Returns: application/json

Parameters

URL Params
id
string
Server id
Request Body
body
ManagementRequest
Reference Type: ManagementRequest

Server action payload

Response

object of ManagementResponse

Reference Type:  ManagementResponse

action_id
string
Unique identifier of the initiated management action.
example: 9b73cfe2a7d84b1c92d3f61234a5efc2
POST /v1/servers/:id/management
curl -X POST https://api.serverista.com/v1/servers/:id/management \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response

{
  "action_id": "example_action_id"
}

Get a server

Get a server by its id

Accepts: application/json
Returns: application/json

Parameters

URL Params
id
string
Server id

Response

object of Server

Reference Type:  Server

firewall_enabled
boolean
Indicates whether the server's firewall is enabled.
example: true
plan
object of Plan
Reference Type: Plan

The plan details associated with this server.
plan_id
integer
Identifier of the plan associated with this server.
example: 2
security_groups
array of SecurityGroup
Reference Type: SecurityGroup

List of security groups associated with this server.
example: {SecurityGroup}
updated_at
string
Timestamp when the server was last updated.
example: 2025-10-31T18:22:00Z
status_date
string
Timestamp of the most recent status change.
example: 2025-10-31T15:04:05Z
user_defined_name
string
Custom name defined by the user for this server.
example: production-web-01
status
string
Current operational status of the server (e.g., running, stopped, provisioning).
example: running
tags
array of Tag
Reference Type: Tag

vm_id
integer
Virtual Machine ID in the underlying infrastructure (optional).
example: 98765
account_id
integer
Identifier of the account that owns this server.
example: 5
created_at
string
Timestamp when the server was created.
example: 2025-10-01T12:30:00Z
data
array of KeyValue
Reference Type: KeyValue

Key-value metadata related to the server.
example: {"name":"OS","value":"Ubuntu 24.04 LTS"}
id
integer
Unique identifier of the server.
example: 101
ip
string
The public or private IP address assigned to the server.
example: 192.168.1.10
order_id
integer
Identifier of the order related to this server.
example: 43
unique_id
integer
Unique internal identifier for the server.
example: 123456
user_id
integer
Identifier of the user who created or manages this server.
example: 12
GET /v1/servers/:id
curl -X GET https://api.serverista.com/v1/servers/:id \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response

{
  "account_id": 123,
  "created_at": "example_created_at",
  "data": [
    {
      "...": null
    }
  ],
  "firewall_enabled": true,
  "id": 123,
  "ip": "example_ip",
  "order_id": 123,
  "plan": {
    "...": null
  },
  "plan_id": 123,
  "security_groups": [
    {
      "...": null
    }
  ],
  "status": "example_status",
  "status_date": "example_status_date",
  "tags": [
    {
      "...": null
    }
  ],
  "unique_id": 123,
  "updated_at": "example_updated_at",
  "user_defined_name": "example_user_defined_name",
  "user_id": 123,
  "vm_id": 123
}

Update server

Updates a server

Accepts: application/json
Returns: application/json

Parameters

URL Params
id
string
Server id
Request Body
body
UpdateServerRequest
Reference Type: UpdateServerRequest

Server update payload

Response

object of GenericResponse

Reference Type:  GenericResponse

message
string
A human-readable message describing the result of the operation.
example: User created successfully.
success
boolean
Indicates whether the operation was successful.
example: true
POST /v1/servers/:id
curl -X POST https://api.serverista.com/v1/servers/:id \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response

{
  "message": "example_message",
  "success": true
}

Get a server statistics

Get a server CPU, RAM, network and disk usage statistics.

Accepts: application/json
Returns: application/json

Parameters

URL Params
id
string
Server id

Response

object of Metrics

Reference Type:  Metrics

net_in_kbps
array of number
Network inbound traffic (in kilobits per second) at each timestamp.
example: 120.4, 256.8, 310.2
net_out_kbps
array of number
Network outbound traffic (in kilobits per second) at each timestamp.
example: 98.3, 210.5, 275.6
timestamps
array of string
List of timestamps (in RFC3339 format) corresponding to each metric data point.
example: "2025-10-31T15:00:00Z", "2025-10-31T15:05:00Z", "2025-10-31T15:10:00Z"
cpu_usage_percent
array of number
CPU usage percentage at each timestamp.
example: 12.5, 35.7, 42.3
disk_read_kbps
array of number
Disk read throughput (in kilobytes per second) at each timestamp.
example: 35.4, 40.1, 38.9
disk_write_kbps
array of number
Disk write throughput (in kilobytes per second) at each timestamp.
example: 20.7, 25.3, 22.8
mem_total_mb
number
Total available memory (in megabytes).
example: 2048
mem_used_mb
array of number
Memory used (in megabytes) at each timestamp.
example: 512, 768, 1024
GET /v1/servers/:id/statistics
curl -X GET https://api.serverista.com/v1/servers/:id/statistics \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d ''
Response

{
  "cpu_usage_percent": [
    {
      "...": null
    }
  ],
  "disk_read_kbps": [
    {
      "...": null
    }
  ],
  "disk_write_kbps": [
    {
      "...": null
    }
  ],
  "mem_total_mb": 123.45,
  "mem_used_mb": [
    {
      "...": null
    }
  ],
  "net_in_kbps": [
    {
      "...": null
    }
  ],
  "net_out_kbps": [
    {
      "...": null
    }
  ],
  "timestamps": [
    {
      "...": null
    }
  ]
}

Users

Manage user profile details and user related functionalities.

Tags

Manage tags for categorizing and organizing your resources.