Application Programming Interface

At Oxide Hosting, we support our customer's development projects by making some of our internal data available publicly. This enables you to make use of our platform data for your own projects as per your requirements. All data currently provided does not require any form of pre-authentication meaning any sensitive data is not currently available via this.

Allows you to list all available products with their respective identifiers, stock and basic descriptions.

Parameters

Name Type Value Description Required
request GET products This specifies the request you are making to the controller. Yes
productid BOTH Integer This specifies for an individual product to be returned. No

cURL Example

curl -k -L "https://api.oxide.host/controller?request=products"
curl -k -L "https://api.oxide.host/controller?request=products&productid=8"
curl -k -X POST -d "productid=8" -L "https://api.oxide.host/controller?request=products"

{"status":"200","response":{"VPS Classic XS":{"id":"8","name":"VPS Classic XS","description":"Features included are listed below.\r\n\r\n1x vCore (3.70ghz),\r\n2048MB DDR4 ECC Ram,\r\n32GB Storage (SSD),\r\n200mbp\/s Port (Upgradeable),\r\nUnmetered Bandwidth,\r\n1x IPv4, 1x IPv6 (\/112) - DDoS Protected,\r\nAutomated Backups,\r\nService Monitoring,\r\nMultiple Locations,\r\nVirtualized by KVM.","recurring":"true","pricing":{"GBP":"3.59","USD":"4.80","EUR":"3.95"},"availabilities":{"france":"available","canada":"available"}}}}

Allows you to list all available host systems which can be used within a query.

Parameters

Name Type Value Description Required
request GET hostsystems This specifies the request you are making to the controller. Yes

cURL Example

curl -k -L "https://api.oxide.host/controller?request=hostsystems"

{"status":"200","response":{"VPS-FR01":{"servername":"VPS-FR01","hostname":"vps.fr01.oxide.systems"},"VPS-FR02":{"servername":"VPS-FR02","hostname":"vps.fr02.oxide.systems"},"VPS-FR03":{"servername":"VPS-FR03","hostname":"vps.fr03.oxide.systems"}

Allows you to call the current status of a particular host system and information regarding such.

Parameters

Name Type Value Description Required
request GET hostsystemsStatus This specifies the request you are making to the controller. Yes
servername BOTH String This specifies which hostsystem you would like to call the information for. Yes

cURL Example

curl -k -L "https://api.oxide.host/controller?request=hostsystemsStatus&servername=VPS-FR01"
curl -k -X POST -d "servername=VPS-FR01" -L "https://api.oxide.host/controller?request=hostsystemsStatus"

{"status":"200","response":{"servername":"VPS-FR01","hostname":"vps.fr01.oxide.systems","location":"Gravelines, France","status":"online","updated":{"lastupdated":"16\/12\/2020 19:56:02","statuslastupdated":"10\/05\/2020 00:00:00"},"serveravailability":"none"}}

Allows you to call the current status of a particular Virtual Server and information regarding such.

Parameters

Name Type Value Description Required
request GET vpsStatus This specifies the request you are making to the controller. Yes
ip BOTH String This specifies which Virtual Server you would like to call the information for. Yes

cURL Example

curl -k -L "https://api.oxide.host/controller?request=vpsStatus&ip=91.134.15.72"
curl -k -X POST -d "ip=91.134.15.72" -L "https://api.oxide.host/controller?request=vpsStatus"

{"status":"200","response":{"id":"124","ip":"91.134.15.72","status":"offline","updated":{"lastupdated":"16\/12\/2020 19:56:57","statuslastupdated":"10\/12\/2020 00:02:11"},"hostsystem":{"name":"VPS-FR01","hostname":"vps.fr01.oxide.systems"},"monitoring":{"monitoring":true,"monitorbatch":"FR4","server":"51.38.161.81"}}}

Allows you to call the current status of all our hostsystems at once including overall percentage offline.

Parameters

Name Type Value Description Required
request GET generalStatus This specifies the request you are making to the controller. Yes

cURL Example

curl -k -L "https://api.oxide.host/controller?request=generalStatus"

{"status":"200","response":{"hostsystems":{"WH-PLESK":{"name":"WH-PLESK","hostname":"plesk.oxide.host","status":"online"},"DBH-FR02":{"name":"DBH-FR02","hostname":"dbh.fr02.oxide.systems","status":"online"},"WEB-VIRTUALIZOR":{"name":"WEB-VIRTUALIZOR","status":"online"},"VPS-CA01":{"name":"VPS-CA01","hostname":"vps.ca01.oxide.systems","status":"online"},"VPS-CA02":{"name":"VPS-CA02","hostname":"vps.ca02.oxide.systems","status":"online"},"VPS-FR01":{"name":"VPS-FR01","hostname":"vps.fr01.oxide.systems","status":"online"},"VPS-FR02":{"name":"VPS-FR02","hostname":"vps.fr02.oxide.systems","status":"online"},"VPS-FR03":{"name":"VPS-FR03","hostname":"vps.fr03.oxide.systems","status":"online"},"VPS-FR04":{"name":"VPS-FR04","hostname":"vps.fr04.oxide.systems","status":"online"},"DBH-CA01":{"name":"DBH-CA01","hostname":"dbh.ca01.oxide.systems","status":"online"},"VPS-US01":{"name":"VPS-US01","hostname":"vps.us01.oxide.systems","status":"online"},"general":{"offlineServers":0,"offlineServersPercentage":"0%"}}}

All that display this symbol do not require authentication. BOTH All that display this symbol may use both POST/GET.