Openprovider DomainService API
The DomainService API from Openprovider — 11 operation(s) for domainservice.
OpenAPI Specification
swagger: '2.0'
info:
title: REST AdditionalData DomainService API
version: 1.0.0-beta
host: api.openprovider.eu
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- Bearer: []
tags:
- name: DomainService
x-displayName: Domain
paths:
/v1beta/domains:
get:
tags:
- DomainService
summary: List domains
operationId: ListDomains
parameters:
- type: string
description: Domain id number.
name: order_by.id
in: query
- type: string
description: The domain name.
name: order_by.domain_name
in: query
- type: string
description: Domain extension.
name: order_by.domain_extension
in: query
- type: string
description: The order date.
name: order_by.order_date
in: query
- type: string
description: The active date.
name: order_by.active_date
in: query
- type: string
description: Domain expiration date.
name: order_by.expiration_date
in: query
- type: string
description: Date on which domain will be renewed.
name: order_by.renewal_date
in: query
- type: string
description: Domain status.
name: order_by.status
in: query
- type: string
description: The transfer date.
name: order_by.transfer_date
in: query
- type: integer
format: int32
description: The limit.
name: limit
in: query
- type: integer
format: int32
description: The offset.
name: offset
in: query
- type: integer
format: int32
description: Domain id number.
name: id
in: query
- type: string
description: Domain extension.
name: extension
in: query
- type: string
description: Date on which domain will be renewed.
name: renewal_date
in: query
- type: string
description: Full name of the domain.
name: full_name
in: query
- type: string
description: The domain name pattern.
name: domain_name_pattern
in: query
- type: string
description: Nameserver group name pattern.
name: ns_group_pattern
in: query
- type: string
description: Domain status.
name: status
in: query
- type: array
items:
type: string
collectionFormat: multi
description: Array of domain statuses to exclude.
name: status_not_equal
in: query
- type: string
description: The queue status.
name: queue_status
in: query
- type: string
description: Handle to filter by.
name: contact_handle
in: query
- type: string
description: The comment pattern.
name: comment_pattern
in: query
- type: boolean
format: boolean
description: With history.
name: with_history
in: query
- type: boolean
format: boolean
description: With api history.
name: with_api_history
in: query
- type: boolean
format: boolean
description: With additional data.
name: with_additional_data
in: query
- type: string
description: When new gTLD is started it gets through several phases before it becomes available for registration to everybody (General availability or GA). There are several phases before GA when it is still possible to apply for a domain, but with some restrictions.
name: application_mode
in: query
- type: boolean
format: boolean
description: Returns information about domain owner email verification status.
name: with_verification_email
in: query
- type: boolean
format: boolean
description: Indicates, if registry EPP statuses should be retrieved.
name: with_registry_statuses
in: query
- type: string
description: The type.
name: response.type
in: query
- type: string
description: The to.
name: response.to
in: query
- type: boolean
format: boolean
description: Indicates whether object is deleted.
name: is_deleted
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainListDomainsResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
post:
tags:
- DomainService
summary: Create domain
operationId: CreateDomain
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainCreateDomainRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainCreateDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/check:
post:
tags:
- DomainService
summary: Check domain
operationId: CheckDomain
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainCheckDomainRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainCheckDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/suggest-name:
post:
tags:
- DomainService
summary: Suggest name domain
operationId: SuggestNameDomain
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainSuggestNameDomainRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainSuggestNameDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/trade:
post:
tags:
- DomainService
summary: Trade domain
operationId: TradeDomain
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainTradeDomainRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainTradeDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/transfer:
post:
tags:
- DomainService
summary: Transfer domain
operationId: TransferDomain
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainTransferDomainRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainTransferDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/{id}:
get:
tags:
- DomainService
summary: Get domain
operationId: GetDomain
parameters:
- type: integer
format: int32
description: Domain id number
name: id
in: path
required: true
- type: string
description: Domain name without extension.
name: domain.name
in: query
- type: string
description: Domain extension.
name: domain.extension
in: query
- type: boolean
format: boolean
description: Returns domain mutations history.
name: with_history
in: query
- type: boolean
format: boolean
description: Returns domain API calls history.
name: with_api_history
in: query
- type: boolean
format: boolean
description: Returns domain additional data.
name: with_additional_data
in: query
- type: boolean
format: boolean
description: Returns information about domain owner email verification status.
name: with_verification_email
in: query
- type: boolean
format: boolean
description: Returns domain abuse details.
name: with_abuse_details
in: query
- type: boolean
format: boolean
description: Returns WPP data.
name: with_whois_privacy_data
in: query
- type: boolean
format: boolean
description: Indicates, if registry EPP statuses should be retrieved.
name: with_registry_statuses
in: query
- type: boolean
format: boolean
description: Indicates whether object is deleted.
name: is_deleted
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainGetDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
put:
tags:
- DomainService
summary: Update domain
operationId: UpdateDomain
parameters:
- type: integer
format: int32
description: Domain id number
name: id
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainUpdateDomainRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainUpdateDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
delete:
tags:
- DomainService
summary: Delete domain
operationId: DeleteDomain
parameters:
- type: integer
format: int32
description: Domain id number
name: id
in: path
required: true
- type: string
description: Domain name without extension.
name: domain.name
in: query
- type: string
description: Domain extension.
name: domain.extension
in: query
- type: string
description: Type of deletion request.
name: type
in: query
- type: boolean
format: boolean
description: Deletes domain, skipping the soft quarantine.
name: skip_soft_quarantine
in: query
- type: boolean
format: boolean
description: Force delete domain even if it has glue records.
name: force_delete
in: query
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainDeleteDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/{id}/last-operation/restart:
post:
tags:
- DomainService
summary: Try again last operation
operationId: TryAgainLastOperation
parameters:
- type: integer
format: int32
description: Domain id number
name: id
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainTryAgainLastOperationRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/responseBoolResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/{id}/renew:
post:
tags:
- DomainService
summary: Renew domain
operationId: RenewDomain
parameters:
- type: integer
format: int32
description: Domain id number
name: id
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainRenewDomainRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainRenewDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/{id}/restore:
post:
tags:
- DomainService
summary: Restore domain
operationId: RestoreDomain
parameters:
- type: integer
format: int32
description: Domain id number
name: id
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainRestoreDomainRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/domainRestoreDomainResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/{id}/transfer/approve:
post:
tags:
- DomainService
summary: Approve transfer
operationId: ApproveTransfer
parameters:
- type: integer
format: int32
description: Domain id number
name: id
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainApproveTransferRequest'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/responseBoolResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
/v1beta/domains/{id}/transfer/send-foa1:
post:
tags:
- DomainService
summary: Send foa1
operationId: SendFoa1
parameters:
- type: integer
format: int32
description: Domain id number
name: id
in: path
required: true
- name: body
in: body
required: true
schema:
$ref: '#/definitions/domainSendFoa1Request'
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/responseBoolResponse'
default:
description: (empty)
schema:
$ref: '#/definitions/errorError'
definitions:
domainTransferDomainRequest:
type: object
title: TransferDomainRequest
properties:
accept_premium_fee:
type: number
format: double
title: Required in case when domain is premium, value is the price returned in the response for TransferDomainRequest without acceptPremiumFee
additional_data:
title: Additional domain data
$ref: '#/definitions/domainTransferAdditionalData'
admin_handle:
type: string
title: Administrative contact handle
at:
type: string
title: Scheduled transfer date
auth_code:
type: string
title: Authorization code
autorenew:
type: string
title: 'Desired autorenew value: off, on, or default'
default: default
billing_handle:
type: string
title: Billing contact handle
comments:
type: string
title: Domain comments
dnssec_keys:
type: array
title: Array containing DNSSEC key information
items:
$ref: '#/definitions/domainDnssecKey'
domain:
title: Domain name and extension
$ref: '#/definitions/domainDomain'
import_contacts_from_registry:
description: Imports contacts data from registry and creates handles after the transfer. Allows to skip admin_handle, billing_handle, owner_handle, reseller_handle and tech_handle parameters.
type: boolean
format: boolean
import_nameservers_from_registry:
description: Imports nameservers from registry after the transfer. Allows to skip ns_group, ns_template_id and ns_template_name parameters.
type: boolean
format: boolean
is_dnssec_enabled:
type: boolean
format: boolean
title: Enables or disables DNSSEC on domain
is_private_whois_enabled:
type: boolean
format: boolean
title: Enables or disables whois privacy protection (WPP) on domain
name_servers:
type: array
title: Array containing name server information
items:
$ref: '#/definitions/domainNameserver'
ns_group:
type: string
title: Name of nameserver group
ns_template_id:
type: integer
format: int32
title: Id of nameserver template
ns_template_name:
type: string
title: Name of nameserver template
owner_handle:
type: string
title: Owner contact handle
promo_code:
type: string
title: Promo code to apply to operation
reseller_handle:
type: string
title: Reseller handle
roid:
type: string
title: Registry id of domain
tech_handle:
type: string
title: Tech contact handle
unit:
type: string
title: Unit of time to register domain, yearly, quarterly, or monthly
use_domicile:
type: boolean
format: boolean
title: Use of domicile or trustee address for TLDs that require local presence
example:
accept_premium_fee: 17
additional_data:
admin_sing_pass_id: ''
auth_code: ''
company_registration_number: XX123456789X03
customer_uin: '374892173498127349'
customer_uin_doc_type:
description: Singapore Personal Access ID
doc_type: singpass
domain_name_variants:
- xn--домен.cat
ftld_token: ''
gay_donation_acceptance: '1'
gay_rights_protection_acceptance: '1'
idn_script: SPA
intended_use: generic
legal_type: Individual
maintainer: ''
membership_id: A
mobile_phone_number_verification: ''
passport_number: X123458
self_service: '1'
trademark: '1'
vat: 11843009X
verification_code: ''
admin_handle: XX123456-XX
at: '2019-04-30'
auth_code: '12345678'
autorenew: default
billing_handle: XX123456-XX
comments: any comment here
dnssec_keys:
- alg: 8
flags: 257
protocol: 3
pub_key: WSgigdu8545g96
readonly: 1
domain:
extension: london
name: test4
import_contacts_from_registry: false
import_nameservers_from_registry: false
is_dnssec_enabled: false
is_private_whois_enabled: 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: 30951
ns_template_name: example
owner_handle: XX123456-XX
promo_code: PROMOCODE
reseller_handle: XX123456-XX
roid: 100590-UK
tech_handle: XX123456-XX
unit: y
use_domicile: false
domainRenewDomainResponse:
type: object
title: RenewDomainResponse
properties:
code:
type: integer
format: int32
title: Response code
data:
title: Response data
$ref: '#/definitions/domainRenewDomainResponseData'
desc:
type: string
title: Response description
maintenance:
type: boolean
format: boolean
title: Indicates that the Openprovider system is temporarily unavailable because of maintenance
warnings:
type: array
title: Contains warning responses if any
items:
$ref: '#/definitions/errorWarning'
example:
code: 0
data:
status: ACT
desc: ''
domainRestoreDomainResponseData:
type: object
title: RestoreDomainResponseData
properties:
status:
type: string
title: Domain status
example:
status: ACT
domainGetDomainResponse:
type: object
title: GetDomainResponse
properties:
code:
type: integer
format: int32
title: Response code
data:
title: Response data
$ref: '#/definitions/domainGetDomainResponseData'
desc:
type: string
title: Response description
maintenance:
type: boolean
format: boolean
title: Indicates that the Openprovider system is temporarily unavailable because of maintenance
warnings:
type: array
title: Contains warning responses if any
items:
$ref: '#/definitions/errorWarning'
example:
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: ''
domainCheckDomainRequest:
type: object
title: CheckDomainRequest
properties:
additional_data:
title: Additional domain data
$ref: '#/definitions/domainCheckAdditionalData'
application_mode:
description: When new gTLD is started it gets through several phases before it becomes available for registration to everybody (General availability or GA). There are several phases before GA when it is still possible to apply for a domain, but with some restrictions.
type: string
domains:
type: array
title: Array of domains to check
items:
$ref: '#/definitions/domainDomain'
provider:
type: string
title: Indicates what provider should be chosen for domain operation
with_price:
type: boolean
format: boolean
title: Indicate whether to include the domain price with domain availability
example:
additional_data:
idn_script: cyrl
application_mode: preregistration
domains:
- extension: london
name: test4
provider: SEDO
with_price: false
domainPremiumPrice:
type: object
title: PremiumPrice
properties:
currency:
type: string
title: Price currency
price:
title: Operation price
$ref: '#/definitions/domainOperationPrice'
example:
currency: USD
price:
create: 0
domainOperationPrice:
type: object
title: OperationPrice
properties:
create:
type: number
format: double
title: Registration price
example:
create: 0
domainTransferDomainResponse:
type: object
title: TransferDomainResponse
properties:
code:
type: integer
format: int32
title: Response code
data:
title: Response data
$ref: '#/definitions/domainTransferDomainResponseData'
desc:
type: string
title: Response description
maintenance:
type: boolean
format: boolean
title: Indicates that the Openprovider system is temporarily unavailable because of maintenance
warnings:
type: array
title: Contains warning responses if any
items:
$ref: '#/definitions/errorWarning'
example:
code: 0
data:
auth_code: '12345678'
description: intendedUse value must contain information on how the domain name will be used
error: 'Nameserver 1: IPv4 is not specified'
expiration_date: '2020-03-31 23:59:59'
id: 123456789
name: intendedUse
renewal_date: '2020-03-29 23:59:59'
required: false
status: ACT
type: text
desc: ''
domainRenewDomainResponseData:
type: object
title: RenewDomainResponseData
properties:
status:
type: string
title: Domain status
example:
status: ACT
domainCheckAdditionalData:
type: object
title: CheckAdditionalData
properties:
idn_script:
type: string
title: 'The idn script states what language or character set the domain name is in
Applicable to: .actor, .ae.org, .airforce, .army, .art, .attorney, .auction, .band, .bar, .best, .br.com, .ceo, .cn.com, .college, .com, .com.de, .com.se, .consulting, .dance, .de.com, .degree, .democrat, .dentist, .design, .engineer, .eu.com, .eus, .feedback, .fm, .forsale, .frl, .fun, .futbol, .gal, .gb.net, .gives, .gr.com, .haus, .hiv, .host, .immobilien, .in.net, .info, .ink, .jp.net, .jpn.com, .kaufen, .kyoto, .lawyer, .love, .market, .me, .mex.com, .moda, .mortgage, .navy, .net, .ninja, .nrw, .online, .ooo, .org, .press, .protection, .pub, .pw, .quebec, .radio.am, .radio.fm, .realty, .rehab, .rent, .republican, .rest, .reviews, .rip, .rocks, .ru.com, .sa.com, .scot, .se.net, .security, .site, .social, .software, .space, .store, .tech, .theatre, .tickets, .top, .uk.com, .uk.net, .us.com, .us.org, .vet, .website, .wiki, .xn--4gbrim, .xn--55qx5d, .xn--5tzm5g, .xn--80asehdb, .xn--80aswg, .xn--c1avg, .xn--czru2d, .xn--i1b6b1a6a2e, .xn--io0a7i, .xn--mk1bu44c, .xn--ngbc5azd, .xn--nqv7f, .xn--t60b56a, .xn--tckwe, .xyz, .za.com'
example:
idn_script: cyrl
domainTryAgainLastOperationRequest:
type: object
title: TryAgainLastOperationRequest
properties:
auth_code:
type: string
title: Auth code for transfer
domain:
title: Domain name and extension
$ref: '#/definitions/domainDomain'
id:
type: integer
format: int32
title: Domain id number
example:
auth_code: 1a2b3c4d5e6f
domain:
extension: london
name: test4
id: 0
domainTransferDomainResponseData:
type: object
title: TransferDomainResponseData
properties:
auth_code:
type: string
title: Authorization code
description:
type: string
title: Parameter description
error:
type: string
title: The error
expiration_date:
type: string
title: Domain expiration date
id:
type: integer
format: int32
title: Domain id number
name:
type: string
title: Parameter name
renewal_date:
type: string
title: Date on which domain will be renewed
required:
type: boolean
format: boolean
title: Indicates, if parameter is required
status:
type: string
title: Domain status
type:
type: string
title: Parameter type
example:
auth_code: '12345678'
description: intendedUse value must contain information on how the domain name will be used
error: 'Nameserver 1: IPv4 is not specified'
expiration_date: '2020-03-31 23:59:59'
id: 123456789
name: intendedUse
renewal_date: '2020-03-29 23:59:59'
required: false
status: ACT
type: text
domainListDomainsResponseData:
type: object
title: ListDomainsResponseD
# --- truncated at 32 KB (117 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openprovider/refs/heads/main/openapi/openprovider-domainservice-api-openapi.yml