13 Domains API: How to create a domain
This is a series of articles dedicated to demonstrating how to get acquainted with Openprovider Domains API methods.
This is a first article in a series in which we are going to cover basic domain management operations. To get more information about our API in general, please use our documentation portal as your reference.
You must have an active Openprovider account for this command to complete successfully. Please keep in mind that you will be automatically charged the registration fee upon successful registration.
Use endpoint path below. Base URL is determined by both the target environment and API version.
REQUEST VALUES
Name
Type
Description
name
string
name
string
Required.
period
integer
period
integer
Required.
auth_code
varchar
auth_codeOptional.
owner_handle
varchar
Optional.
owner_handle
varchar
Required.
admin_handle
varchar
admin_handle
varchar
Required.
tech_handle
varchar
tech_handle
varchar
Required.
billing_handle
varchar
billing_handleOptional.
reseller_handle
varchar
Optional.
ns_group
reseller_handle
varchar
Optional.
ns_group
string
Required only if name_servers field is empty
ns_template_name
string
Optional. Name of the template to use to automatically create DNS zone for the domain; only applicable if nsGroup is dns-openprovider
name_servers
name_servers
Array of objects (Array containing name server information)
Required only if nsGroup field is empty
autorenew
custom
autorenew
custom
on | off | default
is_dnssec_enabled
boolean
0 (default) or 1 - Only accepted when nameservers of Openprovider are used
dnssec_keys
varchar
dnssec_keys
varchar
when using your own nameservers
use_domicile
boolean
use_domicile
boolean
0 or 1
accept_premium_fee
int or double
Required in case when domain is premium, value is the price returned in the response for createDomainRequest without acceptPremiumFee
is_private_whois_enabled
boolean
boolean
default value is 0
promo_code
string
comments
string
comments
string
additional_data
custom
custom
mandatory for some TLDs
application_mode
custom
application_mode
custom
required for new gTLDs
NB The owner, admin and tech handles can be retrieved via the customers endpoint and will be the registered contacts for this domain.
REQUEST EXAMPLE
RESPONSE EXAMPLE
RESPONSE VALUES
| Name |
Type |
Description |
| status |
ACT - active or REQ - requested |
| auth_code |
only in case if TLD supports it |
| activation_date |
available only in case of a succeeded realtime domain registration |
