Download OpenAPI specification:Download
To get your token, go to Elestio security tab, then click on Manage API Tokens > Create Token.
You will get a token similar to ggiKvqrHfpAhBofvjOtax4JI
You will need to call /api/auth/checkAPIToken to get a valid jwt.
You can then use this jwt to call all others API calls.
string User email address | |
token | string User token generated for Authentication |
{- "token": "gx45xxxXuZ5PZxs8dXXRhMpV0"
}
{- "status": "OK",
- "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S"
}
jwt | string User jwt for Authentication |
templateID | string Template id of the service which user wants to create |
serverType | string Type of the service server. |
datacenter | string The datacenter from where the server will be hosted |
serverName | string Name of the server given by user |
appid | string Application id |
data | string |
support | string Level of the support plan choosen for the server |
projectId | string Project id for the selected service |
version | string Version of service software |
adminEmail | string Email address of service owner/admin |
deploymentServiceType | string Enum: "normal" "restore" "clone" The kind of operation you intend to carry out while deploying the VM. Normal refers to simply deploying a regular VM, restore to deploying a new VM from an old deleted VM (Only possible if you're deploying within 14 days of deletion and you don't choose to opt out of borg backup at that time), and clone to deploying a new copy of a running VM. |
serviceType | string Enum: "Service" "CICD" "LB" The type of VM you're deploying. Service refers to a regular VM, CICD refers to a CI/CD pipeline target, and LB refers to a load balancer. |
{- "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
- "templateID": "38",
- "serverType": "SMALL-1C-2G",
- "datacenter": "fsnl",
- "serverName": "ubuntu-3dfd",
- "appid": "Cloudxx",
- "data": "data",
- "support": "level1",
- "projectId": "17734567",
- "version": "1",
- "deploymentServiceType": "normal",
- "serviceType": "Service"
}
{- "action": {
- "id": 402419563,
- "command": "create_server",
- "status": "running",
- "progress": 0,
- "started": "2022-03-08T10:48:46.000Z",
- "finished": "1970-01-01T00:00:00.000Z",
- "resources": [
- {
- "id": 12345678,
- "type": "server"
}
]
}, - "providerServerID": 12345678
}
jwt | string User jwt token for Authentication |
appid | string Application id |
projectId | string Project id for selected service |
isActiveService | string If the service is running it will be true |
{- "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
- "appid": "Cloudxx",
- "projectId": "17734567",
- "isActiveService": "true"
}
[- {
- "id": 12345,
- "status": "running",
- "deploymentStatus": "Deployed",
- "appID": "Cloudxx",
- "selected_software_tag": "latest",
- "displayName": "ubuntu-xxxxx",
- "vmID": "12345678",
- "ipv4": "127.132.230.13",
- "cname": "ubuntu-xxxxx-xxxx.vm.appdrag.net",
- "projectID": "123",
- "template": 38,
- "datacenter": "fsn1",
- "globalIP": "127.17.71.1",
- "country": "Germany",
- "city": "Falkenstein",
- "templateName": "Ubuntu",
- "category": "Operating Systems",
- "token": "ghn45ht2-xxgr-gXxbYxID2",
- "imageType": "ubuntu-20.04",
- "serverType": "SMALL-1C-2G",
- "traffic_outgoing": 0,
- "traffic_ingoing": 0,
- "traffic_included": 21990232555520,
- "cores": 1,
- "ramGB": "2.00",
- "storageSizeGB": 20,
- "isProtected": 0,
- "creationDate": "2022-03-08T11:00:54.000Z",
- "lastUpdate": "2022-03-08T11:03:20.000Z",
- "backupsActivated": 1,
- "remoteBackupsActivated": 1,
- "isFirewallActivated": 0,
- "isAlertsActivated": 0,
- "isLocked": 0,
- "managedDBPort": "",
- "managedDBCLI": "",
- "pricePerHour": "0.014",
- "provider": "hetzner",
- "firewallPorts": "",
- "adminUser": "null",
- "app_AutoUpdate_Enabled": 1,
- "system_AutoUpdate_Enabled": 1,
- "rateLimiter": "150r/m",
- "outputCacheDurationInSeconds": 0,
- "support": "level1"
}
]
jwt | string User jwt token for Authentication |
vmID | string Virtual machine id of selected service |
projectID | string Project id of selected service |
{- "jwt": "ImF1dGSZQOAINZRpdHNX1dG9S",
- "vmID": "123456789",
- "projectID": "123"
}
{- "serviceInfos": [
- {
- "id": 123,
- "appID": "Cloudxx",
- "category": "Databases & Cache",
- "city": "Falkenstein",
- "cname": "postgresql-xxxxx-xxxx.vm.appdrag.net",
- "cores": 1,
- "country": "Germany",
- "creationDate": "2022-03-07T17:57:09.000Z",
- "datacenter": "fsn1",
- "deploymentStatus": "Deployed",
- "displayName": "postgresql-xxxxx",
- "dockerhub_image": "postgres",
- "externalBackupRetainDay": 7,
- "externalBackupUpdateDay": -1,
- "externalBackupUpdateHour": 1,
- "externalBackupUpdateMinute": 0,
- "firewallPorts": "11123,11343",
- "firewall_id": "xxxxx",
- "globalIP": "127.17.71.1",
- "imageType": "ubuntu-20.04",
- "ipv4": "142.132.185.174",
- "ipv6": "2a01:4f8:c010:a3e8::/64",
- "isAlertsActivated": 1,
- "isExternalBackupActivated": 0,
- "isFirewallActivated": 1,
- "isLocked": 0,
- "isOriginExist": 0,
- "isProtected": 0,
- "isVolumeExist": 0,
- "isWaitingForMigration": 0,
- "lastUpdate": "2022-03-07T19:05:56.000Z",
- "managedDBCLI": "PGPASSWORD=[APP_PASSWORD] psql --host=[DOMAIN] --port=34523 --username=postgres",
- "managedDBPort": "34523",
- "outputCacheDurationInSeconds": 0,
- "provider": "hetzner",
- "ramGB": "2.00",
- "rateLimiter": "150r/m",
- "remoteBackupsActivated": 1,
- "selected_software_tag": "14",
- "serverType": "SMALL-1C-2G",
- "status": "running",
- "storageSizeGB": 20,
- "support": "level1"
}
]
}
curl --request GET \ --url https://api.elest.io/api/servers/getTemplates
{- "instances": [
- {
- "id": 11,
- "category": "Databases & Cache",
- "title": "PostgreSQL",
- "version": "14",
- "description": "PostgreSQL is a powerful, open-source, object-relational database system that uses and extends the SQL language combined with many features that safely store and scale the most complicated data workloads. It has a strong reputation for its architecture, reliability, data integrity, robust feature set and extensibility. It runs on all major operating systems, is ACID-compliant, and has powerful add-ons such as the PostGIS geospatial database extender."
}, - {
- "id": 12,
- "category": "Databases & Cache",
- "title": "MySQL",
- "version": "8",
- "description": "MySQL is an open-source relational database management system (RDBMS). Many of the world's largest organizations rely on it to power their high-volume websites, business-critical systems and packaged software. It runs on almost all platforms, including Linux, UNIX and Windows."
}, - {
- "id": 13,
- "category": "Operating Systems",
- "minCores": 1,
- "osName": "Ubuntu 20.04",
- "showOrder": 0,
- "title": "Ubuntu",
- "version": "20.04",
- "description": "Ubuntu is officially released in three editions: Desktop, Server, and Core for Internet of Things devices and robots. All the editions can run on the computer alone, or in a virtual machine"
}, - {
- "id": 14,
- "category": "Applications",
- "description": "WordPress is a free and open-source content management system. The core WordPress software is built by hundreds of community volunteers. You can avail of any of thousands of plugins and themes to transform your site. Over 60 million people have chosen WordPress to power the place on the web they call home. WordPress is written in PHP and paired with a MySQL or MariaDB database.",
- "minCores": 1,
- "osName": "Ubuntu 20.04",
- "showOrder": 0,
- "title": "Wordpress",
- "version": "latest"
}
]
}
curl --request GET \ --url https://api.elest.io/api/servers/getServerSizes
{- "instances": [
- {
- "Continent": "Europe",
- "Country": "Netherlands",
- "City": "Amsterdam",
- "CountryCode": "NL",
- "providerName": "DO",
- "regionID": "ams3",
- "regionCode": "ams3",
- "regionName": "Digital Ocean - NL - AMS3",
- "title": "MICRO-1C-1G",
- "providerType": "s-1vcpu-1gb-intel",
- "vCPU": 1,
- "ramGB": "1.00",
- "storageType": "NVME",
- "storageSizeGB": 25,
- "offerTrafficIncludedGB": "1000",
- "pricePerHour": "0.022",
- "cpuBrand": "Intel Xeon"
}, - {
- "Continent": "Europe",
- "Country": "Netherlands",
- "City": "Amsterdam",
- "CountryCode": "NL",
- "providerName": "DO",
- "regionID": "ams3",
- "regionCode": "ams3",
- "regionName": "Digital Ocean - NL - AMS3",
- "title": "SMALL-1C-2G",
- "providerType": "s-1vcpu-2gb-intel",
- "vCPU": 1,
- "ramGB": "2.00",
- "storageType": "NVME",
- "storageSizeGB": 50,
- "offerTrafficIncludedGB": "2000",
- "pricePerHour": "0.045",
- "cpuBrand": "Intel Xeon"
}, - {
- "Continent": "Europe",
- "Country": "Netherlands",
- "City": "Amsterdam",
- "CountryCode": "NL",
- "providerName": "DO",
- "regionID": "ams3",
- "regionCode": "ams3",
- "regionName": "Digital Ocean - NL - AMS3",
- "title": "MEDIUM-2C-4G",
- "providerType": "s-2vcpu-4gb-intel",
- "vCPU": 2,
- "ramGB": "4.00",
- "storageType": "NVME",
- "storageSizeGB": 80,
- "offerTrafficIncludedGB": "4000",
- "pricePerHour": "0.089",
- "cpuBrand": "Intel Xeon"
}, - {
- "Continent": "Europe",
- "Country": "Netherlands",
- "City": "Amsterdam",
- "CountryCode": "NL",
- "providerName": "DO",
- "regionID": "ams3",
- "regionCode": "ams3",
- "regionName": "Digital Ocean - NL - AMS3",
- "title": "LARGE-4C-8G",
- "providerType": "s-4vcpu-8gb-intel",
- "vCPU": 4,
- "ramGB": "8.00",
- "storageType": "NVME",
- "storageSizeGB": 160,
- "offerTrafficIncludedGB": "5000",
- "pricePerHour": "0.179",
- "cpuBrand": "Intel Xeon"
}, - {
- "Continent": "Europe",
- "Country": "Netherlands",
- "City": "Amsterdam",
- "CountryCode": "NL",
- "providerName": "DO",
- "regionID": "ams3",
- "regionCode": "ams3",
- "regionName": "Digital Ocean - NL - AMS3",
- "title": "XLARGE-8C-16G",
- "providerType": "s-8vcpu-16gb-intel",
- "vCPU": 8,
- "ramGB": "16.00",
- "storageType": "NVME",
- "storageSizeGB": 320,
- "offerTrafficIncludedGB": "6000",
- "pricePerHour": "0.357",
- "cpuBrand": "Intel Xeon"
}, - {
- "Continent": "Asia",
- "Country": "India",
- "City": "Bangalore",
- "CountryCode": "IN",
- "providerName": "DO",
- "regionID": "blr1",
- "regionCode": "blr1",
- "regionName": "Digital Ocean - IN - blr1",
- "title": "MICRO-1C-1G",
- "providerType": "s-1vcpu-1gb-intel",
- "vCPU": 1,
- "ramGB": "1.00",
- "storageType": "NVME",
- "storageSizeGB": 25,
- "offerTrafficIncludedGB": "1000",
- "pricePerHour": "0.022",
- "cpuBrand": "Intel Xeon"
}, - {
- "Continent": "Asia",
- "Country": "India",
- "City": "Bangalore",
- "CountryCode": "IN",
- "providerName": "DO",
- "regionID": "blr1",
- "regionCode": "blr1",
- "regionName": "Digital Ocean - IN - blr1",
- "title": "SMALL-1C-2G",
- "providerType": "s-1vcpu-2gb-intel",
- "vCPU": 1,
- "ramGB": "2.00",
- "storageType": "NVME",
- "storageSizeGB": 50,
- "offerTrafficIncludedGB": "2000",
- "pricePerHour": "0.045",
- "cpuBrand": "Intel Xeon"
}, - {
- "Continent": "Asia",
- "Country": "India",
- "City": "Bangalore",
- "CountryCode": "IN",
- "providerName": "DO",
- "regionID": "blr1",
- "regionCode": "blr1",
- "regionName": "Digital Ocean - IN - blr1",
- "title": "MEDIUM-2C-4G",
- "providerType": "s-2vcpu-4gb-intel",
- "vCPU": 2,
- "ramGB": "4.00",
- "storageType": "NVME",
- "storageSizeGB": 80,
- "offerTrafficIncludedGB": "4000",
- "pricePerHour": "0.089",
- "cpuBrand": "Intel Xeon"
}, - {
- "Continent": "Asia",
- "Country": "India",
- "City": "Bangalore",