RRPproxy.net API v0.0.4 RRPproxy View Source
Documentation for RRPproxy API integration.
Link to this section Summary
Functions
activate_appendix activates an appendix.
add_contact adds a new contact and returns a contact handle.
add_domain registers a new domain.
add_nameserver adds a nameservers to be used for nameserverging domains or zones.
add_tag adds a tags to be used for tagging domains or zones.
check_domain checks wether the given domain name is free.
check_nameserver checks a the given nameserver.
clone_contact clones the given contact.
convert_currency converts the currency according to their current rates.
delete_contact deletes a given contact.
delete_domain deletes a registered domain.
delete_event deletes the given event by id.
delete_nameserver deletes a the given nameserver.
delete_tag deletes a the given tag.
get_zone returns the correct zone for the given domainname.
get_zone_info returns zone information for the given zone.
modify_contact modifies an existing contact and returns a contact handle.
modify_domain modifies domains by the given domain name for domains and zones.
modify_nameserver modifies nameservers by the given nameserver name for domains and zones.
modify_registrar modifies the registrar's (or subaccounts) settings.
modify_tag modifies tags by the given tag name for domains and zones.
query_accounting_list returns all items for accounting since the given date.
query_appendix_list returns a list of all appendices.
query_available_promotion_list returns all available promotions.
query_contact_list returns a list of all contact handles.
query_domain_list returns a list of all registerd domains.
query_event_list returns a list of events.
query_foreign_transfer_list returns a list of foreign transfers.
query_nameserver_list gets a list of nameservers.
query_tag_list gets a list of tags.
query_transfer_list returns a list of local transfers.
query_upcoming_accounting_list returns all items that are upcoming for accounting.
query_zone_list returns the prices per zone.
renew_domain renews a registered domain.
request_token requests a verification token for the given contact or domain.
restore_contact restores a deleted contact.
restore_domain restores a registered domain.
set_auth_code sets the domains auth-code for transfer.
set_domain_renewal_mode sets the domains renewal-mode.
set_domain_transfer_mode sets the domains transfer-mode.
status_account returns information about the accounts financial status.
get_contact returns a contact handle.
status_domain gets the given domain by name.
status_domain_transfer command informs you about the current status of a transfer. You can check if the transfer was successfully initiated or who received the eMail to confirm a transfer.
status_event gets an event by id.
status_nameserver gets the given nameserver by name.
status_owner_change explicity checks the status of an OwnerChange in detail.
status_registrar returns information about your account information.
status_tag gets the given tag by name.
transfer_domain transfers a foreign domain into our account.
Link to this section Functions
activate_appendix(appendix, accept_terms_and_conditions \\ true, creds \\ %Client{})
View Sourceactivate_appendix activates an appendix.
add_contact(contact, validation \\ true, pre_verify \\ true, creds \\ %Client{})
View Sourceadd_contact adds a new contact and returns a contact handle.
add_domain(domain, owner, admin, tech, bill, nameservers \\ [], period \\ "1", creds \\ %Client{})
View Sourceadd_domain registers a new domain.
add_nameserver adds a nameservers to be used for nameserverging domains or zones.
add_tag(tag, description \\ "", type \\ "domain", creds \\ %Client{})
View Sourceadd_tag adds a tags to be used for tagging domains or zones.
check_domain checks wether the given domain name is free.
check_nameserver checks a the given nameserver.
clone_contact clones the given contact.
convert_currency converts the currency according to their current rates.
delete_contact deletes a given contact.
delete_domain deletes a registered domain.
delete_event deletes the given event by id.
delete_nameserver deletes a the given nameserver.
delete_tag deletes a the given tag.
get_zone returns the correct zone for the given domainname.
get_zone_info returns zone information for the given zone.
modify_contact(contact, validation \\ true, pre_verify \\ false, check_only \\ true, creds \\ %Client{})
View Sourcemodify_contact modifies an existing contact and returns a contact handle.
modify_domain modifies domains by the given domain name for domains and zones.
modify_nameserver modifies nameservers by the given nameserver name for domains and zones.
modify_registrar modifies the registrar's (or subaccounts) settings.
modify_tag(tag, newtag \\ "", description \\ "", type \\ "domain", creds \\ %Client{})
View Sourcemodify_tag modifies tags by the given tag name for domains and zones.
query_accounting_list(date, offset \\ 0, limit \\ 2000, creds \\ %Client{})
View Sourcequery_accounting_list returns all items for accounting since the given date.
query_appendix_list(offset \\ 0, limit \\ 1000, creds \\ %Client{})
View Sourcequery_appendix_list returns a list of all appendices.
query_available_promotion_list(offset \\ 0, limit \\ 2000, creds \\ %Client{})
View Sourcequery_available_promotion_list returns all available promotions.
query_contact_list returns a list of all contact handles.
query_domain_list returns a list of all registerd domains.
query_event_list returns a list of events.
query_foreign_transfer_list(offset \\ 0, limit \\ 2000, creds \\ %Client{})
View Sourcequery_foreign_transfer_list returns a list of foreign transfers.
query_nameserver_list(offset \\ 0, limit \\ 1000, creds \\ %Client{})
View Sourcequery_nameserver_list gets a list of nameservers.
query_tag_list(type \\ "domain", offset \\ 0, limit \\ 1000, creds \\ %Client{})
View Sourcequery_tag_list gets a list of tags.
query_transfer_list(offset \\ 0, limit \\ 2000, creds \\ %Client{})
View Sourcequery_transfer_list returns a list of local transfers.
query_upcoming_accounting_list(offset \\ 0, limit \\ 2000, creds \\ %Client{})
View Sourcequery_upcoming_accounting_list returns all items that are upcoming for accounting.
query_zone_list returns the prices per zone.
renew_domain renews a registered domain.
request_token requests a verification token for the given contact or domain.
restore_contact restores a deleted contact.
restore_domain restores a registered domain.
set_auth_code sets the domains auth-code for transfer.
set_domain_renewal_mode(domain, mode \\ "default", token \\ "", creds \\ %Client{})
View Sourceset_domain_renewal_mode sets the domains renewal-mode.
The domains mode for renewals (optional): DEFAULT | AUTORENEW | AUTOEXPIRE | AUTODELETE | RENEWONCE The domains mode for renewals (only valid for the zone de, optional): DEFAULT | AUTORENEW | AUTORENEWMONTHLY | AUTOEXPIRE | AUTODELETE | RENEWONCE The domains mode for renewals (only valid for the zone nl, optional): DEFAULT | AUTORENEW | AUTOEXPIRE | AUTODELETE | RENEWONCE | AUTORENEWQUARTERLY The domains mode for renewals (only valid for the zones com, net, org, info, biz, tv, mobi and me, optional): DEFAULT | AUTORENEW | AUTOEXPIRE | AUTODELETE | RENEWONCE | EXPIREAUCTION
set_domain_transfer_mode(domain, mode \\ "default", token \\ "", creds \\ %Client{})
View Sourceset_domain_transfer_mode sets the domains transfer-mode.
The domains mode for transfers: DEFAULT|AUTOAPPROVE|AUTODENY
status_account returns information about the accounts financial status.
get_contact returns a contact handle.
status_domain gets the given domain by name.
status_domain_transfer command informs you about the current status of a transfer. You can check if the transfer was successfully initiated or who received the eMail to confirm a transfer.
status_event gets an event by id.
status_nameserver gets the given nameserver by name.
status_owner_change explicity checks the status of an OwnerChange in detail.
status_registrar returns information about your account information.
status_tag gets the given tag by name.
transfer_domain(domain, action \\ "request", auth \\ "", owner \\ "", admin \\ "", tech \\ "", bill \\ "", nameservers \\ [], period \\ "1", creds \\ %Client{})
View Sourcetransfer_domain transfers a foreign domain into our account.