VPS API ডকুমেন্টেশন, সার্ভার তৈরি ও পরিচালনার REST API
এটি HTTPS-এ JSON আদান-প্রদান করা একটি REST API। Authorization হেডারে শুধু একটি API কী পাঠালেই প্ল্যান দেখা থেকে সার্ভার তৈরি, পাওয়ার ম্যানেজমেন্ট, রিনিউ ও ডিলিট পর্যন্ত অ্যাকাউন্ট স্ক্রিনের সব কাজ প্রোগ্রাম দিয়ে করতে পারবেন। প্রতিটি অ্যাকাউন্ট মিনিটে 300টি পর্যন্ত রিকোয়েস্ট পাঠাতে পারে।
API দিয়ে যা করা যায়
API ব্যবহার করুন যখন আপনি অনেক সার্ভার পরিচালনা করেন বা ডিপ্লয়মেন্ট স্বয়ংক্রিয় করতে চান। প্ল্যান, অঞ্চল এবং ইমেজের তালিকা লোড করুন; আপনি যখন একটি সার্ভার তৈরি করেন, পেমেন্ট প্রসেস করা হয় এবং আপনার সার্ভার নিশ্চিত হওয়ার পর তৈরি হয়। ওয়েব পেজের মতো একই নিয়ম প্রযোজ্য, তাই API দিয়ে তৈরি সার্ভারও আপনার অ্যাকাউন্টের সার্ভার তালিকায় দেখা যায়।
প্রথমবার ব্যবহার করলে API কুইক স্টার্ট গাইড-এ কী তৈরি থেকে প্রথম সার্ভার তৈরি পর্যন্ত ধাপে ধাপে অনুসরণ করুন। এই পেজটি সব এন্ডপয়েন্ট ও ফিল্ড এক জায়গায় রাখা রেফারেন্স ডকুমেন্ট।
বেস অ্যাড্রেস
সব রিকোয়েস্ট নিচের অ্যাড্রেসের পরে পাথ জুড়ে পাঠান। রিকোয়েস্ট ও রেসপন্সের বডি সবই JSON (UTF-8)।
https://helpervps.com/api/v1
অথেনটিকেশন
হেডার পাঠান Authorization: Bearer YOUR_API_KEY। আপনি প্রথম পেমেন্টের পর আপনার অ্যাকাউন্টের API কী মেনু থেকে একটি কী তৈরি করতে পারেন; কীগুলি hvp_ দিয়ে শুরু হয়। পুরো কী শুধু একবার দেখানো হয়, এটি তৈরি হওয়ার ঠিক পরেই, আর একটি নতুন কী তৈরি করলে পুরানো কী সঙ্গে সঙ্গে অকেজো হয়ে যায়।
curl https://helpervps.com/api/v1/servers \ -H "Authorization: Bearer YOUR_API_KEY"
রিকোয়েস্ট সীমা
| সব রিকোয়েস্ট | প্রতিটি অ্যাকাউন্টে মিনিটে 300টি |
| সার্ভার তৈরি (POST /servers) | প্রতিটি অ্যাকাউন্টে ১০ মিনিটে ১০টি |
| অ্যাকাউন্টে সার্ভারের সংখ্যা | 10টি পর্যন্ত |
সার্ভার কোড
সার্ভারকে সংখ্যা দিয়ে নয়, S-7K2M-9QX4-HB3T-এর মতো সার্ভার কোড দিয়ে চেনা হয়। সার্ভার তালিকা বা তৈরির রেসপন্সের id মান হুবহু পাথে বসান। বড় হাতের ও ছোট হাতের অক্ষরে পার্থক্য করা হয় না।
GET /catalog
বিক্রয়ে থাকা প্ল্যান (plans), অঞ্চল (locations), ইমেজ (images) ও অতিরিক্ত অপশন (addons) একবারে ফেরত দেয়। সার্ভার তৈরির সময় যে কোড দেন, সবই এখান থেকে আসে। monthly হলো মার্কিন ডলারে মাসিক ফি, আর যে অপশন বিক্রি হয় না তা null হিসেবে আসে। অতিরিক্ত ডিস্কের monthly_per_gb দশমিকের পর তিন ঘর পর্যন্ত দেখানো হয়।
রিকোয়েস্টের উদাহরণ
curl https://helpervps.com/api/v1/catalog \ -H "Authorization: Bearer YOUR_API_KEY"
রেসপন্সের উদাহরণ
{
"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
আপনার সার্ভার তালিকা সাম্প্রতিক তৈরি অনুযায়ী ফেরত দেয়। ডিলিট হওয়া বা তৈরি না হওয়া সার্ভার বাদ যায়।
রিকোয়েস্টের উদাহরণ
curl https://helpervps.com/api/v1/servers \ -H "Authorization: Bearer YOUR_API_KEY"
রেসপন্সের উদাহরণ
[
{
"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
একটি সার্ভার তৈরি করে এবং পেমেন্ট প্রসেস করে। প্ল্যান, লোকেশন এবং ইমেজের জন্য ক্যাটালগ কোডগুলি হুবহু ব্যবহার করুন। label 40টি লাতিন অক্ষর, সংখ্যা, ডট এবং হাইফেন নেয়; অন্যান্য অক্ষর হাইফেনে পরিণত হয়। backups, extra_disk_gb এবং ddos_protection ঐচ্ছিক। সফল হলে আপনি সার্ভারের বিবরণ সহ 201 পাবেন, এবং root_password এই রেসপন্সে একবারই অন্তর্ভুক্ত থাকে (আপনি এটি আপনার অ্যাকাউন্টের সার্ভার পেজে 7 দিনের জন্য দেখতে পারেন)।
রিকোয়েস্টের উদাহরণ
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}'রেসপন্সের উদাহরণ
{
"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}
একটি সার্ভারের স্ট্যাটাস, অ্যাড্রেস, মাসিক ফি ও পেমেন্টের মেয়াদ শেষের তারিখ ফেরত দেয়। নতুন সার্ভার creating দিয়ে শুরু হয়, প্রস্তুত হলে running হয় আর ipv4, ipv6 পূরণ হয়। কয়েক সেকেন্ড পরপর দেখলেই যথেষ্ট।
রিকোয়েস্টের উদাহরণ
curl https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \ -H "Authorization: Bearer YOUR_API_KEY"
রেসপন্সের উদাহরণ
{
"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)
start বন্ধ (stopped) সার্ভার চালু করে, আর stop ও reboot চালু (running) সার্ভার বন্ধ বা রিস্টার্ট করে। রেসপন্সে পরিবর্তিত সার্ভারের তথ্য আসে।
রিকোয়েস্টের উদাহরণ
curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/reboot \ -H "Authorization: Bearer YOUR_API_KEY"
রেসপন্সের উদাহরণ
{
"id": "S-7K2M-9QX4-HB3T",
"label": "web-1",
"state": "rebooting",
...
}POST /servers/{id}/renew
এখনই পেমেন্ট করে মেয়াদ বাড়ান। মেয়াদ শেষ হওয়ার পর স্থগিত করা একটি সার্ভারও এই অনুরোধে আবার চালু হয়।
রিকোয়েস্টের উদাহরণ
curl -X POST https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T/renew \ -H "Authorization: Bearer YOUR_API_KEY"
রেসপন্সের উদাহরণ
{
"id": "S-7K2M-9QX4-HB3T",
"state": "running",
"paid_until": "2026-12-18T09:00:00.000Z",
...
}DELETE /servers/{id}
সার্ভার ও ডিস্ক ডিলিট করে। পরের পেমেন্ট তারিখ থেকে আর ফি কাটা হয় না, আর ইতিমধ্যে পরিশোধিত মাসের বাকি সময় রিফান্ড হয় না।
রিকোয়েস্টের উদাহরণ
curl -X DELETE https://helpervps.com/api/v1/servers/S-7K2M-9QX4-HB3T \ -H "Authorization: Bearer YOUR_API_KEY"
রেসপন্সের উদাহরণ
{
"id": "S-7K2M-9QX4-HB3T",
"state": "deleted"
}সার্ভার রেসপন্সের ফিল্ড
| id | সার্ভার কোড (S-XXXX-XXXX-XXXX)। সব পাথে এই মান ব্যবহার করুন। |
| label | সার্ভারের নাম |
| state | creating, running, stopped, rebooting, installing, suspended, check-এর যেকোনো একটি |
| ipv4, ipv6 | সার্ভারের অ্যাড্রেস। প্রস্তুত হওয়ার আগে null |
| monthly | অপশনসহ মাসিক ফি (মার্কিন ডলার, স্ট্রিং) |
| backups, extra_disk_gb, ddos_protection | বেছে নেওয়া অতিরিক্ত অপশন |
| paid_until | মেয়াদ শেষের সময় (UTC, ISO 8601)। সার্ভার এই সময়ে স্থগিত হতে পারে। |
| root_password | শুধু তৈরির রেসপন্সে একবার থাকে। |
স্ট্যাটাসের মান
| creating | সার্ভার তৈরি হচ্ছে। |
| running | চালু আছে। stop, reboot ব্যবহার করা যায়। |
| stopped | বন্ধ আছে। start দিয়ে চালু করুন। |
| rebooting | রিস্টার্ট হচ্ছে। |
| installing | রিইনস্টল হচ্ছে। |
| suspended | মেয়াদ শেষ হওয়ার পর স্থগিত করা হয়েছে। renew দিয়ে এটি আবার চালু করুন। |
| check | আমরা সার্ভার সেটআপের ফলাফল যাচাই করছি। সার্ভার সম্পূর্ণ হবে অথবা পেমেন্ট ফেরত দেওয়া হবে। |
এরর
এরর হলে স্ট্যাটাস কোডের সাথে {"error": "code"} আকারের JSON ফেরত আসে। কোডের মান দেখে প্রসেসিং আলাদা করুন।
| 401 unauthorized | API কী নেই বা ভুল। |
| 403 not_allowed | API আপনার প্রথম পেমেন্টের পর খোলে। |
| 400 bad_request | ফিল্ড নেই বা মান ভুল। কোড ক্যাটালগের মানের মতোই লিখুন। |
| 402 not_enough_balance | পেমেন্ট সম্পূর্ণ করুন এবং এটি আবার পাঠান। |
| 409 limit | অ্যাকাউন্টে তৈরি করা যায় এমন সার্ভারের সংখ্যা পূর্ণ হয়েছে। |
| 409 not_created | সার্ভার তৈরি করা যায়নি। পেমেন্ট ফেরত দেওয়া হয়েছে। |
| 202 checking | আমরা সার্ভার সেটআপের ফলাফল যাচাই করছি। একই অনুরোধ আবার পাঠাবেন না; বরং আপনার সার্ভার তালিকা চেক করুন। আমরা সার্ভার সম্পূর্ণ করব অথবা পেমেন্ট ফেরত দেব। |
| 404 not_found | আপনার অ্যাকাউন্টে এই সার্ভার বা পাথ নেই। |
| 409 wrong_state | সার্ভারের বর্তমান অবস্থায় এই কাজ করা যায় না। |
| 429 rate_limited | রিকোয়েস্ট সীমা পূর্ণ হয়েছে। একটু অপেক্ষা করে পাঠান। |
সাথে দেখার মতো গাইড
পেমেন্ট সুরক্ষিত PayGate চেকআউটের মাধ্যমে করা হয়। আপনি আপনার অ্যাকাউন্টের সার্ভার পেজ থেকে রিইনস্টল এবং একটি নতুন root পাসওয়ার্ড তৈরি করতে পারেন; ধাপগুলি রিইনস্টল গাইড-এ আছে।
API দিয়ে কী করা যায় ও অটোমেশনের উদাহরণ VPS API পেজে, আর প্ল্যান অনুযায়ী মাসিক ফি মূল্য পেজ-এ দেখতে পারবেন।
