v1

latestSwagger 2.02026-08-041113661.2 MB
DomainService

Get domain

get/v1beta/domains/{id}

Path parameters

idinteger required

Domain id number

Query parameters

domain.namestring

Domain name without extension.

domain.extensionstring

Domain extension.

with_historyboolean

Returns domain mutations history.

with_api_historyboolean

Returns domain API calls history.

with_additional_databoolean

Returns domain additional data.

with_verification_emailboolean

Returns information about domain owner email verification status.

with_abuse_detailsboolean

Returns domain abuse details.

with_whois_privacy_databoolean

Returns WPP data.

with_registry_statusesboolean

Indicates, if registry EPP statuses should be retrieved.

is_deletedboolean

Indicates whether object is deleted.

Response

A successful response.

codeinteger
descstring
maintenanceboolean

Example response

{
  "code": 0,
  "data": {
    "abuse_details": {
      "abuse_id": 0,
      "is_domain_held": false,
      "message": ""
    },
    "active_date": "2019-01-27 0:55:17",
    "additional_data": {
      "abogado_acceptance": "",
      "admin_sing_pass_id": "",
      "ae_acceptance": "1",
      "allocation_token": "",
      "auth_code": "",
      "bank_acceptance": "",
      "company_registration_number": "XX123456789X01",
      "coop_acceptance": "1",
      "customer_uin": "374892173498127349",
      "customer_uin_doc_type": {
        "description": "Singapore Personal Access ID",
        "doc_type": "singpass"
      },
      "domain_name_variants": [
        "xn--домен.cat"
      ],
      "eligibility_type": "",
      "eligibility_type_relationship": "",
      "es_annex_acceptance": "1",
      "ftld_token": "",
      "gay_donation_acceptance": "1",
      "gay_rights_protection_acceptance": "1",
      "id_number": "123456789X",
      "id_type": "",
      "idn_script": "SPA",
      "insurance_acceptance": "",
      "intended_use": "generic",
      "law_acceptance": "",
      "legal_type": "Individual",
      "maintainer": "",
      "membership_id": "A",
      "mobile_phone_number_verification": "",
      "ngo_ong_eligibility_acceptance": "",
      "ngo_ong_policy_acceptance": "",
      "passport_number": "X123456",
      "rurf_blocked_domains": "",
      "self_service": "1",
      "trademark": "1",
      "trademark_id": "",
      "travel_acceptance": "1",
      "vat": "11843009X",
      "verification_code": "",
      "vote_acceptance": "",
      "voto_acceptance": ""
    },
    "admin_handle": "XX123456-XX",
    "api_history": [
      {
        "cmd": "deleteDomainRequest",
        "created_at": "2018-09-05 13:58:55",
        "domain_id": 12345678,
        "in": "",
        "out": ""
      }
    ],
    "application_id": "A743C511084404F31B15757DC979A1412-ABI",
    "application_mode": "",
    "application_mode_expiration_date": "",
    "application_mode_title": "",
    "application_notice_id": "983bdc1a0000100000188801724",
    "application_smd": "",
    "auth_code": "1a2b3c4d5e6f",
    "autorenew": "default",
    "billing_handle": "XX123456-XX",
    "can_renew": false,
    "comments": "",
    "comments_last_changed_at": "2018-01-30 14:37:49",
    "creation_date": "2013-07-04 17:14:44",
    "delete_status": "quarantine",
    "deleted_at": "0000-00-00 00:00:00",
    "dnssec": "unsigned",
    "dnssec_keys": [
      {
        "alg": 8,
        "flags": 257,
        "protocol": 3,
        "pub_key": "WSgigdu8545g96",
        "readonly": 1
      }
    ],
    "domain": {
      "extension": "london",
      "name": "test4"
    },
    "expiration_date": "2014-07-04 17:14:44",
    "hard_quarantine_expiry_date": "",
    "has_active_sectigo_zone": false,
    "has_history": false,
    "history": [
      {
        "contents": "Domain: test-example.tldAction: registration succeededStatus: ACTOrder date: 2018-01-30Activation date: 2018-01-30Renewal date: 2019-01-27Expiration date: 2019-01-29Comments: registration of this domain has succeeded Nameserver addresses are automatically resolved by system; Nameserver IP addresses are only saved for glue records",
        "domain": "example.com",
        "ip": "12.123.3.12",
        "subject": "Sent status e-mail to admin@someemail.nl",
        "timestamp": "2018-01-30T14:38:45+01:00",
        "type": "I"
      }
    ],
    "id": 123456789,
    "internal_auth_code": "1a2b3c4d5e6f",
    "is_abusive": false,
    "is_client_hold_enabled": "no",
    "is_deleted": false,
    "is_dnssec_enabled": false,
    "is_hosted_whois": false,
    "is_lockable": false,
    "is_locked": false,
    "is_parked": false,
    "is_premium": false,
    "is_private_whois_allowed": false,
    "is_private_whois_enabled": false,
    "is_sectigo_dns_enabled": false,
    "is_spamexperts_enabled": false,
    "last_changed": "2014-04-18 7:13:05",
    "modify_owner_allowed": false,
    "name_servers": [
      {
        "ip": "12.3.123.121",
        "ip6": "1s23:123:123:f",
        "name": "ns1.example.com",
        "seq_nr": 1
      }
    ],
    "ns_group": "dns-openprovider",
    "ns_template_id": 0,
    "ns_template_name": "",
    "nsgroup_id": 1,
    "order_date": "2013-07-04 17:14:44",
    "owner": {
      "company_name": "Example company",
      "full_name": "Test Van Person"
    },
    "owner_company_name": "Company Name",
    "owner_handle": "XX123456-XX",
    "quarantine_expiration_date": "",
    "registry_expiration_date": "2020-01-29 0:00:00",
    "registry_statuses": {
      "client_hold": {
        "is_changeable": false,
        "value": 0
      },
      "client_transfer_prohibited": {
        "is_changeable": false,
        "value": 0
      }
    },
    "renew": 2,
    "renewal_date": "2022-01-01 0:00:00",
    "reseller_handle": "XX123456-XX",
    "reseller_id": 12345,
    "restorable_until": "",
    "scheduled_at": "",
    "scheduled_from": "",
    "soft_quarantine_expiry_date": "",
    "status": "PRE",
    "tech_handle": "XX123456-XX",
    "trade_allowed": false,
    "trade_auth_code_required": "no",
    "transfer_auth_code_required": "yes",
    "transfer_cancel_supported": false,
    "type": "NEW",
    "unit": "y",
    "use_domicile": false,
    "verification_email_exp_date": "0000-00-00 00:00:00",
    "verification_email_name": "test@example.com",
    "verification_email_status": "not verified",
    "verification_email_status_description": "-",
    "whois_privacy_data": {
      "expiration_date": "2020-04-29 17:15:19"
    }
  },
  "desc": ""
}