VPS.org API

REST API दस्तऐवजीकरण

खाते API

खाते प्रोफाइल व API टोकन माहिती प्राप्त करा. कोणत्या खात्याशी आणि कोणत्या परवानगीशी API टोकन संबंधित आहे हे ओळखण्याकरीता उपयोगी पडते.

शेवटचे बिंदू 1 अंतबिंदू
बेस पाथ /api/v1/account
मिळवा /api/v1/account/me/

खाते व टोकन माहिती प्राप्त करा

अनुप्रयोगात वापरलेले API टोकन करीता खाते प्रोफाइल मेटाडेटा व टोकन क्षेत्र/परवाना परत करतो. जेव्हा तुम्ही अनेक API टोकनचे व्यवस्थापन करता तेव्हा हे उपयोगी पडते व टोकनला कोणते खाते आहे व त्याचे काय परवाने आहेत हे ओळखण्याची गरज असते.

प्रमाणीकरण

वैध API टोकन आवश्यक आहे. कोणत्याही सक्रीय टोकनने या अंतबिंदूचा वापर करू शकतो, त्यास परवानगीचे क्षेत्र नव्हे.

उदाहरण विनंती

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

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

response = requests.get(url, headers=headers)
data = response.json()

print(f"Account: {data['account']['email']}")
print(f"Token: {data['token']['name']}")
print(f"Permissions: {data['token']['permissions']}")
const response = await fetch('https://admin.vps.org/api/v1/account/me/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(`Account: ${data.account.email}`);
console.log(`Token: ${data.token.name}`);
console.log(`Permissions:`, data.token.permissions);
$ch = curl_init('https://admin.vps.org/api/v1/account/me/');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

echo "Account: " . $data['account']['email'] . "\n";
echo "Token: " . $data['token']['name'] . "\n";
echo "Permissions: " . implode(', ', $data['token']['permissions']) . "\n";

उदाहरण प्रतिसाद

{
  "account": {
    "email": "john@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "company_name": "Acme Inc.",
    "created_at": "2024-06-15"
  },
  "token": {
    "name": "Production Deploy Key",
    "permissions": [
      "servers:list",
      "servers:create",
      "servers:power",
      "dns:*"
    ],
    "created_at": "2025-01-10T14:30:00Z",
    "last_used_at": "2025-02-11T08:45:12Z",
    "expires_at": null,
    "is_expired": false
  }
}

प्रतिसाद फील्ड

account object
क्षेत्र प्रकार वर्णन@ title: window
email string Account email address
first_name string | null Account holder's first name
last_name string | null Account holder's last name
company_name string | null Company name (if set)
created_at date Account creation date (YYYY-MM-DD)
token object
क्षेत्र प्रकार वर्णन@ title: window
name string Name assigned to this API token
permissions array List of permission strings (e.g. servers:list, dns:*). See Authentication docs for permission format.
created_at datetime When the token was created (ISO 8601)
last_used_at datetime | null Last time the token was used for authentication
expires_at datetime | null Token expiration date (null if no expiration)
is_expired boolean Whether the token has expired

उत्तर स्थिती कोड

200 Successfully retrieved account and token information
401 Unauthorized - Invalid, expired, or missing API token

सामान्य वापराचे प्रकार

टोकन मालक ओळखा

वेगवेगळ्या अनुप्रयोगाद्वारे अनेक API टोकनचे व्यवस्थापन करताना, टोकन कोणत्या खात्याशी संबंधित आहे हे तपासण्यासाठी या एंडपॉइंटचा वापर करा:

# Check which account this token is associated with
response = requests.get(
    "https://admin.vps.org/api/v1/account/me/",
    headers={"Authorization": f"Bearer {api_token}"}
)
account = response.json()["account"]
print(f"This token belongs to: {account['email']}")

टोकन परवानगी तपासणी करा

API कॉल करण्यापूर्वी, वर्तमान टोकन करीता काय परवानगी आहे याची खात्री करा:

# Check token permissions before performing an action
response = requests.get(
    "https://admin.vps.org/api/v1/account/me/",
    headers={"Authorization": f"Bearer {api_token}"}
)
permissions = response.json()["token"]["permissions"]

if "servers:create" in permissions or "servers:*" in permissions:
    # Token has permission to create servers
    create_server()
else:
    print("Token does not have servers:create permission")

टोकनची मुदत संपली आहे

तुमचे टोकनची मुदत संपण्याकरीता आहे का ते तपासा:

from datetime import datetime

response = requests.get(
    "https://admin.vps.org/api/v1/account/me/",
    headers={"Authorization": f"Bearer {api_token}"}
)
token_info = response.json()["token"]

if token_info["expires_at"]:
    expires = datetime.fromisoformat(token_info["expires_at"])
    days_left = (expires - datetime.now()).days
    if days_left < 7:
        print(f"Warning: Token expires in {days_left} days")
else:
    print("Token has no expiration date")

परवानगी संदर्भ

परवानगी स्वरूपन अनुरूप आहे resource:action. वापरा resource:* स्त्रोत करीता पूर्ण प्रवेश करीता, किंवा *:* पूर्ण API प्रवेश करीता.

स्त्रोत उपलब्ध क्रिया
servers list, create, update, delete, power, backup, snapshot, resize, *
domains list, search, update, renew, *
dns list, create, update, delete, *
snapshots list, delete, *
backups list, *
ssh-keys list, create, delete, *
plans list, *
locations list, *
deployments list, create, delete, *
billing list, *
Manage your tokens: Create, edit, and revoke API tokens at admin.vps.org/account/developers/