KVM V-Server - API Dokumentation

Diese API Route gibt Dir die Möglichkeit all Deine KVM V-Server anzuzeigen.

Anfrage:

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

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
    }
  ]
}
Voraussetzungen:

Der Scope kvm_vservers.list muss aktiv sein.
Diese API Route aktiviert den VNC Server für Deinen KVM V-Server auf unserem Host System. Der VNC Server selbst läuft immer, nur unsere Firewall wird durch den Aufruf dieser API Route wieder Verbindungen zu Deinem VNC Server Port erlauben.

Anfrage:

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

1
2
3
4
5
6
7

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

Der Scope kvm_vservers.vnc muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.
Diese API Route deaktiviert den VNC Server für Deinen KVM V-Server auf unserem Host System. Der VNC Server selbst läuft immer, nur unsere Firewall wird durch den Aufruf dieser API Route keine weiteren Verbindungen zu Deinem VNC Server Port erlauben.

Anfrage:

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

1
2
3
4
5
6
7

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

Der Scope kvm_vservers.vnc muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.
Startet einen KVM V-Server anhand seiner ID. Die ID kann man durch die Auflistung aller KVM V-Server erhalten (siehe Abschnitt 3).

Anfrage:

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

1
2
3
4

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

Der Scope kvm_vservers.state_change muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.
Startet einen KVM V-Server anhand seiner ID neu. Die ID kann man durch die Auflistung aller KVM V-Server erhalten (siehe Abschnitt 3).

Dieser API Aufruf versucht das laufende Betriebssystem neuzustarten. Wenn dies nicht funktioniert und der Server auch noch nach paar Minuten online ist, solltest Du Dir überlegen, ob Du die Force off Option nutzen möchtest (wie in Abschnitt 7 beschrieben).
Anfrage:

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

1
2
3
4

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

Der Scope kvm_vservers.state_change muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.
Fährt einen KVM V-Server anhand seiner ID herunter. Die ID kann man durch die Auflistung aller KVM V-Server erhalten (siehe Abschnitt 3).

Dieser API Aufruf versucht das laufende Betriebssystem herunterzufahren. Wenn dies nicht funktioniert und der Server auch noch nach paar Minuten online ist, solltest Du Dir überlegen, ob Du die Force off Option nutzen möchtest (wie in Abschnitt 7 beschrieben).
Anfrage:

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

1
2
3
4

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

Der Scope kvm_vservers.state_change muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.
Schaltet einen KVM V-Server anhand seiner ID aus. Die ID kann man durch die Auflistung aller KVM V-Server erhalten (siehe Abschnitt 3).

Bitte diese Funktion mit Bedacht nutzen! Dieser API Aufruf schaltet sofort den laufenden Server aus. Dies kann unangenehme Folgen für das Dateisystem haben (=> Datenbeschädigung).
Anfrage:

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

1
2
3
4

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

Der Scope kvm_vservers.state_change muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.