VPS.org API

PENDEKEZO LA MAFUTA

Domains API

Dhibiti usajili wa kikoa, usasishaji, na usanidi kiprogramu.

Sehemu za Mwisho 6 endpoints
Njia ya Msingi /api/v1/domains
PATA /api/v1/domains/

Orodhesha Vikoa Vyote

Andika orodha ya maeneo yote yaliyosajiliwa chini ya akaunti yako.

Vigezo vya Hoja

Penseli Aina Inahitajika Maelezo
status string Hapana Filter by status: active, pending, expired, locked
search string Hapana Tafuta vikoa kwa majina

Ombi la Mfano

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

url = "https://admin.vps.org/api/v1/domains/"
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/domains/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

Jibu la Mfano

{
  "count": 3,
  "results": [
    {
      "id": 101,
      "domain_name": "example.com",
      "status": "active",
      "registration_date": "2023-01-15T10:30:00Z",
      "expiration_date": "2026-01-15T10:30:00Z",
      "auto_renew": true,
      "locked": true,
      "nameservers": [
        "ns1.vps.org",
        "ns2.vps.org"
      ],
      "privacy_protection": true,
      "dns_managed_by": "vps.org"
    },
    {
      "id": 102,
      "domain_name": "myapp.io",
      "status": "active",
      "registration_date": "2024-06-20T14:15:00Z",
      "expiration_date": "2025-06-20T14:15:00Z",
      "auto_renew": false,
      "locked": false,
      "nameservers": [
        "ns1.cloudflare.com",
        "ns2.cloudflare.com"
      ],
      "privacy_protection": false,
      "dns_managed_by": "external"
    }
  ]
}

Misimbo ya Hali ya Majibu

200 Imefanikiwa kurejesha orodha ya vikoa
401 Hairuhusiwi - Tokeni ya uthibitishaji si sahihi au haipo
PENDEKEZO /api/v1/domains/

Sajili Kikoa Kipya

Kuandikishwa jina jipya la eneo hilo na kupatikana kwa Domain kwapaswa kukaguliwa kabla ya kusajiliwa.

Omba Vigezo vya Mwili

Penseli Aina Inahitajika Maelezo
domain_name string Ndiyo Domain name to register (e.g., "example.com")
years integer Hapana Registration period in years (1-10, default: 1)
auto_renew boolean Hapana Enable automatic renewal (default: true)
privacy_protection boolean Hapana Enable WHOIS privacy protection (default: true)
nameservers array Hapana Custom nameservers (default: VPS.org nameservers)

Ombi la Mfano

cURL
Python
JavaScript
PHP
curl -X POST "https://admin.vps.org/api/v1/domains/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_name": "mynewdomain.com",
    "years": 2,
    "auto_renew": true,
    "privacy_protection": true
  }'
import requests

url = "https://admin.vps.org/api/v1/domains/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "domain_name": "mynewdomain.com",
    "years": 2,
    "auto_renew": True,
    "privacy_protection": True
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/domains/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    domain_name: 'mynewdomain.com',
    years: 2,
    auto_renew: true,
    privacy_protection: true
  })
});

const domain = await response.json();
console.log(domain);
$data = [
    'domain_name' => 'mynewdomain.com',
    'years' => 2,
    'auto_renew' => true,
    'privacy_protection' => true
];

$ch = curl_init('https://admin.vps.org/api/v1/domains/');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

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

Jibu la Mfano

{
  "id": 103,
  "domain_name": "mynewdomain.com",
  "status": "pending",
  "registration_date": "2026-01-16T16:00:00Z",
  "expiration_date": "2028-01-16T16:00:00Z",
  "auto_renew": true,
  "locked": true,
  "nameservers": [
    "ns1.vps.org",
    "ns2.vps.org"
  ],
  "privacy_protection": true,
  "dns_managed_by": "vps.org",
  "total_cost": 24.98,
  "message": "Domain registration initiated. Processing may take 5-10 minutes."
}

Misimbo ya Hali ya Majibu

201 Domain registration initiated successfully
400 Bad Request - Invalid domain name or domain already registered
401 Hairuhusiwi - Tokeni ya uthibitishaji si sahihi au haipo
402 Payment Required - Insufficient account balance
Angalia: Domain registration is not instant. Status will change from pending to active within 5-10 minutes. You'll receive an email confirmation when registration completes.
PATA /api/v1/domains/{domain_id}/

Toa Maelezo Mengi Kuhusu Matibabu

Toa habari kamili kuhusu eneo fulani hususa.

Vigezo vya Njia

Penseli Aina Inahitajika Maelezo
domain_id integer Ndiyo Unique domain ID

Ombi la Mfano

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

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

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

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

Jibu la Mfano

{
  "id": 101,
  "domain_name": "example.com",
  "status": "active",
  "registration_date": "2023-01-15T10:30:00Z",
  "expiration_date": "2026-01-15T10:30:00Z",
  "auto_renew": true,
  "locked": true,
  "nameservers": [
    "ns1.vps.org",
    "ns2.vps.org"
  ],
  "privacy_protection": true,
  "dns_managed_by": "vps.org",
  "registrar": "VPS.org",
  "days_until_expiration": 730,
  "whois_info": {
    "registrant": "Privacy Protected",
    "admin_contact": "Privacy Protected",
    "tech_contact": "Privacy Protected",
    "created_date": "2023-01-15",
    "updated_date": "2025-12-20"
  },
  "dns_records_count": 12
}

Misimbo ya Hali ya Majibu

200 Successfully retrieved domain details
401 Hairuhusiwi - Tokeni ya uthibitishaji si sahihi au haipo
404 Haipatikani - Kikoa hakipo
TATU /api/v1/domains/{domain_id}/

Muundo Mpya wa Domain

Habari mpya kuhusu matumizi ya barabara kama vile matumizi ya magari, majina ya watu waliohifadhiwa, na wakati wa faragha.

Vigezo vya Njia

Penseli Aina Inahitajika Maelezo
domain_id integer Ndiyo Unique domain ID

Omba Vigezo vya Mwili

Penseli Aina Inahitajika Maelezo
auto_renew boolean Hapana Enable or disable automatic renewal
privacy_protection boolean Hapana Enable or disable WHOIS privacy
nameservers array Hapana Update nameservers (2-4 nameservers required)
locked boolean Hapana Lock or unlock domain to prevent transfers

Ombi la Mfano

cURL
Python
JavaScript
curl -X PUT "https://admin.vps.org/api/v1/domains/101/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "auto_renew": false,
    "nameservers": [
      "ns1.cloudflare.com",
      "ns2.cloudflare.com"
    ]
  }'
import requests

domain_id = 101
url = f"https://admin.vps.org/api/v1/domains/{domain_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "auto_renew": False,
    "nameservers": [
        "ns1.cloudflare.com",
        "ns2.cloudflare.com"
    ]
}

response = requests.put(url, headers=headers, json=data)
print(response.json())
const domainId = 101;
const response = await fetch(`https://admin.vps.org/api/v1/domains/${domainId}/`, {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    auto_renew: false,
    nameservers: [
      'ns1.cloudflare.com',
      'ns2.cloudflare.com'
    ]
  })
});

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

Jibu la Mfano

{
  "id": 101,
  "domain_name": "example.com",
  "status": "active",
  "auto_renew": false,
  "nameservers": [
    "ns1.cloudflare.com",
    "ns2.cloudflare.com"
  ],
  "privacy_protection": true,
  "locked": true,
  "message": "Domain settings updated successfully. Nameserver changes may take up to 24 hours to propagate."
}

Misimbo ya Hali ya Majibu

200 Domain updated successfully
400 Bad Request - Invalid parameters
401 Hairuhusiwi - Tokeni ya uthibitishaji si sahihi au haipo
404 Haipatikani - Kikoa hakipo
FUTA /api/v1/domains/{domain_id}/

Delete Domain

Ogelea tovuti kutoka kwenye akaunti yako. Hii haiondoi usajili wa utawala - hiyo huiondosha tu kutoka kwa usimamizi wako wa akaunti VPS.org.

Vigezo vya Njia

Penseli Aina Inahitajika Maelezo
domain_id integer Ndiyo Unique domain ID

Ombi la Mfano

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

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

response = requests.delete(url, headers=headers)
print(response.status_code)
const domainId = 101;
const response = await fetch(`https://admin.vps.org/api/v1/domains/${domainId}/`, {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

console.log(response.status);

Misimbo ya Hali ya Majibu

204 Domain removed from account successfully
401 Hairuhusiwi - Tokeni ya uthibitishaji si sahihi au haipo
404 Haipatikani - Kikoa hakipo
Important: Deleting a domain from your VPS.org account does NOT cancel the registration. The domain will continue to be registered and will auto-renew if enabled. To cancel a domain registration, disable auto-renewal and let it expire.
PENDEKEZO /api/v1/domains/{domain_id}/transfer/

Hamishai Domain

Kuanzisha mpango wa kuhamisha utawala hadi watu VPS.org kutoka msajili mwingine.

Vigezo vya Njia

Penseli Aina Inahitajika Maelezo
domain_id integer Ndiyo Unique domain ID

Omba Vigezo vya Mwili

Penseli Aina Inahitajika Maelezo
auth_code string Ndiyo EPP/Authorization code from current registrar
auto_renew boolean Hapana Enable auto-renewal after transfer (default: true)

Ombi la Mfano

cURL
Python
JavaScript
curl -X POST "https://admin.vps.org/api/v1/domains/101/transfer/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "auth_code": "Xy9Kl2Mn#4pQ",
    "auto_renew": true
  }'
import requests

domain_id = 101
url = f"https://admin.vps.org/api/v1/domains/{domain_id}/transfer/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "auth_code": "Xy9Kl2Mn#4pQ",
    "auto_renew": True
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const domainId = 101;
const response = await fetch(`https://admin.vps.org/api/v1/domains/${domainId}/transfer/`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    auth_code: 'Xy9Kl2Mn#4pQ',
    auto_renew: true
  })
});

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

Jibu la Mfano

{
  "id": 101,
  "domain_name": "example.com",
  "transfer_status": "pending",
  "transfer_initiated_at": "2026-01-16T16:30:00Z",
  "estimated_completion": "2026-01-23T16:30:00Z",
  "message": "Domain transfer initiated. You should receive a confirmation email from your current registrar. Transfer typically completes within 5-7 days.",
  "next_steps": [
    "Check email for transfer authorization request",
    "Approve transfer with current registrar",
    "Wait for transfer to complete (5-7 days)",
    "Domain will be automatically renewed for 1 year upon completion"
  ]
}

Misimbo ya Hali ya Majibu

200 Transfer initiated successfully
400 Bad Request - Invalid auth code or domain not eligible for transfer
401 Hairuhusiwi - Tokeni ya uthibitishaji si sahihi au haipo
404 Haipatikani - Kikoa hakipo
402 Payment Required - Insufficient account balance for transfer fee
Matakwa ya kuhamisha:
  • Ni lazima Domain agunduliwe kwa msajili wa sasa
  • Haikosi Domain ana umri wa angalau siku 60
  • Mfumo wa sheria wa Valid EPP/Auth unahitaji
  • Barua pepe ya WHO lazima ipatikane ili kupata kibali
  • Uhamaji unatia ndani kufanywa upya kwa miaka 1 (fee recle)

Ushonaji wa Domain

Watoto Wanaopendwa

Ukungu Usajili (mwaka 1) Habari mpya Hamishamu
.com $12.99 $12.99 $12.99
.net $14.99 $14.99 $14.99
.org $13.99 $13.99 $13.99
.io $39.99 $39.99 $39.99
.dev $14.99 $14.99 $14.99
.app $14.99 $14.99 $14.99
.co $24.99 $24.99 $24.99

Vipengele Vilivyojumuishwa

  • ✓ Ulinzi wa Faragha Huru ya WHOS
  • ✓ Usimamizi Huru wa DNS
  • ✓ Kupeleka Barua za Bure
  • ✓ Kusonga Mbele Huru
  • ✓ Kufungwa kwa Kasha Huru
  • ✓ 24/7 Utegemezo
  • ✓ Usimamizi Rahisi wa Domain
  • ✓ Auto-Uamusho Mpya

Zoea Bora Zaidi la Usimamizi

Usalama

Kuhojiwa

Hamishari