KVM V-Servers - API Documentation

This API route lists all available KVM V-Servers for this customer account.

Request:

curl -X GET -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/kvm-vservers
Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

{
  "kvm_vservers": [
    {
      "id": 1,
      "state": "running",
      "hdd": 130,
      "ram": 3,
      "vcores": 2,
      "bootorder": "hd,cdrom",
      "vnc": {
        "active": true,
        "address": "127.0.0.1:4000"
      },
      "ip_addresses": [
        {
          "id": 1,
          "ip_address": "127.0.0.1",
          "primary": true
        }
      ],
      "customer_product_id": 2
    },
    {
      "id": 2,
      "state": "shut_off",
      "hdd": 180,
      "ram": 6,
      "vcores": 4,
      "bootorder": "hd,cdrom",
      "vnc": {
        "active": false,
        "address": "127.0.0.1:3000"
      },
      "ip_addresses": [
        {
          "id": 3,
          "ip_address": "127.0.0.1",
          "primary": true
        }
      ],
      "customer_product_id": 3
    }
  ]
}
Requirements:

The scope kvm_vservers.list needs to be active.
This API route enables the VNC Server for a KVM V-Server on our host system. The VNC Server itself is always running, but by calling this route, our firewall will allow connections to your VNC Server port. There's no restart required for your KVM V-Server.

Request:

curl -X POST -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/kvm-vservers/:id/vnc/enable
Response:

1
2
3
4
5
6
7

{
  "kvm_vserver_id": 1,
  "vnc": {
    "address": "127.0.0.1:3000",
    "active": true
  }
}
Requirements:

The scope kvm_vservers.vnc needs to be active and the token needs to have access on that product.
This API route disables the VNC Server for a KVM V-Server on our host system. The VNC Server itself is always running, but by calling this route, our firewall will no longer allow connections to your VNC Server port. There's no restart required for your KVM V-Server.

Request:

curl -X POST -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/kvm-vservers/:id/vnc/disable
Response:

1
2
3
4
5
6
7

{
  "kvm_vserver_id": 1,
  "vnc": {
    "address": "127.0.0.1:3000",
    "active": false
  }
}
Requirements:

The scope kvm_vservers.vnc needs to be active and the token needs to have access on that product.
Starts a KVM V-Server (identified by its ID in the URL). The ID can be obtained from the KVM V-Servers list (see section 3.).

Request:

curl -X POST -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/kvm-vservers/:id/start
Response:

1
2
3
4

{
  "kvm_vserver_id": 1,
  "message": "Server has been started."
}
Requirements:

The scope kvm_vservers.state_change needs to be active and the token needs to have access on that product.
Reboots a KVM V-Server (identified by its ID in the URL). The ID can be obtained from the KVM V-Servers list (see section 3.).

This API call tries to gracefully reboot the running system. If this does not work and the server is still up after a few minutes, you might consider using the Force off call as described in section 7.
Request:

curl -X POST -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/kvm-vservers/:id/reboot
Response:

1
2
3
4

{
  "kvm_vserver_id": 1,
  "message": "Server has been rebooted."
}
Requirements:

The scope kvm_vservers.state_change needs to be active and the token needs to have access on that product.
Shuts off a KVM V-Server (identified by its ID in the URL). The ID can be obtained from the KVM V-Servers list (see section 3.).

This API call tries to gracefully shutdown the running system. If this does not work and the server is still up after a few minutes, you might consider using the Force off call as described in section 7.
Request:

curl -X POST -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/kvm-vservers/:id/shutdown
Response:

1
2
3
4

{
  "kvm_vserver_id": 1,
  "message": "Server has been shut down."
}
Requirements:

The scope kvm_vservers.state_change needs to be active and the token needs to have access on that product.
Forces off a KVM V-Server (identified by its ID in the URL). The ID can be obtained from the KVM V-Servers list (see section 3.).

Use this function carefully! The force off option should only be used when a server does not shutdown gracefully. This API call will immediately kill the KVM V-Server process and might lead to data corruption.
Request:

curl -X POST -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/kvm-vservers/:id/force-off
Response:

1
2
3
4

{
  "kvm_vserver_id": 1,
  "message": "Server has been forced off."
}
Requirements:

The scope kvm_vservers.state_change needs to be active and the token needs to have access on that product.