API documentation
Lijst Domeinen
Haal gebruikersdomeinlijst op, ondersteuning voor paginering, sortering en statusfiltering
Content-Type
application-json
categorie
domain
actie
domain_list
Aanvraagparameters
| Parameternaam | Type | Omschrijving | Voorbeeld |
|---|---|---|---|
| sort | Tekst (optioneel) | Sorteermethode: name_asc (domeinnaam oplopend), name_desc (domeinnaam aflopend), time_asc (registratietijd oplopend), time_desc (registratietijd aflopend, standaard) | time_desc |
| page_size | Getal (optioneel) | Aantal items per pagina (standaard: 10, ondersteund: 10, 20, 30, 50, 100) | 20 |
| page_index | Getal (optioneel) | Paginanummer (standaard: 1) | 1 |
| status | Tekst (optioneel) | Domeinstatus: all (alle domeinen, standaard), active (actieve domeinen), expired (verlopen domeinen), stop (gestopte domeinen) | active |
| hold | Tekst (optioneel) | Domein hold-status: lege string (geen filtering, standaard), 0 (geen hold-status), 1 (hold-status) | 0 |
Responseparameters
| Parameternaam | Type | Omschrijving |
|---|---|---|
| code | Geheel getal | Statuscode (200 betekent succes) |
| msg | Tekst | Bericht |
| data | Object | Data-object met domeinlijst en opties |
| data.options | Object | Query-opties inclusief sortering, paginering en filterinstellingen |
| data.options.sort | Tekst | Sorteringsmethode gebruikt in de query |
| data.options.page_size | Geheel getal | Aantal items per pagina |
| data.options.page_index | Geheel getal | Huidige paginanummer |
| data.options.status | Tekst | Statusfilter toegepast op de zoekopdracht |
| data.options.total | Geheel getal | Totaal aantal records |
| data.options.total_pages | Geheel getal | Totaal aantal pagina's |
| data.domain_list | Array | Lijst met domeinobjecten |
| data.domain_list.domain | Tekst | Domeinnaam |
| data.domain_list.created_date | Datum | Aanmaakdatum (JJJJ-MM-DD) |
| data.domain_list.expired_date | Datum | Vervaldatum (JJJJ-MM-DD) |
| data.domain_list.status | Tekst | Domeinstatus (actief/verlopen/gestopt) |
| data.domain_list.nameservers | Array | DNS-serverarray |
| data.domain_list.hold | Geheel getal | Hold-status (0=niet in hold, 1=in hold) |
Voorbeeld aanvraag
{
curl https://api.nicenic.net/v2/?category=domain&action=domain_list&sort={sort}&page_size={page_size}&page_index={page_index}&status={status}&hold={hold}
-H "Authorization: username:api_secret"
-H "Content-Type: application/json"
}
Resultaat teruggeven
0 OK
Succesvolle respons
{
"code": 0,
"msg" : "success",
"data" : {
"options": {
"sort": "time_desc",
"page_size": 20,
"page_index": 1,
"status": "active",
"total": 50,
"total_pages": 3
},
"domain_list": [
{
"domain": "example.com",
"created_date": "2023-01-15",
"expired_date": "2025-01-15",
"status": "active",
"nameservers": ["ns1.example.com", "ns2.example.com"],
"hold": 0
}
]
}
}
400 Ongeldig verzoek
{
"code": 400,
"msg" : "Request parameter error",
}
