{
    "basePath": "https://api.liqu.id/v1",
    "swaggerVersion": "1.2",
    "apiVersion": "1",
    "resourcePath": "/domains",
    "apis": [
        {
            "path": "/domains",
            "operations": [
                {
                    "method": "POST",
                    "summary": "create a new domain",
                    "nickname": "create",
                    "parameters": [
                        {
                            "paramType": "form",
                            "name": "domain_name",
                            "type": "string",
                            "required": true,
                            "description": "Domain name that you need to Register.\n\nFor an Internationalized Domain Name, refer to the supported character sets mentioned below:"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "required": true,
                            "description": "The Customer for whom you wish to Register this domain name."
                        },
                        {
                            "paramType": "form",
                            "name": "registrant_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "The <strong>Registrant Contact</strong> of the domain name."
                        },
                        {
                            "paramType": "form",
                            "name": "billing_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "\n\n\t\t\t\t\t<p>The <strong>Billing Contact</strong> of the domain name.</p><hr>\n\t\t\t\t\t<p><strong>Note</strong></p>\n\t\t\t\t\tPass -1 for the following TLDs:</br>\n\t\t\t\t\t.AT</br>\n\t\t\t\t\t.BERLIN</br>\n\t\t\t\t\t.CA</br>\n\t\t\t\t\t.EU</br>\n\t\t\t\t\t.NL</br>\n\t\t\t\t\t.NZ</br>\n\t\t\t\t\t.RU</br>\n\t\t\t\t\t.UK</br>\n\n\t "
                        },
                        {
                            "paramType": "form",
                            "name": "admin_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "\n\t \t\t\t\t<p>The <strong>Administrative</strong> Contact of the domain name.</p><hr>\n\t\t\t\t\t<p><strong>Note</strong></p>\n\t\t\t\t\tPass -1 for the following TLDs:</br>\n\t\t\t\t\t.EU</br>\n\t\t\t\t\t.NZ</br>\n\t\t\t\t\t.RU</br>\n\t\t\t\t\t.UK</br>\n\n\t "
                        },
                        {
                            "paramType": "form",
                            "name": "tech_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "\n\t \t \t\t\t<p>The <strong>Technical Contact</strong> of the domain name.</p><hr>\n\t\t\t\t\t<p><strong>Note</strong></p>\n\t\t\t\t\tPass -1 for the following TLDs:</br>\n\t\t\t\t\t.EU</br>\n\t\t\t\t\t.NZ</br>\n\t\t\t\t\t.RU</br>\n\t\t\t\t\t.UK</br>\n\n\t "
                        },
                        {
                            "paramType": "form",
                            "name": "years",
                            "type": "integer",
                            "required": false,
                            "description": "Years Order",
                            "defaultValue": 1
                        },
                        {
                            "paramType": "form",
                            "name": "ns",
                            "type": "string",
                            "required": false,
                            "description": "Name Server, for multi ns example ns1.domainname.com,ns2.domainname.com "
                        },
                        {
                            "paramType": "form",
                            "name": "purchase_privacy_protection",
                            "type": "boolean",
                            "required": false,
                            "description": "Privacy Protect Order"
                        },
                        {
                            "paramType": "form",
                            "name": "extra",
                            "type": "string",
                            "required": false,
                            "description": "Extra, example for .asia domain : asia_contact_id=0"
                        },
                        {
                            "paramType": "form",
                            "name": "invoice_option",
                            "type": "string",
                            "required": true,
                            "description": "Invoice Option, example keep_invoice, pay_invoice, no_invoice, only_add "
                        }
                    ],
                    "notes": "create a domain"
                },
                {
                    "method": "GET",
                    "summary": "retrieve domain details",
                    "nickname": "retrieve",
                    "parameters": [
                        {
                            "paramType": "query",
                            "name": "limit",
                            "type": "integer",
                            "description": "Limit views. This should be a value between 10 to 100.",
                            "defaultValue": 10
                        },
                        {
                            "paramType": "query",
                            "name": "page_no",
                            "type": "integer",
                            "description": "Page number for which details are to be fetched",
                            "defaultValue": "1"
                        },
                        {
                            "paramType": "query",
                            "name": "domain_id",
                            "type": "integer",
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "reseller_id",
                            "type": "integer",
                            "description": "Reseller Id(s) whose Orders need to be fetched"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id(s) whose Orders need to be fetched"
                        },
                        {
                            "paramType": "query",
                            "name": "show_child_orders",
                            "type": "boolean",
                            "description": "Whether Sub-Reseller Orders need to be fetched or not"
                        },
                        {
                            "paramType": "query",
                            "name": "tld",
                            "type": "string",
                            "description": "Top Level Domain"
                        },
                        {
                            "paramType": "query",
                            "name": "status",
                            "type": "string",
                            "description": "Status domain. value : Live, Unpaid, Pending, Expired, Pending Delete Restorable, Pending Transfer, Pending Restore."
                        },
                        {
                            "paramType": "query",
                            "name": "domain_name",
                            "type": "string",
                            "description": "Name of the Domain"
                        },
                        {
                            "paramType": "query",
                            "name": "privacy_protection_enabled",
                            "type": "boolean",
                            "description": "Privacy Protect Enable"
                        },
                        {
                            "paramType": "query",
                            "name": "creation_time_start",
                            "type": "string",
                            "description": "Time for listing of Domain Registration Orders whose Creation Date is greater than creation-date-start, format: Y-m-d H:i:s"
                        },
                        {
                            "paramType": "query",
                            "name": "creation_time_end",
                            "type": "string",
                            "description": "Time for listing of Domain Registration Orders whose Creation Date is less than creation-date-end, format: Y-m-d H:i:s"
                        },
                        {
                            "paramType": "query",
                            "name": "expiry_date_start",
                            "type": "string",
                            "description": "Time for listing of Domain Registration Orders whose Expiry Date is greater than expiry-date-start, format: Y-m-d H:i:s"
                        },
                        {
                            "paramType": "query",
                            "name": "expiry_date_end",
                            "type": "string",
                            "description": "Time for listing of Domain Registration Orders whose Expiry Date is less than expiry-date-end, format: Y-m-d H:i:s"
                        },
                        {
                            "paramType": "query",
                            "name": "reseller_email",
                            "type": "string",
                            "description": "Reseller Email whose Orders need to be fetched"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_email",
                            "type": "string",
                            "description": "Customer Email whose Orders need to be fetched"
                        },
                        {
                            "paramType": "query",
                            "name": "exact_domain_name",
                            "type": "integer",
                            "description": "Exact Domain Name, this will show only 1 result, with same name",
                            "defaultValue": "0"
                        }
                    ],
                    "notes": "retrieve domain details"
                }
            ]
        },
        {
            "path": "/domains/availability",
            "operations": [
                {
                    "method": "GET",
                    "summary": "check availability of a domain name",
                    "nickname": "availability",
                    "parameters": [
                        {
                            "paramType": "query",
                            "name": "domain",
                            "type": "string",
                            "required": true,
                            "description": "Domain name(s) that you need to check the availability for"
                        },
                        {
                            "paramType": "query",
                            "name": "lang",
                            "type": "string",
                            "required": false,
                            "description": "IDN Language Code"
                        }
                    ],
                    "notes": "check availability of a domain name"
                }
            ]
        },
        {
            "path": "/domains/details-by-name",
            "operations": [
                {
                    "method": "GET",
                    "summary": "Gets details of the Domain Registration Order associated with the specified domain name.",
                    "nickname": "details-by-name",
                    "parameters": [
                        {
                            "paramType": "query",
                            "name": "domain_name",
                            "type": "string",
                            "required": true,
                            "description": "Domain name associated with the Domain Registration Order whose details need to be fetched."
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": ""
                }
            ]
        },
        {
            "path": "/domains/suggestion",
            "operations": [
                {
                    "method": "GET",
                    "summary": "retrieve domain suggestion for a keyword",
                    "nickname": "suggestion",
                    "parameters": [
                        {
                            "paramType": "query",
                            "name": "keyword",
                            "type": "string",
                            "required": true,
                            "description": "\n\t\t\t\t Search term (keyword or phrase) e.g. 'search' or 'search world'</br></br>\n\n\t\t\t\t<strong>Note</strong></br>\n\t\t\t\tThe search term will be considered as invalid, if it contains more than one consecutive space character.\n\n\t "
                        },
                        {
                            "paramType": "query",
                            "name": "tlds",
                            "type": "string",
                            "required": true,
                            "description": "Domain name extensions (TLDs) you want to search in"
                        },
                        {
                            "paramType": "query",
                            "name": "limit",
                            "type": "string",
                            "required": true,
                            "description": "Total want to appear. This should be a value between 10 to 100.",
                            "defaultValue": 10
                        },
                        {
                            "paramType": "query",
                            "name": "hyphen_allowed",
                            "type": "boolean",
                            "description": "Default value is false. Recommended value is true. If true is passed, generates suggestions with hyphens (Dashes)"
                        },
                        {
                            "paramType": "query",
                            "name": "add_related",
                            "type": "boolean",
                            "description": "Default value is false. Recommended value is true. If true is passed, generates suggestions with related keywords."
                        }
                    ]
                }
            ]
        },
        {
            "path": "/domains/transfer",
            "operations": [
                {
                    "method": "POST",
                    "summary": "transfer domain",
                    "nickname": "transfer",
                    "parameters": [
                        {
                            "paramType": "form",
                            "name": "domain_name",
                            "type": "string",
                            "required": true,
                            "description": "Specify the domain name that you want to transfer."
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "required": true,
                            "description": "The Customer for whom the Order should be added."
                        },
                        {
                            "paramType": "form",
                            "name": "registrant_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "The Registrant Contact of the domain name.</br>\n\t\t\t\t\t\t\t\t\t\tThe Identity of the Registrant Contact of a .UK domain name must not be changed during the Transfer process. You may modify the Identity once the domain name has been transferred to LogicBoxes."
                        },
                        {
                            "paramType": "form",
                            "name": "admin_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "\n\t\t\t\t\t\tThe Administrative Contact of the domain name.</br>\n\t\t\t\t\t\t.EU, .NZ, .RU and .UK domain names do not have an Administrative Contact associated with them. You need to pass the value of admin-contact-id as -1 for these domain names.\n\t \t\t\t"
                        },
                        {
                            "paramType": "form",
                            "name": "billing_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "\n\t\t\t\t\t\tThe Billing Contact of the domain name.</br>\n\t\t\t\t\t\tThe Billing Contact associated with a .EU domain name cannot be modified while .AT, .BERLIN, .CA, .NL, .NZ, .RU and .UK domain names do not have a Billing Contact associated with them.\n\t\t\t\t"
                        },
                        {
                            "paramType": "form",
                            "name": "tech_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "\n\t\t\t\t\t\tThe Technical Contact of the domain name.</br>\n\t\t\t\t\t\tThe Technical Contact associated with a .EU domain name cannot be modified while .NZ, .RU and .UK domain names do not have a Technical Contact associated with them. You need to pass the value of tech-contact-id as -1 for these domain names."
                        },
                        {
                            "paramType": "form",
                            "name": "auth_code",
                            "type": "string",
                            "description": "Authorization Code (a.k.a. Domain Secret) of the domain name that you want to transfer."
                        },
                        {
                            "paramType": "form",
                            "name": "years",
                            "type": "string",
                            "description": "Years",
                            "defaultValue": "1"
                        },
                        {
                            "paramType": "form",
                            "name": "ns",
                            "type": "string",
                            "description": "List of Name Servers to be associated with the domain name. A maximum of 13 Name Servers can be specified."
                        },
                        {
                            "paramType": "form",
                            "name": "extra",
                            "type": "string",
                            "description": "Extra, example asia_contact_id=0"
                        },
                        {
                            "paramType": "form",
                            "name": "invoice_option",
                            "type": "string",
                            "required": true,
                            "description": "\n\t\t\t\t\t\t\tThis will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:</br>\n\t\t\t\t\t\t\t- no_invoice </br>\n\t\t\t\t\t\t\t- pay_invoice</br>\n\t\t\t\t\t\t\t- keep_invoice</br>\n                            - only_add</br>\n\t\t\t\t"
                        },
                        {
                            "paramType": "form",
                            "name": "purchase_privacy_protection",
                            "type": "boolean",
                            "required": false,
                            "description": "Privacy Protect Order"
                        }
                    ],
                    "notes": "transfer domain "
                }
            ]
        },
        {
            "path": "/domains/transfer/validity",
            "operations": [
                {
                    "method": "POST",
                    "summary": "retrieve transfer request validity of a domain name",
                    "nickname": "retrieve transfer request validity",
                    "parameters": [
                        {
                            "paramType": "form",
                            "name": "domain_name",
                            "type": "string",
                            "required": true,
                            "description": "Domain name for which you want to check if the transfer request is valid."
                        },
                        {
                            "paramType": "form",
                            "name": "auth_code",
                            "type": "string",
                            "description": "Auth code."
                        }
                    ],
                    "notes": "retrieve transfer request validity of a domain name "
                }
            ]
        },
        {
            "path": "/domains/{domain_id}",
            "operations": [
                {
                    "method": "GET",
                    "summary": "retrieve a domain details",
                    "nickname": "ability",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "fields",
                            "type": "string",
                            "required": true,
                            "description": "Values can be: All, domain_details, billing_contact, registrant_contact, admin_contact, tech_contact, dnssec, dns, ns, domain_forwarding, childns, raa_verification.",
                            "defaultValue": "all"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": ""
                },
                {
                    "method": "DELETE",
                    "summary": "delete a domain",
                    "nickname": "delete",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "domain id"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "delete a domain "
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/auth_code",
            "operations": [
                {
                    "method": "PUT",
                    "summary": "update auth code of a domain",
                    "nickname": "update auth code ",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "auth_code",
                            "type": "string",
                            "required": true,
                            "description": "New auth-code"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "update auth code of a domain"
                },
                {
                    "method": "GET",
                    "summary": "retrieve auth code of a domain",
                    "nickname": "retrieve auth code ",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "retrieve auth code of a domain"
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/childns",
            "operations": [
                {
                    "method": "POST",
                    "summary": "add a new child name server for a domain",
                    "nickname": "add a new child name ",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "hostname",
                            "type": "string",
                            "required": true,
                            "description": "Child Name Servers name that you want to add."
                        },
                        {
                            "paramType": "form",
                            "name": "ip_address",
                            "type": "string",
                            "required": true,
                            "description": "IP addresses that you want to associate with the Child Name Servers."
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "add a new child name server for a domain"
                },
                {
                    "method": "GET",
                    "summary": "list all child name servers of a domain",
                    "nickname": "list all child name ",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "list all child name servers of a domain"
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/childns/{hostname}/{ip_address}",
            "operations": [
                {
                    "method": "DELETE",
                    "summary": "delete a child name server of a domain",
                    "nickname": "delete a child name ",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "path",
                            "name": "hostname",
                            "type": "string",
                            "required": true,
                            "description": "Child Name Server's name for which the IP address needs to be deleted."
                        },
                        {
                            "paramType": "path",
                            "name": "ip_address",
                            "type": "string",
                            "required": true,
                            "description": "IP address that needs to be deleted."
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "delete a child name server of a domain"
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/childns/{old_hostname}/{old_ip_address}",
            "operations": [
                {
                    "method": "PUT",
                    "summary": "update a child name server of a domain",
                    "nickname": "update a child name ",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "path",
                            "name": "old_hostname",
                            "type": "string",
                            "required": true,
                            "description": "Current Child Name Server of the specified Order."
                        },
                        {
                            "paramType": "path",
                            "name": "old_ip_address",
                            "type": "string",
                            "required": true,
                            "description": "Currently associated IP address with the specified Child Name Server."
                        },
                        {
                            "paramType": "form",
                            "name": "hostname",
                            "type": "string",
                            "required": true,
                            "description": "New Child Name Server that you want to associate with the Order."
                        },
                        {
                            "paramType": "form",
                            "name": "ip_address",
                            "type": "string",
                            "required": true,
                            "description": "New IP address that you want to associate with the specified Child Name Server."
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "update a child name server of a domain"
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/contacts",
            "operations": [
                {
                    "method": "PUT",
                    "summary": "update domain contact",
                    "nickname": "update",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "domain id"
                        },
                        {
                            "paramType": "form",
                            "name": "registrant_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "The Contact that you want to use as the new Registrant Contact"
                        },
                        {
                            "paramType": "form",
                            "name": "billing_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "The Contact that you want to use as the new Billing Contact"
                        },
                        {
                            "paramType": "form",
                            "name": "admin_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "The Contact that you want to use as the new Admin Contact"
                        },
                        {
                            "paramType": "form",
                            "name": "tech_contact_id",
                            "type": "integer",
                            "required": true,
                            "description": "The Contact that you want to use as the new Technical Contact"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "update domain contact"
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/dnssec",
            "operations": [
                {
                    "method": "POST",
                    "summary": "Adding a Delegation Signer (DS) Record",
                    "nickname": "create dnssec",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "domain id"
                        },
                        {
                            "paramType": "form",
                            "name": "keytag",
                            "type": "integer",
                            "required": true,
                            "description": "Contains the tag value of the DNSKEY Resource Record that validates this signature. An integer value in the range 0 to 65536."
                        },
                        {
                            "paramType": "form",
                            "name": "algorithm",
                            "type": "integer",
                            "required": true,
                            "description": "An integer value 1,2,3,4,5,6,7,8,10,13,14,15,16,17,23,252,253,254"
                        },
                        {
                            "paramType": "form",
                            "name": "digesttype",
                            "type": "integer",
                            "required": true,
                            "description": "Min 1 max 6"
                        },
                        {
                            "paramType": "form",
                            "name": "digest",
                            "type": "string",
                            "required": true,
                            "description": "An alpha-numeric string generated by applying the Digest Type algorithm to a message. It needs to be a 40-character string for Digest Type value 1 and a 64-character string for Digest Type values 2 and 3."
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "Adds a Delegation Signer (DS) Record for a Domain Registration Order."
                },
                {
                    "method": "GET",
                    "summary": "Retrieve All Delegation Signer (DS) Record",
                    "nickname": "retrieve all dnssec",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "Retrieve All Delegation Signer (DS) Record"
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/dnssec/{keytag}/{algorithm}/{digesttype}/{digest}",
            "operations": [
                {
                    "method": "DELETE",
                    "summary": "Delete a Delegation Signer (DS) Record",
                    "nickname": "delete a dnssec record",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "path",
                            "name": "keytag",
                            "type": "integer",
                            "required": true,
                            "description": "Contains the tag value of the DNSKEY Resource Record that validates this signature. An integer value in the range 0 to 65536."
                        },
                        {
                            "paramType": "path",
                            "name": "algorithm",
                            "type": "integer",
                            "required": true,
                            "description": "An integer value 1, 2, 3, 4, 5, 6, 7, 8, 10, 252, 253 & 254"
                        },
                        {
                            "paramType": "path",
                            "name": "digesttype",
                            "type": "integer",
                            "required": true,
                            "description": "Min 1 max 3"
                        },
                        {
                            "paramType": "path",
                            "name": "digest",
                            "type": "string",
                            "required": true,
                            "description": "An alpha-numeric string generated by applying the Digest Type algorithm to a message. It needs to be a 40-character string for Digest Type value 1 and a 64-character string for Digest Type values 2 and 3."
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "Delete a Delegation Signer (DS) Record for a Domain Registration Order."
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/irtp_verification/resend",
            "operations": [
                {
                    "method": "POST",
                    "summary": "resend IRTP Verification email of a domain",
                    "nickname": "resend IRTP Verification email",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "required": false,
                            "description": "Customer Id."
                        },
                        {
                            "paramType": "form",
                            "name": "type",
                            "type": "string",
                            "required": false,
                            "description": "email or sms",
                            "defaultValue": "email"
                        }
                    ],
                    "notes": "resend IRTP Verification email of a domain"
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/locked",
            "operations": [
                {
                    "method": "PUT",
                    "summary": "locked a domain",
                    "nickname": "locked",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "reason",
                            "type": "string",
                            "description": "Reason of Locking Domain."
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "locked a domain "
                },
                {
                    "method": "DELETE",
                    "summary": "unlock a domain",
                    "nickname": "unlock",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "unlock a domain "
                },
                {
                    "method": "GET",
                    "summary": "retrieve domain locked status",
                    "nickname": "retrieve domain locked",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "retrieve domain locked status "
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/move",
            "operations": [
                {
                    "method": "POST",
                    "summary": "move domain ",
                    "nickname": "move",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "domain id"
                        },
                        {
                            "paramType": "form",
                            "name": "existing_customer_id",
                            "type": "integer",
                            "required": true,
                            "description": "Existing Customer ID from which the products are to be transferred"
                        },
                        {
                            "paramType": "form",
                            "name": "new_reseller_id",
                            "type": "integer",
                            "required": true,
                            "description": "New Reseller ID to which the products are to be transferred"
                        },
                        {
                            "paramType": "form",
                            "name": "new_customer_id",
                            "type": "integer",
                            "required": true,
                            "description": "New Customer ID to which the products are to be transferred"
                        },
                        {
                            "paramType": "form",
                            "name": "default_contacts",
                            "type": "string",
                            "required": true,
                            "description": "Value to indicate whether the old Contact has to be retained or to use the Default Contact of the new Customer. Valid entries are oldcontact or default."
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "move domain. after move, you will get new domain ID"
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/ns",
            "operations": [
                {
                    "method": "PUT",
                    "summary": "update name servers of a domain",
                    "nickname": "update ns",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "ns",
                            "type": "string",
                            "required": true,
                            "description": "New name server."
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "update name servers of a domain "
                },
                {
                    "method": "GET",
                    "summary": "retrieve name servers of a domain",
                    "nickname": "retrieve ns",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "retrieve name servers of a domain "
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/raa_verification",
            "operations": [
                {
                    "method": "GET",
                    "summary": "retrieve RAA Verification status of a domain",
                    "nickname": "retrieve RAA Verification status ",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "retrieve RAA Verification status of a domain. When verified, response includes raaVerificationDate (datetime registrant completed verification, or null if not yet recorded)."
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/raa_verification/resend",
            "operations": [
                {
                    "method": "POST",
                    "summary": "resend RAA Verification email of a domain",
                    "nickname": "resend RAA Verification email",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "resend RAA Verification email of a domain"
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/renew",
            "operations": [
                {
                    "method": "POST",
                    "summary": "renew domain order",
                    "nickname": "renew",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "domain id"
                        },
                        {
                            "paramType": "form",
                            "name": "years",
                            "type": "integer",
                            "required": true,
                            "description": "Number of years for which you want to Renew this Order."
                        },
                        {
                            "paramType": "form",
                            "name": "current_date",
                            "type": "string",
                            "required": true,
                            "description": "Current Expiry Date of the Order in epoch time format. Format: Y-m-d H:i:s"
                        },
                        {
                            "paramType": "form",
                            "name": "purchase_privacy_protection",
                            "type": "boolean",
                            "description": "Renews the Privacy Protection service for the domain name"
                        },
                        {
                            "paramType": "form",
                            "name": "invoice_option",
                            "type": "string",
                            "required": true,
                            "description": "\n\t\t\t\t\t\t\tThis will decide how the Customer Invoice will be handled. <br/>\n\t\t\t\t\t\t\tSet any of below mentioned Invoice Options for your Customer:<br/>\n\t\t\t\t\t\t\t- no_invoice </br>\n\t\t\t\t\t\t\t- pay_invoice </br>\n\t\t\t\t\t\t\t- keep_invoice</br>\n\t\t\t\t\t\t\t- only_add\n\t\t\t\t"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "renew domain order "
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/restore",
            "operations": [
                {
                    "method": "POST",
                    "summary": "restore domain order",
                    "nickname": "restore",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "domain id"
                        },
                        {
                            "paramType": "form",
                            "name": "invoice_option",
                            "type": "string",
                            "required": true,
                            "description": "This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer: keep_invoice, pay_invoice, no_invoice, only_add"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "restore domain order "
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/suspended",
            "operations": [
                {
                    "method": "PUT",
                    "summary": "suspend a domain",
                    "nickname": "suspend",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "reason",
                            "type": "string",
                            "description": "Reason of Suspending Domain."
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "suspend a domain "
                },
                {
                    "method": "DELETE",
                    "summary": "unsuspend a domain",
                    "nickname": "unsuspend",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "unsuspend a domain "
                },
                {
                    "method": "GET",
                    "summary": "retrieve domain suspend status",
                    "nickname": "retrieve domain suspend",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "retrieve domain suspend status "
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/theft_protection",
            "operations": [
                {
                    "method": "PUT",
                    "summary": "enable theft protection on a domain",
                    "nickname": "enable thief protect",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "enable theft protection on a domain "
                },
                {
                    "method": "DELETE",
                    "summary": "disable theft protection on a domain",
                    "nickname": "disable thief protect",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "disable theft protection on a domain "
                },
                {
                    "method": "GET",
                    "summary": "retrieve theft protection status of a domain",
                    "nickname": "retrieve thief protect",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "query",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "retrieve theft protection status of a domain "
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/transfer/cancel",
            "operations": [
                {
                    "method": "POST",
                    "summary": "Cancels the Transfer-In Order that is awaiting Admin approval.",
                    "nickname": "Cancelling a Transfer",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "Cancels the Transfer-In Order that is awaiting Admin approval."
                }
            ]
        },
        {
            "path": "/domains/{domain_id}/transfer/resend_approval_email",
            "operations": [
                {
                    "method": "POST",
                    "summary": "resend transfer approval email",
                    "nickname": "resend transfer approval email",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "domain_id",
                            "type": "integer",
                            "required": true,
                            "description": "Domain ID"
                        },
                        {
                            "paramType": "form",
                            "name": "customer_id",
                            "type": "integer",
                            "description": "Customer Id."
                        }
                    ],
                    "notes": "resend transfer approval email "
                }
            ]
        }
    ]
}