VPS.org API

डेटी एपीआई प्रलेख

खाता एपीआई

खाता प्रोफ़ाइल और एपीआई टोकन जानकारी प्राप्त करें. यह पहचानने के लिए उपयोगी है कि कौन सा खाता व अनुमति एक एपीआई टोकन के साथ सम्बद्ध है.

अंतिमबिंदुओं 1 अंत- बिन्दु
आधार पथ /api/v1/account
पाना /api/v1/account/me/

खाता जानकारी प्राप्त करें (m)

खाता सेटिंग और टोकन स्कोप/ पैग़ाम के लिए जो निवेदन में प्रयोग किया गया है उसे बताता है. यह उपयोगी है जब आप कई एपीआई टोकन का प्रबंधन करते हैं और उसे पहचानने की जरूरत होती है कि कौन सा खाता है और क्या अनुमति है.

प्रमाणीकरण

एक वैध एपीआई टोकन की जरूरत है. कोई भी सक्रिय टोकन इस अंत बिन्दु तक पहुँच सकता है चाहे इसके अनुमति स्कोप के बावजूद.

उदाहरण अनुरोध

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
क्षेत्र प्रकार वर्णन
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
क्षेत्र प्रकार वर्णन
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

सामान्य इस्तेमाल केस

टोकन मालिक को पहचान लें

भिन्न अनुप्रयोगों के दौरान बहु लकीरों का प्रबंधन करने के दौरान इस अंत बिन्दु का प्रयोग करें जो कि खाता कौन सा चिन्ह है:

# 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']}")

टोकन अनुमतियाँ सत्यापित करें

एपीआई कॉल करने से पहले, जाँच करें कि क्या मौजूदा टोकन है:

# 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:* संसाधन, या पूर्ण एक्सेस के लिए *:* पूर्ण एपीआई पहुँच के लिए.

संसाधन उपलब्ध क्रियाएँ
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/