Tatauranga API

TIKINA /api/v1/domains/

Rārangihia ngā Rohe Katoa

Ka whiwhi rātau i tētahi rārangi o ngā rohe katoa kua whakarārangitia i raro i tōmu kāwanatanga.

Ngā Tawhā Uiui

Parameter	Momo	E hiahiatia ana	Whakamāramatanga
`status`	string	Kāore	Filter by status: `active`, `pending`, `expired`, `locked`
`search`	string	Kāore	Rapua ngā rohe mā te ingoa

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

200	Kua angitu te tiki i te rārangi rohe
401	Kāore i Whakamanahia - Tohu manatoko kore mana, ngaro rānei

POST /api/v1/domains/

Rēhita Rohe Hou

Ka tāurua tētahi ingoa rohe hou. Me tirohia te wāteatanga rohe i mua i te tāututanga.

Tonohia ngā Tawhā Tinana

Parameter	Momo	E hiahiatia ana	Whakamāramatanga
`domain_name`	string	Āe	Domain name to register (e.g., "example.com")
`years`	integer	Kāore	Registration period in years (1-10, default: 1)
`auto_renew`	boolean	Kāore	Enable automatic renewal (default: true)
`privacy_protection`	boolean	Kāore	Enable WHOIS privacy protection (default: true)
`nameservers`	array	Kāore	Custom nameservers (default: VPS.org nameservers)

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

201	Domain registration initiated successfully
400	Bad Request - Invalid domain name or domain already registered
401	Kāore i Whakamanahia - Tohu manatoko kore mana, ngaro rānei
402	Payment Required - Insufficient account balance

Whakapapa: 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.

TIKINA /api/v1/domains/{domain_id}/

Ki te whiwhi mōhiohio rohe

Ka whiwhi mōhiohio mārama mō tētahi rohe tauwhāiti.

Ngā Tawhā Ara

Parameter	Momo	E hiahiatia ana	Whakamāramatanga
`domain_id`	integer	Āe	Unique domain ID

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

200	Successfully retrieved domain details
401	Kāore i Whakamanahia - Tohu manatoko kore mana, ngaro rānei
404	Kāore i Kitea - Kāore he rohe

TUKU /api/v1/domains/{domain_id}/

Whakahou i ngā Whakautu Rangi

Whakahōu i te whakaritenga rohe pēnei i te whakahōu-māori, ngā pūnaha ingoa, me ngā whakaritenga ā-tuatahi.

Ngā Tawhā Ara

Parameter	Momo	E hiahiatia ana	Whakamāramatanga
`domain_id`	integer	Āe	Unique domain ID

Tonohia ngā Tawhā Tinana

Parameter	Momo	E hiahiatia ana	Whakamāramatanga
`auto_renew`	boolean	Kāore	Enable or disable automatic renewal
`privacy_protection`	boolean	Kāore	Enable or disable WHOIS privacy
`nameservers`	array	Kāore	Update nameservers (2-4 nameservers required)
`locked`	boolean	Kāore	Lock or unlock domain to prevent transfers

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

200	Domain updated successfully
400	Bad Request - Invalid parameters
401	Kāore i Whakamanahia - Tohu manatoko kore mana, ngaro rānei
404	Kāore i Kitea - Kāore he rohe

MUKU /api/v1/domains/{domain_id}/

Whakahōu te rohe

Whakamārahia tētahi rohe mai i tōna pūkete. Kāore tēnei e whakakore i te rāhui rohe - ka tangohia anake i te whakahaeretanga o tōna pūkete VPS.org.

Ngā Tawhā Ara

Parameter	Momo	E hiahiatia ana	Whakamāramatanga
`domain_id`	integer	Āe	Unique domain ID

Tauira Tono

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

Ngā Waehere Tūnga Urupare

204	Domain removed from account successfully
401	Kāore i Whakamanahia - Tohu manatoko kore mana, ngaro rānei
404	Kāore i Kitea - Kāore he rohe

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.

POST /api/v1/domains/{domain_id}/transfer/

Ka whakawhiti i te rohe

Ka tīmata te whakawhitinga rohe ki te VPS.org mai i tētahi atu kaituhituhi.

Ngā Tawhā Ara

Parameter	Momo	E hiahiatia ana	Whakamāramatanga
`domain_id`	integer	Āe	Unique domain ID

Tonohia ngā Tawhā Tinana

Parameter	Momo	E hiahiatia ana	Whakamāramatanga
`auth_code`	string	Āe	EPP/Authorization code from current registrar
`auto_renew`	boolean	Kāore	Enable auto-renewal after transfer (default: true)

Tauira Tono

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

Tauira Whakautu

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

Ngā Waehere Tūnga Urupare

200	Transfer initiated successfully
400	Bad Request - Invalid auth code or domain not eligible for transfer
401	Kāore i Whakamanahia - Tohu manatoko kore mana, ngaro rānei
404	Kāore i Kitea - Kāore he rohe
402	Payment Required - Insufficient account balance for transfer fee

Ka hiahiatia te whakawhitinga:

Me whakakīa te rohe i te kaituhituhi o nāianei
Me 60 rā te pakeke o te rohe
E hiahiatia ana te waehere EPP/Auth tika
Me taea te uru mai te imeli WHOIS mō te whakaaetanga
Kei roto i te whakawhitinga te whakaoratanga o te tau 1 (ka hoatu te utu)

Whakataurite Rangi

TLDs rongonui

TLD	Ka whakapūtātia (1 tau)	Whakahou	Ka whakawhitinga
.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

Ngā Āhuatanga kua Whakaurua

✓ Whakahauhautanga Private WHOIS
✓ Manawa DNS
✓ Whakahauhautanga imeli wātea
✓ Whakahaua te rohe wātea

✓ Ko te kōkuhu rohe wātea
✓ 24/7 Ngana
✓ Manawa rohe māmā
✓ Whakahou-mā-te-pūnaha

Ka taea te whakahaere i te rohe

Haumarutanga

Ka taea te whakakōkī rohe: Ka ārai i ngā whakawhitinga kāore i whakaaetia
Ka taea te parenga ā-ringa: E whakawātea ana i ōna mōhiohio whaiaro mai i te WHOIS
Ka whakamahia ngā kupu whakaingoatanga kaha: Pare i tōna pūkete VPS.org
Whakahohe i te 2FA: E tāpiri ana i te haumarutanga tāpiri ki tōna pūnaha
Ka whakamātautia ngā rā o te mutunga: Ka whakaritea te whakahōu-māoata, ngā whakamātautau rānei o te maramataka

Ka whakaritea

Ka whakaritea te DNS: E tohu ana ngā pūnaha ingoa ki te VPS.org mō te whakahaere ngāwari
Whakahou ā-pūmau: Ka taea te ārai i te whakamutunga ā-waha o te rohe
Whakamāramatanga pāhono: Whakataki i ngā mōhiohio tātai WHOIS i te wā o nāianei
DNS te tiakitanga: E whakaaro ana ki te kaiwhakawhiwhi DNS tuarua mo te whakakoretanga

Ka whakawhitinga

60- rā: Kāore e taea te whakawhiti i ngā rohe i roto i ngā rā 60 o te rā o te rārangitanga, i te whakawhitinga o mua rānei
Kāore i te kōkuhua te rohe: Me whakakīa i te pūkete o nāianei i mua i te whakawhitinga
Whakawhiwhia te waehere whakamātautau: E tono ana i te EPP/whakahiutu waehere mai i te kaituhituhi o nāianei
Whakamātautau imeli: Ka whiwhi i ngā imeli whakaaetanga i te wā o te tukanga whakawhitinga
Ka whakaritea ki mua: Ka taea e ngā whakawhitinga te 5-7 rā hei oti

VPS.org API

Rārangihia ngā Rohe Katoa

Ngā Tawhā Uiui

Tauira Tono

Tauira Whakautu

Ngā Waehere Tūnga Urupare

Rēhita Rohe Hou

Tonohia ngā Tawhā Tinana

Tauira Tono

Tauira Whakautu

Ngā Waehere Tūnga Urupare

Ki te whiwhi mōhiohio rohe

Ngā Tawhā Ara

Tauira Tono

Tauira Whakautu

Ngā Waehere Tūnga Urupare

Whakahou i ngā Whakautu Rangi

Ngā Tawhā Ara

Tonohia ngā Tawhā Tinana

Tauira Tono

Tauira Whakautu

Ngā Waehere Tūnga Urupare

Whakahōu te rohe

Ngā Tawhā Ara

Tauira Tono

Ngā Waehere Tūnga Urupare

Ka whakawhiti i te rohe

Ngā Tawhā Ara

Tonohia ngā Tawhā Tinana

Tauira Tono

Tauira Whakautu

Ngā Waehere Tūnga Urupare

Whakataurite Rangi

TLDs rongonui

Ngā Āhuatanga kua Whakaurua

Ka taea te whakahaere i te rohe

Haumarutanga

Ka whakaritea

Ka whakawhitinga