RRPproxy (RRPproxy.net API v0.1.0) View Source

Documentation for RRPproxy API integration.

Link to this section Summary

Functions

add_contact adds a new contact and returns a contact handle.

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_event deletes the given event by id.

delete_nameserver deletes a the given nameserver.

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 since the given date.

query_foreign_transfer_list returns a list of foreign transfers.

query_nameserver_list gets a list of nameservers.

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.

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.

Link to this section Functions

Link to this function

activate_appendix(appendix, accept_terms_and_conditions \\ true, creds \\ default_client())

View Source

activate_appendix activates an appendix.

Link to this function

add_contact(contact, validation \\ true, pre_verify \\ true, creds \\ default_client())

View Source

add_contact adds a new contact and returns a contact handle.

Link to this function

add_domain(domain, owner, admin, tech, bill, nameservers \\ [], period \\ "1", creds \\ default_client())

View Source

add_domain registers a new domain.

Link to this function

add_nameserver(nameserver, ips, creds \\ default_client())

View Source

add_nameserver adds a nameservers to be used for nameserverging domains or zones.

Link to this function

add_tag(tag, description \\ "", type \\ "domain", creds \\ default_client())

View Source

add_tag adds a tags to be used for tagging domains or zones.

Link to this function

check_domain(domain, creds \\ default_client())

View Source

check_domain checks wether the given domain name is free.

Link to this function

check_nameserver(nameserver, creds \\ default_client())

View Source

check_nameserver checks a the given nameserver.

Link to this function

clone_contact(contact, creds \\ default_client())

View Source

clone_contact clones the given contact.

Link to this function

convert_currency(amount, from, to \\ "EUR", creds \\ default_client())

View Source

convert_currency converts the currency according to their current rates.

Link to this function

delete_contact(contact, creds \\ default_client())

View Source

delete_contact deletes a given contact.

Link to this function

delete_domain(domain, action \\ "instant", creds \\ default_client())

View Source

delete_domain deletes a registered domain.

Link to this function

delete_event(event, creds \\ default_client())

View Source

delete_event deletes the given event by id.

Link to this function

delete_nameserver(nameserver, creds \\ default_client())

View Source

delete_nameserver deletes a the given nameserver.

Link to this function

delete_tag(tag, type \\ "domain", creds \\ default_client())

View Source

delete_tag deletes a the given tag.

Link to this function

get_zone(domain, creds \\ default_client())

View Source

get_zone returns the correct zone for the given domainname.

Link to this function

get_zone_info(domain, creds \\ default_client())

View Source

get_zone_info returns zone information for the given zone.

Link to this function

modify_contact(contact, validation \\ true, pre_verify \\ false, check_only \\ false, creds \\ default_client())

View Source

modify_contact modifies an existing contact and returns a contact handle.

Link to this function

modify_domain(domain, attrs \\ [], creds \\ default_client())

View Source

modify_domain modifies domains by the given domain name for domains and zones.

Link to this function

modify_nameserver(nameserver, ips, creds \\ default_client())

View Source

modify_nameserver modifies nameservers by the given nameserver name for domains and zones.

Link to this function

modify_registrar(registrar, creds \\ default_client())

View Source

modify_registrar modifies the registrar's (or subaccounts) settings.

Link to this function

modify_tag(tag, params, type \\ "domain", creds \\ default_client())

View Source

modify_tag modifies tags by the given tag name for domains and zones.

Link to this function

query_accounting_list(date, offset \\ 0, limit \\ 2000, creds \\ default_client())

View Source

query_accounting_list returns all items for accounting since the given date.

Link to this function

query_appendix_list(offset \\ 0, limit \\ 1000, creds \\ default_client())

View Source

query_appendix_list returns a list of all appendices.

Link to this function

query_available_promotion_list(offset \\ 0, limit \\ 2000, creds \\ default_client())

View Source

query_available_promotion_list returns all available promotions.

Link to this function

query_contact_list(offset \\ 0, limit \\ 100, creds \\ default_client())

View Source

query_contact_list returns a list of all contact handles.

Link to this function

query_domain_list(offset \\ 0, limit \\ 1000, creds \\ default_client())

View Source

query_domain_list returns a list of all registerd domains.

Link to this function

query_event_list(date, offset \\ 0, limit \\ 1000, creds \\ default_client())

View Source

query_event_list returns a list of events since the given date.

Link to this function

query_foreign_transfer_list(offset \\ 0, limit \\ 2000, creds \\ default_client())

View Source

query_foreign_transfer_list returns a list of foreign transfers.

Link to this function

query_nameserver_list(offset \\ 0, limit \\ 1000, creds \\ default_client())

View Source

query_nameserver_list gets a list of nameservers.

Link to this function

query_tag_list(type \\ "domain", offset \\ 0, limit \\ 1000, creds \\ default_client())

View Source

query_tag_list gets a list of tags.

Link to this function

query_transfer_list(offset \\ 0, limit \\ 2000, creds \\ default_client())

View Source

query_transfer_list returns a list of local transfers.

Link to this function

query_upcoming_accounting_list(offset \\ 0, limit \\ 2000, creds \\ default_client())

View Source

query_upcoming_accounting_list returns all items that are upcoming for accounting.

Link to this function

query_zone_list(offset \\ 0, limit \\ 2000, creds \\ default_client())

View Source

query_zone_list returns the prices per zone.

Link to this function

renew_domain(domain, years \\ 1, creds \\ default_client())

View Source

renew_domain renews a registered domain.

Link to this function

request_token(people_contact_or_domain, creds \\ default_client())

View Source

request_token requests a verification token for the given contact or domain.

Link to this function

restore_contact(contact, creds \\ default_client())

View Source

restore_contact restores a deleted contact.

Link to this function

restore_domain(domain, creds \\ default_client())

View Source

restore_domain restores a registered domain.

Link to this function

set_domain_auth_code(domain, code, creds \\ default_client())

View Source

set_auth_code sets the domains auth-code for transfer.

Link to this function

set_domain_renewal_mode(domain, mode \\ "default", token \\ "", creds \\ default_client())

View Source

set_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

Link to this function

set_domain_transfer_mode(domain, mode \\ "default", token \\ "", creds \\ default_client())

View Source

set_domain_transfer_mode sets the domains transfer-mode.

The domains mode for transfers: DEFAULT|AUTOAPPROVE|AUTODENY

Link to this function

status_account(creds \\ default_client())

View Source

status_account returns information about the accounts financial status.

Link to this function

status_contact(contact, creds \\ default_client())

View Source

get_contact returns a contact handle.

Link to this function

status_domain(domain, creds \\ default_client())

View Source

status_domain gets the given domain by name.

Link to this function

status_domain_transfer(domain, creds \\ default_client())

View Source

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.

Link to this function

status_event(event, creds \\ default_client())

View Source

status_event gets an event by id.

Link to this function

status_nameserver(nameserver, creds \\ default_client())

View Source

status_nameserver gets the given nameserver by name.

Link to this function

status_owner_change(domain, creds \\ default_client())

View Source

status_owner_change explicity checks the status of an OwnerChange in detail.

Link to this function

status_registrar(creds \\ default_client())

View Source

status_registrar returns information about your account information.

Link to this function

status_tag(tag, type \\ "domain", creds \\ default_client())

View Source

status_tag gets the given tag by name.

Link to this function

transfer_domain(domain, action \\ "request", auth \\ "", owner \\ "", admin \\ "", tech \\ "", bill \\ "", nameservers \\ [], period \\ "1", creds \\ default_client())

View Source

transfer_domain transfers a foreign domain into our account.