VPS.org API

REST API dokumentasyon

Mga Domain API

Maghanap para sa mga magagamit na pangalan ng domain, mag-register at i-renew domain, at pamahalaan ang kanilang mga nameservers at auto-renewal. Domains ay kinikilala sa pamamagitan ng kanilang uuid.

Mga Endpoint 7
Landas ng Batayan /api/v1/domains
KUMUHA /api/v1/domains/

Ilista ang Lahat ng Domain

Bumalik ang mga domain na nakarehistro sa iyong account, 25 bawat pahina. Ang listahan ay walang filter.

Kailangang pahintulot: domains:list

Halimbawang Kahilingan

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);

Halimbawang Tugon

{
  "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"
    }
  ]
}

Mga Patlang ng Tugon

Patlang Uri Paglalarawan
uuid string Domain identifier na ginagamit sa iba pang mga endpoints domain
status string active, pending, expired, cancelled, transferred
registrar string Registrar ang domain ay gaganapin sa
registration_date, expiration_date datetime Kapag ang domain ay nakarehistro at kapag ito expires. expiration_date ay maaaring null.
days_until_expiration integer | null Buong araw hanggang expiration_date, negatibong isang beses expired
is_expired, needs_renewal_soon boolean Kung ang domain ay expired, at kung ito expires sa loob ng susunod na 30 araw
auto_renew, renewal_period_years boolean, integer Kung ang domain ay awtomatikong nagre-renew, at para sa kung gaano karaming taon
registration_price, renewal_price string Mga presyo sa USD bilang decimal string
whois_privacy, transfer_lock boolean WHOIS privacy at registrar transfer lock setting
nameserver1 to nameserver4 string | null Ang domain ng nameservers
created_at, updated_at datetime Kapag ang rekord ay nilikha at huling binago (ISO 8601, UTC)
KUMUHA /api/v1/domains/{uuid}/

Kumuha ng mga detalye ng domain

Bumalik ng isang domain bagay sa mga patlang sa itaas.

Kailangang pahintulot: domains:list

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

Mga Kodigo ng Katayuan ng Tugon

200 Tagumpay
404 Hindi natagpuan, o ito ay pag-aari ng iba pang account
Post /api/v1/domains/search/

Maghanap ng Domain Availability

Tingnan kung ang isang pangalan ay magagamit sa paligid ng 20 popular na extension (com, net, org, io, dev, co, app, ai at higit pa), pati na rin ang extension na iyong na-type kung ito ay hindi kabilang sa kanila. Mga resulta simulan sa eksaktong tugma, pagkatapos ay magagamit na mga pangalan, pagkatapos ay kinuha ang mga.

Kailangang pahintulot: domains:search

Humiling ng mga Parameter ng Katawan

Parameter Uri Kinakailangan Paglalarawan
domain string Oo Isang pangalan na may o walang extension, halimbawa mysite o mysite.com (2 hanggang 63 character)

Halimbawang Kahilingan

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"])

Halimbawang Tugon

{
  "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
}

Ang mga presyo ay mga numero sa USD para sa isang taon at null para sa mga pangalan na hindi magagamit. Ang mga presyo na ipinapakita ay ilustratibo.

Mga Kodigo ng Katayuan ng Tugon

200 Tagumpay
400 Nawawalang domain, o naglalaman ito ng mga character maliban sa mga titik, digit at hyphens
500 Ang registrar na hanapin ay nabigo. Subukan muli mamaya.
Post /api/v1/domains/register/

Magrehistro ng Bagong Domain

Ang availability at presyo ay sinusuri muli sa registrar bago ang pag-charge. Ang mga detalye ng contact ng registrant ay kinuha mula sa iyong profile sa account. Kung tinanggihan ng registrar ang pag-register pagkatapos ng pag-charge, ang pagbabayad ay ibabalik.

Kailangang pahintulot: domains:register (na ibinigay ng domain:*)

Humiling ng mga Parameter ng Katawan

Parameter Uri Kinakailangan Paglalarawan
domain string Oo Ang buong pangalan ng domain kabilang ang extension nito, halimbawa example.com
years integer Hindi Registration panahon, 1 hanggang 10 (default 1). Ang presyo ay ang taunang presyo beses taon..ai nangangailangan ng hindi ba sa2taon; isang mas maliit na halaga ay bumalik 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}'

Halimbawang Tugon

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

Mga Kodigo ng Katayuan ng Tugon

201 Ang domain ay nakarehistro
400 Hindi wastong domain, domain na hindi na magagamit, presyo ay hindi maaaring na-verify, lumang paraan ng pagbabayad, o ang pagbabayad ay nabigo
402 Walang paraan ng pagbabayad sa file, o hindi nababayaran invoice
500 Ang pagbabayad ay hindi maaaring iproseso, o ang registrar tinanggihan ang registration pagkatapos ng pagbabayad. Sa ikalawang kaso ang error message ay nagsasabi kung ang refund nagpunta sa pamamagitan ng.
Post /api/v1/domains/{uuid}/renew/

Mag-renew ng isang Domain

Pinapanumbalik ang domain at sinisingil ang renewal_price nito sa bawat taon sa iyong nai-save na paraan ng pagbabayad.

Kailangang pahintulot: domains:renew

Humiling ng mga Parameter ng Katawan

Parameter Uri Kinakailangan Paglalarawan
years integer Hindi Taon upang magdagdag, 1 hanggang 10 (default 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)!"
}

Mga Kodigo ng Katayuan ng Tugon

200 Domain na pinalitan
400 Hindi wastong taon, walang presyo ng pagpapanumbalik para sa domain, walang magagamit na paraan ng pagbabayad, o ang pagbabayad ay nabigo
404 Hindi natagpuan, o ito ay pag-aari ng iba pang account
500 Ang pagbabayad ay hindi maaaring iproseso, o ang pagbabayad ay nagpunta sa pamamagitan ng ngunit ang registrar renewal ay nabigo. Makipag-ugnay sa suporta sa kaso na iyon.
PUT /api/v1/domains/{uuid}/nameservers/

I-update ang Nameservers

Para sa pamamahala ng DNS sa DNS API, gamitin ns1.vps.org, ns2.vps.org at ns3.vps.org at lumikha ng isang zone para sa domain.

Kailangang pahintulot: domains:update

Humiling ng mga Parameter ng Katawan

Parameter Uri Kinakailangan Paglalarawan
nameserver1 string Oo Pangunahing nameserver hostname
nameserver2, nameserver3, nameserver4 string Hindi Karagdagang nameserver hostnames 
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"}'

Mga Kodigo ng Katayuan ng Tugon

200 Nameservers na-update; ang katawan ay ang domain object
400 nameserver1 nawawalang
404 Hindi natagpuan, o ito ay pag-aari ng iba pang account
500 Ang update ay nabigo; ang katawan ay may error at patlang ng mensahe
PUT /api/v1/domains/{uuid}/auto-renew/

I-on o i-off ang Auto-Renewal

Magpadala enabled bilang isang JSON boolean: anumang hindi-walang laman string, kabilang ang string false, ay nagpapakita ng auto-renew sa.

Kailangang pahintulot: 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}'

Mga Kodigo ng Katayuan ng Tugon

200 Pagse-set na-save; ang katawan ay ang domain object
400 enabled nawawalang
404 Hindi natagpuan, o ito ay pag-aari ng iba pang account

Mga tala