VPS.org API

REST API ডকুমেন্টেশন

VPS.org API ডকুমেন্টেশন

VPS সার্ভার, ডোমেইন, DNS, ব্যাকআপ এবং আরও অনেক কিছু পরিচালনার জন্য সম্পূর্ণ REST API ডকুমেন্টেশন।

বেস ইউআরএল https://admin.vps.org/api/v1
প্রমাণীকরণ বিয়ারার টোকেন
সংস্করণ v1
ফরম্যাট JSON

শুরু করা

VPS.org API আপনাকে আপনার VPS হোস্টিং অবকাঠামোর সমস্ত দিক প্রোগ্রাম্যাটিকভাবে পরিচালনা করতে দেয়, যার মধ্যে রয়েছে সার্ভার, ডোমেন, DNS রেকর্ড, ব্যাকআপ এবং স্ন্যাপশট।

প্রমাণীকরণ

সমস্ত API অনুরোধের জন্য Bearer টোকেন ব্যবহার করে প্রমাণীকরণ প্রয়োজন। আপনি আপনার অ্যাকাউন্ট সেটিংস থেকে আপনার API টোকেন তৈরি করতে পারেন admin.vps.org/account/developers/.

cURL
Python
JavaScript
curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

প্রত্যেক টোকেন তার নিজস্ব অনুমতি বহন করে, যেমন servers:list অথবা dns:*। টোকেনের অনুমতির প্রয়োজনে যে অনুরোধ করা হয় তা 403 এবং required_permission ক্ষেত্র ব্যবহার করে প্রত্যাখ্যান করা হয়। অনুমতি সংক্রান্ত রেফারেন্স

হার সীমাবদ্ধতা

অনুমোদিত অনুরোধ প্রতি অ্যাকাউন্ট প্রতি ঘন্টায় ১,০০০ পর্যন্ত সীমাবদ্ধ করা হয়েছে। অনুমোদন না করা অনুরোধ প্রতি IP ঠিকানা প্রতি ঘন্টায় ১০০ পর্যন্ত সীমাবদ্ধ করা হয়েছে। সীমার অতিরিক্ত অনুরোধের জন্য 429 এবং Retry-After শীর্ষচরণ প্রদান করা হবে যা অপেক্ষা করার সেকেন্ডের সংখ্যা নির্দেশ করে। সফল প্রতিক্রিয়ার ক্ষেত্রে কোনো রেট লিমিট শীর্ষচরণ প্রেরণ করা হবে না।

পৃষ্ঠা সংখ্যা

তালিকার শেষ বিন্দু একটি বস্তু ফিরিয়ে দেয় যার সংখ্যা, পরবর্তী, পূর্ববর্তী এবং ফলাফল, প্রতি পৃষ্ঠায় ২৫টি বস্তু। পৃষ্ঠার মধ্যে স্থানান্তর করতে পৃষ্ঠাটি পাস করুন, অথবা পরবর্তী URL অনুসরণ করুন যতক্ষণ না তা নূল হয়। সার্ভারের তালিকা page_size গ্রহণ করে, ১০০ পর্যন্ত।

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

ত্রুটি পরিচালনা

সাফল্য বা ব্যর্থতা নির্দেশ করতে API স্ট্যান্ডার্ড HTTP স্ট্যাটাস কোড ব্যবহার করে:

স্ট্যাটাস কোড বর্ণনা
200 সফল - অনুরোধ সফলভাবে সম্পন্ন হয়েছে
201 তৈরি করা হয়েছে - রিসোর্স সফলভাবে তৈরি করা হয়েছে
400 খারাপ অনুরোধ - অবৈধ প্যারামিটার অথবা ত্রুটিপূর্ণ অনুরোধ
202, 204 স্বীকৃত এবং লাইন করা (২০২), অথবা কোন প্রতিক্রিয়া বডি ছাড়া মুছে ফেলা হয়েছে (২০৪)
402 পরিশোধের প্রয়োজন: ফাইলে কোনো পরিশোধের পদ্ধতি নেই, পরিশোধ না করা বিল, অথবা কার্ডের পূর্ব-অনুমোদন প্রত্যাখ্যান করা হয়েছে
403 নিষিদ্ধ: টোকেনটি অনুপস্থিত, অবৈধ বা মেয়াদ উত্তীর্ণ, অথবা প্রয়োজনীয় অনুমতি অনুপস্থিত। অনুমোদন ব্যর্থ হলে 401 নয়, 403 ফিরিয়ে দেওয়া হবে।
404 পাওয়া যায়নি - রিসোর্স বিদ্যমান নেই
409 দ্বন্দ্ব: উদাহরণস্বরূপ, একটি মাপ পরিবর্তনের কাজ ইতিমধ্যেই চলছে, যথেষ্ট ক্ষমতা নেই, অথবা একটি ডিসপ্লে ইতিমধ্যেই চলছে
429 অনেক বেশি অনুরোধ - রেটের সীমা অতিক্রম করেছে
500 অভ্যন্তরীণ সার্ভার ত্রুটি - আমাদের পক্ষ থেকে কিছু ভুল হয়েছে।
503 সার্ভিস পাওয়া যাচ্ছে না: অস্থায়ী সমস্যা। পুনরায় চেষ্টা করুন, পাঠানোর সময় Retry-After সম্মানিত করা হবে।

সমস্যার মূল অংশ JSON। অধিকাংশ ক্ষেত্রেই একটি বিস্তারিত ক্ষেত্র অথবা একটি সমস্যা ক্ষেত্র রয়েছে, কখনও কখনও একটি বার্তা সহ; বৈধতা পরীক্ষার সমস্যা ক্ষেত্র নাম অনুযায়ী সমস্যার তালিকা প্রদর্শন করে।

এপিআই বিভাগ

বিভাগ অনুসারে আমাদের API ডকুমেন্টেশন ব্রাউজ করুন:

সার্ভার এপিআই 15 শেষবিন্দু

সার্ভার তৈরি, পরীক্ষা, শক্তি, আকার পরিবর্তন এবং মুছে ফেলা, root পাসওয়ার্ড পুনঃনির্ধারণ, বিপরীত DNS নির্ধারণ, কমান্ড চালানো, এবং SSH কী ব্যবস্থাপনা করুন।

ডকুমেন্টেশন দেখুন
ব্যাকআপ API 4 শেষবিন্দু

সার্ভারের ব্যাক-আপ তালিকাভুক্ত করুন, একটি নতুন ব্যাক-আপ আরম্ভ করুন এবং ব্যাক-আপ থেকে সার্ভার পুনরুদ্ধার করুন।

ডকুমেন্টেশন দেখুন
স্ন্যাপশট API 4 শেষবিন্দু

সার্ভারের লেবেলকৃত স্ন্যাপশট নিন, তাদের তালিকা এবং তাদের মুছে ফেলুন।

ডকুমেন্টেশন দেখুন
প্ল্যানস এপিআই 2 শেষবিন্দু

উপলব্ধ VPS পরিকল্পনা এবং মূল্য নির্ধারণের তথ্য পুনরুদ্ধার করুন। সম্পদ, মূল্য নির্ধারণ এবং প্রাপ্যতা সম্পর্কে বিশদ জানুন।

ডকুমেন্টেশন দেখুন
অপারেটিং সিস্টেম API 2 শেষবিন্দু

অপারেটিং সিস্টেম এবং সংস্করণের তালিকা যা আপনি ইনস্টল করতে পারেন, যেমন উবুন্টু, ডেবিয়ান, রকির লিনাক্স, সেন্টওএস স্ট্রিম, ফেডোরা এবং অ্যালপিন।

ডকুমেন্টেশন দেখুন
ডোমেইন API 7 শেষবিন্দু

ডোমেইন ব্যবহারযোগ্যতা পরীক্ষা করুন, নিবন্ধন করুন এবং নতুন করে তৈরি করুন, এবং নেম সার্ভার এবং স্বয়ংক্রিয় নতুন করে তৈরির ব্যবস্থা করুন।

ডকুমেন্টেশন দেখুন
ডিএনএস অ্যাপলিকেশন 13 শেষবিন্দু

DNS অঞ্চল তৈরি করুন এবং তাদের A, A, CNAME, MX, TXT, SRV, CAA এবং অন্যান্য রেকর্ড তৈরি, হালনাগাদ এবং মুছে ফেলুন।

ডকুমেন্টেশন দেখুন
অবস্থান API 2 শেষবিন্দু

সার্ভার স্থাপনের জন্য উপলব্ধ অবস্থান তালিকাভুক্ত করুন।

ডকুমেন্টেশন দেখুন
অ্যাকাউন্ট 1 শেষবিন্দু

অ্যাকাউন্ট প্রোফাইল এবং API টোকেন সংক্রান্ত তথ্য উদ্ধার করুন। একটি টোকেন যে অ্যাকাউন্টের অন্তর্ভুক্ত তা চিহ্নিত করুন এবং এর অনুমতি পরীক্ষা করুন।

ডকুমেন্টেশন দেখুন
সংশ্লিষ্ট 7 শেষবিন্দু

আপনার অ্যাফিলিয়েট ব্যালেন্স, রেফারেন্স, কমিশন এবং পেমেন্ট আপনার নিজের রিপোর্টিং-এ টানুন, পেমেন্ট সেটিংস পরিবর্তন করুন এবং পেমেন্টের অনুরোধ করুন।

ডকুমেন্টেশন দেখুন

আরও বেশি এনডোমেন্ট

API-র অ্যাপলিকেশন স্থাপনের জন্যও এনডপয়েন্ট রয়েছে (/api/v1/deploy-configs/ এবং /api/v1/deployments/)। এগুলো এই পৃষ্ঠাতে এখনো বর্ণনা করা হয়নি; মিথস্ক্রিয় রেফারেন্সে প্রত্যেক এনডপয়েন্টের তালিকা রয়েছে, যা লাইভ API থেকে উৎপাদিত।

মিথস্ক্রিয় API রেফারেন্স খুলুন

সাহায্য দরকার?

আপনার যদি প্রশ্ন থাকে অথবা API সম্পর্কে সহায়তার প্রয়োজন হয়, তাহলে অনুগ্রহ করে যোগাযোগ করতে দ্বিধা করবেন না: