How to use the EDIS Global Management API

Manage your VPS the right way

The EDIS Global Management API lets you manage active VPS services in your account. Use it to:

authenticate and create a session
check VPS status and resource usage
power a server on, off, or reset it
reinstall a VPS or mount an ISO
manage VNC, PTR records, traffic pool actions, settings, and webhooks

You must have at least one active VPS in your account before you can enable API Access in the VPS Management Portal.

Simple Guide
Developer Version
Full End-2-End Example

Let’s keep this simple

Think of the Management API like a secure remote control for a VPS you already own.👉 You do not start by sending a power or reinstall command.
👉 You first create an auth session and collect the temporary values required for sending management requests.After that, you reuse those values to run other endpoints.

The basic idea

The workflow is always the same:

Enable API Access in the VPS Management Portal
Create an auth session
Collect the session values
Use those values on management endpoints
Re-authenticate when the session expires

The most important values you receive are:

api_host
kvm_id
signature
valid_until

These are the core values used across the Management API.

Step-by-step overview

Enable API Access

Open the VPS Management Portal for one of your VPS services and enable API access.

API access is account-wide. Enabling it for one VPS activates it for all existing and future VPS in your account until you disable it.

Create auth session

Call the auth endpoint with your Client Portal email and password.

Collect session values

Save api_host, kvm_id, signature, and valid_until from the response.

Run management endpoints

Use those values on endpoints such as power state, reinstall, mount ISO, VNC, PTR, traffic pool, and more.

Re-authenticate when needed

If the session expires, create a new auth session and use the new values.

Create an auth session

curl --request POST \
  --url https://session.edisglobal.com/kvm/v2/get/auth \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data email=YOUR_EMAIL \
  --data pw=YOUR_PASSWORD \
  --data kvm_id=YOUR_KVM_ID

You can omit kvm_id if you need auth data for all VPS services in your account.

Example auth response

{
  "data": {
    "kvm_847362_918273": {
      "api_host": "7f3a21.edisglobal.com",
      "kvm_id": "kvm_847362_918273",
      "valid_until": 1789456123,
      "signature": "12345678901234567890123456789012345678901234567890",
      "primary_ip": "185.203.118.74"
    }
  },
  "status": "success"
}

What do these values mean?

api_host → the VPS-specific API host you will call next
kvm_id → the VPS you want to manage
signature → temporary auth signature for that session
valid_until → session expiry timestamp

If the session expires, request a new one.

Example: check power state

curl --request POST \
  --url https://API_HOST/kvm/v2/get/power \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=SESSION_SIGNATURE \
  --data kvm_id=KVM_ID \
  --data valid_until=VALID_UNTIL

Example response:

{
  "data": "server powered on",
  "status": "success",
  "traffic_suspended": false
}

Example: reinstall a VPS

Start by fetching a list of auto-installable OS images:

curl --request POST \
  --url https://API_HOST/kvm/v2/get/images \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=SESSION_SIGNATURE \
  --data kvm_id=KVM_ID \
  --data valid_until=VALID_UNTIL

Select one and trigger an installation.

curl --request POST \
  --url https://API_HOST/kvm/v2/set/reinstall \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=SESSION_SIGNATURE \
  --data kvm_id=KVM_ID \
  --data valid_until=VALID_UNTIL \
  --data image=cloudinit_ubuntu-lts-22-04 \
  --data password=YOUR_PASSWORD

Pro tip

Avoid hardcoding values. Always create a fresh auth session and fetch current parameters before performing actions.

Key takeaway

The Management API is simple once you understand this pattern:

create auth session
collect session values
call the endpoint you need
re-authenticate when the session expires

That’s the core principle.

Management API workflow

Use this order when working with the API:

Enable API Access

Enable API access in the VPS Management Portal of one of your VPS services.
API access is a global setting. Enabling it for one VPS activates it for all existing and future VPS in your account until you disable it.

Create auth session

Call the authentication endpoint and retrieve temporary session values.

Store common values

Save api_host, kvm_id, signature, and valid_until.

Call management endpoints

Use the session values on power, install, traffic, settings, VNC, PTR, hooks, and information endpoints.

Refresh expired sessions

Create a new auth session when valid_until has passed.

Common parameters used across the Management API

Most management endpoints use the same core parameters:

api_host
signature
kvm_id
valid_until

Some endpoints require additional parameters such as:

image
password
iso
force_reset
PTR or VNC values
settings payloads
webhook configuration values

The api_host is VPS-specific and comes from the auth session response.

Authentication

Create auth session

Creates a temporary authentication session for one VPS or for all VPS services on the account.Endpoint: /management-api-reference/authentication/create-auth-sessionImportant output fields:

api_host
kvm_id
signature
valid_until
primary_ip

curl --request POST \
  --url https://session.edisglobal.com/kvm/v2/get/auth \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data email=YOUR_EMAIL \
  --data pw=YOUR_PASSWORD \
  --data kvm_id=YOUR_KVM_ID

{
  "data": {
    "kvm_847362_918273": {
      "api_host": "7f3a21.edisglobal.com",
      "kvm_id": "kvm_847362_918273",
      "valid_until": 1789456123,
      "signature": "12345678901234567890123456789012345678901234567890",
      "primary_ip": "185.203.118.74"
    }
  },
  "status": "success"
}

Pro tip

Avoid hardcoding API values.Autoinstall images are subject to change, and api_host is not static. It may change when EDIS Global migrates a VPS to a different host node.Always generate a new auth session and retrieve current parameters before calling management endpoints.

Full endpoint list

Session & authentication

Create auth session
Creates a temporary authenticated management session and returns the required parameters (api_host, signature, kvm_id, valid_until) for all subsequent Management API requests.

Power management

Hard reset
Performs an immediate hard reboot of the VPS (restarts the hypervisor process).
Power state
Returns the current power state of the VPS (e.g., powered on or powered off).
Power on
Powers on a VPS that is currently shut down.
Power off
Powers off a running VPS.

Installation & recovery

List available ISO images for installation
Returns a list of ISO images available for manual installation, recovery, or rescue environments.
List of autoinstall OS images
Returns available operating system images for automated installation.
Reinstall fresh OS
Reinstalls the VPS using an autoinstall operating system image.
Mount ISO
Mounts an ISO image to the VPS for manual installation or recovery.
Umount ISO
Removes the currently mounted ISO from the VPS.
Provide custom ISO
Downloads and mounts a custom ISO image from a specified URL.
Upload and replace QCOW2
Replaces the VPS disk with a provided QCOW2 image.

Traffic Pool

Enable auto-hydration
Selects a 100 GB, 200 GB, 300 GB, or 500 GB automatic assignment for one VPS. The assignment runs at 99% usage and requires a sufficient Traffic Pool balance.
Disable auto-hydration
Disables automatic traffic assignment.
Auto-hydration status
Returns the current auto-hydration status for the VPS.
Traffic Pool balance
Returns the available balance in the global traffic pool.
Hydration log
Returns a log of traffic assignments (automatic and manual).
Manually assign traffic (manual hydration)
Manually assigns traffic from the traffic pool to a VPS.

Settings

Retrieve hardware settings
Returns the current configurable hardware settings of the VPS.
Save hardware settings changes
Applies updated hardware configuration settings.

Monitoring & information

Pull a VNC screenshot
Captures and returns a screenshot of the VPS console via VNC.
VPS details
Returns full VPS details, including configuration, usage, network data, and metadata.
Traffic usage
Returns traffic usage statistics for the VPS.
CPU usage
Returns current or recent CPU usage data.
Basic details
Returns a simplified set of VPS information.
Mount details
Shows which ISO (if any) is currently mounted.

VNC management

VNC keymap
Sets the keyboard layout for the VNC console.
VNC status
Returns the current VNC access status.
Enable VNC
Enables VNC access to the VPS.
Disable VNC
Disables VNC access.

PTR (rDNS)

Get PTR
Returns current reverse DNS (PTR) records.
Delete PTR
Deletes a PTR record.
Set PTR
Creates or updates a PTR record.

Webhooks

Get all webhooks
Returns all configured webhooks for the VPS.
Delete webhook
Deletes a webhook.
Traffic monitor webhook
Creates a webhook that triggers when a traffic threshold is reached.
Callback example
Shows an example payload of a webhook callback.

Full example: authenticate, check status, reinstall, and verify mount

This example shows a realistic workflow for managing one existing VPS.In this example, you:

create an auth session
collect the session values
check power state
get available autoinstall images
reinstall the VPS
get available ISO images
mount an ISO
verify the mounted ISO

Step 1: Create the auth session

curl --request POST \
  --url https://session.edisglobal.com/kvm/v2/get/auth \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data email=YOUR_EMAIL \
  --data pw=YOUR_PASSWORD \
  --data kvm_id=kvm_847362_918273

Example response:

{
  "data": {
    "kvm_847362_918273": {
      "api_host": "7f3a21.edisglobal.com",
      "api_rdns": "dns-api.edisglobal.com",
      "kvm_id": "kvm_847362_918273",
      "valid_until": 1789456123,
      "signature": "12345678901234567890123456789012345678901234567890",
      "suspended": "n",
      "description": "v2eu",
      "lps": "DE",
      "lps_ispremium": true,
      "primary_ip": "185.203.118.74"
    }
  },
  "status": "success"
}

From here, save:

api_host=7f3a21.edisglobal.com
kvm_id=kvm_847362_918273
signature=12345678901234567890123456789012345678901234567890
valid_until=1789456123

Step 2: Check power state

curl --request POST \
  --url https://7f3a21.edisglobal.com/kvm/v2/get/power \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=12345678901234567890123456789012345678901234567890 \
  --data kvm_id=kvm_847362_918273 \
  --data valid_until=1789456123

Example response:

{
  "data": "server powered on",
  "status": "success",
  "traffic_suspended": false
}

Step 3: Get available autoinstall images

curl --request POST \
  --url https://7f3a21.edisglobal.com/kvm/v2/get/images \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=12345678901234567890123456789012345678901234567890 \
  --data kvm_id=kvm_847362_918273 \
  --data valid_until=1789456123

Example response excerpt:

{
  "data": [
    "cloudinit_almalinux-9",
    "cloudinit_debian-bookworm",
    "cloudinit_debian-trixie",
    "cloudinit_ubuntu-lts-22-04",
    "cloudinit_ubuntu-lts-24-04",
    "windows-server-2022"
  ],
  "status": "success"
}

For this example, use:

cloudinit_ubuntu-lts-22-04

Step 4: Reinstall the VPS

curl --request POST \
  --url https://7f3a21.edisglobal.com/kvm/v2/set/reinstall \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=12345678901234567890123456789012345678901234567890 \
  --data kvm_id=kvm_847362_918273 \
  --data valid_until=1789456123 \
  --data image=cloudinit_ubuntu-lts-22-04 \
  --data password=YOUR_NEW_PASSWORD

Example response:

{
  "status": "success"
}

A Linux reinstall usually finishes in about 5 minutes. You don’t receive an email with credentials.

Step 5: Get available ISO images

curl --request POST \
  --url https://7f3a21.edisglobal.com/kvm/v2/get/isos \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=12345678901234567890123456789012345678901234567890 \
  --data kvm_id=kvm_847362_918273 \
  --data valid_until=1789456123

Example response excerpt:

{
  "data": [
    "0_SystemRescue-10.02-amd64.iso",
    "1_Password-Reset-Helper.iso",
    "Windows_Server_2019_RS5_EVAL_x64_EN-US.iso",
    "Windows_Server_2022_EVAL_x64_EN-US.iso",
    "pfSense-2.7.iso"
  ],
  "status": "success"
}

For this example, mount:

Windows_Server_2022_EVAL_x64_EN-US.iso

Step 6: Mount the ISO

curl --request POST \
  --url https://7f3a21.edisglobal.com/kvm/v2/set/mount \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=12345678901234567890123456789012345678901234567890 \
  --data kvm_id=kvm_847362_918273 \
  --data valid_until=1789456123 \
  --data iso=Windows_Server_2022_EVAL_x64_EN-US.iso \
  --data force_reset=no

Example response:

{
  "status": "success"
}

Step 7: Verify the current mount

curl --request POST \
  --url https://7f3a21.edisglobal.com/kvm/v2/get/mount \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=12345678901234567890123456789012345678901234567890 \
  --data kvm_id=kvm_847362_918273 \
  --data valid_until=1789456123

Example response:

{
  "current_iso": "Windows_Server_2022_EVAL_x64_EN-US.iso",
  "status": "success"
}

What this example shows

This end-to-end example used the Management API to:

authenticate a VPS session
retrieve session values
inspect current VPS state
retrieve autoinstall image names
reinstall the VPS
retrieve ISO names
mount an ISO
confirm the current mount state

This is the general pattern you will also use for other management tasks such as:

VNC access
PTR changes
traffic pool actions
hardware settings
webhook setup

Final takeaway

The Management API always starts with auth session first.Once you have:

api_host
kvm_id
signature
valid_until

you can manage the VPS just like you would in the web portal.

​Manage your VPS the right way

​Let’s keep this simple

​The basic idea

​Step-by-step overview

​Create an auth session

​Example auth response

​What do these values mean?

​Example: check power state

​Example: reinstall a VPS

​Pro tip

​Key takeaway

​Management API workflow

​Common parameters used across the Management API

​Authentication

​Create auth session

​Pro tip

​Full endpoint list

​Session & authentication

​Power management

​Installation & recovery

​Traffic Pool

​Settings

​Monitoring & information

​VNC management

​PTR (rDNS)

​Webhooks

​Full example: authenticate, check status, reinstall, and verify mount

​Step 1: Create the auth session

​Step 2: Check power state

​Step 3: Get available autoinstall images

​Step 4: Reinstall the VPS

​Step 5: Get available ISO images

​Step 6: Mount the ISO

​Step 7: Verify the current mount

​What this example shows

​Final takeaway

Manage your VPS the right way

Let’s keep this simple

The basic idea

Step-by-step overview

Create an auth session

Example auth response

What do these values mean?

Example: check power state

Example: reinstall a VPS

Pro tip

Key takeaway

Management API workflow

Common parameters used across the Management API

Authentication

Create auth session

Pro tip

Full endpoint list

Session & authentication

Power management

Installation & recovery

Traffic Pool

Settings

Monitoring & information

VNC management

PTR (rDNS)

Webhooks

Full example: authenticate, check status, reinstall, and verify mount

Step 1: Create the auth session

Step 2: Check power state

Step 3: Get available autoinstall images

Step 4: Reinstall the VPS

Step 5: Get available ISO images

Step 6: Mount the ISO

Step 7: Verify the current mount

What this example shows

Final takeaway