VPS.org API

REST API ਡੌਕੂਮੈਂਟੇਸ਼ਨ

ਡੋਮੇਨ API

ਉਪਲੱਬਧ ਡੋਮੇਨ ਨਾਂ ਲਈ ਖੋਜ, ਡੋਮੇਨ ਰਜਿਸਟਰੇਸ਼ਨ ਅਤੇ ਨਵੀਨੀਕਰਨ, ਅਤੇ ਉਨ੍ਹਾਂ ਦੇ ਨਾਂ ਸਰਵਰ ਅਤੇ ਆਟੋ- ਨਵੀਨੀਕਰਨ ਪਰਬੰਧ ਕਰੋ । ਡੋਮੇਨ ਉਨ੍ਹਾਂ ਦੇ uuid ਨਾਲ ਪਛਾਣਿਆ ਜਾਂਦਾ ਹੈ ।

ਅੰਤਮ ਬਿੰਦੂ 7
ਬੇਸ ਪਾਥ /api/v1/domains
ਪ੍ਰਾਪਤ ਕਰੋ /api/v1/domains/

ਸਾਰੇ ਡੋਮੇਨਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ

ਤੁਹਾਡੇ ਅਕਾਊਂਟ ਵਿੱਚ ਰਜਿਸਟਰਡ ਡੋਮੇਨ ਮੁੜ- ਪ੍ਰਾਪਤ ਕਰੋ, ਪ੍ਰਤੀ ਸਫ਼ਾ 25 । ਲਿਸਟ ਵਿੱਚ ਕੋਈ ਫਿਲਟਰ ਨਹੀਂ ਹੈ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: domains:list

ਉਦਾਹਰਨ ਬੇਨਤੀ

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

url = "https://admin.vps.org/api/v1/domains/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for domain in response.json()["results"]:
    print(domain["domain_name"], domain["status"], domain["expiration_date"])
const response = await fetch('https://admin.vps.org/api/v1/domains/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

ਉਦਾਹਰਨ ਜਵਾਬ

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
      "domain_name": "example.com",
      "status": "active",
      "registrar": "dynadot",
      "registration_date": "2026-01-15T10:30:00Z",
      "expiration_date": "2027-01-15T10:30:00Z",
      "days_until_expiration": 122,
      "is_expired": false,
      "needs_renewal_soon": false,
      "auto_renew": true,
      "renewal_period_years": 1,
      "registration_price": "12.64",
      "renewal_price": "12.64",
      "whois_privacy": true,
      "nameserver1": "ns1.vps.org",
      "nameserver2": "ns2.vps.org",
      "nameserver3": "ns3.vps.org",
      "nameserver4": null,
      "transfer_lock": true,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-09-01T08:12:40Z"
    }
  ]
}

ਜਵਾਬ ਖੇਤਰ

ਖੇਤਰ ਦੀ ਕਿਸਮ ਵੇਰਵਾ
uuid string ਹੋਰ ਡੋਮੇਨ ਅੰਤ- ਬਿੰਦੂ ਵਿੱਚ ਵਰਤੀ ਡੋਮੇਨ ਪਛਾਣ
status string active, pending, expired, cancelled, transferred
registrar string ਡੋਮੇਨ ਰਜਿਸਟਰੇਟਰ ਹੈ
registration_date, expiration_date datetime ਜਦੋਂ ਡੋਮੇਨ ਰਜਿਸਟਰ ਕੀਤਾ ਗਿਆ ਸੀ ਅਤੇ ਜਦੋਂ ਇਹ ਮਿਆਦ ਪੁੱਗਦੀ ਹੈ । expiration_ date null ਹੋ ਸਕਦਾ ਹੈ ।
days_until_expiration integer | null ਮਿਆਦ ਪੁੱਗਣ_ ਮਿਤੀ ਤੱਕ ਪੂਰੇ ਦਿਨ, ਇੱਕ ਵਾਰ ਮਿਆਦ ਪੁੱਗਣ ਉੱਤੇ ਨੈਗਟਿਵ
is_expired, needs_renewal_soon boolean ਕੀ ਡੋਮੇਨ ਦੀ ਮਿਆਦ ਪੁੱਗੀ ਹੈ ਅਤੇ ਕੀ ਇਹ ਅਗਲੇ 30 ਦਿਨਾਂ ਵਿੱਚ ਮਿਆਦ ਪੁੱਗੇਗੀ
auto_renew, renewal_period_years boolean, integer ਕੀ ਡੋਮੇਨ ਆਟੋਮੈਟਿਕ ਹੀ ਨਵਾਂ ਕੀਤਾ ਜਾਵੇ ਅਤੇ ਕਿੰਨੇ ਸਾਲਾਂ ਲਈ
registration_price, renewal_price string ਦਸ਼ਮਲਵ ਸਤਰ ਵਜੋਂ USD ਵਿੱਚ ਕੀਮਤਾਂ
whois_privacy, transfer_lock boolean WHOIS ਪਰਾਈਵੇਸੀ ਅਤੇ ਰਜਿਸਟਰੇਸ਼ਨ ਟਰਾਂਸਫਰ ਲਾਕ ਸੈਟਿੰਗ
nameserver1 to nameserver4 string | null ਡੋਮੇਨ ਦਾ ਨਾਂ ਸਰਵਰ
created_at, updated_at datetime ਜਦੋਂ ਰਿਕਾਰਡ ਬਣਾਇਆ ਗਿਆ ਅਤੇ ਆਖਰੀ ਵਾਰ ਬਦਲਿਆ ਗਿਆ (ISO 8601, UTC)
ਪ੍ਰਾਪਤ ਕਰੋ /api/v1/domains/{uuid}/

ਡੋਮੇਨ ਵੇਰਵਾ ਲਵੋ

ਇੱਕ ਡੋਮੇਨ ਆਬਜੈਕਟ ਉੱਤੇ ਖੇਤਰ ਨਾਲ ਵਾਪਸ ਕਰੋ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: domains:list

curl -X GET "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

ਜਵਾਬ ਸਥਿਤੀ ਕੋਡ

200 ਸਫਲਤਾ
404 ਨਹੀਂ ਲੱਭਿਆ ਜਾਂ ਇਹ ਹੋਰ ਅਕਾਊਂਟ ਨਾਲ ਸਬੰਧਤ ਹੈ
ਪੋਸਟ /api/v1/domains/search/

ਡੋਮੇਨ ਉਪਲੱਬਧਤਾ ਖੋਜ

ਜਾਂਚ ਕਰੋ ਕਿ ਕੀ ਨਾਂ 20 ਪਪੁਲੇ ਐਕਸ਼ਟੇਸ਼ਨ (com, net, org, io, dev, co, app, ai ਅਤੇ ਹੋਰ) ਵਿੱਚ ਉਪਲੱਬਧ ਹੈ, ਅਤੇ ਜੇਕਰ ਤੁਸੀਂ ਜੋ ਐਕਸ਼ਟੇਸ਼ਨ ਲਿਖਿਆ ਹੈ ਉਹ ਉਹਨਾਂ ਵਿੱਚ ਨਹੀਂ ਹੈ ਤਾਂ । ਨਤੀਜੇ ਸਹੀ ਮਿਲਾਨ ਨਾਲ ਸ਼ੁਰੂ ਹੁੰਦੇ ਹਨ, ਫਿਰ ਉਪਲੱਬਧ ਨਾਂ, ਫਿਰ ਵਰਤੇ ਨਾਂ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: domains:search

ਬਾਡੀ ਪੈਰਾਮੀਟਰ ਦੀ ਬੇਨਤੀ ਕਰੋ

ਪੈਰਾਮੀਟਰ ਦੀ ਕਿਸਮ ਲੋੜੀਂਦਾ ਵੇਰਵਾ
domain string ਹਾਂ ਇਕਸਟੈਨਸ਼ਨ ਨਾਲ ਜਾਂ ਬਿਨਾਂ ਇੱਕ ਨਾਂ, ਜਿਵੇਂ ਕਿ mysite ਜਾਂ mysite. com (2 ਤੋਂ 63 ਅੱਖਰ)

ਉਦਾਹਰਨ ਬੇਨਤੀ

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/domains/search/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.com"}'
import requests

url = "https://admin.vps.org/api/v1/domains/search/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers, json={"domain": "mysite.com"})
for result in response.json()["results"]:
    if result["available"]:
        print(result["domain"], result["registration_price"], result["renewal_price"])

ਉਦਾਹਰਨ ਜਵਾਬ

{
  "results": [
    {
      "domain": "mysite.com",
      "available": false,
      "price": null,
      "registration_price": null,
      "renewal_price": null,
      "tld": "com",
      "is_exact_match": true
    },
    {
      "domain": "mysite.dev",
      "available": true,
      "price": 17.24,
      "registration_price": 17.24,
      "renewal_price": 17.24,
      "tld": "dev",
      "is_exact_match": false
    }
  ],
  "base_domain": "mysite",
  "search_count": 20
}

ਕੀਮਤਾਂ ਇੱਕ ਸਾਲ ਲਈ USD ਵਿੱਚ ਹਨ ਅਤੇ ਉਹਨਾਂ ਨਾਂਵਾਂ ਲਈ ਨਲ ਹਨ, ਜੋ ਕਿ ਉਪਲੱਬਧ ਨਹੀਂ ਹਨ । ਵੇਖਾਏ ਗਏ ਕੀਮਤਾਂ ਉਦਾਹਰਨ ਲਈ ਹਨ ।

ਜਵਾਬ ਸਥਿਤੀ ਕੋਡ

200 ਸਫਲਤਾ
400 ਗੁੰਮ ਡੋਮੇਨ ਹੈ ਜਾਂ ਇਸ ਵਿੱਚ ਅੱਖਰ, ਅੰਕ ਅਤੇ ਹਾਈਫਨ ਤੋਂ ਬਿਨਾਂ ਹੋਰ ਅੱਖਰ ਹਨ
500 ਰਜਿਸਟਰੇਸ਼ਨ ਖੋਜ ਫੇਲ੍ਹ ਹੈ । ਬਾਅਦ ਵਿੱਚ ਮੁੜ ਕੋਸ਼ਿਸ ਕਰੋ ।
ਪੋਸਟ /api/v1/domains/register/

ਨਵਾਂ ਡੋਮੇਨ ਰਜਿਸਟਰ ਕਰੋ

ਇੱਕ ਡੋਮੇਨ ਰਜਿਸਟਰਡ ਕਰੋ ਅਤੇ ਤੁਹਾਡੇ ਸੰਭਾਲੇ ਗਏ ਭੁਗਤਾਨ ਢੰਗ ਦਾ ਚਾਰਜ ਕਰੋ । ਉਪਲੱਬਧਤਾ ਅਤੇ ਕੀਮਤ ਰਜਿਸਟਰਡ ਨਾਲ ਚਾਰਜ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਮੁੜ ਚੈੱਕ ਕੀਤੀ ਜਾਂਦੀ ਹੈ । ਰਜਿਸਟਰਡ ਸੰਪਰਕ ਵੇਰਵਾ ਤੁਹਾਡੇ ਅਕਾਊਂਟ ਪਰੋਫਾਇਲ ਤੋਂ ਲਿਆ ਜਾਂਦਾ ਹੈ । ਜੇਕਰ ਰਜਿਸਟਰਡ ਚਾਰਜ ਕਰਨ ਤੋਂ ਬਾਅਦ ਰਜਿਸਟਰਡ ਨੂੰ ਰੱਦ ਕਰ ਦੇਵੇ ਤਾਂ ਭੁਗਤਾਨ ਮੁੜ ਦਿੱਤਾ ਜਾਂਦਾ ਹੈ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: domains:register (ਡੋਮੇਨ ਵਲੋਂ ਦਿੱਤਾ: *)

ਬਾਡੀ ਪੈਰਾਮੀਟਰ ਦੀ ਬੇਨਤੀ ਕਰੋ

ਪੈਰਾਮੀਟਰ ਦੀ ਕਿਸਮ ਲੋੜੀਂਦਾ ਵੇਰਵਾ
domain string ਹਾਂ ਪੂਰਾ ਡੋਮੇਨ ਨਾਂ, ਜਿਸ ਵਿੱਚ ਐਕਸ਼ਟੇਸ਼ਨ ਵੀ ਸ਼ਾਮਲ ਹੈ, ਜਿਵੇਂ ਕਿ example. com
years integer ਕੋਈ ਨਹੀਂ ਰਜਿਸਟਰੇਸ਼ਨ ਸਮਾਂ, 1 ਤੋਂ 10 (ਮੂਲ 1) ਹੈ। ਕੀਮਤ ਸਾਲਾਨਾ ਕੀਮਤ ਸਾਲਾਂ ਵਿੱਚ ਹੈ।.ai ਲਈ ਘੱਟੋ-ਘੱਟ2ਸਾਲ ਲੋੜੀਦੇ ਹਨ; ਛੋਟਾ ਮੁੱਲ 400 ਦਿੰਦਾ ਹੈ।
curl -X POST "https://admin.vps.org/api/v1/domains/register/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "mysite.dev", "years": 1}'

ਉਦਾਹਰਨ ਜਵਾਬ

{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "domain_name": "mysite.dev",
  "message": "mysite.dev registered successfully!"
}

ਜਵਾਬ ਸਥਿਤੀ ਕੋਡ

201 ਡੋਮੇਨ ਰਜਿਸਟਰਡ
400 ਗਲਤ ਡੋਮੇਨ, ਡੋਮੇਨ ਹੁਣ ਉਪਲੱਬਧ ਨਹੀਂ ਹੈ, ਕੀਮਤ ਜਾਂਚ ਨਹੀਂ ਕੀਤੀ ਜਾ ਸਕੀ, ਪੁਰਾਣਾ ਭੁਗਤਾਨ ਢੰਗ, ਜਾਂ ਭੁਗਤਾਨ ਫੇਲ੍ਹ ਹੈ
402 ਫਾਇਲ ਉੱਤੇ ਕੋਈ ਭੁਗਤਾਨ ਢੰਗ ਨਹੀਂ ਹੈ, ਜਾਂ ਨਾ- ਭੁਗਤਾਨ ਕੀਤੇ ਬਿੱਲ
500 ਭੁਗਤਾਨ ਕਾਰਵਾਈ ਨਹੀਂ ਕੀਤੀ ਜਾ ਸਕੀ, ਜਾਂ ਰਜਿਸਟਰੇਟਰ ਨੇ ਭੁਗਤਾਨ ਕਰਨ ਬਾਅਦ ਰਜਿਸਟਰੇਸ਼ਨ ਨੂੰ ਰੱਦ ਕਰ ਦਿੱਤਾ ਹੈ । ਦੂਜੇ ਮਾਮਲੇ ਵਿੱਚ ਗਲਤੀ ਸੁਨੇਹਾ ਦੱਸਦਾ ਹੈ ਕਿ ਕੀ ਮੁੜ ਭੁਗਤਾਨ ਕੀਤਾ ਗਿਆ ਹੈ ।
ਪੋਸਟ /api/v1/domains/{uuid}/renew/

ਡੋਮੇਨ ਨਵਾਂ ਕਰੋ

ਡੋਮੇਨ ਨਵੀਨੀਕਰਨ ਅਤੇ ਹਰ ਸਾਲ ਲਈ ਨਵੀਨੀਕਰਨ_ ਕੀਮਤ ਤੁਹਾਡੇ ਸੰਭਾਲੇ ਗਏ ਭੁਗਤਾਨ ਢੰਗ ਨਾਲ ਚਾਰਜ ਕਰੋ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: domains:renew

ਬਾਡੀ ਪੈਰਾਮੀਟਰ ਦੀ ਬੇਨਤੀ ਕਰੋ

ਪੈਰਾਮੀਟਰ ਦੀ ਕਿਸਮ ਲੋੜੀਂਦਾ ਵੇਰਵਾ
years integer ਕੋਈ ਨਹੀਂ ਜੋੜਨ ਲਈ ਸਾਲ, 1 ਤੋਂ 10 (ਮੂਲ 1)
curl -X POST "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"years": 1}'
{
  "success": true,
  "domain_uuid": "e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c",
  "new_expiration": "2028-01-15T10:30:00+00:00",
  "message": "example.com renewed successfully for 1 year(s)!"
}

ਜਵਾਬ ਸਥਿਤੀ ਕੋਡ

200 ਡੋਮੇਨ ਨਵੀਨੀਕਰਨ
400 ਗਲਤ ਸਾਲ, ਡੋਮੇਨ ਲਈ ਕੋਈ ਨਵੀਨੀਕਰਨ ਕੀਮਤ ਨਹੀਂ, ਕੋਈ ਵਰਤਣਯੋਗ ਭੁਗਤਾਨ ਢੰਗ ਨਹੀਂ, ਜਾਂ ਭੁਗਤਾਨ ਫੇਲ੍ਹ ਹੈ
404 ਨਹੀਂ ਲੱਭਿਆ ਜਾਂ ਇਹ ਹੋਰ ਅਕਾਊਂਟ ਨਾਲ ਸਬੰਧਤ ਹੈ
500 ਭੁਗਤਾਨ ਪਰੋਸੈਸ ਨਹੀਂ ਕੀਤਾ ਜਾ ਸਕਿਆ, ਜਾਂ ਭੁਗਤਾਨ ਚੱਲਿਆ ਪਰ ਰਜਿਸਟਰੇਸ਼ਨ ਮੁੜ-ਨਿਰਧਾਰਨ ਫੇਲ੍ਹ ਹੋਇਆ । ਇਸ ਮਾਮਲੇ ਵਿੱਚ ਸਹਿਯੋਗ ਨਾਲ ਸੰਪਰਕ ਕਰੋ ।
PUT /api/v1/domains/{uuid}/nameservers/

ਨਾਂ ਸਰਵਰ ਅੱਪਡੇਟ

ਰਜਿਸਟਰੇਟਰ ਉੱਤੇ ਡੋਮੇਨ ਨਾਂ ਸਰਵਰ ਸੈੱਟ ਕਰੋ ਅਤੇ ਅੱਪਡੇਟ ਡੋਮੇਨ ਆਬਜੈਕਟ ਮੁੜ ਭੇਜੋ । DNS API ਨਾਲ DNS ਪਰਬੰਧ ਕਰਨ ਲਈ ns1. vps.org, ns2. vps.org ਅਤੇ ns3. vps.org ਵਰਤੋਂ ਅਤੇ ਡੋਮੇਨ ਲਈ ਜ਼ੋਨ ਬਣਾਓ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: domains:update

ਬਾਡੀ ਪੈਰਾਮੀਟਰ ਦੀ ਬੇਨਤੀ ਕਰੋ

ਪੈਰਾਮੀਟਰ ਦੀ ਕਿਸਮ ਲੋੜੀਂਦਾ ਵੇਰਵਾ
nameserver1 string ਹਾਂ ਪ੍ਰਾਇਮਰੀ ਨਾਂ ਸਰਵਰ ਹੋਸਟ ਨਾਂ
nameserver2, nameserver3, nameserver4 string ਕੋਈ ਨਹੀਂ ਹੋਰ ਨਾਂ ਸਰਵਰ ਹੋਸਟ ਨਾਂ
curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/nameservers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"nameserver1": "ns1.vps.org", "nameserver2": "ns2.vps.org", "nameserver3": "ns3.vps.org"}'

ਜਵਾਬ ਸਥਿਤੀ ਕੋਡ

200 ਨਾਂ ਸਰਵਰ ਅੱਪਡੇਟ; ਬਾਡੀ ਡੋਮੇਨ ਇਕਾਈ ਹੈ
400 ਨਾਂ- ਸਰਵਰ1 ਗੁੰਮ ਹੈ
404 ਨਹੀਂ ਲੱਭਿਆ ਜਾਂ ਇਹ ਹੋਰ ਅਕਾਊਂਟ ਨਾਲ ਸਬੰਧਤ ਹੈ
500 ਅੱਪਡੇਟ ਫੇਲ੍ਹ ਹੈ; ਬਾਡੀ ਵਿੱਚ ਗਲਤੀ ਅਤੇ ਸੁਨੇਹਾ ਖੇਤਰ ਹਨ
PUT /api/v1/domains/{uuid}/auto-renew/

ਆਟੋ- ਨਵੀਨੀਕਰਨ ਚਾਲੂ ਜਾਂ ਬੰਦ ਕਰੋ

auto_renew ਸੈੱਟ ਕਰੋ ਅਤੇ ਅੱਪਡੇਟ ਡੋਮੇਨ ਇਕਾਈ ਮੁੜ ਦਿਓ । JSON ਬੁਲੀਅਨ ਵਾਂਗ ਭੇਜੋ: ਕੋਈ ਵੀ ਖਾਲੀ ਨਹੀਂ ਹੋਣ ਵਾਲੀ ਸਤਰ, ਸਤਰ false ਸਮੇਤ, ਆਟੋ-ਰਿਨਾਇਵਲ ਯੋਗ ਕਰੇਗੀ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: domains:update

curl -X PUT "https://admin.vps.org/api/v1/domains/e4b7a2c9-1d3f-4e5a-8b6c-7d8e9f0a1b2c/auto-renew/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

ਜਵਾਬ ਸਥਿਤੀ ਕੋਡ

200 ਸੈਟਿੰਗ ਸੰਭਾਲੀ ਗਈ; ਬਾਡੀ ਡੋਮੇਨ ਇਕਾਈ ਹੈ
400 ਯੋਗ ਗੁੰਮ ਹੈ
404 ਨਹੀਂ ਲੱਭਿਆ ਜਾਂ ਇਹ ਹੋਰ ਅਕਾਊਂਟ ਨਾਲ ਸਬੰਧਤ ਹੈ

ਨੋਟਿਸ