API reference

General API basics

• Authentication
• AutoDNS messages
• Bulk request
• Demo mode
• Example implementations
• Formats
• Frequent list inquire requests
• List inquire
• Multitasks
• Single inquire
• Software Development Kit (SDK)
• User status

JSON API basics

• General query parameters
• HTTP Header

Objects

• Account object
• Application object
• AutoDNSSEC object
• BackupMX object
• Basic customer contact object
• Basic customer object
• Basic customer spool verification object
• Basic user object
• Billing object limit object
• Bulk job object
• Cancelation object
• Card object
• Contact document object
• Contact extensions
• Contact job object
• Contact object
• Contact verification domain object
• Contact verification message object
• Contact verification object
• Currency rate object
• DNSSEC object
• Document object
• Domain AutoDelete extensions object
• Domain buy extensions object
• Domain cancelation extensions object
• Domain extensions object (JSON) - domain addons object (XML)
• Domain monitoring object
• Domain monitoring setup
• Domain object
• Domain parking extensions
• Domain premium object
• Domain prereg addon object
• Domain prereg object
• Domain restore object (JSON) restore object (XML)
• Domain services object
• Domain TMCH claim notice extensions
• Domain zone object
• General objects
• Generic customer object
• Greylisting policy object
• History object
• Invoice days object
• Item object
• Job object
• JSON specific objects
• Mail list object
• MailProxy object
• MailProxy policy object
• Main ip object
• Metric object
• Name server object
• Object extended user assignement entity object
• Parking account object
• Parking domain object
• Physical name server group object
• Prereg config object
• Profile object
• Redirect object
• Resource record object
• Sedo parking account object
• Sedo parking account postal address object
• Sedo parking account tax details object
• SEPA mandate object
• Service profiles object
• Service users profile object
• SOA object
• Spam policy object
• SSL - objects
• Subscription object
• Time period object
• Transfer object (out)
• Trusted application functions object
• Trusted application object
• User ACL object
• User ACLs object
• User details object
• User object
• Virtual name server group object
• Virtual name server object
• Workflow event object
• XML specific objects
• Zone job object
• Zone object

Enums and constants

• Accounting document type constants
• ACL restriction enum
• Addon update mode enum
• Au eligibility id type constants
• Au eligibility type constants
• Au policy reason constants
• Au registrant id type constants
• Auth type enum
• Auto delete status enum
• Auto renew status constants
• Banned files enum
• Banned files type enum
• Billing status enum
• Cancelation action enum
• Cancelation execdate enum
• Cancelation status constants
• Cancelation type enum
• Card status enum
• Cira CPR constants
• Contact document type enum
• Contact protection enum
• Contact type enum
• Credit card vendor enum
• Customer type enum
• DNS check enum
• DNSSec algorithm enum
• DNSSEC flags enum
• Domain prereg status constants
• Execution type enum
• Gender enum
• General enums
• Generic status enum
• Greylisting mode enum
• Header mode enum
• Hk document type constants
• Hk industry type constants
• Invoice status constants
• It entity type constants
• Job status constants
• Jobs industry class constants
• Mailproxy protection/protection constants
• Message type constants
• Nack reason enum
• Name server action constants
• Notify type enum
• Object assignement mode enum
• Parking account status enum
• Parking account type enum
• Parking provider constants
• Payment constants
• Policy mode enum
• Premium status constants
• Prereg ipr app capacity enum
• Prereg phase enum
• Profile flag enum
• Provider enum
• Purge type enum
• Rdds OptIn constants
• Redirect mode enum
• Redirect type enum
• Registration type constants
• Registry status constants
• Resource record type enum
• Ro person type constants
• Search and replace type
• SEPA status enum
• Services enum
• SOA level enum
• SSL enums
• Time unit constants
• Transfer status constants
• Transfer type enum
• Uk type constants
• User language constants
• User lock enum
• User status constants / user substatus constants
• Workflow event type enum

Tasks

• AuthSession tasks
• AutoDelete tasks
• BackupMX tasks
• CommonLog list
• Contact document tasks
• Contact tasks
• Contact verification tasks
• DNSSEC tasks
• Document info
• Domain cancelation tasks
• Domain premium tasks
• Domain prereg tasks
• Domain restore tasks
• Domain tasks
• History info
• Invoice list
• Job tasks
• MailProxy tasks
• Object check
• Object user assignment tasks
• Parking tasks
• Polling tasks
• Price classes list
• Redirect tasks
• SSL tasks
• Tmch tasks
• Transfer tasks
• Trusted application list
• User tasks
• Zone tasks

SSL tasks

• Certificate comment update
• Certificate contact create
• Certificate contact delete
• Certificate contact info
• Certificate contact list
• Certificate contact update
• Certificate create
• Certificate delete
• Certificate info
• Certificate job cancel
• Certificate job history info
• Certificate job history list
• Certificate job info
• Certificate job list
• Certificate list
• Certificate prepare order
• Certificate reissue
• Certificate renew
• Certificate revoke
• Resend approver email

Zone tasks

• Zone AXFR
• Zone comment update
• Zone create
• Zone delete
• Zone history info
• Zone history list
• Zone import
• Zone info
• Zone job history list
• Zone job info
• Zone job list
• Zone list
• Zone query list
• Zone update
• Zone update bulk

Domain tasks

• Domain buy order
• Domain comment update
• Domain create
• Domain create plus
• Domain history info
• Domain history list
• Domain info
• Domain list
• Domain monitoring delete
• Domain monitoring list
• Domain ownerchange
• Domain renew
• Domain update
• Domain update plus

XML specific objects

• Auth Object
• Imported Object
• Message Object
• Msg Object
• Notify Object
• Request Object
• Response Object
• Result Object
• Status Object
• Task Object
• Where Object

SSL enums

• Auth method constants
• Business category enum
• Certificate transparency privacy enum
• Certificate type enum
• Code signing type enum
• Csr hash algorithm constants enum
• IP restriction type constants enum
• Server software type constants enum
• Server software type enum
• Signature hash algorithm constants enum
• SSL product enum

Transfer tasks

• AuthInfo delete
• AuthInfo send
• AuthInfo1 create
• AuthInfo2 create
• Domain status update
• Domain transfer
• Domain transfer out
• Domain transfer plus
• Domain transfer plus with ownerchange
• Transfer out info
• Transfer out list

SSL - objects

• CaCertificate object
• CertAuthentication object
• Certificate history object
• Certificate object
• Certificate request / Certificate data object
• Contact object (SSL)
• Extended validation addon object
• IP restriction object
• IP restrictions object
• Subject alternative name object

Parking tasks

• Parking account delete
• Parking account import
• Parking account info
• Parking account list
• Parking domain create
• Parking domain delete
• Parking domain info
• Parking domain list
• Parking domain update
• Sedo parking account create

Contact tasks

• Contact create
• Contact delete
• Contact history list
• Contact info
• Contact job history list
• Contact job info
• Contact job list
• Contact list
• Contact update

User tasks

• User copy
• User create
• User delete
• User info
• User list
• User profile info
• User profile update
• User update
• User verification create

Notification examples

• Domain contact job notifications
• Domain job notifications
• Domain ownerchange job notifications
• Domain transfer job notifications
• DomainAutoUpdate notifications
• OwnerC validation notifications (OCVAL)
• Purge notifications
• TransferOut notifications

Domain cancelation tasks

• Domain cancelation create
• Domain cancelation delete
• Domain cancelation history info
• Domain cancelation history list
• Domain cancelation info
• Domain cancelation list
• Domain cancelation update

JSON specific objects

• JsonResponseData Object
• Messages Object
• NotifyMessage Object
• PollMessage Object
• QueryFilter Object
• ResponseObject Object
• ResponseStatus Object

DNSSEC tasks

• DNSSec info
• DNSSec job list
• DNSSec key rollover
• DNSSec list
• DNSSec sign
• DNSSec unsign
• Domain DNSSEC update

Domain prereg tasks

• Domain prereg confirm
• Domain prereg create
• Domain prereg create plus
• Domain prereg delete
• Domain prereg info
• Domain prereg list
• Domain prereg update

General objects

• Data object
• Flags object
• Objects or object object
• Order object
• Simple object object
• View object

AutoDNS messages

• Configuration of the notifications in the user interface
• Example for realtime system response - Notify (N)
• FAQs messaging - push, polling, parent notifys
• Job processing workflows and notifications
• Notification examples
• Retrieving system notifications - polling and push

—

• API (JSON /XML)
• API documentation (JSON/XML)
• General API basics
• JSON
• XML

Redirect tasks

• Redirect create
• Redirect delete
• Redirect info
• Redirect list
• Redirect update

MailProxy tasks

• Mailproxy create
• Mailproxy delete
• Mailproxy info
• Mailproxy list
• Mailproxy update

Contact verification tasks

• Contact verification create
• Contact verification history list
• Contact verification info
• Contact verification list
• Contact verification resend email

Domain premium tasks

• Domain premium group list
• Domain premium info
• Domain premium list
• Domain premium TLD list

BackupMX tasks

• BackupMX create
• BackupMX delete
• BackupMX info
• BackupMX list

Job tasks

• Bulk job list
• Job history list
• Workflow job info
• Workflow job list

Job processing workflows and notifications

• Processing Domain- and Contact Jobs
• Processing Transfer-In and Ownerchange Jobs
• Processing Transfer-Out Jobs
• Processing Zone, User and Inquire Jobs

General enums

• Operator type enum
• Order Type Enum
• Status type enum

API documentation (JSON/XML)

• Enums and constants
• Objects
• Tasks

Tmch tasks

• Tmch claims list
• Tmch labels prereg list
• Tmch mark list

Polling tasks

• Poll confirm
• Poll info

JSON

• JSON API basics
• JSON technical documentation

XML

• General XML keywords
• XML API basics

AuthSession tasks

• AuthSession create
• AuthSession delete

Contact document tasks

• Contact document create (upload)
• Contact document info (download)

Domain restore tasks

• Domain restore
• Domain restore list

Object user assignment tasks

• Object user assignement all
• Object user assignement task

AutoDelete tasks

• AutoDelete list

—

• Domain Robot JSON API

EPP API guides

• Activating, updating or revoking access to the EPP API
• Deleting active domain cancelations
• Deleting domains on expiration date
• EPP API basics
• Extending domain registration period
• How to use the XSD files
• Premium domains
• Registering domains

TLD extensions

• .aero
• .au
• .bank
• .barcelona
• .ca
• .cat
• .hk
• .ie
• .it
• .jobs
• .nz
• .ro
• .ru
• .scot
• .sport
• .swiss
• .uk
• .zuerich

Domain

• Domain check
• Domain create
• Domain delete
• Domain info
• Domain renew
• Domain restore
• Domain transfer
• Domain update

API reference

• AuthInfo
• Contact
• Domain
• EPP extensions
• Polling
• Session

Contact

• Contact Check
• Contact Create
• Contact Delete
• Contact Info
• Contact Update

EPP extensions

• Domain extensions
• General contact extensions
• System notification extensions
• TLD extensions

—

• API reference
• EPP API
• EPP API guides

AuthInfo

• Domain create AuthInfo1
• Domain create AuthInfo2
• Domain delete AuthInfo1

Session

• Hello
• Login
• Logout

Polling

• Domain notifications
• System notifications
• Transfer notifications

Certificate process automation

• Automation of certificate ordering
• Automation of certificate reissues
• Automation of certificate renews
• Automation of S/MIME certificate ordering
• Tasks for managing certificate orders

—

• API Processes
• Certificate process automation
• Domain process automation
• Workflow descriptions for the most important tasks

Domain process automation

• Automation of domain deletion
• Automation of domain registrations
• Automation of domain renews

—

• Domain Robot SSL XML API
• SSL API Reference

—

• Additional API Functions
• Domain Studio guide
• Email Parser guide
• ID Document Management
• Product Store guide
• WhoisProxy guide
• XML price list guide