VPS API docs: REST API para gumawa at mamahala ng server

Ang magagawa gamit ang API

Ang API ay para sa mga nagma-manage ng maraming server o gustong i-automate ang deployment. I-load ang listahan ng mga plan, rehiyon at image; kapag gumawa ka ng server, ipoproseso ang bayad at ang iyong server ay gagawin pagkatapos ng kumpirmasyon. Ang parehong patakaran tulad ng web pages ay nalalapat, kaya ang mga server na ginawa gamit ang API ay makikita rin sa listahan ng server ng iyong account.

Kung unang beses mo, sundan nang sunod sunod ang API quick start guide mula sa paggawa ng key hanggang sa paggawa ng unang server. Ang page na ito ay reference na nagtitipon ng lahat ng endpoint at field sa iisang lugar.

Base address

Lahat ng request ay ipinapadala sa pagdagdag ng path sa likod ng address sa ibaba. Lahat ng request at response body ay JSON (UTF-8).

https://helpervps.com/api/v1

Authentication

Ipadala ang header na Authorization: Bearer YOUR_API_KEY. Maaari kang gumawa ng key mula sa API keys menu sa iyong account pagkatapos ng iyong unang bayad; ang mga key ay nagsisimula sa hvp_. Ang buong key ay ipapakita lamang nang isang beses, kaagad pagkatapos itong gawin, at ang paggawa ng bagong key ay agad na magdi-disable sa lumang key.

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

Limitasyon ng request

Server code

Kinikilala ang server hindi sa numero kundi sa server code tulad ng S-7K2M-9QX4-HB3T. Ilagay lang sa path ang id mula sa listahan ng server o sa response ng paggawa. Hindi mahalaga ang malaki o maliit na titik.

GET /catalog

Ibinabalik nang sabay ang mga binebentang specs (plans), lokasyon (locations), image (images) at dagdag na option (addons). Dito galing ang lahat ng code na ilalagay sa paggawa ng server. Ang monthly ay buwanang bayad sa US dollar, at ang option na hindi binebenta ay null. Ang monthly_per_gb ng dagdag na disk ay ipinapakita hanggang tatlong decimal place.

Halimbawa ng request

curl https://helpervps.com/api/v1/catalog \
  -H "Authorization: Bearer YOUR_API_KEY"

Halimbawa ng response

{
  "plans": [
    { "code": "s2", "type": "basic", "vcpu": 1, "ram_mb": 2048, "disk_gb": 50, "transfer_tb": 2, "monthly": "2.48" }
  ],
  "locations": ["frankfurt", "singapore", "seoul"],
  "images": ["ubuntu-24-04", "debian-13", "almalinux-10", "app-docker"],
  "addons": {
    "backups": { "percent_of_plan": 5.6 },
    "extra_disk": { "sizes_gb": [50, 100, 250, 500, 1000], "monthly_per_gb": "0.028" },
    "ddos_protection": { "monthly": "1.68" }
  }
}

GET /servers

Ibinabalik ang listahan ng server mo ayon sa pinakabagong ginawa. Hindi kasama ang binura o hindi nagawang server.

Halimbawa ng request

curl https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

Halimbawa ng response

[
  {
    "id": "S-7K2M-9QX4-HB3T",
    "label": "web-1",
    "state": "running",
    "ipv4": "192.0.2.15",
    "ipv6": "2001:db8::15",
    "monthly": "2.48",
    "backups": false,
    "extra_disk_gb": 0,
    "ddos_protection": false,
    "paid_until": "2026-11-18T09:00:00.000Z"
  }
]

POST /servers

Gumagawa ng server at ipoproseso ang bayad. Gamitin ang catalog codes para sa plan, lokasyon at image kung paano ito. Ang label ay maaaring hanggang 40 Latin na titik, numero, tuldok at gitling; ang ibang character ay magiging gitling. Opsyonal ang backups, extra_disk_gb at ddos_protection. Kapag nagtagumpay, makakatanggap ka ng 201 kasama ang mga detalye ng server, at kasama ang root_password nang isang beses sa response na ito (maaari mo rin itong tingnan sa server page ng iyong account sa loob ng 7 araw).

Halimbawa ng request

curl -X POST https://helpervps.com/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"plan":"s2","location":"frankfurt","image":"ubuntu-24-04","label":"web-1","backups":true,"extra_disk_gb":0,"ddos_protection":false}'

Halimbawa ng response

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "creating",
  "ipv4": null,
  "ipv6": null,
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z",
  "root_password": "..."
}

GET /servers/{id}

Ibinabalik ang status, address, buwanang bayad at petsa ng pagtatapos ng bayad ng isang server. Nagsisimula ang bagong server sa creating, nagiging running kapag handa na, at napupunan ang ipv4 at ipv6. Sapat na ang pag-check bawat ilang segundo.

Halimbawa ng request

curl https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

Halimbawa ng response

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "running",
  "ipv4": "192.0.2.15",
  "ipv6": "2001:db8::15",
  "monthly": "2.61",
  "backups": true,
  "extra_disk_gb": 0,
  "ddos_protection": false,
  "paid_until": "2026-11-18T09:00:00.000Z"
}

POST /servers/{id}/start (stop, reboot)

Ino-on ng start ang huminto (stopped) na server, at ino-off o nire-restart ng stop at reboot ang tumatakbong (running) server. Ang response ay ang binagong info ng server.

Halimbawa ng request

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/reboot \
  -H "Authorization: Bearer YOUR_API_KEY"

Halimbawa ng response

{
  "id": "S-7K2M-9QX4-HB3T",
  "label": "web-1",
  "state": "rebooting",
  ...
}

POST /servers/{id}/renew

Magbayad ngayon para pahabain ang validity period. Ang server na na-suspend pagkatapos ng expiry ay muling mag-o-on din sa request na ito.

Halimbawa ng request

curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/renew \
  -H "Authorization: Bearer YOUR_API_KEY"

Halimbawa ng response

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "running",
  "paid_until": "2026-12-18T09:00:00.000Z",
  ...
}

DELETE /servers/{id}

Binubura ang server at ang disk nito. Hindi na sisingilin simula sa susunod na billing date, at hindi nire-refund ang natitirang panahon ng nabayarang buwan.

Halimbawa ng request

curl -X DELETE https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \
  -H "Authorization: Bearer YOUR_API_KEY"

Halimbawa ng response

{
  "id": "S-7K2M-9QX4-HB3T",
  "state": "deleted"
}

Mga field ng server response

Mga status value

Mga error

Kapag may error, ibinabalik ang JSON na hugis {"error": "code"} kasama ang status code. Hatiin ang pag-handle ayon sa code value.

Mga kaugnay na gabay

Ang mga bayad ay ginagawa sa pamamagitan ng secure na PayGate checkout. Maaari kang mag-reinstall at gumawa ng bagong root password sa server page ng iyong account; ang mga hakbang ay nasa gabay sa reinstall.

Makikita ang magagawa gamit ang API at mga halimbawa ng automation sa page na VPS API, at ang buwanang bayad kada specs sa pricing page.