VPS.org API

REST API દસ્તાવેજીકરણ

ડોમેન્સ API

ઉપલબ્ધ ડોમેઇન નામો માટે શોધો, નોંધણી કરો અને ડોમેઇનને નવીકરણ કરો, અને તેમના નામ સર્વર અને આપોઆપ-નવીકરણનું સંચાલન કરો. ડોમેઇન તેમના uuid દ્વારા ઓળખાય છે.

અંતિમ બિંદુઓ 7
બેઝ પાથ /api/v1/domains
મેળવો /api/v1/domains/

બધા ડોમેન્સની યાદી બનાવો

તમારા ખાતામાં નોંધાયેલ ડોમેઇન પાછા આપે છે, પાના દીઠ ૨૫. યાદીમાં ગાળકો નથી.

જરૂરી પરવાનગી: 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 જ્યારે ડોમેઇન નોંધાયેલ હતું અને જ્યારે તે સમાપ્ત થાય છે. સમાપ્તિ_તારીખ નકામી હોઈ શકે.
days_until_expiration integer | null પૂરા દિવસો સુધી સમાપ્તિ તારીખ (_d), એકવાર સમાપ્ત થાય ત્યારે નકારાત્મક
is_expired, needs_renewal_soon boolean શું ડોમેઇનની સમયમર્યાદા સમાપ્ત થઈ ગઈ છે, અને શું તે આગળના ૩૦ દિવસોમાં સમાપ્ત થાય છે
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/

ડોમેઇન ઉપલબ્ધતા શોધો

ચકાસે છે કે શું નામ ૨૦ લોકપ્રિય એક્સટેન્સન (com, net, org, io, dev, co, app, ai અને વધુ) પર ઉપલબ્ધ છે, અને જો તે તેમનામાં ન હોય તો તમે લખેલ એક્સટેન્સન. પરિણામો ચોક્કસ બંધબેસતી સાથે શરૂ થાય છે, પછી ઉપલબ્ધ નામો, પછી લેવાયેલા.

જરૂરી પરવાનગી: domains:search

બોડી પેરામીટર્સની વિનંતી કરો

પરિમાણો પ્રકાર જરૂરી વર્ણન
domain string હા એક્સટેન્સન સાથે અથવા વગર નામ, ઉદાહરણ તરીકે mysite અથવા mysite.com (૨ થી ૬૩ અક્ષરો)

ઉદાહરણ વિનંતી

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 નહિં રજીસ્ટ્રેશન સમયગાળા, ૧ થી ૧૦ (મૂળભૂત ૧). કિંમત વાર્ષિક કિંમત વખત વર્ષો છે..ai ઓછામાં ઓછા ૨ વર્ષની જરૂરિયાત છે; નાની કિંમત ૪૦૦ પાછી આપે છે. 
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 નહિં ઉમેરવા માટેના વર્ષો, ૧ થી ૧૦ (મૂળભૂત ૧) 
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 nameserver1 ગુમ થયેલ છે
404 મળ્યુ નથી, અથવા તે બીજા ખાતાને લગતુ છે
500 સુધારો નિષ્ફળ; શરીર પાસે ભૂલ અને સંદેશા ક્ષેત્રો છે
PUT /api/v1/domains/{uuid}/auto-renew/

આપોઆપ પુનઃતાજું કરવાનું ચાલુ અથવા બંધ કરો

auto_renew સુયોજિત કરે છે અને સુધારેલ ડોમેઇન ઓબ્જેક્ટ પાછું આપે છે. JSON બુલિયન તરીકે સક્રિય થયેલ મોકલો: કોઇપણ ખાલી નહિં હોય તેવી શબ્દમાળા, શબ્દમાળા ખોટુ સમાવતી, આપોઆપ પુનઃતાજું કરવાનું ચાલુ કરે છે.

જરૂરી પરવાનગી: 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 મળ્યુ નથી, અથવા તે બીજા ખાતાને લગતુ છે

નોંધો