HELPER VPS

API

JSON عبر HTTPS. أرسل مفتاح API في ترويسة Authorization. حتى 300 طلبًا في الدقيقة.

العنوان الأساسي

https://helpervps.com/api/v1

المصادقة

الترويسة Authorization: Bearer YOUR_API_KEY. أنشئ المفتاح في صفحة مفتاح API بعد أول عملية شحن.

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

GET /catalog

الأحجام والمواقع والأنظمة المتاحة للاختيار.

مثال على الاستجابة

{
  "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

خوادمك.

مثال على الاستجابة

[
  { "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"}

ينشئ خادمًا ويدفع الشهر الأول من رصيدك. تظهر كلمة مرور root في الاستجابة مرة واحدة.

مثال على الاستجابة

{
  "id": 41,
  "state": "creating",
  "root_password": "..."
}

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

إجراءات التشغيل.

مثال على الاستجابة

{
  "id": 41,
  "state": "running"
}

POST /servers/{id}/renew

يدفع شهرًا إضافيًا الآن.

مثال على الاستجابة

{
  "id": 41,
  "paid_until": "2026-12-14T09:00:00Z"
}

DELETE /servers/{id}

يحذف الخادم. لا يُسترد باقي الشهر.

مثال على الاستجابة

{
  "id": 41,
  "state": "deleted"
}

الأخطاء

تعيد الأخطاء رمز حالة غير 2xx ونص JSON يتضمن رمز الخطأ.

unauthorizedمفتاح API مفقود أو غير صحيح
not_allowedيُفتح API بعد أول عملية شحن
bad_requestحقل مفقود أو غير صحيح
not_enough_balanceاشحن رصيدك أولًا
limitعدد الخوادم في الحساب كبير جدًا
not_createdتعذّر إنشاء الخادم؛ أُعيد الشهر إلى رصيدك
checkingلم يؤكد المزوّد؛ سنكمل الخادم أو نعيد الشهر
not_foundلا يوجد خادم بهذا المعرّف في حسابك
wrong_stateلا يتوافق الإجراء مع حالة الخادم الحالية
rate_limitedطلبات كثيرة جدًا خلال دقيقة