Domains

query-domain-list

Accepts (optional)

pattern Pattern to match (globbing, like "dom*")

from

Start from this item in list

to

End by this item

showstatus   

Returns additional column, showing domain status; may be 0 or 1

showgrants

Returns additional column, showing domain grants; may be 0 or 1

showprivacy

Returns additional columns, showing privacy status; may be 0 or 1

The following columns will be added:

privacy-status - shows the currently active privacy status
privacy-origin - shows the privacy status, which was bought
privacy-expiration - shows the expiration date of privacy

 

Returns

List of registered domains and their expiration dates (one per line, separated by whitespace). If "showstatus" is present, the the list will be with three columns, the last one showing domain status (like "lock,autorenew" etc - comma separated).

 

 

Example:

  https://dmapi.joker.com/request/query-domain-list?pattern=a*&showstatus=1&auth-sid=<your-current-session-id>

 

 

Last update: 2016-11-17 16:55

domain-register

Requires (mandatory)

domain         
Domain name to register
period Registration period in months (not in years!)
status Set domain status (only "production" is accepted so far)
owner-c Owner contact handle
billing-c Billing contact handle
admin-c Administrative contact handle
tech-c Technical contact handle
ns-list List of name servers, delimited by colon


Accepts (optional)

autorenew if set to "1", domain will be autorenewed upon expiration
language

3 letter language code for IDN domains

registrar-tag     

Registrar tag, also known as "Membership token", currently only needed for .XXX domains

privacy

basic|pro|none - adds whois privacy subscription to domain order, see also Whois Privacy Services

 

This request allows to register a domain.

You must have registered contacts (handles) to be able to register a domain.(=> contact-create, query-contact-list)


Important: Please note that the registration period is in months, not years. In most cases, this number is a multiple of 12.

 

 

Example:

  https://dmapi.joker.com/request/domain-register?domain=example.com&period=12&status=production&owner-c=COCO-4711&billing-c=COCO-4712&admin-c=COCO-4712&tech-c=COCO-4712&ns-list=a.ns.joker.com,b.ns.joker.com,c.ns.joker.com&auth-sid=<your-current-session-id>

 

 

Last update: 2016-11-17 16:56

domain-renew

 

Requires (mandatory)

domain domain name to renew
period renewal period in months (not in years!)

expyear

the wanted expiration year (e.g. '2014')

 

Accepts (optional)

privacy       basic|pro|none|keep - adds whois privacy subscription to domain renewal
 

none: explicitly do a renew without privacy services, even if currently privacy is enabled

keep: renew with the same level of privacy service which is currently active for the domain

see also Whois Privacy Services

 

 

With this request you can renew the domain. Please be aware that all renewals are not refundable.

 

"expyear" is a safety option which can be used instead of "period" to renew domain till specified year (not longer). If you use "period", and by mistake send the request more than once, domain will be renewed again, while with "expyear", it will not be renewed if it's expiration year is greater or equals to specified.

Only one of "period" or "expyear" may be used, but not both.

 

Please note:

 

Example:

  https://dmapi.joker.com/request/domain-renew?domain=example.com&period=12&auth-sid=<your-current-session-id

 

 

Last update: 2017-07-21 16:25

domain-modify

Requires (mandatory)

domain domain name to modify

 

Accepts (optional)

billing-c domain contact data to modify
admin-c
tech-c
ns-list   list of new nameservers delimited by colon ":" (it will replace existing nameservers!)
registrar-tag 

Registrar tag, also known as "Membership token", currently used for .XXX domains

dnssec

if specified, allows setting or removal of DNSSEC keys for domain. If not specified, DNSSEC records will not be changed. Value of "0" will remove DNSSEC, value of "1" will add DNSSEC (and ds-N parameters must be provided)

 ds-1            list of DNSSEC parameter sets (min. 2, max. 6) for DNSSEC enabled domains
 ds-2            for com/net/org/tv/cc each entry has format:
 ds-3                tag:alg:digest-type:digest
 ds-4            for de:
 ds-5                protocol:alg:flags:pubkey-base64
 ds-6


With this request you can modify

 

Please only specify contact handles which you want to modify, all unspecified handles will be left as is.

 

For DNSSEC, you will find more information here .

 

 

Example:

  https://dmapi.joker.com/request/domain-modify?ns-list=a.my-own-ns.com:b.my-own-ns.com&auth-sid=<your-current-session-id>

 

Example for adding a key (and enabling DNSSEC):

http://dmapi.joker.com/request/domain-modify?domain=example.de&dnssec=1&ds-1=256:3:5:AwEAAd4TaRzEn0zJfw9w2qkazHTqOX97XwNzoDHMKgClJbX/jr9YGdCYKpTfcKQbVmpI4EVBJOjNWawOJEgpVivw53yHbtEFLOCSYyjwHuXaWiEv0sESNAoPCXQurp4tbHSlnRpyxyzV3dsh9/qUIkJEXxcEuFPaLG3bz1z0Ude6gMXr
http://dmapi.joker.com/request/domain-modify?domain=example.com&dnssec=1&ds-1=38698:5:1:AFE249392848D0458B3967BA1EE9BDEA6C3ECB43

 

Example for removing DNSSEC information:

https://dmapi.joker.com/request/domain-modify?domain=example.com&dnssec=0

 

Last update: 2019-09-20 13:42

domain-delete

Requires (mandatory)

domain domain name to delete

 

Accepts (optional)

force 
if present and set to '1', 'Y' or 'Yes', the domain will be deleted even if older than 72 hours.


With this request you can delete a domain.

If you delete a domain within the first 72 hours after the registration, the registration-fee will be refunded to your account.

To delete a domain which is registered for more than 72 hours, you must specify "force=1", otherwise the request will be rejected.

 

 

Example:

 https://dmapi.joker.com/request/domain-delete?domain=example.com&force=1&auth-sid=<your-current-session-id>

 

 

Last update: 2016-11-17 17:12

domain-owner-change

 

Requires

domain domain name to change the owner of
name (optional) full name (if empty, fname + lname will be used)
fname first name
lname last name
title (optional)
individual (optional) Y, Yes, N, No
organization (optional if individual)
email mailaddress of the contact
address-1 street address
address-2 (optional)
address-3 (optional)
city
state (optional)
postal-code
country ISO country code (2 letters)
phone
extension (optional)
fax (optional)
   
lock-opt-out (optional) yes, no  (new IRTP-C: do not apply a 60 days transfer lock to the domain)


With this request you can change the visible WHOIS owner of a domain.

Either "name" or "lname" and "fname" must be provided. Fields not marked as optional are mandatory, and must not be empty.

For the revised ICANN IRTP-C (change of registrar) policy, please also visit our documentation.

 

Example:

  https://dmapi.joker.com/request/domain-owner-change?domain=example.com&fname=John&lname=Doe&email=johnd@someisp.com&address-1=Smartroad 1&city=Smalltown&postal-code=40122&country=US&phone=+1.422.8001&auth-sid=<your-current-session-id>

 

 

 

 

Last update: 2016-12-07 11:47

domain-lock

Requires (mandatory)

domain domain name to lock


With this request you can lock a domain to prevent from fraudulent transfer attempts.

If a domain is locked, each transfer-request from a foreign registrar will be declined.

 

 

Example:

  https://dmapi.joker.com/request/domain-lock?domain=example.com&auth-sid=<your-current-session-id>

 

 

Last update: 2016-11-17 17:03

domain-unlock

Requires (mandatory)

domain domain name to unlock


With this request you can unlock a domain.

If you want to transfer a domain to a foreign registrar, it has to be unlocked.

 

 

Example:

  https://dmapi.joker.com/request/domain-unlock?domain=example.com&auth-sid=<your-current-session-id>

 

 

Last update: 2016-11-17 17:04

domain-transfer-in-reseller

Requires (mandatory)

domain full qualified domain name to transfer to Joker.com
transfer-auth-id AUTH-ID required for all domains except .eu
owner-c new owner contact handle to be used for transferred domain
admin-c

new admin contact handle

tech-c new tech contact handle
billing-c new billing contact handle

Accepts (optional)

status

new domain status to be set after transfer (lock, production)

period

renewal period in months, not in years! [not in use, please leave empty]

autorenew

Autorenew flag for the domain (0 or 1); if not set explicitly, defaults to 1

ns-list 

list of colon-separated nameservers

privacy basic|pro|none - adds whois privacy subscription to domain transfer, see also Whois Privacy Services


With this request you can initiate a transfer of the domain from another registrar to Joker.com.

You have to provide a valid AUTH-ID (you have to request this from the current provider of the domain).

 

Please note:

 

 

Example:

  https://dmapi.joker.com/request/domain-transfer-in-reseller?domain=example.com&transfer-auth-id=abc123xyz&owner-c=COCO-4711&admin-c=COCO-4712&tech-c=COCO-4712&billing-c=COCO-4712&auth-sid=<your-current-session-id>

 

 

 

Last update: 2016-11-17 17:06

domain-set-property

Requires

domain domain name or pattern
pname property name 
pvalue property value (may be empty)

 

With this request you can set a property (flag) for a domain or a set of domains, selected by wildcard pattern.

 

List of available properties and their effects:

autorenew

0 or 1

If set to 1, the domain will be automatically renewed on expiration (if you have enough funds in your account)

whois-opt-out

 0 or 1

currently only used for .tel domains; if set to 1, owner information will not be shown in whois

privacy

off or basic or pro (if available)

If value provided is empty, then the property will be cleared, i.e. the default will be used.

 

Example:

  https://dmapi.joker.com/request/domain-set-property?domain=example.com&pname=autorenew&pvalue=1&auth-sid=<your-current-session-id>

 

 

Last update: 2016-12-15 15:11

domain-get-property

Requires

domain domain name
pname property name (same as in domain-set-property)

 

With this request you can query the value of a specific property set for a domain.

It returns a single line, which looks like:

autorenew: 0

 

 

Example:

  https://dmapi.joker.com/request/domain-get-property?domain=example.com&pname=autorenew&auth-sid=<your-current-session-id>

 

 

Last update: 2016-11-17 17:09

domain-transfer-get-auth-id

Requires

domain domain name to get AUTH-ID for

 

Retrieves domain's Auth-ID, which is required when transfering domains to another registrar.

This request is not real-time, i.e. you have to check detailed reply (use "result-retrieve") to get the Auth-ID.

 

Please note:

Every request will generate a new Auth-ID, thus rendering any previously requested Auth-ID invalid.

 

 

Example:

https://dmapi.joker.com/request/domain-transfer-get-auth-id?domain=example.com&auth-sid=<your-current-session-id>

 

 

 

Last update: 2016-11-17 17:10

domain-transfer-control

This request allows to retrieve status information for all pending transfers. Additionally, transfers can be cancelled, or the FOA email can be re-sent. 

 

Parameters:

        action                  One of: list, show, resend-foa, cancel
        domain                  Domain name to control transfer of (ignored when action=list)
 

 

action=list

When action=list, this request returns a list (columns are separated by tabs) of all currently pending transfers:

 

        <domain> <state> <owner-email> <admin-email>

 

where <state> is one of (listed in "natural" transition order):

 

                IN_DB
                PAYMENT_PREPARED
                PAYMENT_ACQUIRED

                PENDING_FOA_SENDING

                        Joker.com could not parse the recipient of the FOA.
                        Manual action from Joker.com is required and happens
                        during office hours, thus in worst case it may take
                        few days (during weekend or holidays).

                FOA_BEEN_SENT
                
                        FOA is sent and Joker.com is waiting for owner's
                        reaction. Owner has 5 days to react, thus the state
                        may last up to 5 days.
                        
                FOA_NACK                FOA is rejected
                FOA_ACK                 FOA is accepted

                REGISTRY_REQUEST_SENT

                REGISTRY_REQUEST_RECEIVED_NOW_WAITING
                
                        FOA had been accepted, transfer request is sent
                        and the losing registrar has to release the domain.
                        This state may take up to 5 days, we could do nothing
                        to speed it up.
                        While in this state, transfer may be cancelled
                        by using "action=cancel".

                REGISTRY_CANCELATION_PENDING
                
                        The user has requested cancel of domain transfer
                        by using "action=cancel".

                DOMAIN_WITH_JOKER_PENDING_COMPLETE
                
                        The domain is actually with Joker.com, but either
                        we haven’t noticed yet (batch pending) or manual
                        work is necessary.
                        Please contact Joker.com if this state lasts longer
                        than 1 hour.

                PAYMENT_COMMITTED

                TRANSFER_PROCESSED_SUCCESSFULLY

 

action=show

When action=show, the status of a specified domain is returned like:

 

        domain: example.com
        status: FOA_BEEN_SENT
        owner_email: owner@example.com
        admin_email: admin@example.com
        transfer-id: 123456

 

action=resend-foa

When action=resend-foa, FOA will be resent (only possible in state FOA_BEEN_SENT).

 

action=cancel

When action=cancel, the (pending) transfer will be cancelled.

 

Returns

Status code is 1000 for successful request, or >= 2000 otherwise.

 

Example

Example request:

 

        https://dmapi.joker.com/request/domain-transfer-control?domain=example.com&action=resend-foa

 

 

Last update: 2018-01-29 14:28

domain-check

Requires (mandatory)

domain domain name to check


With this request you can check if a domain is available for registration.

 

 

Example:

https://dmapi.joker.com/request/domain-check?domain=example.com&auth-sid=<your-current-session-id>

 

 

Last update: 2019-03-11 11:58