Passa al contenuto principale

DomainPaginatedListResponse

Successful response with a page of Domain

errorintegerrequired

Always 0 in a successful response

Constant value: 0
messagestring | nullnullablerequired

Always null in a successful response

data object[]required

Items of the page: an empty list beyond the last page

  • Array [
  • domain_idintegerrequired
    tld_idintegerrequired

    Id of the TLD of the domain (GET /api/v3/tlds/{tld_id})

    domain_name objectrequired

    Name of a domain, whole and split into name and extension, in Unicode and in punycode

    unicodestring | nullnullablerequired

    Full domain name in Unicode, for example farò.it

    punycodestring | nullnullablerequired

    Full domain name in punycode, for example xn--far-ena.it

    unicode_namestring | nullnullablerequired

    Name without the extension, in Unicode

    punycode_namestring | nullnullablerequired

    Name without the extension, in punycode

    unicode_tldstring | nullnullablerequired

    Extension (TLD) without the leading dot, in Unicode

    punycode_tldstring | nullnullablerequired

    Extension (TLD) without the leading dot, in punycode

    dns_type objectrequired

    Nameserver type of a domain, which decides where its DNS zone is managed

    type_codestringrequired

    Code of the nameserver type: INTERNAL (our "standard" nameservers), EXTERNAL (nameservers of a third party) or CLOUDFLARE (Cloudflare nameservers, with a Cloudflare account)

    type_namestringrequired

    Name of the nameserver type, in Italian: Standard, Esterna or Cloudflare

    dns_accountstring | nullnullablerequired

    Email of the Cloudflare account that manages the DNS zone, with the Cloudflare nameservers; null with the other nameserver types, and when the zone is on our own Cloudflare account

    nameservers object[]required

    Nameservers of the domain; sort gives their order

  • Array [
  • hostnamestringrequired
    address_ipv4string | nullnullablerequired

    IPv4 address of the nameserver, saved when the nameservers were set; null when not known

    address_ipv6string | nullnullablerequired

    IPv6 address of the nameserver; not filled in for now, always null

    sortintegerrequired

    Position of the nameserver, from 1

  • ]
  • domain_data objectrequired

    Data of the domain at the registry; null when there are none

    anyOf
    registry_statusstring | nullnullablerequired

    Status of the domain as the registry reports it, for example ok, clientTransferProhibited or pendingDelete

    incoming_authcodestring | nullnullablerequired

    Authcode given for the incoming transfer of the domain; null without the domains:secrets scope

    outgoing_authcodestring | nullnullablerequired

    Authcode to transfer the domain to another registrar; null without the domains:secrets scope

    registry_nameserversstring | nullnullablerequired

    Nameservers of the domain at the registry, as a text in the format of the registry (usually hostnames separated by commas)

    registry_expirydate-timenullablerequired

    Expiry of the domain at the registry

    registry_createddate-timenullablerequired

    Registration of the domain at the registry

    registry_updateddate-timenullablerequired

    Last update of the domain at the registry

    registry_deletiondate-timenullablerequired

    Deletion of the domain at the registry, when the registry reports one

    date_deactivationdate-timenullablerequired

    When these data were deactivated because the registrar no longer has the domain (for example after an outgoing transfer); null while they are active

    identity_validation_statusstring | nullnullablerequired

    Status of the validation of the identity of the registrant: VERIFIED, NOT_VERIFIED, PENDING or FAILED

    is_on_holdbooleanrequired

    Whether the domain is on hold at the registry (status clientHold)

    transfer_wrong_authcodeboolean | nullnullablerequired

    Whether the incoming transfer failed because of a wrong authcode; null when not known

    transfer_lockedboolean | nullnullablerequired

    Whether the incoming transfer failed because the domain is locked at the current registrar; null when not known

    date_createddate-timerequired

    When these data were recorded: a new version is recorded each time the data at the registry change

    contacts_countintegerrequired

    Number of active contacts of the domain

    date_info_lastdate-timenullablerequired

    When the data of the domain were last requested from the registry

    date_dns_checkdate-timenullablerequired

    When the DNS zone and the DNSSEC of the domain were last checked

    vanity_nameserver_enabledbooleanrequired

    Whether the domain uses vanity nameservers: our nameservers with hostnames of the domain itself (for example ns1.example.com)

  • ]
  • meta objectrequired

    Pagination of the list

    totalintegerrequired

    Number of items in the whole list

    countintegerrequired

    Number of items in this page: 0 beyond the last page

    pagesintegerrequired

    Number of pages of the list

    pageintegerrequired

    Number of this page, starting from 1

    per_pageintegerrequired

    Maximum number of items in a page

    DomainPaginatedListResponse
    {
    "error": 0,
    "message": "string",
    "data": [
    {
    "domain_id": 0,
    "tld_id": 0,
    "domain_name": {
    "unicode": "string",
    "punycode": "string",
    "unicode_name": "string",
    "punycode_name": "string",
    "unicode_tld": "string",
    "punycode_tld": "string"
    },
    "dns_type": {
    "type_code": "string",
    "type_name": "string"
    },
    "dns_account": "string",
    "nameservers": [
    {
    "hostname": "string",
    "address_ipv4": "string",
    "address_ipv6": "string",
    "sort": 0
    }
    ],
    "domain_data": {
    "registry_status": "string",
    "incoming_authcode": "string",
    "outgoing_authcode": "string",
    "registry_nameservers": "string",
    "registry_expiry": "2024-07-29T15:51:28.071Z",
    "registry_created": "2024-07-29T15:51:28.071Z",
    "registry_updated": "2024-07-29T15:51:28.071Z",
    "registry_deletion": "2024-07-29T15:51:28.071Z",
    "date_deactivation": "2024-07-29T15:51:28.071Z",
    "identity_validation_status": "string",
    "is_on_hold": true,
    "transfer_wrong_authcode": true,
    "transfer_locked": true,
    "date_created": "2024-07-29T15:51:28.071Z"
    },
    "contacts_count": 0,
    "date_info_last": "2024-07-29T15:51:28.071Z",
    "date_dns_check": "2024-07-29T15:51:28.071Z",
    "vanity_nameserver_enabled": true
    }
    ],
    "meta": {
    "total": 0,
    "count": 0,
    "pages": 0,
    "page": 0,
    "per_page": 0
    }
    }