Services

Account

class domainrobot.services.account.AccountService(http)

Customer account operations.

Parameters:

http (HttpClient)

info(*, headers=None)

Inquire account data of the customer.

Parameters:

headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Account data.

update(body, *, headers=None)

Update the notification parameters.

Parameters:

• body (dict) – Account data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Account data.

BackupMx

class domainrobot.services.backup_mx.BackupMxService(http)

BackupMX record operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Create a new BackupMX.

Parameters:

• body (dict) – BackupMX data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with BackupMx data.

info(domain, *, headers=None)

Inquire data for a BackupMX.

Parameters:

• domain (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with BackupMx data.

delete(domain, *, headers=None)

Delete a BackupMX.

Parameters:

• domain (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

list(body=None, *, keys=None, headers=None)

List BackupMX entries.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of BackupMx.

Certificate

class domainrobot.services.certificate.CertificateService(http)

SSL certificate operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Order a new certificate. Async operation.

Parameters:

• body (dict) – Certificate data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

info(certificate_id, *, headers=None)

Inquire data for a certificate.

Parameters:

• certificate_id (int) – Certificate ID.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Certificate data.

reissue(certificate_id, body, *, headers=None)

Reissue a certificate. Async operation.

Parameters:

• certificate_id (int) – Certificate ID.

• body (dict) – Certificate data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

delete(certificate_id, *, headers=None)

Delete a certificate. Async operation.

Parameters:

• certificate_id (int) – Certificate ID.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

renew(certificate_id, body, *, headers=None)

Renew a certificate. Async operation.

Parameters:

• certificate_id (int) – Certificate ID.

• body (dict) – Certificate data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

revoke(certificate_id, body, *, headers=None)

Revoke a certificate by serial number.

Parameters:

• certificate_id (int) – Certificate ID.

• body (dict) – Revocation data including serial number.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

list(body=None, *, keys=None, headers=None)

List certificates.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of Certificate.

prepare_order(body, *, headers=None)

Prepare a certificate order (check CSR and generate auth data).

Parameters:

• body (dict) – Certificate data including the CSR.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with CertificateData data.

create_realtime(body, *, headers=None)

Order or renew a certificate in realtime.

Parameters:

• body (dict) – Certificate data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Certificate data.

comment_update(certificate_id, body, *, headers=None)

Update the comment for a certificate.

Parameters:

• certificate_id (int) – Certificate ID.

• body (dict) – Comment data.

• headers (dict | None) – Optional extra HTTP headers.

install_check(body, *, headers=None)

Check an installed certificate on a server.

Parameters:

• body (dict) – Request data including hostname.

• headers (dict | None) – Optional extra HTTP headers.

check_vmc_data(body, *, headers=None)

Check data against VMC certificate requirements.

Parameters:

• body (dict) – VMC check data.

• headers (dict | None) – Optional extra HTTP headers.

site_seal(certificate_id, *, headers=None)

Fetch site seal information for a certificate.

Parameters:

• certificate_id (int) – Certificate ID.

• headers (dict | None) – Optional extra HTTP headers.

Contact

class domainrobot.services.contact.ContactService(http)

Domain contact operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Create a new domain contact.

Parameters:

• body (dict) – Contact data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Contact data.

info(contact_id, *, headers=None)

Inquire data for a domain contact.

Parameters:

• contact_id (int) – Contact ID.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Contact data.

update(contact_id, body, *, headers=None)

Update a domain contact.

Parameters:

• contact_id (int) – Contact ID.

• body (dict) – Contact data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Contact data.

delete(contact_id, *, headers=None)

Delete a domain contact.

Parameters:

• contact_id (int) – Contact ID.

• headers (dict | None) – Optional extra HTTP headers.

list(body=None, *, keys=None, headers=None)

List domain contacts.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of Contact.

comment_update(contact_id, body, *, headers=None)

Update the comment for a contact.

Parameters:

• contact_id (int) – Contact ID.

• body (dict) – Comment data.

• headers (dict | None) – Optional extra HTTP headers.

Domain

class domainrobot.services.domain.DomainService(http)

Domain operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Register a new domain. Async operation.

Parameters:

• body (dict) – Domain data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

info(name, *, headers=None)

Inquire data for a domain.

Parameters:

• name (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Domain data.

update(name, body, *, headers=None)

Update a domain. Async operation.

Parameters:

• name (str) – Domain name.

• body (dict) – Domain data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

list(body=None, *, keys=None, headers=None)

List domains.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of Domain.

transfer(body, *, headers=None)

Transfer a domain. Async operation.

Parameters:

• body (dict) – Domain transfer data including authinfo.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

renew(name, body, *, headers=None)

Renew a domain. Async operation.

Parameters:

• name (str) – Domain name.

• body (dict) – Renewal data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

restore(name, body, *, headers=None)

Restore a domain. Async operation.

Parameters:

• name (str) – Domain name.

• body (dict) – Restore data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

restore_list(body=None, *, keys=None, headers=None)

List restorable domains.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of DomainRestore.

update_status(name, body, *, headers=None)

Update the registry status for a domain. Async operation.

Parameters:

• name (str) – Domain name.

• body (dict) – Status data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

authinfo1_create(name, *, headers=None)

Create an AuthInfo1 for a domain.

Parameters:

• name (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Domain data.

authinfo1_delete(name, *, headers=None)

Delete an AuthInfo1 for a domain.

Parameters:

• name (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

authinfo2_create(name, *, headers=None)

Create an AuthInfo2 for a domain.

Parameters:

• name (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

cancelation_create(name, body, *, headers=None)

Create a cancelation for a domain.

Parameters:

• name (str) – Domain name.

• body (dict) – Cancelation data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with DomainCancelation data.

cancelation_update(name, body, *, headers=None)

Update a cancelation for a domain.

Parameters:

• name (str) – Domain name.

• body (dict) – Cancelation data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with DomainCancelation data.

cancelation_delete(name, *, headers=None)

Delete a cancelation for a domain.

Parameters:

• name (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

cancelation_info(name, *, headers=None)

Inquire cancelation data for a domain.

Parameters:

• name (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with DomainCancelation data.

cancelation_list(body=None, *, keys=None, headers=None)

List domain cancelations.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of DomainCancelation.

comment_update(name, body, *, headers=None)

Update the comment for a domain.

Parameters:

• name (str) – Domain name.

• body (dict) – Comment data.

• headers (dict | None) – Optional extra HTTP headers.

buy(body, *, headers=None)

Buy a domain from the premium market. Async operation.

Parameters:

• body (dict) – Domain buy data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

trade(body, *, headers=None)

Change the owner of a domain (trade). Async operation.

Parameters:

• body (dict) – Domain trade data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

owner_change(name, body, *, headers=None)

Change the owner contact of a domain. Async operation.

Parameters:

• name (str) – Domain name.

• body (dict) – Owner change data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

dnssec_update(name, body, *, headers=None)

Update DNSSEC data for a domain. Async operation.

Parameters:

• name (str) – Domain name.

• body (dict) – DNSSEC data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Job data.

DomainStudio

class domainrobot.services.domain_studio.DomainStudioService(http)

DomainStudio search operations.

Parameters:

http (HttpClient)

search(body, *, headers=None)

Search for free, premium, and alternate domain names.

Parameters:

• body (dict) – Search request data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of DomainEnvelope.

Hello

class domainrobot.services.hello.HelloService(http)

Connection test operations.

Parameters:

http (HttpClient)

ping(*, headers=None)

Test the connection to the API.

Parameters:

headers (dict | None) – Optional extra HTTP headers.

Job

class domainrobot.services.job.JobService(http)

Asynchronous job operations.

Parameters:

http (HttpClient)

info(job_id, *, headers=None)

Inquire data for a job.

Parameters:

• job_id (int) – Job ID.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with ObjectJob data.

list(body=None, *, keys=None, headers=None)

List jobs.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of ObjectJob.

cancel(job_id, *, headers=None)

Cancel a job.

Parameters:

• job_id (int) – Job ID.

• headers (dict | None) – Optional extra HTTP headers.

confirm(job_id, *, headers=None)

Confirm a job.

Parameters:

• job_id (int) – Job ID.

• headers (dict | None) – Optional extra HTTP headers.

MailProxy

class domainrobot.services.mail_proxy.MailProxyService(http)

Mail proxy operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Create a new mail proxy.

Parameters:

• body (dict) – MailProxy data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with MailProxy data.

info(domain, *, headers=None)

Inquire data for a mail proxy.

Parameters:

• domain (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with MailProxy data.

update(domain, body, *, headers=None)

Update a mail proxy.

Parameters:

• domain (str) – Domain name.

• body (dict) – MailProxy data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with MailProxy data.

delete(domain, *, headers=None)

Delete a mail proxy.

Parameters:

• domain (str) – Domain name.

• headers (dict | None) – Optional extra HTTP headers.

list(body=None, *, keys=None, headers=None)

List mail proxies.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of MailProxy.

Poll

class domainrobot.services.poll.PollService(http)

Poll message operations.

Parameters:

http (HttpClient)

info(*, headers=None)

Inquire the latest poll message.

Parameters:

headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with PollMessage data.

confirm(poll_id, *, headers=None)

Confirm a poll message.

Parameters:

• poll_id (int) – Poll message ID.

• headers (dict | None) – Optional extra HTTP headers.

Redirect

class domainrobot.services.redirect.RedirectService(http)

Domain and email redirect operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Create a new redirect.

Parameters:

• body (dict) – Redirect data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Redirect data.

info(source, *, headers=None)

Inquire data for a redirect.

Parameters:

• source (str) – Source domain.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Redirect data.

update(source, body, *, headers=None)

Update a redirect.

Parameters:

• source (str) – Source domain.

• body (dict) – Redirect data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Redirect data.

delete(source, *, headers=None)

Delete a redirect.

Parameters:

• source (str) – Source domain.

• headers (dict | None) – Optional extra HTTP headers.

list(body=None, *, keys=None, headers=None)

List redirects.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of Redirect.

Session

class domainrobot.services.session.SessionService(http)

Session / login operations.

Parameters:

http (HttpClient)

login(body, *, headers=None)

Log in and create a new session.

Parameters:

• body (dict) – Login credentials.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with User data.

logout(*, headers=None)

Log out and delete the current session.

Parameters:

headers (dict | None) – Optional extra HTTP headers.

SslContact

class domainrobot.services.ssl_contact.SslContactService(http)

SSL contact operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Create a new SSL contact.

Parameters:

• body (dict) – SSL contact data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with SslContact data.

info(ssl_contact_id, *, headers=None)

Inquire data for an SSL contact.

Parameters:

• ssl_contact_id (int) – SSL contact ID.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with SslContact data.

update(ssl_contact_id, body, *, headers=None)

Update an SSL contact.

Parameters:

• ssl_contact_id (int) – SSL contact ID.

• body (dict) – SSL contact data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with SslContact data.

delete(ssl_contact_id, *, headers=None)

Delete an SSL contact.

Parameters:

• ssl_contact_id (int) – SSL contact ID.

• headers (dict | None) – Optional extra HTTP headers.

list(body=None, *, keys=None, headers=None)

List SSL contacts.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of SslContact.

Subscription

class domainrobot.services.subscription.SubscriptionService(http)

Subscription contract operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Create a new subscription.

Parameters:

• body (dict) – Subscription data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Subscription data.

update(contract_id, body, *, headers=None)

Update a subscription.

Parameters:

• contract_id (int) – Contract ID.

• body (dict) – Subscription data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Subscription data.

delete(contract_id, *, headers=None)

Delete a subscription.

Parameters:

• contract_id (int) – Contract ID.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Subscription data.

list(body=None, *, headers=None)

List subscriptions.

Parameters:

• body (dict | None) – Optional query filters.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of Subscription.

TransferOut

class domainrobot.services.transfer_out.TransferOutService(http)

Transfer-out request operations.

Parameters:

http (HttpClient)

list(body=None, *, keys=None, headers=None)

List outgoing transfer requests.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of TransferOut.

answer(domain, answer_type, body=None, *, headers=None)

Accept (ACK) or reject (NACK) a transfer request.

Parameters:

• domain (str) – Domain name.

• answer_type (Literal['ACK', 'NACK']) – "ACK" or "NACK".

• body (dict | None) – Optional transfer-out data (e.g. nackReason).

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with TransferOut data.

User

class domainrobot.services.user.UserService(http)

User management operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Create a new user.

Parameters:

• body (dict) – User data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with User data.

info(user, context, *, headers=None)

Inquire data for a user.

Parameters:

• user (str) – Username.

• context (int) – Context number.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with User data.

update(user, context, body, *, headers=None)

Update a user.

Parameters:

• user (str) – Username.

• context (int) – Context number.

• body (dict) – User data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with User data.

delete(user, context, *, headers=None)

Delete a user.

Parameters:

• user (str) – Username.

• context (int) – Context number.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with User data.

list(body=None, *, headers=None)

List users.

Parameters:

• body (dict | None) – Optional query filters.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of User.

Zone

class domainrobot.services.zone.ZoneService(http)

DNS zone operations.

Parameters:

http (HttpClient)

create(body, *, headers=None)

Create a zone.

Parameters:

• body (dict) – Zone data.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Zone data.

info(name, virtual_ns, *, headers=None)

Inquire data for a zone.

Parameters:

• name (str) – Zone origin.

• virtual_ns (str) – Virtual name server.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Zone data.

update(name, virtual_ns, body, *, headers=None)

Update a zone.

Parameters:

• name (str) – Zone origin.

• virtual_ns (str) – Virtual name server.

• body (dict) – Zone data to update.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Zone data.

delete(name, virtual_ns, *, headers=None)

Delete a zone.

Parameters:

• name (str) – Zone origin.

• virtual_ns (str) – Virtual name server.

• headers (dict | None) – Optional extra HTTP headers.

list(body=None, *, keys=None, headers=None)

List zones.

Parameters:

• body (dict | None) – Optional query filters.

• keys (list[str] | None) – Additional data keys to return.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with list of Zone.

stream(name, body, *, headers=None)

Add or remove records for a zone (stream update).

Parameters:

• name (str) – Zone origin.

• body (dict) – Stream data with adds and rems lists.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Zone data.

import_zone(name, virtual_ns, body, *, headers=None)

Import a zone.

Parameters:

• name (str) – Zone origin.

• virtual_ns (str) – Virtual name server.

• body (dict) – Zone data to import.

• headers (dict | None) – Optional extra HTTP headers.

Returns:

Response with Zone data.