Manage Your VPS the Right Way
EDIS Global Management API is used to 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 control panel.
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 KVM 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 KVM 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 it is disabled.
Create auth session
Call the auth endpoint with your client area 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_947312_968273",
"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
Pick 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 KVM 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 it is disabled.
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
Pro Tip
Avoid hardcoding API values.Autoinstall images are subject to change, and api_host is not static — it may change when a VPS is migrated 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 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
Traffic Pool
Settings
- 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
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
Full Example: Authenticate, Check Status, Reinstall, and Verify Mount
This example shows a realistic workflow for managing one existing VPS.We will:
- 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, we will 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:A Linux reinstall usually finishes in about 5 minutes. No email with credentials is being sent.
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, we will 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:
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.