1. Kennisbank
  2. API
  3. Domains : list

Domains : List

  • Aangemaakt : 15-05-2023
  • Laatste update: 20-12-2023

Omschrijving

Haal lijst op met alle domeinnamen uit het account

Endpoint


URL parameters

Bekijk voor meer informatie over de mogelijke zoekwaarden en de pagina: Zoekopdrachten

Parameter Datatype Omschrijving
domain_name String Zoekwaarde voor de domeinnaam
sld String Zoekwaarde voor de SLD van de domeinnaam
tld String Zoekwaarde voor de TLD van de domeinnaam
status Array Zoekwaarde voor status van de domeinnaam
Bekijk voor meer informatie over de mogelijke domein statussen de pagina: Domein statussen
registrant_handle String Zoekwaarde voor handle van het registrant contact
admin_handle String Zoekwaarde voor handle van het admin contact
tech_handle String Zoekwaarde voor handle van het tech contact
billing_handle String Zoekwaarde voor handle van het billing contact
date_expiry String Zoekwaarde voor de verloopdatum, formaat: YYYY-MM-DDThh:mm:ssZ in UTC tijdzone in RFC 3339
auto_renewal Boolean Zoekwaarde voor het automatisch verlengen van de domeinnaam (true = aan, false = uit)
auto_renewal_period Integer Zoekwaarde voor de periode waarmee de domeinnaam verlengd wordt
date_renewal Datetime Zoekwaarde voor verlengdatum van de domeinnnaam
auth_code String Zoekwaare voor de authcode
auth_code_date_expiry String Zoekwaarde voor de verloopdatum van de verloopdatum, formaat: YYYY-MM-DDThh:mm:ssZ in UTC tijdzone in RFC 3339
idn_language String Zoekwaarde voor de IDN taal
date_created Datetime Zoekwaarde voor datum waarop de domeinnaam aan het account werd toegevoegd, formaat: YYYY-MM-DDThh:mm:ssZ in UTC tijdzone in RFC 3339
date_deleted Datetime Zoekwaarde voor datum waarop de domeinnaam werd opgeheven, formaat: YYYY-MM-DDThh:mm:ssZ in UTC tijdzone in RFC 3339
transfer_lock Boolean Zoekwaarde voor de transfer lock van de domeinnaam:
true: aan
false = uit
leeg: geen transfer lock beschikbaar
premium_domain String Zoekwaarde voor premium domeinnaam
premium_price Float Zoekwaarde voor de premium prijs
premium_price_currency String Zoekwaarde voor de munteenheid van de premium prijs
custom_price_domain String Zoekwaarde voor voor domein met specifieke prijs
custom_price Float Zoekwaarde voor de specifieke prijs
custom_price_currency String Zoekwaarde voor de munteenheid van de specifieke prijs
dns_hosted Boolean Zoekwaarde voor hosted DNS of eigen gespecificeerde nameservers
dns_hosted_template String Zoekwaarde voor DNS-template van hosted DNS
nsgroup Boolean Zoekwaarde voor hosted DNS of eigen gespecificeerde nameservers
dnssec String Zoekwaarde voor DNSSEC ondertekende domeinnamen:
signed: Ondertekend met DNSSEC
unsigned: Niet voorzien van DNSSEC
tags Array Zoekwaarde voor tags van de domeinnaam
services Array Zoekwaarde voor geactiveerde diensten bij de domeinnaam van de domeinnaam. Mogelijke waarden:
trustee: Trustee contact idprotect: ID protect

Antwoord

Parameter Type Omschrijving
Array: data[] met object:
domain_name String Domeinnaam
status Array Status van de domeinnaam

Bekijk voor meer informatie over de mogelijke domein statussen de pagina: Domein statussen
date_expiry String Datum en tijdstip waarop de domeinnaam verloopt in RFC 3339 formaat
auto_renew Boolean Automatisch verlengen van de domeinnaam
auto_renew_period Integer De periode in maanden waarmee de domeinnaam verlengd zal worden
date_renewal Datetime Datum en tijdstip waarop de domeinnaam wordt verlengd in RFC 3339 formaat
auth_code String Auth-code van de domeinnaam
auth_code_date_expiry Datetime Verloopdatum van de auth_code, NULL als de auth_code niet verloopt
date_created Datetime Datum en tijdstip waarop de domeinnaam aan het account werd toegevoegd UTC tijdzone in RFC 3339
date_deleted Datetime Datum en tijdstip waarop de domeinnaam aan het opgeheven, alleen bij status 'quarantaine' UTC tijdzone in RFC 3339
transfer_lock Boolean Of de domeinnaam is voorzien van een transfer lock, een domeinnaam voorzien van een transfer lock kan niet verhuisd worden. NULL als de extensie geen transfer locks ondersteunt.
registant_handle String Contact handle van de registrant
contacts Object Object met de contacten van de domeinnaam bestaande uit:
type: Het type van het contact: admin, tech of billing
handle: De handle van het contact
premium_domain Boolean Of de domeinnaam een premium domeinnaam is
premium_price Object Object met de informatie over de premium prijs:
currency: De munteenheid van de prijs (string)
price: De prijs van de domeinnaam (float)
dns_hosted Boolean Of de domeinnaam gebruik maakt van de nameservers van MijnDomeinReseller of zelf gespecificeerde nameservers
dns_hosted_template String Naam van de DNS-template, alleen zichtbaar als dns_hosted=true, NULL wanneer er geen DNS-template is gekoppeld
nsgroup String De naam van de nameserver group die is opgegeven, NULL als de nameservers van MijnDomeinReseller worden gebruikt
dnssec String Of de domeinnaam is ondertekend met DNSSEC:
signed: Als de domeinnaam is voorzien van DNSSEC
unsigned: Als de domeinnaam niet is voorzien van DNSSEC
Object: pagination
current_page Integer Huidige pagina
per_page Integer Aantal resultaten per pagina
total_pages Integer Totaal aantal pagina's
total_results Integer Totaal aantal resultaten

Voorbeelden


Beschrijving:
Haal lijst met domeinnamen op

Opdracht in PHP: 
<?php
$env      = "live"; // live or test
$api_key  = "XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$api_url  = "/v2/domains";
$api_host = $env === "live" ? "https://api.mijndomeinreseller.nl" : "https://api-test.mijndomeinreseller.nl";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_host . $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer $api_key"));
$output = curl_exec($ch);
curl_close($ch);

echo $output;
Opdracht in cURL: 
curl -H "Authorization: Bearer XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
https://api-test.mijndomeinreseller.nl/v2/domains
Antwoord: 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8            

{
  "data": [
    {
      "domain_name": "somedomainname.nl",
      "sld": "somedomainname",
      "tld": "nl",
      "status": [
        "registered"
      ],
      "date_expiry": "2024-10-14T00:00:00+02:00",
      "auto_renewal": true,
      "auto_renewal_period": 12,
      "date_renewal": "2024-10-14T00:00:00+02:00",
      "date_deleted": null,
      "auth_code": "rmu7J4G3PQ4Y",
      "auth_code_date_expiry": null,
      "idn_language": null,
      "date_created": "2018-10-14T15:12:20+02:00",
      "transfer_lock": null,
      "registrant_handle": "CONTACTHANDLE-1",
      "contacts": [
        {
	  "type": "admin",
	  "handle": "CONTACTHANDLE-1"
	},
	{
	  "type": "tech",
	  "handle": "CONTACTHANDLE-2"
	}
      ],
      "premium_domain": false,
      "custom_price_domain": false,
      "dns_hosted": true,
      "dns_hosted_template": null,
      "dnssec": "signed",
      "tags": ["customers"],
      "services": []
     },
     {
       "domain_name": "someotherdomainname.blog",
       "sld": "someotherdomainname",
       "tld": "blog",
       "status": [
         "registered"
       ],
       "date_expiry": "2024-12-28T00:00:00+02:00",
       "auto_renewal": true,
       "auto_renewal_period": 12,
       "date_renewal": "2024-12-28T00:00:00+02:00",
       "date_deleted": null,
       "auth_code": "%eyZMz%EB@2cpAOe",
       "auth_code_date_expiry": null,
       "idn_language": null,
       "date_created": "2019-12-28T15:12:20+02:00",
       "transfer_lock": true,
       "registrant_handle": "CONTACTHANDLE-1",
       "contacts": [
         {
	   "type": "admin",
	   "handle": "CONTACTHANDLE-1"
	 },
	 {
	   "type": "tech",
	   "handle": "CONTACTHANDLE-2"
	 }
	 {
	   "type": "billing",
	   "handle": "CONTACTHANDLE-3"
	 }
       ],
       "premium_domain": true,
       "premium_price" {
         "currency": "USD",
         "price": 123.45
       },
       "custom_price_domain": false,
       "dns_hosted": false,
       "nsgroup": "myhostingDNS",
       "dnssec": "signed",
       "tags": [],
       "services": []
     }, 
     {
       "domain_name": "quarantainedomain.be",
       "sld": "quarantainedomain",
       "tld": "be,
       "status": [
         "quarantine"
       ],
       "date_expiry": "2024-06-13T00:00:00+01:00",
       "auto_renewal": true,
       "auto_renewal_period": 12,
       "date_renewal": "2024-06-13T00:00:00+01:00",
       "date_deleted": "2024-06-12T23:55:55+01:00",
       "auth_code": null,
       "auth_code_date_expiry": null,
       "idn_language": null,
       "date_created": "2020-06-13T09:28:45+02:00",
       "transfer_lock": true,
       "registrant_handle": "CONTACTHANDLE-1",
       "contacts": [
	 {
	   "type": "tech",
	   "handle": "CONTACTHANDLE-2"
	 }
       ],
       "premium_domain": false,
       "custom_price_domain": false,
       "dns_hosted": false,
       "nsgroup": "myhostingDNS",
       "dnssec": "signed",
       "tags": [],
       "services": []
     },    
  ],
  pagination": {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_results": 3
  }
}

Beschrijving:
Haal een lijst met domeinnamen op die in quarantaine zijn

Opdracht in PHP: 
<?php
$env      = "live"; // live or test
$api_key  = "XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$api_url  = "/v2/domains?status=quarantine";
$api_host = $env === "live" ? "https://api.mijndomeinreseller.nl" : "https://api-test.mijndomeinreseller.nl";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_host . $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer $api_key"));
$output = curl_exec($ch);
curl_close($ch);

echo $output;
Opdracht in cURL: 
curl -H "Authorization: Bearer XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
"https://api-test.mijndomeinreseller.nl/v2/domains?status=quarantine"
Antwoord: 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8            

{
  "data": [
    {
      "domain_name": "quarantainedomain.be",
      "sld": "quarantainedomain",
      "tld": "be,
      "status": [
        "quarantine"
      ],
      "date_expiry": "2024-06-13T00:00:00+01:00",
      "auto_renew": true,
      "auto_renew_period": 12,
      "date_renewal": "2024-06-13T00:00:00+01:00",
      "date_deleted": "2024-06-12T23:55:55+01:00",
      "auth_code": null,
      "auth_code_date_expiry": null,
      "idn_language": null,
      "date_created": "2020-06-13T09:28:45+02:00",
      "transfer_lock": true,
      "registrant_handle": "CONTACTHANDLE-1",
      "contacts": [
        {
          "type": "tech",
          "handle": "CONTACTHANDLE-2"
        }
      ],
      "premium_domain": false,
      "custom_price_domain": false,
      "dns_hosted": false,
      "nsgroup": "myhostingDNS",
      "dnssec": "signed",
      "tags": [],
      "services": []
    }    
  ],
  pagination": {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_results": 1
  }
}

Beschrijving:
Haal alle premium domeinnamen op, gesorteerd op verlengdatum

Opdracht in PHP: 
<?php
$env      = "live"; // live or test
$api_key  = "XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$api_url  = "/v2/domains?premium_domain=true&sort=date_renewal";
$api_host = $env === "live" ? "https://api.mijndomeinreseller.nl" : "https://api-test.mijndomeinreseller.nl";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_host . $api_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Authorization: Bearer $api_key"));
$output = curl_exec($ch);
curl_close($ch);

echo $output;
Opdracht in cURL: 
curl -H "Authorization: Bearer XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
"https://api-test.mijndomeinreseller.nl/v2/domains?premium_domain=true&sort=date_renewal"
Antwoord: 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8            

{
  "data": [
    {
      "domain_name": "someotherdomainname.blog",
      "sld": "someotherdomainname",
      "tld": "blog",
      "status": [
        "registered"
      ],
      "date_expiry": "2024-12-28T00:00:00+02:00",
      "auto_renew": true,
      "auto_renew_period": 12,
      "date_renewal": "2024-12-28T00:00:00+02:00",
      "date_deleted": null,
      "auth_code": "%eyZMz%EB@2cpAOe",
      "auth_code_date_expiry": null,
      "idn_language": null,
      "date_created": "2019-12-28T15:12:20+02:00",
      "transfer_lock": true,
      "registrant_handle": "CONTACTHANDLE-1",
      "contacts": [
        {
	  "type": "admin",
	  "handle": "CONTACTHANDLE-1"
	},
	{
	  "type": "tech",
	  "handle": "CONTACTHANDLE-2"
	}
	{
	  "type": "billing",
	  "handle": "CONTACTHANDLE-3"
	}
      ],
      "premium_domain": true,
      "premium_price" {
        "currency": "USD",
        "price": 123.45
      },
      "custom_price_domain": false,
      "dns_hosted": false,
      "nsgroup": "myhostingDNS",
      "dnssec": "signed",
      "tags": [],
      "services": []
    }
  ],
  pagination": {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_results": 1
  }
}

API Documentatie

Versie V2.2b, 05-07-2024