VPS.org API

REST API -dokumentaatio

Verkkoaluerajapinta

Etsi saatavilla olevia verkkotunnuksia, rekisteröi ja uusi verkkotunnuksia sekä hallinnoi niiden nimipalvelimia ja automaattiuudistuksia. Verkkotunnukset tunnistetaan verkkotunnuksen avulla.

Päätepisteet 7
Perusreitti /api/v1/domains
SAADA /api/v1/domains/

Listaa kaikki verkkotunnukset

Palauttaa tilillesi rekisteröidyt verkkotunnukset, 25 sivulla. Luettelossa ei ole suodattimia.

Vaadittu lupa: domains:list

Esimerkkipyyntö

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

Esimerkkivastaus

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

Vastauskentät

Kenttä Tyyppi Tavaran kuvaus
uuid string Verkkoaluetunniste, jota käytetään muissa verkkotunnuksen päätetapahtumissa
status string active, pending, expired, cancelled, transferred
registrar string Kirjaaja:
registration_date, expiration_date datetime Kun verkkotunnus rekisteröitiin ja se päättyi. Viimeinen voimassaolopäivä voi olla mitätön.
days_until_expiration integer | null Kokonaiset päivät, kunnes viimeinen voimassaolopäivä on päättynyt, negatiivinen kerran
is_expired, needs_renewal_soon boolean Onko verkkotunnus vanhentunut ja päättyykö se seuraavien 30 päivän kuluessa
auto_renew, renewal_period_years boolean, integer Uusiutuuko verkkotunnus automaattisesti ja kuinka monta vuotta
registration_price, renewal_price string Hinnat Yhdysvaltain dollareina desimaalin kielinä
whois_privacy, transfer_lock boolean WhoIS:n yksityisyys ja rekisterisiirron lukitusasetukset
nameserver1 to nameserver4 string | null Verkkotunnuksen nimipalvelimet
created_at, updated_at datetime Kun levy on luotu ja viimeksi muutettu (ISO 8601, UTC)
SAADA /api/v1/domains/{uuid}/

Hanki verkkotunnuksen tiedot

Palauttaa yhden verkkotunnuksen ja yllä olevat kentät.

Vaadittu lupa: domains:list

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

Vastauksen tilakoodit

200 Onnistuminen
404 Ei löytynyt, tai se kuuluu toiselle tilille
JÄLKEEN /api/v1/domains/search/

Etsi verkkotunnuksen saatavuus

Tarkistaa, onko nimi saatavilla noin 20 suositun laajennuksen (com, net, org, io, dev, co, app, ai ja enemmän) ja sen laajennuksen välillä, jonka kirjoitit, jos se ei ole joukossa. Tulokset alkavat tarkalla osumalla, sitten saatavilla olevilla nimillä ja sitten otetuilla.

Vaadittu lupa: domains:search

Pyynnön rungon parametrit

Muuttuja Tyyppi Pakollinen Tavaran kuvaus
domain string Kyllä Nimi, jolla on tai ei ole laajennusta, esimerkiksi mysite tai mysite.com (2-63 merkkiä)

Esimerkkipyyntö

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

Esimerkkivastaus

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

Hinnat ovat vuoden ajan Yhdysvaltain dollareina, eikä niitä ole saatavilla. Hinnat ovat havainnollistavia.

Vastauksen tilakoodit

200 Onnistuminen
400 Puuttuva verkkotunnus tai se sisältää muita merkkejä kuin kirjaimia, numeroita ja välimerkkejä
500 Rekisterinpitäjän haku epäonnistui.
JÄLKEEN /api/v1/domains/register/

Rekisteröi uusi verkkotunnus

Rekisteröi verkkotunnuksen ja veloittaa tallennetun maksutapasi. Saatavuus ja hinta tarkistetaan rekisteristä uudelleen juuri ennen maksua. Rekisteröijän yhteystiedot on otettu tiliprofiilistasi. Jos rekisteröityjä hylkää rekisteröinnin maksun jälkeen, maksu palautetaan.

Vaadittu lupa: domains:register (myönnetty alueittain:*)

Pyynnön rungon parametrit

Muuttuja Tyyppi Pakollinen Tavaran kuvaus
domain string Kyllä Koko verkkotunnus, mukaan lukien sen laajennus, esimerkiksi.com
years integer Ei tarvitse. Registration period, 1 to 10 (default 1). The price is the yearly price times years. .ai requires at least 2 years; a smaller value returns 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}'

Esimerkkivastaus

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

Vastauksen tilakoodit

201 Verkkoalue rekisteröity
400 Virheellinen verkkotunnus, verkkotunnus ei ole enää saatavilla, hintaa ei voitu tarkistaa, vanhentunut maksutapa tai maksu epäonnistui
402 Ei maksutapaa tiedostossa tai maksamattomia laskuja
500 Maksua ei voitu käsitellä, tai ilmoittaja hylkäsi rekisteröinnin maksun jälkeen. Toisessa tapauksessa virheilmoitus kertoo, menikö palautus läpi.
JÄLKEEN /api/v1/domains/{uuid}/renew/

Uusi verkkoalue

Uudistaa verkkotunnuksen ja veloittaa sen uusimishintaa vuosittain tallennetusta maksutavasta.

Vaadittu lupa: domains:renew

Pyynnön rungon parametrit

Muuttuja Tyyppi Pakollinen Tavaran kuvaus
years integer Ei tarvitse. Lisävuosia, 1-10 (oletus 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)!"
}

Vastauksen tilakoodit

200 Verkkoalue uusittu
400 Virheellinen vuosi, verkkotunnuksen uusimishinta, käyttökelpoinen maksutapa tai maksu epäonnistui
404 Ei löytynyt, tai se kuuluu toiselle tilille
500 Maksua ei voitu käsitellä tai maksu meni läpi, mutta rekisteritunnusten uusiminen epäonnistui. Ota yhteyttä tukiin.
PUT /api/v1/domains/{uuid}/nameservers/

Päivitä nimipalvelimet

Asettaa verkkotunnuksen nimipalvelimet rekisterinpitäjään ja palauttaa päivitetyn verkkotunnuksen. DNS:n hallinnoimiseksi DNS-rajapintaan käytetään ns1.vps.org:ää, ns2.vps.org:ää ja ns3.vps.orgia ja luodaan verkkotunnukselle alue.

Vaadittu lupa: domains:update

Pyynnön rungon parametrit

Muuttuja Tyyppi Pakollinen Tavaran kuvaus
nameserver1 string Kyllä Ensisijainen nimipalvelin
nameserver2, nameserver3, nameserver4 string Ei tarvitse. Muita nimipalvelinten isäntänimiä 
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"}'

Vastauksen tilakoodit

200 Nimipalvelimet päivitetty; keho on verkkotunnusobjekti
400 nimipalvelin1 puuttuu
404 Ei löytynyt, tai se kuuluu toiselle tilille
500 Päivitys epäonnistui; kehossa on virhe- ja viestikentät
PUT /api/v1/domains/{uuid}/auto-renew/

Automaattinen uusiminen päälle tai pois päältä

Asettaa automaattisesti _uusii ja palauttaa päivitetyn verkkotunnuksen. Lähetä käytössä JSON-booleana: mikä tahansa tyhjä merkkijono, mukaan lukien väärä merkkijono, käynnistää automaattisesti uusimisen.

Vaadittu lupa: 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}'

Vastauksen tilakoodit

200 Asetukset tallennettu; keho on verkkotunnusobjekti
400 ei käytössä
404 Ei löytynyt, tai se kuuluu toiselle tilille

Huomautuksia