API
JSON over HTTPS. Send your API key in the Authorization header. Up to 300 requests per minute.
Base address
https://helpervps.com/api/v1
Authentication
Header Authorization: Bearer YOUR_API_KEY. Create the key on the API key page after your first top-up.
curl https://helpervps.com/api/v1/servers \ -H "Authorization: Bearer YOUR_API_KEY"
GET /catalog
Sizes, locations and systems you can pick.
Example response
{
"plans": [ { "code": "s2", "vcpu": 1, "ram_mb": 2048, "disk_gb": 50, "monthly": "12.00" } ],
"locations": [ "frankfurt", "singapore" ],
"images": [ "ubuntu-24-04", "debian-12" ]
}GET /servers
Your servers.
Example response
[
{ "id": 41, "label": "web-1", "state": "running", "ipv4": "192.0.2.15", "paid_until": "2026-11-14T09:00:00Z" }
]POST /servers {"plan":"s2","location":"frankfurt","image":"ubuntu-24-04","label":"web-1"}
Creates a server and pays the first month from your balance. The root password is in the response once.
Example response
{
"id": 41,
"state": "creating",
"root_password": "..."
}POST /servers/{id}/start (stop, reboot)
Power actions.
Example response
{
"id": 41,
"state": "running"
}POST /servers/{id}/renew
Pays one more month now.
Example response
{
"id": 41,
"paid_until": "2026-12-14T09:00:00Z"
}DELETE /servers/{id}
Deletes the server. The rest of the month is not refunded.
Example response
{
"id": 41,
"state": "deleted"
}Errors
Errors return a non 2xx status and a JSON body with an error code.
| unauthorized | Missing or wrong API key |
| not_allowed | The API opens after your first top-up |
| bad_request | A field is missing or wrong |
| not_enough_balance | Top up first |
| limit | Too many servers on the account |
| not_created | The server could not be created; the month is back in your balance |
| checking | The supplier did not confirm; we finish the server or return the month |
| not_found | No such server on your account |
| wrong_state | The action does not fit the server's current state |
| rate_limited | Too many requests in a minute |