{"openapi":"3.0.3","info":{"title":"RRPProxy REST API","description":"This is the RRPProxy RESTful API","version":"2.0.0-ote.12","termsOfService":"https://www.rrpproxy.net/Legal/Terms_und_Conditions","contact":{"name":"RRPProxy Support","email":"support@rrpproxy.net","url":"https://www.rrpproxy.net/Contact/Contact_Form"}},"servers":[{"url":"https://rest-ote.rrpproxy.net/v1"}],"paths":{"/account":{"get":{"operationId":"statusAccount","summary":"XRRP command StatusAccount (statusAccount)","description":"\n","tags":["account"],"parameters":[{"name":"registrar","in":"query","schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","description":"Amount: Current amount used in the account"},"credit":{"type":"string","format":"decimal","description":"Credit: The credit available in the account"},"credit_threshold":{"type":"string","format":"decimal","description":"Credit threshold: The credit threshold"},"currency":{"type":"string","description":"Currency: currency in which the account is being billed"},"registrar":{"type":"string","description":"Registrar: Name of the account"},"vat":{"type":"string","format":"decimal","description":"VAT Percentage: VAT Percentage"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusAccount"}},"/account/{registrar}":{"patch":{"operationId":"modifyAccount","summary":"XRRP command ModifyAccount (modifyAccount)","description":"\n","tags":["subreseller"],"parameters":[{"name":"registrar","in":"path","required":true,"description":"the registrar for the accounting.","schema":{"type":"string","description":"the registrar for the accounting."}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addvat":{"type":"string","nullable":true,"enum":["0","1"],"description":"determines if vat will be calculated and added to the accounting."},"amount":{"type":"string","format":"decimal","description":"the amount of the accounting."},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"createcomment":{"type":"string","nullable":true,"enum":["0","1"],"description":"determines if a registrar comment will be created for the accounting."},"currency":{"type":"string","description":"the currency of the accounting."},"domain":{"type":"string","nullable":true,"description":"the domain for the accounting."},"operator":{"type":"string","nullable":true,"description":"Changelog user who made the changes to the accounting."},"period":{"type":"integer","format":"int32","nullable":true,"description":"the period of the accounting"},"periodtype":{"type":"string","nullable":true,"description":"The periodtype of the accounting."},"reason":{"type":"string","nullable":true,"description":"the description of the accounting that will be shown in the registrar comment and in the accounting list."},"type":{"type":"string","nullable":true,"description":"the type of the accounting that will be shown as main description in the accounting list."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"amount":{"type":"string","description":"Amount accounted"},"currency":{"type":"string","description":"Currency accounted"},"email":{"type":"string","description":"Sending email status"},"exchange_currency":{"type":"string","description":"Price currency"},"exchange_rate":{"type":"string","description":"Price currency exchange rate"},"registrar":{"type":"string","description":"Registrar name"},"vat":{"type":"string","description":"Vat accounted"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyAccount"}},"/accounting":{"get":{"operationId":"queryAccountingList","summary":"XRRP command QueryAccountingList (queryAccountingList)","description":"The QueryAccountingList command gives you a detailed overview of all transactions in your account.\n","tags":["account"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"object","in":"query","description":"Show only accountings for this object","schema":{"type":"string","nullable":true,"description":"Show only accountings for this object"}},{"name":"mindate","in":"query","required":true,"description":"Search accountings younger than this date","schema":{"type":"string","format":"date","description":"Search accountings younger than this date"}},{"name":"maxdate","in":"query","description":"Search accountings older than this date","schema":{"type":"string","format":"date","description":"Search accountings older than this date"}},{"name":"registrar","in":"query","description":"Show accountings from this registrar","schema":{"type":"string","description":"Show accountings from this registrar"}},{"name":"order","in":"query","description":"Order resulting list in this direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"Order resulting list in this direction"}},{"name":"orderby","in":"query","description":"Order resulting list by this column","schema":{"type":"string","nullable":true,"enum":["ACCOUNTINGDATE","ACCOUNTINGTYPE","ACCOUNTINGOBJECT"],"description":"Order resulting list by this column"}},{"name":"wide","in":"query","description":"Show more or less details","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details"}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domains that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domains that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domains that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domains that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domains that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domains that are associated with this zone tag."}}},{"name":"accountingtype","in":"query","description":"Show only accountings for this accountingtype","schema":{"type":"string","nullable":true,"description":"Show only accountings for this accountingtype"}},{"name":"accountingpricing","in":"query","description":"Show only accountings for this accountingpricing","schema":{"type":"string","nullable":true,"enum":["STANDARD","PREMIUM","RAM"],"description":"Show only accountings for this accountingpricing"}},{"name":"skip-opening-balances","in":"query","description":"Skips the output of the opening balances to increase performance of the API call.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Skips the output of the opening balances to increase performance of the API call."}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"accounting_amount":{"type":"integer","format":"int32","description":"Accounting amount: Amount used for charging this transaction"},"accounting_currency":{"type":"string","description":"Accounting currency: Currency used to charge this transaction"},"accounting_date":{"type":"string","format":"date-time","description":"Accounting date: Date of this transaction"},"accounting_description":{"type":"string","description":"Accounting description: Description of the transaction"},"accounting_price":{"type":"string","format":"decimal","description":"Accounting price: Price charged during this transaction"},"accounting_pricing":{"type":"string","nullable":true,"description":"Accounting pricing: Shows what pricing was used to calculate the accounting e.g. PREMIUM, PROMO, RAM or STANDARD."},"accounting_total":{"type":"string","format":"decimal","description":"Accounting total price: Total amount including vat charged during this transaction"},"accounting_type":{"type":"string","description":"Accounting type: Type of the transaction"},"accounting_vat":{"type":"string","format":"decimal","description":"Accounting V.A.T.: VAT used for this transaction"},"accounting_vat_price":{"type":"string","format":"decimal","description":"Accounting V.A.T. price: V.A.T. charged during this transaction"},"exchange_currency":{"type":"string","description":"Exchange currency: Exchange currency"},"exchange_rate":{"type":"number","format":"float","description":"Exchange rate: Exchange rate used to convert the charged currency to your account currency"},"invoice_period":{"type":"string","description":"Invoice period: Period valid for this transaction"},"subreseller":{"type":"string","nullable":true,"description":"Invoice period: The registrarname of the subresller that caused this accounting"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of accountings shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"opening_balance":{"type":"string","format":"decimal","description":"Opening balance: Balance of the account at the beginning of this list"},"opening_balance_price":{"type":"string","format":"decimal","description":"Opening balance price: Balance of your account at the beginning of the list (excluded V.A.T.)"},"opening_balance_vat_price":{"type":"string","format":"decimal","description":"Opening balance V.A.T. price: V.A.T. balance of your account at the beginning of the list"},"sum":{"type":"string","format":"decimal","description":"Sum: Sum of all transactions (including V.A.T.) in this list"},"sum_price":{"type":"string","format":"decimal","description":"Sum price: Sum of all transactions in this list (excluding V.A.T.)"},"sum_vat_price":{"type":"string","format":"decimal","description":"Sum V.A.T. price: V.A.T. sum of all transactions in this list"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing accountings"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAccountingList"}},"/accounting/-/transaction":{"delete":{"operationId":"cancelTransaction","summary":"XRRP command CancelTransaction (cancelTransaction)","description":"\n","tags":["subreseller"],"parameters":[{"name":"accountingtype","in":"query","description":"the accountihng type of the transaction to cancel.","schema":{"type":"string","nullable":true,"description":"the accountihng type of the transaction to cancel."}},{"name":"commandname","in":"query","description":"the commandname of the transaction to cancel.","schema":{"type":"string","nullable":true,"description":"the commandname of the transaction to cancel."}},{"name":"date","in":"query","description":"the date and time of the transaction to cancel.","schema":{"type":"string","nullable":true,"description":"the date and time of the transaction to cancel."}},{"name":"object","in":"query","description":"the object of the transaction to cancel.","schema":{"type":"string","nullable":true,"description":"the object of the transaction to cancel."}},{"name":"registrar","in":"query","required":true,"description":"the registrar of the transaction to cancel.","schema":{"type":"string","description":"the registrar of the transaction to cancel."}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CancelTransaction"},"patch":{"operationId":"refundTransaction","summary":"XRRP command RefundTransaction (refundTransaction)","description":"\n","tags":["subreseller"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountingtype":{"type":"string","nullable":true,"description":"the accounting type of the transaction to be refunded"},"amount":{"type":"string","format":"decimal","nullable":true,"description":"the amount for the new refund accounting."},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"commandname":{"type":"string","nullable":true,"description":"the commandname of the transaction to be refunded"},"date":{"type":"string","nullable":true,"description":"the date and time of the transaction to refund."},"object":{"type":"string","nullable":true,"description":"the object of the accounting to refund."},"reason":{"type":"string","nullable":true,"description":"the reason for the new refund accounting."},"registrar":{"type":"string","description":"the registrar of the transaction to cancel."},"type":{"type":"string","nullable":true,"description":"the transaction type for the new refund accounting."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RefundTransaction"}},"/accounting/{type}/upcoming":{"get":{"operationId":"queryUpcomingAccountingList","summary":"XRRP command QueryUpcomingAccountingList (queryUpcomingAccountingList)","description":"Shows all upcoming accountings for domain names and services including the current settings for the domain names and services.\n","tags":["account"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"days","in":"query","description":"# Days: Set the number of days for the upcoming renewal accountings","schema":{"type":"integer","format":"int32","nullable":true,"description":"# Days: Set the number of days for the upcoming renewal accountings"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","ZONE","RENEWALDATE","CLASS"],"description":"Sort the result by this column"}},{"name":"type","in":"path","required":true,"description":"Objecttype: The type of the upcoming renewal accountings that should be listed","schema":{"type":"string","nullable":true,"enum":["DOMAIN","SERVER","DATABASE","WEBSPACE","RAM","TRUSTEE","OTHER","WINSERVER","SUBRESELLER"],"description":"Objecttype: The type of the upcoming renewal accountings that should be listed"}},{"name":"includesub","in":"query","description":"Include subresellers: Includes all accountings for objects on all subreseller acccounts in the list","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Include subresellers: Includes all accountings for objects on all subreseller acccounts in the list"}},{"name":"wide","in":"query","description":"Show a detailed list or a grouped list version","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show a detailed list or a grouped list version"}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domains that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domains that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domains that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domains that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domains that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domains that are associated with this zone tag."}}},{"name":"zone","in":"query","description":"Zone: Pattern match for zone for type domain","schema":{"type":"string","nullable":true,"description":"Zone: Pattern match for zone for type domain"}},{"name":"domain","in":"query","description":"Domain: Pattern match for domain name for type domain","schema":{"type":"string","nullable":true,"description":"Domain: Pattern match for domain name for type domain"}},{"name":"renewaldate","in":"query","description":"Pattern match for renewaldate","schema":{"type":"string","format":"date","nullable":true,"description":"Pattern match for renewaldate"}},{"name":"class","in":"query","description":"Class: Pattern match for class for service types","schema":{"type":"string","nullable":true,"description":"Class: Pattern match for class for service types"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","description":"Class: The type of the service or the server class"},"currency":{"type":"string","description":"Currency: Currency of the price and vat values"},"domain":{"type":"string","description":"Domain: The domain name that is up for a renewal"},"period":{"type":"integer","format":"int32","description":"Period: The period for the renewal"},"periodtype":{"type":"string","description":"Periodtype: The periodtype for the renewal"},"price":{"type":"string","format":"decimal","description":"Price: Price that will be charged for the renew"},"quantity":{"type":"integer","format":"int32","description":"Quantity: The quantity of renewals that have been grouped"},"registrar":{"type":"string","description":"Registrar: The registrar where the domain name is registered with."},"renewaldate":{"type":"string","format":"date-time","description":"Renewaldate: The date of the upcoming renewal"},"vat":{"type":"string","format":"decimal","description":"V.A.T.: V.A.T. that will be charged for the renew"},"zone":{"type":"string","description":"Zone: The zone of the domain"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of accountings shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"server":{"type":"array","description":"Server: The unique id of the server","items":{"type":"string","description":"Server: The unique id of the server"}},"sum":{"type":"string","format":"decimal","description":"Sum: Sum of all upcoming accountings in this list"},"sum_price":{"type":"string","format":"decimal","description":"Sum Price: Sum of all upcoming accountings in this list without VAT"},"sum_vat":{"type":"string","format":"decimal","description":"Sum V.A.T.: V.A.T. sum of all upcoming accountings in this list"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing accountings"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryUpcomingAccountingList"}},"/acmeaccount":{"post":{"operationId":"addACMEaccount","summary":"XRRP command AddACMEaccount (addACMEaccount)","description":"\n","tags":["acmeaccount"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addservicetag":{"type":"array","description":"Service Tag: The service tags that will be associated with this service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be associated with this service."}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"domain":{"type":"array","description":"Domain: The domains the ACME account is created with","items":{"type":"string","nullable":true,"description":"Domain: The domains the ACME account is created with"}},"period":{"type":"string","enum":["1","2","3"],"description":"Period: How many years you want to apply for this ACME account"},"product":{"type":"string","enum":["DV"],"description":"Product: The ACME product: DV"},"provider":{"type":"string","enum":["SECTIGO"],"description":"Provider: The ACME certificate provider"},"servicetag":{"type":"array","description":"Service Tag: The service tags that will be associated with this service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be associated with this service."}},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code: This parameter will be used to get the promotion - pricing, please have a look into the newsletter to see if any promotion is active"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"acmeaccount":{"type":"string","description":"The created ACME account ID"},"acmeaccount_hmac":{"type":"string","description":"HMAC key for the external account"},"acmeaccount_kid":{"type":"string","description":"Key identifier for the external account"},"acmeserverurl":{"type":"string","description":"ACME server directory URL"},"domain":{"type":"array","description":"Domain the account was requested to be created with","items":{"type":"string","description":"Domain the account was requested to be created with"}},"domain_cost":{"type":"array","description":"Cost charged for the domain; 0 when free of charge, empty on failure","items":{"type":"string","format":"decimal","nullable":true,"description":"Cost charged for the domain; 0 when free of charge, empty on failure"}},"domain_currency":{"type":"array","description":"Currency of the cost; empty on failure","items":{"type":"string","nullable":true,"description":"Currency of the cost; empty on failure"}},"domain_error":{"type":"array","description":"Error message from the service provider when DOMAIN_SUCCESS is 0; empty on success","items":{"type":"string","description":"Error message from the service provider when DOMAIN_SUCCESS is 0; empty on success"}},"domain_ordernumber":{"type":"array","description":"Order number from the service provider; empty on failure","items":{"type":"integer","format":"int32","nullable":true,"description":"Order number from the service provider; empty on failure"}},"domain_success":{"type":"array","description":"1 if the domain was successfully added at the service provider, 0 otherwise","items":{"type":"string","enum":["0","1"],"description":"1 if the domain was successfully added at the service provider, 0 otherwise"}},"error":{"type":"array","description":"Error message for a service tag that could not be created or associated","items":{"type":"string","description":"Error message for a service tag that could not be created or associated"}},"product":{"type":"string","description":"ACME product"},"status":{"type":"string","description":"Account status"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddACMEaccount"}},"/acmeaccount/-/domain":{"get":{"operationId":"checkACMEaccountDomainPrice","summary":"XRRP command CheckACMEaccountDomainPrice (checkACMEaccountDomainPrice)","description":"\n","tags":["acmeaccount"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","required":true,"description":"Domain: Domain name to be checked for price","schema":{"type":"string","description":"Domain: Domain name to be checked for price"}},{"name":"acmeaccount","in":"query","required":true,"description":"ACMEACCOUNT: The ACMEACCOUNT to be checked","schema":{"type":"string","description":"ACMEACCOUNT: The ACMEACCOUNT to be checked"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"currency":{"type":"string","description":"Currency of the price"},"domains_included":{"type":"array","description":"Associated FQDNs included in the subscription by Sectigo (e.g. www.X for a base domain)","items":{"type":"string","description":"Associated FQDNs included in the subscription by Sectigo (e.g. www.X for a base domain)"}},"period":{"type":"integer","format":"int32","description":"Total subscription days (totalSubscriptionDays from Sectigo billing breakdown)"},"periodtype":{"type":"string","description":"Period unit; always DAY"},"price":{"type":"string","format":"decimal","description":"Price for the domain"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckACMEaccountDomainPrice"}},"/acmeaccount/domains":{"get":{"operationId":"queryACMEaccountDomainList","summary":"XRRP command QueryACMEaccountDomainList (queryACMEaccountDomainList)","description":"\n","tags":["acmeaccount"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"acmeaccount","in":"query","description":"Filter the result by this string","schema":{"type":"string","nullable":true,"description":"Filter the result by this string"}},{"name":"domain","in":"query","description":"Filter the result by this string (wildcards allowed)","schema":{"type":"string","nullable":true,"description":"Filter the result by this string (wildcards allowed)"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","REGISTRATION_EXPIRATION_DATE"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"includesub","in":"query","description":"Include subresellers: Includes all accountings for all subreseller acccounts in the list.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Include subresellers: Includes all accountings for all subreseller acccounts in the list."}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"acmeaccount":{"type":"array","description":"ACME account ID","items":{"type":"string","description":"ACME account ID"}},"basedomain":{"type":"array","description":"Base domain that made this domain free, if applicable","items":{"type":"string","nullable":true,"description":"Base domain that made this domain free, if applicable"}},"column":{"type":"array","description":"Column names returned in the result set","items":{"type":"string","description":"Column names returned in the result set"}},"count":{"type":"integer","format":"int32","description":"Number of results returned"},"created_by":{"type":"array","description":"Registrar who created the entry","items":{"type":"string","description":"Registrar who created the entry"}},"created_date":{"type":"array","description":"Creation date","items":{"type":"string","format":"date","description":"Creation date"}},"domain":{"type":"array","description":"Domain name","items":{"type":"string","description":"Domain name"}},"first":{"type":"integer","format":"int32","description":"Index of the first result returned"},"last":{"type":"integer","format":"int32","description":"Index of the last result returned"},"limit":{"type":"integer","format":"int32","description":"Maximum number of results per page"},"registrar":{"type":"array","description":"Owning registrar; only returned with WIDE and INCLUDESUB","items":{"type":"string","description":"Owning registrar; only returned with WIDE and INCLUDESUB"}},"registration_expiration_date":{"type":"array","description":"Domain subscription expiration date","items":{"type":"string","format":"date","description":"Domain subscription expiration date"}},"total":{"type":"integer","format":"int32","description":"Total number of matching results"},"updated_by":{"type":"array","description":"Last user to update the entry","items":{"type":"string","description":"Last user to update the entry"}},"updated_date":{"type":"array","description":"Date of the last update","items":{"type":"string","format":"date","description":"Date of the last update"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryACMEaccountDomainList"}},"/acmeaccount/servers":{"get":{"operationId":"queryACMEaccountServerList","summary":"XRRP command QueryACMEaccountServerList (queryACMEaccountServerList)","description":"\n","tags":["acmeaccount"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"provider","in":"query","description":"ACME provider: The ACME provider to get server URL; if omitted all providers are returned","schema":{"type":"string","enum":["SECTIGO"],"description":"ACME provider: The ACME provider to get server URL; if omitted all providers are returned"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"acmeserverurl":{"type":"array","description":"ACME server directory URL","items":{"type":"string","description":"ACME server directory URL"}},"column":{"type":"array","description":"List columns","items":{"type":"string","description":"List columns"}},"product":{"type":"array","description":"ACME product supported by this server","items":{"type":"string","description":"ACME product supported by this server"}},"provider":{"type":"array","description":"ACME certificate provider","items":{"type":"string","description":"ACME certificate provider"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryACMEaccountServerList"}},"/acmeaccount/{acmeaccount}":{"delete":{"operationId":"deleteACMEaccount","summary":"XRRP command DeleteACMEaccount (deleteACMEaccount)","description":"\n","tags":["acmeaccount"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"acmeaccount","in":"path","required":true,"description":"ACMEACCOUNT: The ACMEACCOUNT to be deleted","schema":{"type":"string","description":"ACMEACCOUNT: The ACMEACCOUNT to be deleted"}},{"name":"instant","in":"query","description":"If 1, permanently deactivate the account at the CA immediately (irreversible). Default: 0 (restorable within grace period)","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"If 1, permanently deactivate the account at the CA immediately (irreversible). Default: 0 (restorable within grace period)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteACMEaccount"},"get":{"operationId":"statusACMEaccount","summary":"XRRP command StatusACMEaccount (statusACMEaccount)","description":"\n","tags":["acmeaccount"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"acmeaccount","in":"path","required":true,"description":"ACME account: The ACME account ID","schema":{"type":"string","description":"ACME account: The ACME account ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"acmeaccount":{"type":"string","description":"The ACME account ID"},"acmeaccount_hmac":{"type":"string","description":"HMAC key for the external account"},"acmeaccount_kid":{"type":"string","description":"Key identifier for the external account"},"acmeserverurl":{"type":"string","description":"ACME server URL"},"created_by":{"type":"string","description":"Registrar who created the account"},"created_date":{"type":"string","format":"date","description":"Creation date"},"ipaddress":{"type":"string","description":"IP address of the ACME client"},"last_activity_date":{"type":"string","format":"date","description":"Date of the last activity on the account"},"paid_until_date":{"type":"string","format":"date","description":"Date until the subscription is paid"},"product":{"type":"string","description":"ACME product"},"provider":{"type":"string","description":"Certificate provider"},"registrar":{"type":"string","description":"Owning registrar"},"registration_expiration_date":{"type":"string","format":"date","description":"Subscription expiration date"},"renewal_date":{"type":"string","format":"date","description":"Date on which automatic renewal will be attempted"},"renewalmode":{"type":"string","description":"Renewal mode"},"status":{"type":"string","description":"Account status"},"updated_by":{"type":"string","description":"Last user to update the account"},"updated_date":{"type":"string","format":"date","description":"Date of the last update"},"useragent":{"type":"string","description":"User agent string of the ACME client"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusACMEaccount"},"patch":{"operationId":"modifyACMEaccount","summary":"XRRP command ModifyACMEaccount (modifyACMEaccount)","description":"\n","tags":["acmeaccount"],"parameters":[{"name":"acmeaccount","in":"path","required":true,"description":"ACME account: The ACME account ID","schema":{"type":"string","description":"ACME account: The ACME account ID"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"adddomain":{"type":"array","description":"Add new domains to the account","items":{"type":"string","nullable":true,"description":"Add new domains to the account"}},"addservicetag":{"type":"array","description":"Service Tag: The service tags that will be added to the service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be added to the service."}},"checkonly":{"type":"string","nullable":true,"enum":["0","1"],"description":"Check only mode: If set to 1, check and return domain prices without applying any changes"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"deldomain":{"type":"array","description":"Remove domains from the account","items":{"type":"string","nullable":true,"description":"Remove domains from the account"}},"delservicetag":{"type":"array","description":"Service Tag: The service tags that will be deleted from the service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be deleted from the service."}},"servicetag":{"type":"array","description":"Service Tag: The service tags that will be associated with this service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be associated with this service."}},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code: This parameter will be used to get the promotion - pricing, please have a look into the newsletter to see if any promotion is active"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"adddomain_class":{"type":"array","description":"Whether adding the domain would be charged or is free; only returned with CHECKONLY","items":{"type":"string","enum":["charged","free"],"description":"Whether adding the domain would be charged or is free; only returned with CHECKONLY"}},"adddomain_cost":{"type":"array","description":"Price charged to the registrar for adding the domain, or the price it would be charged with CHECKONLY; 0 for free domains, empty on failure","items":{"type":"string","format":"decimal","nullable":true,"description":"Price charged to the registrar for adding the domain, or the price it would be charged with CHECKONLY; 0 for free domains, empty on failure"}},"adddomain_currency":{"type":"array","description":"Currency of ADDDOMAIN_COST; empty on failure","items":{"type":"string","nullable":true,"description":"Currency of ADDDOMAIN_COST; empty on failure"}},"adddomain_domain":{"type":"array","description":"Domain that was requested to be added","items":{"type":"string","description":"Domain that was requested to be added"}},"adddomain_error":{"type":"array","description":"Error message from the service provider when ADDDOMAIN_SUCCESS is 0; empty on success","items":{"type":"string","description":"Error message from the service provider when ADDDOMAIN_SUCCESS is 0; empty on success"}},"adddomain_ordernumber":{"type":"array","description":"Order number from the service provider; empty on failure","items":{"type":"integer","format":"int32","nullable":true,"description":"Order number from the service provider; empty on failure"}},"adddomain_period":{"type":"array","description":"Number of period units the cost covers; only returned with CHECKONLY","items":{"type":"integer","format":"int32","description":"Number of period units the cost covers; only returned with CHECKONLY"}},"adddomain_periodtype":{"type":"array","description":"Period unit; only returned with CHECKONLY","items":{"type":"string","description":"Period unit; only returned with CHECKONLY"}},"adddomain_success":{"type":"array","description":"1 if the domain was successfully added at the service provider, 0 otherwise","items":{"type":"string","enum":["0","1"],"description":"1 if the domain was successfully added at the service provider, 0 otherwise"}},"deldomain_domain":{"type":"array","description":"Domain that was requested to be removed","items":{"type":"string","description":"Domain that was requested to be removed"}},"deldomain_error":{"type":"array","description":"Error message from the service provider when DELDOMAIN_SUCCESS is 0; empty on success","items":{"type":"string","description":"Error message from the service provider when DELDOMAIN_SUCCESS is 0; empty on success"}},"deldomain_success":{"type":"array","description":"1 if the domain was successfully removed at the registry, 0 otherwise","items":{"type":"string","enum":["0","1"],"description":"1 if the domain was successfully removed at the registry, 0 otherwise"}},"error":{"type":"array","description":"Error message for a service tag that could not be created or associated","items":{"type":"string","description":"Error message for a service tag that could not be created or associated"}},"registration_expiration_date":{"type":"string","format":"date","description":"New subscription expiration date, returned when the first domain is added"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyACMEaccount"}},"/acmeaccount/{acmeaccount}/renew":{"patch":{"operationId":"renewACMEaccount","summary":"XRRP command RenewACMEaccount (renewACMEaccount)","description":"\n","tags":["acmeaccount"],"parameters":[{"name":"acmeaccount","in":"path","required":true,"description":"ACMEACCOUNT: The ACMEACCOUNT to be renewed","schema":{"type":"string","description":"ACMEACCOUNT: The ACMEACCOUNT to be renewed"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"checkonly":{"type":"string","nullable":true,"enum":["0","1"],"description":"Check only mode: If set to 1, check and return price without applying any changes"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"expirationdate":{"type":"integer","format":"int32","description":"Current expiration year: The current expiration year of the ACME account (May be checked with StatusACMEaccount)."},"period":{"type":"string","enum":["1","2","3"],"description":"Period: The amount of years, you want to renew the acmeaccount"},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code: This parameter will be used to get the promotion - pricing, please have a look into the newsletter to see if any promotion is active"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"currency":{"type":"string","description":"Currency of the price (returned on CHECKONLY)"},"period":{"type":"integer","format":"int32","description":"Number of period units for the renewal (returned on CHECKONLY)"},"periodtype":{"type":"string","description":"Period unit for the renewal (returned on CHECKONLY)"},"price":{"type":"string","format":"decimal","description":"Price for the renewal period (returned on CHECKONLY)"},"registration_expiration_date":{"type":"string","format":"date","description":"Expiration date: The new expiration date of the ACME account"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RenewACMEaccount"}},"/acmeaccount/{acmeaccount}/renewalmode":{"put":{"operationId":"setACMEaccountRenewalMode","summary":"XRRP command SetACMEaccountRenewalMode (setACMEaccountRenewalMode)","description":"This command allows you to change the renewal mode for a domain name.\n","tags":["acmeaccount"],"parameters":[{"name":"acmeaccount","in":"path","required":true,"description":"ACMEACCOUNT: The ACMEACCOUNT to change the renewal mode for","schema":{"type":"string","description":"ACMEACCOUNT: The ACMEACCOUNT to change the renewal mode for"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"renewalmode":{"type":"string","enum":["DEFAULT","AUTORENEW","AUTOEXPIRE","AUTODELETE"],"description":"Renewalmode: The ACME account mode for renewals"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"SetACMEaccountRenewalMode"}},"/acmeaccount/{acmeaccount}/restore":{"patch":{"operationId":"restoreACMEaccount","summary":"XRRP command RestoreACMEaccount (restoreACMEaccount)","description":"\n","tags":["acmeaccount"],"parameters":[{"name":"acmeaccount","in":"path","required":true,"description":"ACMEACCOUNT: The ACMEACCOUNT to be restored","schema":{"type":"string","description":"ACMEACCOUNT: The ACMEACCOUNT to be restored"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code: This parameter will be used to get the promotion - pricing, please have a look into the newsletter to see if any promotion is active"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RestoreACMEaccount"}},"/aftermarket":{"get":{"operationId":"queryAftermarketList","summary":"XRRP command QueryAftermarketList (queryAftermarketList)","description":"Search domains in the aftermarket. The searchterm is given by \"KEYWORD\".\n","tags":["aftermarket"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"keyword","in":"query","required":true,"description":"Return domains belonging to this keyword","schema":{"type":"string","description":"Return domains belonging to this keyword"}},{"name":"minlength","in":"query","description":"Min. Length: Search only for domains longer than this (AfterNIC)","schema":{"type":"integer","format":"int32","nullable":true,"description":"Min. Length: Search only for domains longer than this (AfterNIC)"}},{"name":"maxlength","in":"query","description":"Max. Length: Search only for domains shorter than this (AfterNIC)","schema":{"type":"integer","format":"int32","nullable":true,"description":"Max. Length: Search only for domains shorter than this (AfterNIC)"}},{"name":"minprice","in":"query","description":"Min. price: Search only for domains more expensive than this","schema":{"type":"string","format":"decimal","description":"Min. price: Search only for domains more expensive than this"}},{"name":"maxprice","in":"query","description":"Max. price: Search only for domains less expensive than this","schema":{"type":"string","format":"decimal","description":"Max. price: Search only for domains less expensive than this"}},{"name":"filter","in":"query","description":"Filter: Don't search for domains containing this","schema":{"type":"string","description":"Filter: Don't search for domains containing this"}},{"name":"offensive","in":"query","description":"Offensive: Filter out domains with offensive or adult words. Default is \"0\" (don't filter anything) (SEDO)","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Offensive: Filter out domains with offensive or adult words. Default is \"0\" (don't filter anything) (SEDO)"}},{"name":"listingtype","in":"query","description":"Listing type: Type of listing to be searched","schema":{"type":"string","nullable":true,"description":"Listing type: Type of listing to be searched"}},{"name":"provider","in":"query","required":true,"description":"Provider: Which aftermarket provider to search","schema":{"type":"string","enum":["sedo"],"description":"Provider: Which aftermarket provider to search"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: Domain for sale"},"listing_type":{"type":"string","enum":["make_offer","buy_now staged_transfer","buy_now instant_transfer","fasttransfer","normal"],"description":"Type of listing: The type of listing on the aftermarket platform"},"minimum_offer":{"type":"string","format":"decimal","description":"Minimum offer: Minimum (non binding) offer the seller asks for"},"minimum_price":{"type":"string","format":"decimal","description":"Minimum price: Sellers desired target price"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: The provider this listing is from"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of domains shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"sedocode":{"type":"string","description":"Sedo code: Sedo code"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAftermarketList"}},"/aftermarket/account":{"get":{"operationId":"queryAftermarketAccountList","summary":"XRRP command QueryAftermarketAccountList (queryAftermarketAccountList)","description":"A list of all configured Aftermarket Accounts in this RRPproxy Account\n","tags":["aftermarket"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"aftermarketaccount","in":"query","description":"Aftermarket Account: Filter the result by this string (wildcard allowed)","schema":{"type":"string","description":"Aftermarket Account: Filter the result by this string (wildcard allowed)"}},{"name":"description","in":"query","description":"Description: Filter the result by this string (wildcard allowed)","schema":{"type":"string","description":"Description: Filter the result by this string (wildcard allowed)"}},{"name":"accountkey","in":"query","description":"Accountkey: Filter the result by this string (wildcard allowed)","schema":{"type":"string","description":"Accountkey: Filter the result by this string (wildcard allowed)"}},{"name":"provider","in":"query","description":"Provider: Filter the result by this string (wildcard allowed)","schema":{"type":"string","description":"Provider: Filter the result by this string (wildcard allowed)"}},{"name":"order","in":"query","description":"The sorting direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sorting direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["AFTERMARKETACCOUNT","DESCRIPTION","ACOUNTKEY","PROVIDER"],"description":"Sort the result by this column"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"accountkey":{"type":"string","description":"Accountkey: The associated accountapikey from the aftermarket provider"},"aftermarketaccount":{"type":"string","description":"Aftermarket account: Token to identify the aftermarket account"},"count":{"type":"integer","format":"int32","description":"Count: Total number of accounts shown"},"description":{"type":"string","description":"Description: The freetext description of this account"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"listed_domains":{"type":"integer","format":"int32","description":"Listed domains: How many domains are listed with this account"},"login_successful":{"type":"string","enum":["0","1"],"description":"Login successful: Determines if the login at the aftermarket was successful for this account"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Aftermarket platform where this process was initiated"},"total":{"type":"integer","format":"int32","description":"Total: Total number of aftermarket accounts"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAftermarketAccountList"},"post":{"operationId":"addAftermarketAccount","summary":"XRRP command AddAftermarketAccount (addAftermarketAccount)","description":"To add your Aftermarket Account via API, please use this command.\n","tags":["aftermarket"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountkey":{"type":"string","description":"Accountkey: The Aftermarket Accountkey"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"description":{"type":"string","description":"Description: Freetext for easier identification, could be set to the accountname used by the endcustomer or similar"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Provider of the Aftermarket Account"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"aftermarketaccount":{"type":"string","description":"Aftermarket Account: Unique identifier of the account"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddAftermarketAccount"}},"/aftermarket/account/{aftermarketaccount}":{"delete":{"operationId":"deleteAftermarketAccount","summary":"XRRP command DeleteAftermarketAccount (deleteAftermarketAccount)","description":"To remove access to an aftermarket - account from our system. This is only possible if no domain is listed on this account.\n","tags":["aftermarket"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"aftermarketaccount","in":"path","required":true,"description":"Aftermarket account: Unique identifier of the account","schema":{"type":"string","description":"Aftermarket account: Unique identifier of the account"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteAftermarketAccount"},"get":{"operationId":"statusAftermarketAccount","summary":"XRRP command StatusAftermarketAccount (statusAftermarketAccount)","description":"Shows the total number of domains currently listed via an Aftermarket Account and the \"health\" of the account\n","tags":["aftermarket"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"aftermarketaccount","in":"path","required":true,"description":"Aftermarket account: Unique identifier of the account","schema":{"type":"string","description":"Aftermarket account: Unique identifier of the account"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"accountkey":{"type":"string","description":"Accountkey: Accountkey used at the aftermarket provider"},"aftermarketaccount":{"type":"string","description":"Aftermarket account: Unique identifier of the account"},"description":{"type":"string","description":"Description: Freetext for easier identification"},"listed_domains":{"type":"integer","format":"int32","description":"Listed domains: Number of domains listed using this account"},"login_successful":{"type":"string","enum":["0","1"],"description":"Login successful: Identifies if the login at the aftermarket - provider was successful (i.e. the accountkey is correct)"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Provider of the Aftermarket Account"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusAftermarketAccount"},"patch":{"operationId":"modifyAftermarketAccount","summary":"XRRP command ModifyAftermarketAccount (modifyAftermarketAccount)","description":"To change your Aftermarket Account Key or the description associated with the respective Aftermarket Account via API, please use this command.\n","tags":["aftermarket"],"parameters":[{"name":"aftermarketaccount","in":"path","required":true,"description":"Aftermarket account: Unique identifier of the account","schema":{"type":"string","description":"Aftermarket account: Unique identifier of the account"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountkey":{"type":"string","description":"Accountkey: If the Account Key changed at the Aftermarket Provider and a different key is provided, the command will return an error. If this parameter is left empty, it won’t be changed in your RRPproxy account"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"description":{"type":"string","description":"Description: Freetext for easier identification. Will be overwritten if this parameter is passed along without content"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyAftermarketAccount"}},"/aftermarket/approval":{"get":{"operationId":"queryAftermarketApprovalList","summary":"XRRP command QueryAftermarketApprovalList (queryAftermarketApprovalList)","description":"Query all initiated aftermarket processes\n","tags":["aftermarket"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"confirmationemail":{"type":"string","description":"Email: Where the confirmation token was sent"},"confirmationsent":{"type":"string","format":"date","description":"Confirmation sent: Time when the confirmationtoken was sent"},"contact":{"type":"string","description":"Contact: Contact which the domain belongs to while in sale"},"count":{"type":"integer","format":"int32","description":"Count: Total number of processes shown"},"domain":{"type":"string","description":"Domain: Domain(s) of this pending approval"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"group":{"type":"string","description":"Token: Group id to identify a sales process"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Aftermarket platform where this process was initiated"},"status":{"type":"string","enum":["FREE","TOKENSEND","ONHOLD","FOA_SENT","INITIATED"],"description":"Status: Current status of the approval"},"total":{"type":"integer","format":"int32","description":"Total: Total number of aftermarket processes"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAftermarketApprovalList"}},"/aftermarket/bid":{"get":{"operationId":"queryAftermarketBidList","summary":"XRRP command QueryAftermarketBidList (queryAftermarketBidList)","description":"Query all initiated aftermarket processes\n","tags":["aftermarket"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"bid":{"type":"string","format":"decimal","description":"Bid: The currently hightest bid / price"},"bidstatus":{"type":"string","enum":["INITIATED","FAILED","SUCCESS","WAITINGFORAUTH","INTRANSFER"],"description":"Status: Status of the process"},"count":{"type":"integer","format":"int32","description":"Count: Total number of processes shown"},"direction":{"type":"string","enum":["INCOMING"],"description":"Direction: Direction of the aftermarket process"},"domain":{"type":"string","description":"Domain: The domain which this process is about"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Aftermarket platform where this process was initiated"},"token":{"type":"string","description":"Token: Token to identify an auctioning process"},"total":{"type":"integer","format":"int32","description":"Total: Total number of aftermarket processes"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAftermarketBidList"}},"/aftermarket/bid/{domain}":{"patch":{"operationId":"aftermarketBid","summary":"XRRP command AftermarketBid (aftermarketBid)","description":"This command is used to accept a counteroffer or give a new bid in an auction. An auction is started with an optional ReserveDomain followed by BuyDomain if BuyDomain returnes \"bidding = 1\"\n","tags":["aftermarket"],"parameters":[{"name":"domain","in":"path","required":true,"description":"The domauin, what this bid is about","schema":{"type":"string","description":"The domauin, what this bid is about"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["bid","accept","counter"]},"bid":{"type":"string","format":"decimal","description":"The new bid"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"token":{"type":"string","description":"Token to identify the process"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AftermarketBid"},"post":{"operationId":"buyDomain","summary":"XRRP command BuyDomain (buyDomain)","description":"Start a bid on a domain or directly buy a domain in the aftermarket. A domain may be reserved previously via ReserveDomain. If the buying - process uses direct buy, no further action needs to be done. Domains where the seller needs to approve the bid, go into an auctioning process (see AftermarketBid)\n","tags":["aftermarket"],"parameters":[{"name":"domain","in":"path","required":true,"description":"Domain: The domain to be bought","schema":{"type":"string","description":"Domain: The domain to be bought"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bid":{"type":"string","format":"decimal","description":"Price: Price to buy the domain for"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"contact":{"type":"string","description":"Contact: Contact used to buy the domain, will be used for all contacthandles after the transfer"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Where to buy the domain"},"token":{"type":"string","nullable":true,"description":"Token: Token used to reserve a domain"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"bidding":{"type":"string","enum":["0","1"],"description":"Bidding: Determines if this process was a direct buy or auctioning was enabled"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Provider, where the process was initialized"},"status":{"type":"string","enum":["pending","processing"],"description":"Status: Status of the buying process"},"token":{"type":"string","description":"Token: Token to identify this process in our system"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"BuyDomain"}},"/aftermarket/domain":{"get":{"operationId":"queryAftermarketDomainList","summary":"XRRP command QueryAftermarketDomainList (queryAftermarketDomainList)","description":"Returns a list of all Domains in your RRPproxy account that are currently listed for sale through the Aftermarket System. Offers parameters to narrow down the resulting response.\n","tags":["aftermarket"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["AFTERMARKETDOMAIN","AFTERMARKETACCOUNT","DOMAIN","PRICE","STATUS","LISTINGTYPE","PROVIDER"],"description":"Sort the result by this column"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"aftermarketaccount":{"type":"string","description":"Aftermarket account: Token to identify the aftermarket account a domain resided on"},"aftermarketdomain":{"type":"string","description":"Aftermarket Domain: Token to describe a unique aftermarket process"},"domain":{"type":"string","description":"Domain: The listed domain"},"listingtype":{"type":"string","enum":["make_offer","buy_now"],"description":"Listing type: Type of the listing"},"price":{"type":"string","format":"decimal","description":"Price: The price for which this domain is on sale for"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Aftermarket platform where this process was initiated"},"status":{"type":"string","enum":["FOA_PENDING","UNLISTED","LISTED","SUCCESS"],"description":"Listing status: Status of the listing"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of domains shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of aftermarket domains"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAftermarketDomainList"},"post":{"operationId":"addAftermarketDomain","summary":"XRRP command AddAftermarketDomain (addAftermarketDomain)","description":"Adding a Domain for selling via the Aftermarket System requires the statement of:\n\n\tthe Domain name (needs to be managed by the same registrar in RRPproxy),\n\tthe identifier of the Aftermarket Account, \n\ta Price, with minimum of 90 USD (in account currency) is required,\n\tthe type of listing, make_offer (offers can be made) or buy_now (price is fixed) and\n\tthe Aftermarket Provider.\n\t\nThe successful command always returns an alphanumerical token to identify the listing (AFTERMARKETDOMAIN). If multiple domains are listed at once, PRICE0 is used for DOMAIN0, PRICE1 for DOMAIN1 etc. \n\nAfter a domain has been added to the Aftermarket System, a Form Of Authorisation (FOA) email will be sent to the Admin Contacts of the respective domain. If several domains with the same Admin Contact are added, only one FOA email for these domains will be sent, if the domains are added within a 5 minute timeframe.\n\nThe FOA email contains a link including an approval code to aftermarketapproval.com to activate the listing. The respective URL for approving Sedo listings is http://sedo.aftermarketapproval.com/\n\nOnce the Admin Contact approved the listing, the respective domain(s) will be submitted for listing at the selected provider. If after 5 days no approval is received, the domain will automatically be removed from the Aftermarket System in RRPproxy.\n","tags":["aftermarket"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"aftermarketaccount":{"type":"string","description":"Aftermarket account: Identifier of the account where the domain shall be listed"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"domain":{"type":"array","description":"Domain: The domain to be sold","items":{"type":"string","description":"Domain: The domain to be sold"}},"listingtype":{"type":"string","enum":["buy_now","make_offer"],"description":"Listing type: How the domain should be listed on the aftermarket"},"price":{"type":"array","description":"Price: The price the domain should be sold for","items":{"type":"integer","format":"int32","description":"Price: The price the domain should be sold for"}},"provider":{"type":"string","enum":["sedo"],"description":"Provider"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"aftermarketdomain#":{"type":"string","description":"Aftermarketdomain: The ID of the domain to be sold"},"domain#":{"type":"string","description":"Domain: The domain listed for sale"},"status#":{"type":"string","enum":["FOA_PENDING"],"description":"Status"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddAftermarketDomain"}},"/aftermarket/domain/{aftermarketdomain}":{"delete":{"operationId":"deleteAftermarketDomain","summary":"XRRP command DeleteAftermarketDomain (deleteAftermarketDomain)","description":"To permanently remove a domain from an aftermarket and not only remove it from a listing, this command may be used\n","tags":["aftermarket"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"aftermarketdomain","in":"path","required":true,"description":"Token: Unique token to identify the process","schema":{"type":"string","description":"Token: Unique token to identify the process"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"status":{"type":"string","enum":["DELETED","DELETE PENDING"],"description":"Status: The listing status"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteAftermarketDomain"},"get":{"operationId":"statusAftermarketDomain","summary":"XRRP command StatusAftermarketDomain (statusAftermarketDomain)","description":"Requires the identifier token for a listing. Returns the listed domain, price, status at the Aftermarket Provider, listing type and the used Aftermarket Provider.\n","tags":["aftermarket"],"parameters":[{"name":"aftermarketdomain","in":"path","required":true,"description":"Token: The ID of the domain","schema":{"type":"string","description":"Token: The ID of the domain"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"aftermarketaccount":{"type":"string","description":"Aftermarket Account: The Aftermarket Account used to sell this domain"},"aftermarketdomain":{"type":"string","description":"Aftermarket Domain: The ID of the domain to be sold"},"domain":{"type":"string","description":"Domain: The domain listed for sale"},"listed":{"type":"string","enum":["0","1"],"description":"Listed"},"listingtype":{"type":"string","enum":["make_offer","buy_now"],"description":"Listing type: How the domain should be listed on the aftermarket"},"price":{"type":"string","format":"decimal","description":"Price: The price the domain should is sold for"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Which aftermarket provider is used"},"status":{"type":"string","enum":["FOA_PENDING","SUCCESS","LISTED","UNLISTED"],"description":"Status: Status of the domain"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusAftermarketDomain"},"patch":{"operationId":"modifyAftermarketDomain","summary":"XRRP command ModifyAftermarketDomain (modifyAftermarketDomain)","description":"The listing at the Aftermarket Provider can be changed by updating the price, the type of listing (auction or fixed price) or temporarily remove the domain from the listing, but keeping it in the system.\n","tags":["aftermarket"],"parameters":[{"name":"aftermarketdomain","in":"path","required":true,"description":"Aftermarket domain: The ID of the domain to be sold","schema":{"type":"string","description":"Aftermarket domain: The ID of the domain to be sold"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"listed":{"type":"string","nullable":true,"enum":["0","1"],"description":"Listed: Change the status of the listing"},"listingtype":{"type":"string","nullable":true,"enum":["buy_now","make_offer"],"description":"Listing type: How the domain should be listed on the aftermarket"},"price":{"type":"string","format":"decimal","description":"Price: The price the domain should be sold for (\u003e90USD)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"aftermarketdomain":{"type":"string","description":"Aftermarketdomain: The ID of the domain to be sold"},"domain":{"type":"string","description":"Domain: The domain listed for sale"},"status":{"type":"string","enum":["LISTED","UNLISTED"]}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyAftermarketDomain"}},"/aftermarket/{domain}/reserve":{"post":{"operationId":"reserveDomain","summary":"XRRP command ReserveDomain (reserveDomain)","description":"Reserve a domain in the aftermarket. The domain will be reserved for 8 hours. To later buy the domain, use BuyDomain with the token returned from this command.\n","tags":["aftermarket"],"parameters":[{"name":"domain","in":"path","required":true,"description":"Domain: The domain to be bought","schema":{"type":"string","description":"Domain: The domain to be bought"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bid":{"type":"string","format":"decimal","description":"Price: Price to buy the domain for"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"contact":{"type":"string","description":"Contact: Contact used to buy the domain, will be used for all contacthandles after the transfer"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Where to buy the domain"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"expires":{"type":"string","format":"date","description":"Expiry date: Date the hold expires (if returned by provider)"},"provider":{"type":"string","enum":["sedo"],"description":"Provider: Provider, where the process was initialized"},"token":{"type":"string","description":"Token: Token to identify this process in our system"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ReserveDomain"}},"/appendix":{"get":{"operationId":"queryAppendixList","summary":"XRRP command QueryAppendixList (queryAppendixList)","description":"\n","tags":["registrar"],"parameters":[{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["APPENDIX"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","description":"Shows additional data for each subreseller.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows additional data for each subreseller."}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","enum":["0","1"],"description":"Activate: Indicates if the appendix already activated"},"appendix":{"type":"string","description":"Appendix: Name of the appendix"}}}},"property":{"type":"object","properties":{"activation_date":{"type":"array","description":"Activation date: When was the appendix activated","items":{"type":"string","format":"date","description":"Activation date: When was the appendix activated"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of appendices shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of appendices"},"zones":{"type":"array","description":"Zones: Zones integrated in the appendix","items":{"type":"string","description":"Zones: Zones integrated in the appendix"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAppendixList"}},"/appendix/{appendix}":{"get":{"operationId":"getAppendix","summary":"XRRP command GetAppendix (getAppendix)","description":"\n","tags":["registrar"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"appendix","in":"path","required":true,"description":"The name of the appendix you want to show","schema":{"type":"string","nullable":true,"description":"The name of the appendix you want to show"}},{"name":"zone","in":"query","description":"Zone for which you want to get the appendix","schema":{"type":"string","nullable":true,"description":"Zone for which you want to get the appendix"}},{"name":"service","in":"query","description":"Service for which you want to get the appendix","schema":{"type":"string","nullable":true,"description":"Service for which you want to get the appendix"}},{"name":"type","in":"query","description":"Class of the service for which you want to get the appendix","schema":{"type":"string","nullable":true,"description":"Class of the service for which you want to get the appendix"}},{"name":"language","in":"query","description":"Language of the appendix content and changelog you want to show.","schema":{"type":"string","nullable":true,"enum":["EN","DE"],"description":"Language of the appendix content and changelog you want to show."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"activation_date":{"type":"string","format":"date-time","nullable":true,"description":"Activation date: When the appendix was activated."},"active":{"type":"integer","format":"int32","description":"Active: If the appendix was agreed and the zones of the appendix are active in the account."},"appendix":{"type":"string","description":"Appendix: The appendix for the requested zone"},"changelog":{"type":"array","description":"Changelog: Changelog prior to last version.","items":{"type":"string","description":"Changelog: Changelog prior to last version."}},"content":{"type":"array","description":"Content: BASE64 encoded appendix content","items":{"type":"string","description":"Content: BASE64 encoded appendix content"}},"version":{"type":"number","format":"float","description":"Version: When the domain was last updated, if never it's the same like the created date"},"zone":{"type":"array","description":"Zone: Zone contained in the appendix","items":{"type":"string","nullable":true,"description":"Zone: Zone contained in the appendix"}},"zones":{"type":"string","nullable":true,"description":"Zones: All zones contained in the appendix"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"GetAppendix"},"patch":{"operationId":"activateAppendix","summary":"XRRP command ActivateAppendix (activateAppendix)","description":"\n","tags":["registrar"],"parameters":[{"name":"appendix","in":"path","required":true,"description":"The appendix to be activated","schema":{"type":"string","description":"The appendix to be activated"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"x-accept-tac":{"type":"string","enum":["1","0"],"description":"Accept the terms and conditions explained in the appendix"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"email":{"type":"string","enum":["failed","successful"],"description":"Email: Indicate, if the email with details about the appendix has been sent1"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ActivateAppendix"}},"/certificate":{"get":{"operationId":"queryCertificateList","summary":"XRRP command QueryCertificateList (queryCertificateList)","description":"\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"admincontact","in":"query","schema":{"type":"string"}},{"name":"approveremail","in":"query","schema":{"type":"string"}},{"name":"billingcontact","in":"query","schema":{"type":"string"}},{"name":"certificate","in":"query","schema":{"type":"string"}},{"name":"certificateorder","in":"query","schema":{"type":"string"}},{"name":"createddate","in":"query","schema":{"type":"string"}},{"name":"domain","in":"query","schema":{"type":"string"}},{"name":"ownercontact","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"techcontact","in":"query","schema":{"type":"string"}},{"name":"webservertype","in":"query","schema":{"type":"string"}},{"name":"servertype","in":"query","schema":{"type":"string"}},{"name":"updateddate","in":"query","schema":{"type":"string"}},{"name":"expirationdate","in":"query","schema":{"type":"string"}},{"name":"class","in":"query","schema":{"type":"string"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version","schema":{"type":"string","nullable":true,"enum":["1","2"],"description":"API version: Select the used API version"}},{"name":"includesub","in":"query","description":"Include subresellers: Includes all accountings for certificates on all subreseller acccounts in the list.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Include subresellers: Includes all accountings for certificates on all subreseller acccounts in the list."}},{"name":"servicetag","in":"query","description":"Service Tag: Show only services that are associated with this service tag.","schema":{"type":"array","description":"Service Tag: Show only services that are associated with this service tag.","items":{"type":"string","nullable":true,"description":"Service Tag: Show only services that are associated with this service tag."}}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is CERTIFICATE.","schema":{"type":"string","nullable":true,"enum":["CERTIFICATE","STATUS","CERTIFICATEORDER","SERVERTYPE","CREATEDDATE","UPDATEDDATE","EXPIRATIONDATE","CLASS"],"description":"Order the results for the corresponding column. Default is CERTIFICATE."}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"class":{"type":"string","description":"Certificate class: The class of the certificate"},"created_date":{"type":"string","format":"date-time","description":"Created date: Date the certificate was issued"},"registrar":{"type":"string","description":"The registrar of the certificate. Only shown when parameter includesub is used."}}}},"property":{"type":"object","properties":{"certificate":{"type":"array","description":"Unique ID of the certificate","items":{"type":"string","description":"Unique ID of the certificate"}},"certificateorder":{"type":"array","description":"CertificateOrders: ID of the associated certificate order","items":{"type":"string","description":"CertificateOrders: ID of the associated certificate order"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of certificates shown"},"domain":{"type":"array","description":"First domain the certificate may be used for","items":{"type":"string","description":"First domain the certificate may be used for"}},"expiration_date":{"type":"array","description":"Expiration date: Date the certificate expires","items":{"type":"string","format":"date-time","description":"Expiration date: Date the certificate expires"}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"server_type":{"type":"array","description":"Server type: Type of the server where the certificate can be used","items":{"type":"string","description":"Server type: Type of the server where the certificate can be used"}},"status":{"type":"array","description":"Current status of the certificate","items":{"type":"string","description":"Current status of the certificate"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing certificates"},"updated_date":{"type":"array","description":"Updated date: Date the certificate was last changed","items":{"type":"string","format":"date-time","description":"Updated date: Date the certificate was last changed"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryCertificateList"},"post":{"operationId":"addCertificate","summary":"XRRP command AddCertificate (addCertificate)","description":"Request a new SSL certificate\n","tags":["certificate"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addservicetag":{"type":"array","description":"Service Tag: The service tags that will be associated with this service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be associated with this service."}},"admincontact0":{"type":"string","description":"Admin contact: Admin contact for the certificate (may not contain special chars / umlauts)"},"algorithm":{"type":"string","nullable":true,"description":"Algorithm: Hashing algorithm to be used, GetCertificateInfo will provide a list of valid IDs for each class"},"apiversion":{"type":"string","nullable":true,"enum":["1","2"],"description":"Switch the version of the SSL API system: \u003cNULL\u003e"},"approveremail":{"type":"array","description":"Approver email: Emails where the approval-links should be sent to for SAN certificates","items":{"type":"string","nullable":true,"description":"Approver email: Emails where the approval-links should be sent to for SAN certificates"}},"authmethod":{"type":"string","nullable":true,"enum":["EMAIL","DNS","FILE"],"description":"Authmethod: Method for authentication of the domainname"},"billingcontact0":{"type":"string","description":"Billing contact: Billing contact for the certificate (may not contain special chars / umlauts)"},"cacertificate":{"type":"string","nullable":true,"description":"The root certificate: The root certificate to be used, GetCertificateInfo will provide a list of valid IDs for each class"},"checkonly":{"type":"string","nullable":true,"enum":["1","0"],"description":"Only verify the request: Only verify that the request parameters are valid for the specified class"},"class":{"type":"string","enum":["geotrustflexdv","rapidssldv","securesiteflexov","securesiteflexev","securesiteproov","securesiteproev","ssl123dv","webserverov","webserverev","geotrusttruebizidov","geotrusttruebizidev","instantsslov","premiumov","singledomainev","positivessldv","unifiedcommunicationsdv","unifiedcommunicationsov","multidomainev","multidomainov","multidomaindv"],"description":"Certificate class: Type of certificate to be added"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"csr":{"type":"array","description":"Certificate Signing Request: The CSR to be used to generate the certificate","items":{"type":"string","nullable":true,"description":"Certificate Signing Request: The CSR to be used to generate the certificate"}},"dcvdomain":{"type":"array","description":"DCV Domain: Domain the DCV validation applies for, mostly the domain itself without subdomains","items":{"type":"string","nullable":true,"description":"DCV Domain: Domain the DCV validation applies for, mostly the domain itself without subdomains"}},"dcvemail":{"type":"array","description":"DCV email: Email to validate the request if dcvmethod = email for domain#","items":{"type":"string","nullable":true,"description":"DCV email: Email to validate the request if dcvmethod = email for domain#"}},"dcvlanguage":{"type":"string","nullable":true,"enum":["en","de","es","fr","it","ja","kr","nl","pt_br","ru","zh_cn","zh_tw"],"description":"DCV language: Language of the verification emails"},"dcvmethod":{"type":"string","nullable":true,"enum":["EMAIL","DNS-TXT","DNS-CNAME","HTTP","HTTPS"],"description":"DCV method: Method for authentication of the domain name(s)"},"dcvscope":{"type":"string","nullable":true,"enum":["base","fqdn"],"description":"DCV scope: Level of domain validation"},"dcvtoken":{"type":"string","nullable":true,"description":"DCV Token: Token generated by CheckCertificate"},"domain":{"type":"array","description":"Domain: Domains for certificate, first one is the CommonName","items":{"type":"string","nullable":true,"description":"Domain: Domains for certificate, first one is the CommonName"}},"evapprovercontact":{"type":"array","description":"EV approver contact: EV approver - CertificateContact","items":{"type":"string","nullable":true,"description":"EV approver contact: EV approver - CertificateContact"}},"evapproveremail":{"type":"string","nullable":true,"description":"EV approver - Email: The email address for this new contact handle"},"evapproverfirstname":{"type":"string","nullable":true,"description":"EV approver - First name: The given name of the new contact (may be empty for an organization handle)"},"evapproverjobtitle":{"type":"string","nullable":true,"description":"EV approver - Jobtitle: The job title for this new contact handle"},"evapproverlastname":{"type":"string","nullable":true,"description":"EV approver - Last name: The family name of the new contact (may be empty for an organization handle)"},"evapproverphone":{"type":"string","nullable":true,"description":"EV approver - Phone: The telephone number for this new contact handle"},"noautofilldomains":{"type":"string","nullable":true,"enum":["1","0"],"description":"No autofill of domains: Prevent auto-population of the domain list with free alternatives"},"organizationapproveremail":{"type":"string","nullable":true,"description":"Organization approver - Email: The email address of the new contact in the organization"},"organizationapproverfirstname":{"type":"string","nullable":true,"description":"Organization approver - First name: Given name of the new contact in the organization"},"organizationapproverjobtitle":{"type":"string","nullable":true,"description":"Organization approver - Jobtitle: The job title of the new contact in the organization"},"organizationapproverlastname":{"type":"string","nullable":true,"description":"Organization approver - Last name: Family name of the new contact in the organization"},"organizationapproverphone":{"type":"string","nullable":true,"description":"Organization approver - Phone: The telephone number of the new contact in the organization"},"organizationcity":{"type":"string","nullable":true,"description":"City: The city for this new contact handle"},"organizationcontact":{"type":"string","nullable":true,"description":"Organization contact: Organization - CertificateContact"},"organizationcountry":{"type":"string","nullable":true,"description":"Country code: The country for this new contact handle (please use the country code, e.g. \"DE\" or \"US\")"},"organizationdba":{"type":"string","nullable":true,"description":"Organization: DBA of the organization (if necessary)"},"organizationemail":{"type":"string","nullable":true,"description":"Email: The email address for this new contact handle"},"organizationname":{"type":"string","nullable":true,"description":"Organization: The organization the new contact will be created for"},"organizationohandle":{"type":"string","nullable":true,"description":"Organization O-Handle: An existing O(rganization)-Handle which will be used to create a new CertificateContact"},"organizationphandle":{"type":"string","nullable":true,"description":"Organization P-Handle: An existing P(ersonal)-Handle which will be used to create a new CertificateContact"},"organizationphone":{"type":"string","nullable":true,"description":"Phone: The telephone number for this new contact handle"},"organizationstate":{"type":"string","nullable":true,"description":"State: The federal state for this new contact handle"},"organizationstreet":{"type":"string","nullable":true,"description":"Street: The street for this new contact handle"},"organizationzip":{"type":"string","nullable":true,"description":"ZIP code: The postal code for this new contact handle"},"ownercontact0":{"type":"string","description":"Owner contact: Owner contact for the certificate (may not contain special chars / umlauts)"},"period":{"type":"string","enum":["1","1y","7d","14d","21d","28d","30d","35d","42d","49d","56d","63d","70d","77d","84d","90d","91d","98d","105d","112d","119d","126d","133d","140d","147d","154d","161d","168d","175d","182d","189d","196d","203d","210d","217d","224d","231d","238d","245d","252d","259d","266d","273d","280d","287d","294d","301d","308d","315d","322d","329d","336d","343d","350d","357d","364d","365d"],"description":"Period: Maximum validity period of the certificate order"},"servertype":{"type":"string","nullable":true,"enum":["apache","barracuda","weblogic","cisco","citrix","cpanel","f5","ibm","java","lighttpd","lotus","macos","exchange.*2007","exchange.*2010","exchange.*2013","exchange.*2016","forefront","iis56","iis7","iis8","iis10","netscape","iplanet","nginx","novellichain","novellnetware","oracle","qmail","sunone","tomcat","webstar","zeus","other"],"description":"Servertype: Servertype"},"servicetag":{"type":"array","description":"Service Tag: The service tags that will be associated with this service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be associated with this service."}},"techcontact":{"type":"array","description":"Tech contact: Tech - CertificateContact","items":{"type":"string","nullable":true,"description":"Tech contact: Tech - CertificateContact"}},"techcontact0":{"type":"string","description":"Tech contact: Tech contact for the certificate (may not contain special chars / umlauts)"},"techemail":{"type":"array","description":"Technical contact - Email: The email address for this new contact handle","items":{"type":"string","nullable":true,"description":"Technical contact - Email: The email address for this new contact handle"}},"techfirstname":{"type":"array","description":"Technical contact - First name: The given name of the new contact (may be empty for an organization handle)","items":{"type":"string","nullable":true,"description":"Technical contact - First name: The given name of the new contact (may be empty for an organization handle)"}},"techjobtitle":{"type":"array","description":"Technical contact - Jobtitle: The job title for this new contact handle","items":{"type":"string","nullable":true,"description":"Technical contact - Jobtitle: The job title for this new contact handle"}},"techlastname":{"type":"array","description":"Technical contact - Last name: The family name of the new contact (may be empty for an organization handle)","items":{"type":"string","nullable":true,"description":"Technical contact - Last name: The family name of the new contact (may be empty for an organization handle)"}},"techphone":{"type":"array","description":"Technical contact - Phone: The telephone number for this new contact handle","items":{"type":"string","nullable":true,"description":"Technical contact - Phone: The telephone number for this new contact handle"}},"webservertype":{"type":"string","nullable":true,"enum":["apachessl","apacheraven","apachessleay","c2net","Ibmhttp","Iplanet","Dominogo4625","Dominogo4626","Domino","iis4","iis5","Netscape","zeusv3","Other","apacheopenssl","apache2","apacheapachessl","cobaltseries","cpanel","ensim","hsphere","ipswitch","plesk","tomcat","WebLogic","website","webstar","iis"],"description":"Webserver type: Type of the webserver where the certificate should be used"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"billingcount#":{"type":"integer","format":"int32","description":"Number of times the billingtype is charged"},"billingtype#":{"type":"string","description":"Charged billing type"},"ca":{"type":"string","description":"The certificate authority used"},"ca_certificate_id":{"type":"string","description":"The ID of the root certificate (if requested)"},"ca_order_id":{"type":"string","description":"ID of the order at the CA"},"cert#":{"type":"string","description":"The certificate content (if immediate issuance is used)"},"certificate":{"type":"string","description":"ID of the new certificate"},"certificateorder":{"type":"string","description":"ID of the new certificate order"},"class":{"type":"string","description":"Certificate class used"},"class_name":{"type":"string","description":"Marketing name of the certificate class used"},"created_by":{"type":"string","description":"Registrar ordering this certificate"},"created_date":{"type":"string","format":"date","description":"Time the certificate was ordered"},"csr#":{"type":"string","description":"The provided Certificate Signing Request"},"currency":{"type":"string","description":"Currency used for the transaction"},"dcv_domain#":{"type":"string","description":"DCV domain (if requested)"},"dcv_email#":{"type":"string","description":"DCV email (if requested)"},"dcv_method#":{"type":"string","description":"DCV method for this domain"},"dcv_scope#":{"type":"string","description":"DCV scope (if requested)"},"dns_rr#":{"type":"string","description":"Name of the RR entry needed for DNS based authentication"},"domain#":{"type":"string","description":"Domains associated with the certificate"},"evapprovercontact":{"type":"string","description":"EV approver contact for the certificate"},"expiration_date":{"type":"string","format":"date","description":"Expiration date of the certificate (if immediate issuance is used)"},"file_contents#":{"type":"string","description":"Content for the file needed for file based authentication"},"file_name#":{"type":"string","description":"Name for the file needed for file based authentication"},"intermediate#":{"type":"string","description":"Intermediate certificate content (if immediate issuance is used)"},"order_paid_until":{"type":"string","format":"date","description":"Date until the order is paid"},"organizationcontact":{"type":"string","description":"Organizational contact for the certificate"},"parent_certificate":{"type":"string","description":"ID of the old certificate (if renewed or reissued)"},"period":{"type":"string","description":"Period requested in the command"},"price":{"type":"string","format":"decimal","description":"Price of the certificate"},"root#":{"type":"string","description":"Root certificate content (if immediate issuance is used)"},"server_type":{"type":"string","description":"Type of server where the certificate is used"},"status":{"type":"string","description":"Status of the certificate request"},"techcontact#":{"type":"string","description":"Technical contact for the certificate"},"updated_by":{"type":"string","description":"Registrar who last updated the certificate"},"updated_date":{"type":"string","format":"date","description":"Date when the certificate was last updated"},"vat":{"type":"string","format":"decimal","description":"VAT applied to the transaction"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddCertificate"}},"/certificate/-/availability":{"get":{"operationId":"checkCertificate","summary":"XRRP command CheckCertificate (checkCertificate)","description":"The command checks if the certificate request is valid and which information is inside.\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"csr","in":"query","description":"A base64 encoded certificate request","schema":{"type":"array","description":"A base64 encoded certificate request","items":{"type":"string","nullable":true,"description":"A base64 encoded certificate request"}}},{"name":"crt","in":"query","description":"A base64 encoded X509 certificate","schema":{"type":"array","description":"A base64 encoded X509 certificate","items":{"type":"string","nullable":true,"description":"A base64 encoded X509 certificate"}}},{"name":"domain","in":"query","description":"Domain: Optional domain to check approver email addresses","schema":{"type":"array","description":"Domain: Optional domain to check approver email addresses","items":{"type":"string","nullable":true,"description":"Domain: Optional domain to check approver email addresses"}}},{"name":"class","in":"query","description":"Class: Optional class to check approver email addresses","schema":{"type":"string","nullable":true,"enum":["SSL123","SSLWebServer","SSLWebServerWC","SSLWebServerEV","SGCSuperCerts","SecureSite","SecureSitePro","SecureSiteEV","SecureSiteProEV","QuickSSLPremium","TrueBizID","TrueBizIDWC","TrueBizIDEV","RapidSSL","RapidSSLWC","InstantSSL","SGCWildcardSSL","PositiveSSL","PremiumSSL","ExtendedValidatedSSL","PositiveWildcardSSL","unifiedcommunicationsdv","unifiedcommunicationsov","multidomainov","multidomainev"],"description":"Class: Optional class to check approver email addresses"}},{"name":"generatedcvtoken","in":"query","description":"Generate a dcv token. This requires a CSR and CLASS","schema":{"type":"string","nullable":true,"enum":["1","0"],"description":"Generate a dcv token. This requires a CSR and CLASS"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version","schema":{"type":"string","nullable":true,"enum":["1","2"],"description":"API version: Select the used API version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"crt_extended_key_usage#":{"type":"array","description":"CRT Extended Key Usage: Details of the allowed usage for the CRT","items":{"type":"string","description":"CRT Extended Key Usage: Details of the allowed usage for the CRT"}},"crt_issuer":{"type":"string","description":"CRT Issuer: Issuer of the CRT"},"crt_issuer_commonname":{"type":"string","description":"CRT Issuer CommonName: Common name given in the CRT"},"crt_issuer_country":{"type":"string","description":"CRT Issuer Country: Country given in the CRT"},"crt_issuer_emailaddress":{"type":"string","description":"CRT Issuer Email Address: Email given in the CRT"},"crt_issuer_location":{"type":"string","description":"CRT Issuer Location: City given in the CRT"},"crt_issuer_organization":{"type":"string","description":"CRT Issuer Organization: Organization given in the CRT"},"crt_issuer_organizational_unit":{"type":"string","description":"CRT Issuer Organizational Unit: Unit of the organization given in the CRT"},"crt_issuer_state":{"type":"string","description":"CRT Issuer State: State given in the CRT"},"crt_key_usage#":{"type":"array","description":"CRT Key Usage: Allowed usage for the CRT","items":{"type":"string","description":"CRT Key Usage: Allowed usage for the CRT"}},"crt_public_key_algorithm":{"type":"string","description":"CRT Public Key Algorithm: Public key algorithm used for the CRT"},"crt_san#":{"type":"array","description":"CRT SAN: Domains encoded in the CRT","items":{"type":"string","description":"CRT SAN: Domains encoded in the CRT"}},"crt_serial":{"type":"string","description":"CRT Serial: Serial of the CRT"},"crt_signature_algorithm":{"type":"string","description":"CRT Signature Algorithm: Signature algorithm used for the CRT"},"crt_size":{"type":"integer","format":"int32","description":"CRT Size: Size of the CRT"},"crt_subject":{"type":"string","description":"CRT Subject: Subject encoded in the CRT"},"crt_subject_commonname":{"type":"string","description":"CRT Subject CommonName: Common name given in the CRT"},"crt_subject_country":{"type":"string","description":"CRT Subject Country: Country given in the CRT"},"crt_subject_emailaddress":{"type":"string","description":"CRT Subject Email Address: Email given in the CRT"},"crt_subject_location":{"type":"string","description":"CRT Subject Location: City given in the CRT"},"crt_subject_organization":{"type":"string","description":"CRT Subject Organization: Organization given in the CRT"},"crt_subject_organizational_unit":{"type":"string","description":"CRT Subject Organizational Unit: Unit of the organization given in the CRT"},"crt_subject_state":{"type":"string","description":"CRT Subject State: State given in the CRT"},"crt_validity_not_after":{"type":"string","format":"date-time","description":"CRT Validity Not After: CRT only valid before this date"},"crt_validity_not_before":{"type":"string","format":"date-time","description":"CRT Validity Not Before: CRT only valid after this date"},"crt_version":{"type":"string","description":"CRT Version: Version encoded in the CRT"},"csr_commonname":{"type":"string","description":"CSR CommonName: Common name given in the CSR"},"csr_country":{"type":"string","description":"CSR Country: Country given in the CSR"},"csr_emailaddress":{"type":"string","description":"CSR Email Address: Email given in the CSR"},"csr_key_usage#":{"type":"array","description":"CSR Key Usage: Allowed usage of the CSR","items":{"type":"string","description":"CSR Key Usage: Allowed usage of the CSR"}},"csr_location":{"type":"string","description":"CSR Location: City given in the CSR"},"csr_organization":{"type":"string","description":"CSR Organization: Organization given in the CSR"},"csr_organizational_unit":{"type":"string","description":"CSR Organizational Unit: Unit of the organization given in the CSR"},"csr_public_key_algorithm":{"type":"string","description":"CSR Public Key Algorithm: Public key algorithm used for the CSR"},"csr_san#":{"type":"array","description":"CSR SAN: Domains encoded in the CSR","items":{"type":"string","description":"CSR SAN: Domains encoded in the CSR"}},"csr_signature_algorithm":{"type":"string","description":"CSR Signature Algorithm: Signature algorithm used for the CSR"},"csr_size":{"type":"integer","format":"int32","description":"CSR Size: Size of the CSR"},"csr_state":{"type":"string","description":"CSR State: State given in the CSR"},"csr_subject":{"type":"string","description":"CSR Subject: Subject encoded in the CSR"},"dcv_email#":{"type":"array","description":"DCV email: Valid DCV email for the domain","items":{"type":"string","description":"DCV email: Valid DCV email for the domain"}},"dcv_token":{"type":"string","description":"Immediate issuance DCV token: Token used during immediate issuance"},"domain#":{"type":"array","description":"Domain: Domain linked to DCV email","items":{"type":"string","description":"Domain: Domain linked to DCV email"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckCertificate"}},"/certificate/-/info":{"get":{"operationId":"getCertificateInfo","summary":"XRRP command GetCertificateInfo (getCertificateInfo)","description":"Query information about a certificate class\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"class","in":"query","description":"Class: Return information about this zone","schema":{"type":"string","enum":["SSL123","SSLWebServer","SSLWebServerWC","SSLWebServerEV","SGCSuperCerts","SecureSite","SecureSitePro","SecureSiteEV","SecureSiteProEV","QuickSSLPremium","TrueBizID","TrueBizIDWC","TrueBizIDEV","RapidSSL","RapidSSLWC","InstantSSL","SGCWildcardSSL","PositiveSSL","PremiumSSL","ExtendedValidatedSSL","PositiveWildcardSSL"],"description":"Class: Return information about this zone"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version","schema":{"type":"string","nullable":true,"enum":["1","2"],"description":"API version: Select the used API version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"algorithms#":{"type":"array","description":"Algorithms: Supported hashing algorithms","items":{"type":"string","description":"Algorithms: Supported hashing algorithms"}},"brand":{"type":"string","description":"Brand: The brand of the certificate"},"class":{"type":"string","description":"Class: Product name of the certificate class"},"dcv_dns_cname":{"type":"string","enum":["0","1"],"description":"DNS CNAME authentication: This class supports DNS CNAME-based authentication"},"dcv_dns_txt":{"type":"string","enum":["0","1"],"description":"DNS TXT authentication: This class supports DNS TXT-based authentication"},"dcv_email":{"type":"string","enum":["0","1"],"description":"Email authentication: This class supports email-based authentication"},"dcv_http":{"type":"string","enum":["0","1"],"description":"HTTP authentication: This class supports HTTP-based authentication"},"dcv_https":{"type":"string","enum":["0","1"],"description":"HTTPS authentication: This class supports HTTPS-based authentication"},"dcv_languages":{"type":"array","description":"DCV languages: Supported languages for DCV, comma-separated","items":{"type":"string","description":"DCV languages: Supported languages for DCV, comma-separated"}},"evapprovercontact":{"type":"string","description":"EV approver contact: Indicates whether an EV approver contact is required"},"included_domains_with_base":{"type":"integer","format":"int32","description":"Included domains: Number of domains included with the base price"},"included_nonwildcard_domains_with_base":{"type":"integer","format":"int32","description":"Included non-wildcard domains: Number of non-wildcard domains included with the base price"},"included_wildcard_domains_with_base":{"type":"integer","format":"int32","description":"Included wildcard domains: Number of wildcard domains included with the base price"},"max_domains":{"type":"integer","format":"int32","description":"Max domains: Maximum number of domains allowed"},"max_domains_including_alternatives":{"type":"integer","format":"int32","description":"Max domains including alternatives: Maximum number of domains including alternatives"},"max_free_alternatives":{"type":"integer","format":"int32","description":"Max free alternatives: Maximum number of free alternative domains"},"max_nonwildcard_domains":{"type":"integer","format":"int32","description":"Max non-wildcard domains: Maximum number of non-wildcard domains allowed"},"max_wildcard_domains":{"type":"integer","format":"int32","description":"Max wildcard domains: Maximum number of wildcard domains allowed"},"name":{"type":"string","description":"Name: Product name of the certificate class"},"organizationcontact":{"type":"string","description":"Organization contact: Indicates whether an organization contact is required"},"periods":{"type":"string","description":"Periods: Years possible with this class, comma-separated list"},"prefix":{"type":"string","description":"Prefix: 2 characters prefix for this class in Centralnic Reseller"},"root_certificates#":{"type":"array","description":"Root certificates: Supported root certificates","items":{"type":"string","description":"Root certificates: Supported root certificates"}},"server_type#":{"type":"array","description":"Server types: Supported server types for the certificate","items":{"type":"string","description":"Server types: Supported server types for the certificate"}},"supplier":{"type":"string","description":"Supplier: Supplier of the certificate"},"supports_immediate_issuance":{"type":"string","enum":["0","1"],"description":"Immediate issuance: Indicates whether immediate issuance is supported"},"techcontact":{"type":"string","description":"Technical contact: Indicates whether a technical contact is required"},"type":{"type":"string","description":"Type: Type of the certificate (e.g., DV, OV, EV)"},"wildcard":{"type":"string","enum":["0","1"],"description":"Wildcard possible"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"GetCertificateInfo"}},"/certificate/{certificate}":{"delete":{"operationId":"deleteCertificate","summary":"XRRP command DeleteCertificate (deleteCertificate)","description":"\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"certificate","in":"path","required":true,"description":"Certificate: The ID of the certificate order to be deleted","schema":{"type":"string","description":"Certificate: The ID of the certificate order to be deleted"}},{"name":"sub","in":"query","description":"Certificate: The ID of the certificate sub to be deleted","schema":{"type":"string","description":"Certificate: The ID of the certificate sub to be deleted"}},{"name":"action","in":"query","description":"Type of cancellation for certificate: Type of cancelation","schema":{"type":"string","nullable":true,"enum":["REVOKE","CANCELORDER","REVOKEORDER"],"description":"Type of cancellation for certificate: Type of cancelation"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version","schema":{"type":"string","nullable":true,"enum":["1","2"],"description":"API version: Select the used API version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteCertificate"},"get":{"operationId":"statusCertificate","summary":"XRRP command StatusCertificate (statusCertificate)","description":"\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"certificate","in":"path","required":true,"description":"ID of the certificate order","schema":{"type":"string","description":"ID of the certificate order"}},{"name":"sub","in":"query","description":"ID of the certificate sub","schema":{"type":"string","nullable":true,"description":"ID of the certificate sub"}},{"name":"wide","in":"query","description":"Show details of the certificate","schema":{"type":"string","nullable":true,"enum":["1","0"],"description":"Show details of the certificate"}},{"name":"chainformat","in":"query","description":"Format of the certificate chain","schema":{"type":"string","nullable":true,"enum":["pem","pem_reverse","zip","zip_reverse","zip_noroot","p7b"],"description":"Format of the certificate chain"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version","schema":{"type":"string","nullable":true,"enum":["1","2"],"description":"API version: Select the used API version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"ca":{"type":"string","description":"The certificate authority used"},"ca_certificate_id":{"type":"string","description":"The ID of the root certificate (if requested)"},"ca_order_id":{"type":"string","description":"ID of the order at the CA"},"cert#":{"type":"string","description":"The certificate content"},"certificate":{"type":"string","description":"ID of the new certificate"},"certificateorder":{"type":"string","description":"ID of the new certificate order"},"class":{"type":"string","description":"Certificate class used"},"class_name":{"type":"string","description":"Marketing name of the certificate class used"},"created_by":{"type":"string","description":"Registrar ordering this certificate"},"created_date":{"type":"string","format":"date-time","description":"Time the certificate was ordered"},"csr#":{"type":"string","description":"The provided Certificate Signing Request"},"currency":{"type":"string","description":"Currency used for the transaction"},"dcv_domain#":{"type":"string","description":"DCV domain (if requested)"},"dcv_email#":{"type":"string","description":"DCV email (if requested)"},"dcv_method#":{"type":"string","description":"DCV method for this domain"},"dcv_scope#":{"type":"string","description":"DCV scope (if requested)"},"dns_rr#":{"type":"string","description":"Name of the RR entry needed for DNS based authentication"},"domain#":{"type":"string","description":"Domains associated with the certificate"},"evapprovercontact":{"type":"string","description":"EV approver contact for the certificate"},"expiration_date":{"type":"string","format":"date-time","description":"Expiration date of the certificate"},"file_contents#":{"type":"string","description":"Content for the file needed for file based authentication"},"file_name#":{"type":"string","description":"Name for the file needed for file based authentication"},"intermediate#":{"type":"string","description":"Intermediate certificate content"},"order_paid_until":{"type":"string","format":"date-time","description":"Date until the order is paid"},"organizationcontact":{"type":"string","description":"Organizational contact for the certificate"},"p7b#":{"type":"string","description":"P7B file containing the certificate and chain (if requested)"},"parent_certificate":{"type":"string","description":"ID of the old certificate (if renewed or reissued)"},"root#":{"type":"string","description":"Root certificate content"},"server_type":{"type":"string","description":"Type of server where the certificate is used"},"status":{"type":"string","description":"Status of the certificate request"},"techcontact#":{"type":"string","description":"Technical contact for the certificate"},"updated_by":{"type":"string","description":"Registrar who last updated the certificate"},"updated_date":{"type":"string","format":"date-time","description":"Date when the certificate was last updated"},"zip#":{"type":"string","description":"ZIP file containing the certificate and chain (if requested)"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusCertificate"},"patch":{"operationId":"modifyCertificate","summary":"XRRP command ModifyCertificate (modifyCertificate)","description":"Change the ApproverEmail for a not-yet-issued certificate ordered at DigiCert / Symantec / Thawte / Geotrust\n","tags":["certificate"],"parameters":[{"name":"certificate","in":"path","required":true,"description":"Certificate: Unique ID of the certificate to be changed","schema":{"type":"string","description":"Certificate: Unique ID of the certificate to be changed"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addservicetag":{"type":"array","description":"Service Tag: The service tags that will be added to the service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be added to the service."}},"apiversion":{"type":"string","nullable":true,"enum":["1"],"description":"API version: Select the used API version"},"approveremail":{"type":"array","description":"Approver email: Emails where the approval-links should be sent to for SAN certificates","items":{"type":"string","nullable":true,"description":"Approver email: Emails where the approval-links should be sent to for SAN certificates"}},"authmethod":{"type":"string","nullable":true,"enum":["EMAIL"],"description":"Authmethod: Change method for authentication of the domainname"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"delservicetag":{"type":"array","description":"Service Tag: The service tags that will be deleted from the service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be deleted from the service."}},"servicetag":{"type":"array","description":"Service Tag: The service tags that will be associated with this service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be associated with this service."}},"sub":{"type":"string","description":"ID of the certificate sub"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyCertificate"},"put":{"operationId":"reissueCertificate","summary":"XRRP command ReissueCertificate (reissueCertificate)","description":"Reissue a SSL certificate with a new CSR.\n","tags":["certificate"],"parameters":[{"name":"certificate","in":"path","required":true,"description":"Certificate: ID of the certificate order to be reissued","schema":{"type":"string","description":"Certificate: ID of the certificate order to be reissued"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"algorithm":{"type":"string","nullable":true,"description":"Algorithm: Hashing algorithm to be used, GetCertificateInfo will provide a list of valid IDs"},"apiversion":{"type":"string","nullable":true,"enum":["1","2"],"description":"API version: Select the used API version"},"authmethod":{"type":"string","nullable":true,"enum":["EMAIL","DNS","FILE"],"description":"Authmethod: Method for authentication of the domainname"},"cacertificate":{"type":"string","nullable":true,"description":"The root certificate: The root certificate to be used, GetCertificateInfo will provide a list of valid IDs"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"csr":{"type":"array","description":"Certificate Signing Request: The CSR to be used to generate the certificate","items":{"type":"string","nullable":true,"description":"Certificate Signing Request: The CSR to be used to generate the certificate"}},"dcvscope":{"type":"string","nullable":true,"enum":["base","fqdn"],"description":"DCV scope: Level of domain validation"},"dcvtoken":{"type":"string","nullable":true,"description":"DCV Token: If a new CSR was provided, token generated by CheckCertificate"},"domain":{"type":"array","description":"Domain: Additional domain for SAN, which will be charged seperately","items":{"type":"string","nullable":true,"description":"Domain: Additional domain for SAN, which will be charged seperately"}},"reissueemail":{"type":"array","description":"Reissue emails: Emails where the approval-links should be sent to for SAN certificates","items":{"type":"string","nullable":true,"description":"Reissue emails: Emails where the approval-links should be sent to for SAN certificates"}},"sub":{"type":"string","nullable":true,"description":"Certificate: ID of the certificate sub to be reissued"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"ca":{"type":"string","description":"The certificate authority used"},"ca_certificate_id":{"type":"string","description":"The ID of the root certificate (if requested)"},"ca_order_id":{"type":"string","description":"ID of the order at the CA"},"cert#":{"type":"array","description":"The certificate content","items":{"type":"string","description":"The certificate content"}},"certificate":{"type":"string","description":"ID of the new certificate"},"certificateorder":{"type":"string","description":"ID of the new certificate order"},"class":{"type":"string","description":"Certificate class used"},"class_name":{"type":"string","description":"Marketing name of the certificate class used"},"created_by":{"type":"string","description":"Registrar ordering this certificate"},"created_date":{"type":"string","format":"date","description":"Time the certificate was ordered"},"csr#":{"type":"array","description":"The provided Certificate Signing Request","items":{"type":"string","description":"The provided Certificate Signing Request"}},"currency":{"type":"string","description":"Currency used for the transaction"},"dcv_domain#":{"type":"array","description":"DCV domain (if requested)","items":{"type":"string","description":"DCV domain (if requested)"}},"dcv_email#":{"type":"array","description":"DCV email (if requested)","items":{"type":"string","description":"DCV email (if requested)"}},"dcv_method#":{"type":"array","description":"DCV method for this domain","items":{"type":"string","description":"DCV method for this domain"}},"dcv_scope#":{"type":"array","description":"DCV scope (if requested)","items":{"type":"string","description":"DCV scope (if requested)"}},"dns_rr#":{"type":"array","description":"Name of the RR entry needed for DNS based authentication","items":{"type":"string","description":"Name of the RR entry needed for DNS based authentication"}},"domain#":{"type":"array","description":"Domains associated with the certificate","items":{"type":"string","description":"Domains associated with the certificate"}},"evapprovercontact":{"type":"string","description":"EV approver contact for the certificate"},"expiration_date":{"type":"string","format":"date","description":"Expiration date of the certificate"},"file_contents#":{"type":"array","description":"Content for the file needed for file based authentication","items":{"type":"string","description":"Content for the file needed for file based authentication"}},"file_name#":{"type":"array","description":"Name for the file needed for file based authentication","items":{"type":"string","description":"Name for the file needed for file based authentication"}},"intermediate#":{"type":"array","description":"Intermediate certificate content","items":{"type":"string","description":"Intermediate certificate content"}},"order_paid_until":{"type":"string","format":"date","description":"Date until the order is paid"},"organizationcontact":{"type":"string","description":"Organizational contact for the certificate"},"parent_certificate":{"type":"string","description":"ID of the old certificate"},"root#":{"type":"array","description":"Root certificate content","items":{"type":"string","description":"Root certificate content"}},"server_type":{"type":"string","description":"Type of server where the certificate is used"},"status":{"type":"string","description":"Status of the certificate request"},"techcontact#":{"type":"string","description":"Technical contact for the certificate"},"updated_by":{"type":"string","description":"Registrar who last updated the certificate"},"updated_date":{"type":"string","format":"date","description":"Date when the certificate was last updated"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ReissueCertificate"}},"/certificate/{certificate}/renew":{"patch":{"operationId":"renewCertificate","summary":"XRRP command RenewCertificate (renewCertificate)","description":"Renew a SSL - certificate\n","tags":["certificate"],"parameters":[{"name":"certificate","in":"path","required":true,"description":"Certificate: The ID of the certificate order to be renewed","schema":{"type":"string","description":"Certificate: The ID of the certificate order to be renewed"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"algorithm":{"type":"string","nullable":true,"description":"Algorithm: Hashing algorithm to be used, GetCertificateInfo will provide a list of valid IDs for each class"},"apiversion":{"type":"string","nullable":true,"enum":["1","2"],"description":"API version: Select the used API version"},"approveremail":{"type":"array","description":"Approver email: Emails where the approval-links should be sent to for SAN certificates","items":{"type":"string","nullable":true,"description":"Approver email: Emails where the approval-links should be sent to for SAN certificates"}},"authmethod":{"type":"string","nullable":true,"enum":["EMAIL","DNS","FILE"],"description":"Authmethod: Method for authentication of the domainname"},"cacertificate":{"type":"string","nullable":true,"description":"The root certificate: The root certificate to be used, GetCertificateInfo will provide a list of valid IDs for each class"},"checkonly":{"type":"string","nullable":true,"enum":["1","0"],"description":"Only verify the request: Only verify that the request parameters are valid for the specified class"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"csr":{"type":"array","description":"Certificate Signing Request: The CSR to be used to generate the certificate","items":{"type":"string","nullable":true,"description":"Certificate Signing Request: The CSR to be used to generate the certificate"}},"dcvemail":{"type":"array","description":"DCV email: Email to validate the request if dcvmethod = email for domain#","items":{"type":"string","nullable":true,"description":"DCV email: Email to validate the request if dcvmethod = email for domain#"}},"dcvlanguage":{"type":"string","nullable":true,"enum":["en","de","es","fr","it","ja","kr","nl","pt_br","ru","zh_cn","zh_tw"],"description":"DCV language: Language of the verification emails"},"dcvmethod":{"type":"string","nullable":true,"enum":["EMAIL","DNS-TXT","DNS-CNAME","HTTP","HTTPS"],"description":"DCV method: Method for authentication of the domainname(s)"},"dcvscope":{"type":"string","nullable":true,"enum":["base","fqdn"],"description":"DCV scope: Level of domain validation"},"dcvtoken":{"type":"string","nullable":true,"description":"DCV Token: Token generated by CheckCertificate"},"domain":{"type":"array","description":"Domain: Domains for certificate, first one is the CommonName","items":{"type":"string","nullable":true,"description":"Domain: Domains for certificate, first one is the CommonName"}},"evapprovercontact":{"type":"string","nullable":true,"description":"EV approver contact: EV approver - CertificateContact"},"evapproveremail":{"type":"string","nullable":true,"description":"EV approver - Email: The email address for this new contact handle"},"evapproverfirstname":{"type":"string","nullable":true,"description":"EV approver - First name: The given name of the new contact (may be empty for an organization handle)"},"evapproverjobtitle":{"type":"string","nullable":true,"description":"EV approver - Jobtitle: The job title for this new contact handle"},"evapproverlastname":{"type":"string","nullable":true,"description":"EV approver - Last name: The family name of the new contact (may be empty for an organization handle)"},"evapproverphone":{"type":"string","nullable":true,"description":"EV approver - Phone: The telephone number for this new contact handle"},"organizationcity":{"type":"string","nullable":true,"description":"City: The city for this new contact handle"},"organizationcontact":{"type":"string","nullable":true,"description":"Organization contact: Organization - CertificateContact"},"organizationcountry":{"type":"string","nullable":true,"description":"Country code: The country for this new contact handle (please use the country code, e.g. \"DE\" or \"US\")"},"organizationdba":{"type":"string","nullable":true,"description":"Organization: DBA of the organization (if necessary)"},"organizationemail":{"type":"string","nullable":true,"description":"Email: The email address for this new contact handle"},"organizationname":{"type":"string","nullable":true,"description":"Organization: The organization the new contact will be created for"},"organizationphone":{"type":"string","nullable":true,"description":"Phone: The telephone number for this new contact handle"},"organizationstate":{"type":"string","nullable":true,"description":"State: The federal state for this new contact handle"},"organizationstreet":{"type":"string","nullable":true,"description":"Street: The street for this new contact handle"},"organizationzip":{"type":"string","nullable":true,"description":"ZIP code: The postal code for this new contact handle"},"period":{"type":"string","enum":["1","1y","7d","14d","21d","28d","30d","35d","42d","49d","56d","63d","70d","77d","84d","90d","91d","98d","105d","112d","119d","126d","133d","140d","147d","154d","161d","168d","175d","182d","189d","196d","203d","210d","217d","224d","231d","238d","245d","252d","259d","266d","273d","280d","287d","294d","301d","308d","315d","322d","329d","336d","343d","350d","357d","364d","365d"],"description":"Period: Maximum validity period of the certificate order"},"servertype":{"type":"string","nullable":true,"description":"Servertype: Servertype"},"sub":{"type":"string","nullable":true,"description":"Certificate: The ID of the certificate sub to be renewed"},"techcontact":{"type":"string","nullable":true,"description":"Tech contact: Tech - CertificateContact"},"techemail":{"type":"string","nullable":true,"description":"Technical contact - Email: The email address for this new contact handle"},"techfirstname":{"type":"string","nullable":true,"description":"Technical contact - First name: The given name of the new contact (may be empty for an organization handle)"},"techjobtitle":{"type":"string","nullable":true,"description":"Technical contact - Jobtitle: The job title for this new contact handle"},"techlastname":{"type":"string","nullable":true,"description":"Technical contact - Last name: The family name of the new contact (may be empty for an organization handle)"},"techphone":{"type":"string","nullable":true,"description":"Technical contact - Phone: The telephone number for this new contact handle"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"billingcount#":{"type":"array","description":"Number of times the billingtype is charged","items":{"type":"integer","format":"int32","description":"Number of times the billingtype is charged"}},"billingtype#":{"type":"array","description":"Charged billing type","items":{"type":"string","description":"Charged billing type"}},"ca":{"type":"string","description":"The certificate authority used"},"ca_certificate_id":{"type":"string","description":"The ID of the root certificate (if requested)"},"ca_order_id":{"type":"string","description":"ID of the order at the CA"},"cert#":{"type":"array","description":"The certificate content","items":{"type":"string","description":"The certificate content"}},"certificate":{"type":"string","description":"ID of the new certificate"},"certificateorder":{"type":"string","description":"ID of the new certificate order"},"class":{"type":"string","description":"Certificate class used"},"class_name":{"type":"string","description":"Marketing name of the certificate class used"},"created_by":{"type":"string","description":"Registrar ordering this certificate"},"created_date":{"type":"string","format":"date","description":"Time the certificate was ordered"},"csr#":{"type":"array","description":"The provided Certificate Signing Request","items":{"type":"string","description":"The provided Certificate Signing Request"}},"currency":{"type":"string","description":"Currency used for the transaction"},"dcv_domain#":{"type":"array","description":"DCV domain (if requested)","items":{"type":"string","description":"DCV domain (if requested)"}},"dcv_email#":{"type":"array","description":"DCV email (if requested)","items":{"type":"string","description":"DCV email (if requested)"}},"dcv_method#":{"type":"array","description":"DCV method for this domain","items":{"type":"string","description":"DCV method for this domain"}},"dcv_scope#":{"type":"array","description":"DCV scope (if requested)","items":{"type":"string","description":"DCV scope (if requested)"}},"dns_rr#":{"type":"array","description":"Name of the RR entry needed for DNS based authentication","items":{"type":"string","description":"Name of the RR entry needed for DNS based authentication"}},"domain#":{"type":"array","description":"Domains associated with the certificate","items":{"type":"string","description":"Domains associated with the certificate"}},"evapprovercontact":{"type":"string","description":"EV approver contact for the certificate"},"expiration_date":{"type":"string","format":"date","description":"Expiration date of the certificate"},"file_contents#":{"type":"array","description":"Content for the file needed for file based authentication","items":{"type":"string","description":"Content for the file needed for file based authentication"}},"file_name#":{"type":"array","description":"Name for the file needed for file based authentication","items":{"type":"string","description":"Name for the file needed for file based authentication"}},"intermediate#":{"type":"array","description":"Intermediate certificate content","items":{"type":"string","description":"Intermediate certificate content"}},"order_paid_until":{"type":"string","format":"date","description":"Date until the order is paid"},"organizationcontact":{"type":"string","description":"Organizational contact for the certificate"},"parent_certificate":{"type":"string","description":"ID of the old certificate (if renewed or reissued)"},"period":{"type":"string","description":"Period requested in the command"},"price":{"type":"string","format":"decimal","description":"Price of the certificate"},"root#":{"type":"array","description":"Root certificate content","items":{"type":"string","description":"Root certificate content"}},"server_type":{"type":"string","description":"Type of server where the certificate is used"},"status":{"type":"string","description":"Status of the certificate request"},"techcontact#":{"type":"string","description":"Technical contact for the certificate"},"updated_by":{"type":"string","description":"Registrar who last updated the certificate"},"updated_date":{"type":"string","format":"date","description":"Date when the certificate was last updated"},"vat":{"type":"string","format":"decimal","description":"VAT applied to the transaction"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RenewCertificate"}},"/certificate/{certificate}/revoke":{"delete":{"operationId":"revokeCertificate","summary":"XRRP command RevokeCertificate (revokeCertificate)","description":"\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"certificate","in":"path","required":true,"description":"Certificate: The ID of the certificate to be cancelled","schema":{"type":"string","description":"Certificate: The ID of the certificate to be cancelled"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version","schema":{"type":"string","nullable":true,"enum":["2"],"description":"API version: Select the used API version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RevokeCertificate"}},"/certificatecontact":{"get":{"operationId":"queryCertificateContactList","summary":"XRRP command QueryCertificateContactList (queryCertificateContactList)","description":"Search for certificate contact handles. Wildcards are allowed for every parameter. Default will show all contacts.\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"certificatecontact","in":"query","schema":{"type":"string"}},{"name":"organization","in":"query","description":"Search for contacts with this organization","schema":{"type":"string","description":"Search for contacts with this organization"}},{"name":"email","in":"query","description":"Search for contacts with this email","schema":{"type":"string","description":"Search for contacts with this email"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}},{"name":"type","in":"query","description":"Search for contacts of this type","schema":{"type":"string","description":"Search for contacts of this type"}},{"name":"jobtitle","in":"query","description":"Search for contacts with this jobtitle","schema":{"type":"string","description":"Search for contacts with this jobtitle"}},{"name":"firstname","in":"query","description":"Search for contacts with this first name","schema":{"type":"string","description":"Search for contacts with this first name"}},{"name":"lastname","in":"query","description":"Search for contacts with this last name","schema":{"type":"string","description":"Search for contacts with this last name"}},{"name":"phone","in":"query","description":"Search for contacts with this phone number","schema":{"type":"string","description":"Search for contacts with this phone number"}},{"name":"organizationdba","in":"query","description":"Search for contacts doing business as...","schema":{"type":"string","description":"Search for contacts doing business as..."}},{"name":"organizationstreet","in":"query","description":"Search for contacts with this street","schema":{"type":"string","description":"Search for contacts with this street"}},{"name":"organizationcity","in":"query","description":"Search for contacts in this city","schema":{"type":"string","description":"Search for contacts in this city"}},{"name":"organizationzip","in":"query","description":"Search for contacts in this zip code","schema":{"type":"string","description":"Search for contacts in this zip code"}},{"name":"organizationstate","in":"query","description":"Search for contacts in this state","schema":{"type":"string","description":"Search for contacts in this state"}},{"name":"organizationcountry","in":"query","description":"Search for contacts in this country","schema":{"type":"string","description":"Search for contacts in this country"}},{"name":"organizationphone","in":"query","description":"Search for contacts with this organizational phone","schema":{"type":"string","description":"Search for contacts with this organizational phone"}},{"name":"organizationcategory","in":"query","description":"Search for contacts with this business category","schema":{"type":"string","description":"Search for contacts with this business category"}},{"name":"createddate","in":"query","description":"Search for contacts created on this date","schema":{"type":"string","description":"Search for contacts created on this date"}},{"name":"updateddate","in":"query","description":"Search for contacts updated on this date","schema":{"type":"string","description":"Search for contacts updated on this date"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is CERTIFICATECONTACT.","schema":{"type":"string","nullable":true,"enum":["CERTIFICATECONTACT","TYPE","JOBTITLE","FIRSTNAME","LASTNAME","PHONE","EMAIL","ORGANIZATION","ORGANIZATIONDBA","ORGANIZATIONSTREET","ORGANIZATIONCITY","ORGANIZATIONZIP","ORGANIZATIONSTATE","ORGANIZATIONCOUNTRY","ORGANIZATIONPHONE","ORGANIZATIONCATEGORY","CREATEDDATE","UPDATEDDATE"],"description":"Order the results for the corresponding column. Default is CERTIFICATECONTACT."}},{"name":"apiversion","in":"query","description":"API version: Select the used API version (Command only available in 2022 version)","schema":{"type":"string","nullable":true,"enum":["2"],"description":"API version: Select the used API version (Command only available in 2022 version)"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"contact":{"type":"array","description":"Contact: ID of the contact handle","items":{"type":"string","description":"Contact: ID of the contact handle"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"deletion_date":{"type":"array","description":"Deletion Date: Deletion date when the unlinked contact will be deleted.","items":{"type":"string","format":"date","description":"Deletion Date: Deletion date when the unlinked contact will be deleted."}},"email":{"type":"string","description":"Email: Email of the certificate contact"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"firstname":{"type":"string","description":"Firstname: First name of the certificate contact"},"jobtitle":{"type":"string","description":"Job title: Job title of the certificate contact"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"lastname":{"type":"string","description":"Lastname: Last name of the certificate contact"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"order":{"type":"string","nullable":true,"enum":["ASC","DESC"]},"orderby":{"type":"string","nullable":true,"enum":["CERTIFICATECONTACT","TYPE","JOBTITLE","FIRSTNAME","LASTNAME","PHONE","EMAIL","ORGANIZATION","ORGANIZATIONDBA","ORGANIZATIONSTREET","ORGANIZATIONCITY","ORGANIZATIONZIP","ORGANIZATIONSTATE","ORGANIZATIONCOUNTRY","ORGANIZATIONPHONE","ORGANIZATIONCATEGORY","CREATEDDATE","UPDATEDDATE"],"description":"Order the results for the corresponding column. Default is CERTIFICATECONTACT."},"organization":{"type":"string","description":"Organization: Organization of the certificate contact"},"organizationcity":{"type":"string","description":"Organization city: City for the Organization  of the certificate contact"},"organizationcountry":{"type":"string","description":"Organization country: Country for the Organization  of the certificate contact"},"organizationdba":{"type":"string","description":"Organization DBA: Organization doing business as"},"organizationphone":{"type":"string","description":"Organization phone: Phone number for the Organization  of the certificate contact"},"organizationstate":{"type":"string","description":"Organization state: State for the Organization  of the certificate contact"},"organizationstreet":{"type":"string","description":"Organization street: Street for the Organization  of the certificate contact"},"organizationzip":{"type":"string","description":"Organization zip: Zip for the Organization  of the certificate contact"},"phone":{"type":"string","description":"Phone: Phone number of the certificate contact"},"status":{"type":"array","description":"Status: Status of the contact. Can be linked, unlinked or clientAutoDeleteProhibited.","items":{"type":"string","description":"Status: Status of the contact. Can be linked, unlinked or clientAutoDeleteProhibited."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"},"type":{"type":"string","description":"Type"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryCertificateContactList"},"post":{"operationId":"addCertificateContact","summary":"XRRP command AddCertificateContact (addCertificateContact)","description":"The AddCertificateContact command allows you to add a new contact in our certificate system.\n","tags":["certificate"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"apiversion":{"type":"string","nullable":true,"enum":["2"],"description":"API version: Select the used API version (Command only available in 2022 version)"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"email":{"type":"string","description":"Email: The email address for this new contact handle"},"firstname":{"type":"string","nullable":true,"description":"First name: The given name of the new contact (may be empty for an organization handle)"},"jobtitle":{"type":"string","nullable":true,"description":"Jobtitle: The jobtitle for this new contact handle"},"lastname":{"type":"string","nullable":true,"description":"Last name: The family name of the new contact (may be empty for an organization handle)"},"ohandle":{"type":"string","nullable":true,"description":"O-Handle: An optional O-Handle to create an organization contact from"},"organizationcity":{"type":"string","description":"City: The city for this new contact handle"},"organizationcountry":{"type":"string","description":"Country code: The country for this new contact handle (please use the country code, e.g. \"DE\" or \"US\")"},"organizationdba":{"type":"string","nullable":true,"description":"Organization: DBA of the organization (if necessary)"},"organizationemail":{"type":"string","description":"Email: The email address for this new contact handle"},"organizationname":{"type":"string","nullable":true,"description":"Organization: The organization the new contact will be created for"},"organizationphone":{"type":"string","description":"Phone: The telephone number for this new contact handle"},"organizationstate":{"type":"string","nullable":true,"description":"State: The federal state for this new contact handle"},"organizationstreet":{"type":"string","description":"Street: The street for this new contact handle"},"organizationzip":{"type":"string","nullable":true,"description":"ZIP code: The postal code for this new contact handle"},"phandle":{"type":"string","nullable":true,"description":"P-Handle: An optional P-Handle to create the contact from"},"phone":{"type":"string","description":"Phone: The telephone number for this new contact handle"},"type":{"type":"string","enum":["organization","tech","evapprover"],"description":"Type of contact: The type of contact to be added"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"certificatecontact":{"type":"string","description":"Contact: The ID of the new CertificateContact"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddCertificateContact"}},"/certificatecontact/{certificatecontact}":{"get":{"operationId":"statusCertificateContact","summary":"XRRP command StatusCertificateContact (statusCertificateContact)","description":"\n","tags":["certificate"],"parameters":[{"name":"certificatecontact","in":"path","required":true,"description":"Certificate contact ID","schema":{"type":"string","description":"Certificate contact ID"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version (Command only available in 2022 version)","schema":{"type":"string","nullable":true,"enum":["2"],"description":"API version: Select the used API version (Command only available in 2022 version)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"ca":{"type":"array","description":"Created contact at the CA","items":{"type":"string","description":"Created contact at the CA"}},"castatus":{"type":"array","description":"Created contact status at the CA","items":{"type":"string","description":"Created contact status at the CA"}},"certificatecontact":{"type":"string","description":"Contact handle: Contact ID"},"created_by":{"type":"string","description":"Created by: Account where this contact was created in"},"created_date":{"type":"string","format":"date-time","description":"Created date: Date when this contact was created"},"email":{"type":"string","description":"E-Mail: Email address of this contact"},"first_name":{"type":"string","description":"First name: First name of this contact"},"jobtitle":{"type":"string","description":"Job title: Title of this contact"},"last_name":{"type":"string","description":"Last name: Last name of this contact"},"organization_city":{"type":"string","description":"City: City of this contact"},"organization_country":{"type":"string","description":"Country code: Country code of this handle"},"organization_email":{"type":"string","description":"E-Mail: Email address of this contact"},"organization_name":{"type":"string","description":"Organization: Organization of this contact"},"organization_phone":{"type":"string","description":"Phone: Phone number of this contact"},"organization_state":{"type":"string","description":"State: State of this contact"},"organization_street":{"type":"array","description":"Street: Street of this contact","items":{"type":"string","description":"Street: Street of this contact"}},"organization_zip":{"type":"string","description":"ZIP code: Zip code of this contact"},"phone":{"type":"string","description":"Phone: Phone number of this contact"},"registrar":{"type":"string"},"type":{"type":"string","enum":["organization","tech","evapprover"],"description":"The type of contact: Type of contact"},"updated_by":{"type":"string","description":"Updated by: Account where the contact was last updated"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Date when the contact was last updated"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusCertificateContact"}},"/certificateorder":{"get":{"operationId":"queryCertificateOrderList","summary":"XRRP command QueryCertificateOrderList (queryCertificateOrderList)","description":"Search for certificate orders\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"certificateorder","in":"query","description":"Search for orders with this ID","schema":{"type":"string","description":"Search for orders with this ID"}},{"name":"paiduntil","in":"query","description":"Search for orders with this paid-until - date","schema":{"type":"string","description":"Search for orders with this paid-until - date"}},{"name":"status","in":"query","description":"Search for orders with this status","schema":{"type":"string","description":"Search for orders with this status"}},{"name":"class","in":"query","description":"Search for orders with this class","schema":{"type":"string","description":"Search for orders with this class"}},{"name":"createddate","in":"query","description":"Search for orders with this created date","schema":{"type":"string","description":"Search for orders with this created date"}},{"name":"updateddate","in":"query","description":"Search for orders with this updated date","schema":{"type":"string","description":"Search for orders with this updated date"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version (Command only available in 2022 version)","schema":{"type":"string","nullable":true,"enum":["2"],"description":"API version: Select the used API version (Command only available in 2022 version)"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is CERTIFICATEORDER.","schema":{"type":"string","nullable":true,"enum":["CERTIFICATEORDER","PAIDUNTIL","STATUS","CLASS","CREATEDDATE","UPDATEDDATE"],"description":"Order the results for the corresponding column. Default is CERTIFICATEORDER."}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"certificateorder":{"type":"array","description":"CertificateOrders: ID of the certificate order","items":{"type":"string","description":"CertificateOrders: ID of the certificate order"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"created_date":{"type":"array","description":"Created date: Date the order was created","items":{"type":"string","format":"date","description":"Created date: Date the order was created"}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"order":{"type":"string","nullable":true,"enum":["ASC","DESC"]},"orderby":{"type":"string","nullable":true,"enum":["CERTIFICATEORDER","CREATED_DATE","UPDATED_DATE","STATUS","PAIDUNTIL"],"description":"Order the results for the corresponding column. Default is CERTIFICATECONTACT."},"paiduntil":{"type":"array","description":"Paid until: Date the order will expire","items":{"type":"string","format":"date","description":"Paid until: Date the order will expire"}},"status":{"type":"array","description":"Status: Status of the certificate orders.","items":{"type":"string","description":"Status: Status of the certificate orders."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"},"updated_date":{"type":"array","description":"Updated date: Date of the last modification of the certificate order","items":{"type":"string","format":"date","description":"Updated date: Date of the last modification of the certificate order"}},"wide":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryCertificateOrderList"}},"/certificateorder/{certificateorder}":{"delete":{"operationId":"cancelCertificateOrder","summary":"XRRP command CancelCertificateOrder (cancelCertificateOrder)","description":"\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"certificateorder","in":"path","required":true,"description":"Certificate: The ID of the certificate order to be cancelled","schema":{"type":"string","description":"Certificate: The ID of the certificate order to be cancelled"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version","schema":{"type":"string","nullable":true,"enum":["2"],"description":"API version: Select the used API version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CancelCertificateOrder"},"get":{"operationId":"statusCertificateOrder","summary":"XRRP command StatusCertificateOrder (statusCertificateOrder)","tags":["certificate"],"parameters":[{"name":"certificateorder","in":"path","required":true,"description":"Order ID","schema":{"type":"string","description":"Order ID"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"apiversion","in":"query","description":"API version: Select the API version used (Command only available in 2022 version)","schema":{"type":"string","nullable":true,"enum":["1","2"],"description":"API version: Select the API version used (Command only available in 2022 version)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"ca":{"type":"string","description":"The CA where this CertificateOrder was created"},"certificate":{"type":"array","description":"A certificate within this CertificateOrder","items":{"type":"string","description":"A certificate within this CertificateOrder"}},"certificate_expiration_date":{"type":"array","description":"Expiration date of the certificate","items":{"type":"string","format":"date-time","nullable":true,"description":"Expiration date of the certificate"}},"certificate_status":{"type":"array","description":"Status of the certificate","items":{"type":"string","enum":["active","processing","expired","revoked","failed","canceled","cancel_processing","revoke_processing"],"description":"Status of the certificate"}},"certificateorder":{"type":"string","description":"ID of the CertificateOrder"},"class":{"type":"string","description":"Class of the CertificateOrder"},"created_by":{"type":"string","description":"The user who created this CertificateOrder"},"created_date":{"type":"string","format":"date-time","description":"Creation date of this CertificateOrder"},"paid_until":{"type":"string","format":"date-time","description":"Date until a certifictae in this CertificateOrder may be valid"},"status":{"type":"string","enum":["active","processing","expired","revoked","failed","canceled","cancel_processing","revoke_processing"],"description":"Status of the order"},"updated_by":{"type":"string","description":"The user the last update of the CertificateOrder was made by"},"updated_date":{"type":"string","format":"date-time","description":"Last update of a certificate in the CertificateOrder"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusCertificateOrder"}},"/certificateorder/{certificateorder}/revoke":{"delete":{"operationId":"revokeCertificateOrder","summary":"XRRP command RevokeCertificateOrder (revokeCertificateOrder)","description":"\n","tags":["certificate"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"certificateorder","in":"path","required":true,"description":"Certificate order: The ID of the certificate order to be cancelled","schema":{"type":"string","description":"Certificate order: The ID of the certificate order to be cancelled"}},{"name":"apiversion","in":"query","description":"API version: Select the used API version","schema":{"type":"string","nullable":true,"enum":["2"],"description":"API version: Select the used API version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RevokeCertificateOrder"}},"/claims":{"get":{"operationId":"queryClaimsNoticeList","summary":"XRRP command QueryClaimsNoticeList (queryClaimsNoticeList)","description":"List all claims notices currently active.\n","tags":["claims"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"wide","in":"query","description":"Wide: Show more or less details","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Wide: Show more or less details"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"Action"},"address":{"type":"string"},"claimsnotice":{"type":"string"},"created_date":{"type":"string","format":"date-time","description":"Created date"},"domain":{"type":"string"},"id":{"type":"integer","format":"int32","description":"Id"},"message_sent":{"type":"string","description":"Message sent"},"message_sent_date":{"type":"string","format":"date-time","description":"Message sent date"},"token":{"type":"string"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of applications shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of applications"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryClaimsNoticeList"}},"/claimsnotice/{token}":{"get":{"operationId":"statusClaimsNotice","summary":"XRRP command StatusClaimsNotice (statusClaimsNotice)","description":"Lists details of a specified claims notice.\n","tags":["claims"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"token","in":"path","required":true,"description":"Token: Relevant token to query.","schema":{"type":"string","nullable":true,"description":"Token: Relevant token to query."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"claimsnotice":{"type":"array","items":{"type":"string"}},"claimsnoticeurl":{"type":"array","items":{"type":"string"}},"domain":{"type":"array","items":{"type":"string"}},"token":{"type":"array","items":{"type":"string"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusClaimsNotice"}},"/claimsnotice/{token}/activate":{"post":{"operationId":"activateClaimsNotice","summary":"XRRP command ActivateClaimsNotice (activateClaimsNotice)","description":"\n","tags":["claims"],"parameters":[{"name":"token","in":"path","required":true,"description":"Token: Defines the object to be approved / denied.","schema":{"type":"string","description":"Token: Defines the object to be approved / denied."}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["APPROVE","DENY"],"description":"Action: Defines the action: APPROVE or DENY."},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ActivateClaimsNotice"}},"/commandsyntax/{commandname}":{"get":{"operationId":"queryCommandSyntax","summary":"XRRP command QueryCommandSyntax (queryCommandSyntax)","description":"\n","parameters":[{"name":"parent","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"commandname","in":"path","required":true,"description":"The name of the command where the syntax is unknown","schema":{"type":"string","description":"The name of the command where the syntax is unknown"}},{"name":"type","in":"query","description":"Type of syntax to be shown","schema":{"type":"string","nullable":true,"enum":["REQUEST","RESPONSE"],"description":"Type of syntax to be shown"}},{"name":"domain","in":"query","required":true,"schema":{"type":"string"}},{"name":"class","in":"query","description":"A class to query (may be a TLD, too)","schema":{"type":"string","nullable":true,"description":"A class to query (may be a TLD, too)"}},{"name":"showonlyparent","in":"query","description":"Shows only parent values","schema":{"type":"string","nullable":true,"enum":["1","0"],"description":"Shows only parent values"}},{"name":"ignorezone","in":"query","description":"Shows all entries of all zones","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows all entries of all zones"}},{"name":"newformat","in":"query","description":"Return the new format of the parameter definition: Shows new parameter formats","schema":{"type":"string","nullable":true,"enum":["0","1","2"],"description":"Return the new format of the parameter definition: Shows new parameter formats"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"default":{"type":"string","nullable":true,"description":"Default value"},"dependency":{"type":"string","nullable":true,"description":"Dependency definiton"},"description":{"type":"string","description":"Parameter Description"},"example":{"type":"string","nullable":true,"description":"Example value"},"max":{"type":"string","description":"Maximum values"},"optional":{"type":"string","description":"Optional"},"parameter":{"type":"string","description":"Parameter Name"},"paramgroup":{"type":"string","description":"Parameter Group"},"position":{"type":"string","description":"Position"},"property":{"type":"string","description":"Property name"},"quantity":{"type":"string","description":"Quantity"},"range":{"type":"string","description":"Range"},"required":{"type":"boolean","nullable":true,"description":"Is required"},"title":{"type":"string","description":"Title of the parameter"},"type":{"type":"string","nullable":true,"description":"Type"},"validation":{"type":"string","nullable":true,"description":"Validation definition"},"wide":{"type":"boolean","description":"Wide"},"zone":{"type":"string","nullable":true,"description":"Zone"}}}},"property":{"type":"object","properties":{"commanddescription":{"type":"array","description":"Command description","items":{"type":"string","nullable":true,"description":"Command description"}},"commandname":{"type":"string","description":"Command Name"},"domain":{"type":"string","description":"Domain"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryCommandSyntax"}},"/contact":{"get":{"operationId":"queryContactList","summary":"XRRP command QueryContactList (queryContactList)","description":"Search for contact handles, wildcards are allowed for every parameter. Default will show all contacts.\n","tags":["contact"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"contact","in":"query","description":"Search for contacts with this ID","schema":{"type":"string","description":"Search for contacts with this ID"}},{"name":"title","in":"query","description":"Search for contacts with this title","schema":{"type":"string","description":"Search for contacts with this title"}},{"name":"firstname","in":"query","description":"Search for contacts with this first name","schema":{"type":"string","description":"Search for contacts with this first name"}},{"name":"middlename","in":"query","description":"Search for contacts with this middle (second) name","schema":{"type":"string","description":"Search for contacts with this middle (second) name"}},{"name":"lastname","in":"query","description":"Search for contacts with this last name","schema":{"type":"string","description":"Search for contacts with this last name"}},{"name":"organization","in":"query","description":"Search for contacts with this organization","schema":{"type":"string","description":"Search for contacts with this organization"}},{"name":"layer","in":"query","description":"Select the dataset based on different criterias","schema":{"type":"string","nullable":true,"enum":["DEFAULT","SHOWSUBLAYER","SHOWMERGEDLAYER"],"description":"Select the dataset based on different criterias"}},{"name":"street","in":"query","description":"Search for contacts with this street","schema":{"type":"string","description":"Search for contacts with this street"}},{"name":"zip","in":"query","description":"Search for contacts with this zip code","schema":{"type":"string","description":"Search for contacts with this zip code"}},{"name":"city","in":"query","description":"Search for contacts with this city","schema":{"type":"string","description":"Search for contacts with this city"}},{"name":"state","in":"query","description":"Search for contacts with this state","schema":{"type":"string","description":"Search for contacts with this state"}},{"name":"country","in":"query","description":"Search for contacts with this country","schema":{"type":"string","description":"Search for contacts with this country"}},{"name":"phone","in":"query","description":"Search for contacts with this phone number","schema":{"type":"string","description":"Search for contacts with this phone number"}},{"name":"fax","in":"query","description":"Search for contacts with this FAX number","schema":{"type":"string","description":"Search for contacts with this FAX number"}},{"name":"email","in":"query","description":"Search for contacts with this email","schema":{"type":"string","description":"Search for contacts with this email"}},{"name":"validated","in":"query","description":"Search for contacts with validated contact data","schema":{"type":"string","description":"Search for contacts with validated contact data"}},{"name":"verified","in":"query","description":"Search for contacts with verified email address","schema":{"type":"string","description":"Search for contacts with verified email address"}},{"name":"x-au-validated","in":"query","description":"Show .AU validated contacts only.","schema":{"type":"string","nullable":true,"enum":["0","1","*"],"description":"Show .AU validated contacts only."}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}},{"name":"union","in":"query","description":"Special search param for Union Select on DB for WI","schema":{"type":"string","nullable":true,"description":"Special search param for Union Select on DB for WI"}},{"name":"status","in":"query","description":"Search for contacts who are linked with an object, unlinked and up for deletion or clientAutoDeleteProhibited by autodelete=0.","schema":{"type":"string","nullable":true,"enum":["LINKED","UNLINKED","CLIENTAUTODELETEPROHIBITED"],"description":"Search for contacts who are linked with an object, unlinked and up for deletion or clientAutoDeleteProhibited by autodelete=0."}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"type","in":"query","description":"Select the dataset based on different criterias","schema":{"type":"string","nullable":true,"enum":["DEFAULT","SHOWVERIFICATIONREQUESTED"],"description":"Select the dataset based on different criterias"}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is ID.","schema":{"type":"string","nullable":true,"enum":["ID","FIRSTNAME","LASTNAME","ORGANIZATION","STREET","CITY","ZIP","COUNTRY","EMAIL","VALIDATED","VERIFIED","CREATEDDATE","X-AU-VALIDATED"],"description":"Order the results for the corresponding column. Default is ID."}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"contact":{"type":"string","description":"Contact: ID of the contact handle"},"contact_email":{"type":"string","description":"Email: Email given in the contact"},"registrar":{"type":"string","description":"Reseller: Reseller"},"roid":{"type":"string","description":"Registry object ID: Registry Object ID, unique ID of this contact"},"validated":{"type":"string","description":"Validated: Validated given in the contact"},"verification_created_date":{"type":"string","format":"date-time","description":"Verification created: Verification created date"},"verification_history":{"type":"string","description":"Verification history: Chronological history of verification requests"},"verification_last_requested":{"type":"string","format":"date-time","nullable":true,"description":"Verification requested: Last email verification requested date"}}}},"property":{"type":"object","properties":{"column":{"type":"array","description":"List columns","items":{"type":"string","description":"List columns"}},"contact_city":{"type":"array","description":"City: City given in the contact","items":{"type":"string","description":"City: City given in the contact"}},"contact_country":{"type":"array","description":"Country: Country given in the contact","items":{"type":"string","description":"Country: Country given in the contact"}},"contact_fax":{"type":"array","description":"FAX number: FAX number given in the contact","items":{"type":"string","description":"FAX number: FAX number given in the contact"}},"contact_firstname":{"type":"array","description":"First name: First name given in the contact","items":{"type":"string","description":"First name: First name given in the contact"}},"contact_lastname":{"type":"array","description":"Last name: Last name given in the contact","items":{"type":"string","description":"Last name: Last name given in the contact"}},"contact_middlename":{"type":"array","description":"Middle name: Second name given in the contact","items":{"type":"string","description":"Middle name: Second name given in the contact"}},"contact_organization":{"type":"array","description":"Organization: Organization given in the contact","items":{"type":"string","description":"Organization: Organization given in the contact"}},"contact_phone":{"type":"array","description":"Phone number: Phone number given in the contact","items":{"type":"string","description":"Phone number: Phone number given in the contact"}},"contact_state":{"type":"array","description":"State: State given in the contact","items":{"type":"string","description":"State: State given in the contact"}},"contact_street":{"type":"array","description":"Street: Street given in the contact","items":{"type":"string","description":"Street: Street given in the contact"}},"contact_title":{"type":"array","description":"Title: Title given in the contact","items":{"type":"string","description":"Title: Title given in the contact"}},"contact_zip":{"type":"array","description":"Zip code: Zip code given in the contact","items":{"type":"string","description":"Zip code: Zip code given in the contact"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"created_by":{"type":"array","description":"Created by: Account the contact handle was created in","items":{"type":"string","description":"Created by: Account the contact handle was created in"}},"created_date":{"type":"array","description":"Created date: Date the contact handle was created","items":{"type":"string","format":"date-time","description":"Created date: Date the contact handle was created"}},"deletion_date":{"type":"array","description":"Deletion Date: Deletion Date when the unlinked contact will be delete.","items":{"type":"string","format":"date-time","description":"Deletion Date: Deletion Date when the unlinked contact will be delete."}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"status":{"type":"array","description":"Status: Status of the contact. Can be linked, unlinked or clientAutoDeleteProhibited.","items":{"type":"string","description":"Status: Status of the contact. Can be linked, unlinked or clientAutoDeleteProhibited."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"},"updated_by":{"type":"array","description":"Updated by: Account who did the last modification of the contact handle","items":{"type":"string","description":"Updated by: Account who did the last modification of the contact handle"}},"updated_date":{"type":"array","description":"Updated date: Date of the last modification of the contact handle","items":{"type":"string","format":"date-time","description":"Updated date: Date of the last modification of the contact handle"}},"verified":{"type":"array","description":"Verified: Verified given in the contact","items":{"type":"string","description":"Verified: Verified given in the contact"}},"x-au-validated":{"type":"array","description":".AU validated: .AU contact validation status.","items":{"type":"string","description":".AU validated: .AU contact validation status."}},"x-au-validated-notes":{"type":"string","nullable":true,"description":".AU validated notes"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryContactList"},"post":{"operationId":"addContact","summary":"XRRP command AddContact (addContact)","description":"The AddContact command allows you to add a new contact. The system automatically substitutes existing handles. If you wish to create a new handle, please use the parameter new = 1.\n","tags":["contact"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"type":"string","nullable":true,"description":"Authcode: The authorization code for this new contact handle"},"autodelete":{"type":"string","nullable":true,"enum":["0","1"],"description":"Auto Delete: Autodelete 0 sets the contact to clientDeleteProhibited, so that it will not get deleted automatically if it is not linked with an object."},"checkonly":{"type":"string","nullable":true,"enum":["0","1"],"description":"Checkonly"},"city":{"type":"string","description":"City: The city for this new contact handle"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"country":{"type":"string","description":"Country code: The country for this new contact handle (please use the country code, e.g. \"DE\" or \"US\")"},"email":{"type":"string","description":"Email: The email - address for this new contact handle"},"fax":{"type":"string","nullable":true,"description":"Fax: The fax number for this new contact handle"},"firstname":{"type":"string","nullable":true,"description":"First name: The given name of the new contact (may be empty for an organization handle)"},"lastname":{"type":"string","nullable":true,"description":"Last name: The family name of the new contact (may be empty for an organization handle)"},"middlename":{"type":"string","nullable":true,"description":"Middle name: The middle name of the new contact (may be empty for an organization handle)"},"new":{"type":"string","nullable":true,"enum":["0","1"],"description":"Create a new contact handle even if the same handle already exists"},"organization":{"type":"string","nullable":true,"description":"Organization: The organization the new contact will be created for (may be empty for a personal handle)"},"phone":{"type":"string","description":"Phone: The telephone number for this new contact handle. This needs to be in the format +\u003ccountry code\u003e.\u003csubscriber number\u003e - country code: 1-3 digits, subscriber number 1-14 digits"},"preverify":{"type":"string","nullable":true,"enum":["0","1"],"description":"Preverify"},"state":{"type":"string","nullable":true,"description":"State: The federal state for this new contact handle"},"status":{"type":"array","description":"Contact status","items":{"type":"string","nullable":true,"description":"Contact status"}},"street":{"type":"array","description":"Street: The street for this new contact handle","items":{"type":"string","nullable":true,"description":"Street: The street for this new contact handle"}},"title":{"type":"string","nullable":true,"description":"Title: Title of the person for this new contact handle (e.g. Mr. or Mrs.)"},"validation":{"type":"string","nullable":true,"enum":["0","1"],"description":"Validation"},"x-au-domain":{"type":"string","description":"Domainname: Please enter the Domainname that should be Checked for Policy Compliance (Trademark Rules)"},"x-au-domain-idnumber":{"type":"string","description":"Identification number: Specify the identification number as appropriate"},"x-au-domain-idtype":{"type":"string","enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA"],"description":"Identification type: This is the identification type of the registrant.  Specify 'ABN', 'ACN', or 'OTHER'. 'OTHER' refers to ARBN or Inc Association Number"},"x-au-owner-accept-validation-terms":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept validation terms: Confirm that the Registrant being validated has explicitly consented to have their details validated."},"x-au-owner-cardnumber":{"type":"string","nullable":true,"description":"Identification card number: The number of the card used to validate the Registrant."},"x-au-owner-dob":{"type":"string","format":"date","nullable":true,"description":"Date of birth: Date of Birth of the Registrant being validated."},"x-au-owner-iddate":{"type":"string","format":"date","nullable":true,"description":"Citizenship acquisition date: Date when the citizenship was acquired."},"x-au-owner-idissuer":{"type":"string","nullable":true,"enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"],"description":"State where the ID was issued: State where the ID was issued."},"x-au-owner-idnumber":{"type":"string","nullable":true,"description":"Identification number: The number of the ID used to validate the Registrant."},"x-au-owner-idtype":{"type":"string","nullable":true,"enum":["1","2","3","4","5","6"],"description":"Identification type: The type of ID used to validate the Registrant."},"x-au-owner-organization":{"type":"string","description":"Owner Organization or Name: The Organization name"},"x-br-register-number":{"type":"string","nullable":true,"description":".BR VAT ID"},"x-disclose":{"type":"string","nullable":true,"description":"Disclosed: Show various fields in the contact, possible values: name, organization, address, phone, fax, email. (May be comma-separated, not supported by all registries)"},"x-es-identificacion":{"type":"string","nullable":true,"description":"Identification: The ID card or passport number."},"x-es-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Legal form: The legal form used for the owner contact"},"x-es-tipo-identificacion":{"type":"string","nullable":true,"enum":["0","1","2","3","4"],"description":"Type identification: Indicates the type of identification"},"x-undisclose":{"type":"string","nullable":true,"description":"Undisclosed: Hide various fields in the contact, possible values: name, organization, address, phone, fax, email. (May be comma-separated, not supported by all registries)"},"x-verification-data":{"type":"array","description":"Verification Data Type: The data type that matches the associated trustframework and values.","items":{"type":"string","nullable":true,"enum":["email","phone","name","address"],"description":"Verification Data Type: The data type that matches the associated trustframework and values."}},"x-verification-evidence":{"type":"array","description":"Verification Evidence: The evidence used for the associated verification. (e.g. \"passport\" for name and address)","items":{"type":"string","nullable":true,"enum":["idcard","passport","population_register","residence_permit","proof_of_arrival","drivers_licence","company_register","company_statement","bank_account","online_payment_account","utility_account","bank_statement","tax_statement","written_attestation","digital_attestation","postal_ver_transaction_log","email_ver_transaction_log","address_database","phone_ver_transaction_log"],"description":"Verification Evidence: The evidence used for the associated verification. (e.g. \"passport\" for name and address)"}},"x-verification-method":{"type":"array","description":"Verification Method: The method that has been used for the associated verification.","items":{"type":"string","nullable":true,"enum":["auth","electronic_document","physical_document","vdig","bvr","pvr","data","reachability"],"description":"Verification Method: The method that has been used for the associated verification."}},"x-verification-reference":{"type":"array","description":"Verification Reference: The reference code for the associated verification.","items":{"type":"string","nullable":true,"description":"Verification Reference: The reference code for the associated verification."}},"x-verification-result":{"type":"array","description":"Verification Result: Was the associated verification successful?","items":{"type":"string","nullable":true,"enum":["success","failed"],"description":"Verification Result: Was the associated verification successful?"}},"x-verification-timestamp":{"type":"array","description":"Verification Timestamp: The timestamp of the associated verification.","items":{"type":"string","format":"date-time","nullable":true,"description":"Verification Timestamp: The timestamp of the associated verification."}},"x-verification-trustframework":{"type":"array","description":"Verification Trustframework: The trustframework that was used to verify the associated data type.","items":{"type":"string","nullable":true,"description":"Verification Trustframework: The trustframework that was used to verify the associated data type."}},"zip":{"type":"string","nullable":true,"description":"ZIP code: The postal code for this new contact handle"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string","description":"Auth code"},"contact":{"type":"string","description":"Contact: The ID of the new handle"},"contact_name":{"type":"string"},"created_date":{"type":"string","format":"date-time","description":"Created date"},"rating":{"type":"integer","format":"int32","description":"Rating"},"rating_reason":{"type":"string","description":"Rating reason"},"rating_reference":{"type":"string","description":"Rating reference"},"rating_risklevel":{"type":"string","description":"Rating risklevel"},"roid":{"type":"string","description":"ROID: The Registry Object ID of the new handle"},"validated":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact is validated"},"verification_requested":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact verification request has been created"},"verified":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact is verified"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddContact"}},"/contact/-/availability":{"get":{"operationId":"checkContacts","summary":"XRRP command CheckContacts (checkContacts)","description":"\n","tags":["contact"],"parameters":[{"name":"contact0","in":"query","schema":{"type":"string"}},{"name":"contact1","in":"query","schema":{"type":"string"}},{"name":"contact10","in":"query","schema":{"type":"string"}},{"name":"contact11","in":"query","schema":{"type":"string"}},{"name":"contact12","in":"query","schema":{"type":"string"}},{"name":"contact13","in":"query","schema":{"type":"string"}},{"name":"contact14","in":"query","schema":{"type":"string"}},{"name":"contact15","in":"query","schema":{"type":"string"}},{"name":"contact16","in":"query","schema":{"type":"string"}},{"name":"contact17","in":"query","schema":{"type":"string"}},{"name":"contact18","in":"query","schema":{"type":"string"}},{"name":"contact19","in":"query","schema":{"type":"string"}},{"name":"contact2","in":"query","schema":{"type":"string"}},{"name":"contact20","in":"query","schema":{"type":"string"}},{"name":"contact21","in":"query","schema":{"type":"string"}},{"name":"contact22","in":"query","schema":{"type":"string"}},{"name":"contact23","in":"query","schema":{"type":"string"}},{"name":"contact24","in":"query","schema":{"type":"string"}},{"name":"contact25","in":"query","schema":{"type":"string"}},{"name":"contact26","in":"query","schema":{"type":"string"}},{"name":"contact27","in":"query","schema":{"type":"string"}},{"name":"contact28","in":"query","schema":{"type":"string"}},{"name":"contact29","in":"query","schema":{"type":"string"}},{"name":"contact3","in":"query","schema":{"type":"string"}},{"name":"contact30","in":"query","schema":{"type":"string"}},{"name":"contact31","in":"query","schema":{"type":"string"}},{"name":"contact4","in":"query","schema":{"type":"string"}},{"name":"contact5","in":"query","schema":{"type":"string"}},{"name":"contact6","in":"query","schema":{"type":"string"}},{"name":"contact7","in":"query","schema":{"type":"string"}},{"name":"contact8","in":"query","schema":{"type":"string"}},{"name":"contact9","in":"query","schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"contactcheck":{"type":"array","description":"Contact check: The result of the contact availability check in the format \"\u003cCODE\u003e \u003cDESCRIPTION\u003e\"","items":{"type":"string","description":"Contact check: The result of the contact availability check in the format \"\u003cCODE\u003e \u003cDESCRIPTION\u003e\""}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckContacts"},"post":{"operationId":"checkContacts_2","summary":"XRRP command CheckContacts (checkContacts_2)","description":"\n","tags":["contact"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"contact0":{"type":"string"},"contact1":{"type":"string"},"contact10":{"type":"string"},"contact11":{"type":"string"},"contact12":{"type":"string"},"contact13":{"type":"string"},"contact14":{"type":"string"},"contact15":{"type":"string"},"contact16":{"type":"string"},"contact17":{"type":"string"},"contact18":{"type":"string"},"contact19":{"type":"string"},"contact2":{"type":"string"},"contact20":{"type":"string"},"contact21":{"type":"string"},"contact22":{"type":"string"},"contact23":{"type":"string"},"contact24":{"type":"string"},"contact25":{"type":"string"},"contact26":{"type":"string"},"contact27":{"type":"string"},"contact28":{"type":"string"},"contact29":{"type":"string"},"contact3":{"type":"string"},"contact30":{"type":"string"},"contact31":{"type":"string"},"contact4":{"type":"string"},"contact5":{"type":"string"},"contact6":{"type":"string"},"contact7":{"type":"string"},"contact8":{"type":"string"},"contact9":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"contactcheck":{"type":"array","description":"Contact check: The result of the contact availability check in the format \"\u003cCODE\u003e \u003cDESCRIPTION\u003e\"","items":{"type":"string","description":"Contact check: The result of the contact availability check in the format \"\u003cCODE\u003e \u003cDESCRIPTION\u003e\""}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckContacts"}},"/contact/-/validate":{"patch":{"operationId":"validateContact","summary":"XRRP command ValidateContact (validateContact)","description":"The ValidateContact command allows you to validate a new or existing contact, using a thrid party provider. This is not free of charge.\n","tags":["contact"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"type":"string","nullable":true,"description":"Authcode: The authorization code for this new contact handle"},"autodelete":{"type":"string","nullable":true,"enum":["0","1"],"description":"Auto Delete: Autodelete 0 sets the contact to clientDeleteProhibited, so that it will not get deleted automatically if it is not linked with an object."},"checkonly":{"type":"string","nullable":true,"enum":["0","1"],"description":"Checkonly"},"city":{"type":"string","description":"City: The city for this new contact handle"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"country":{"type":"string","description":"Country code: The country for this new contact handle (please use the country code, e.g. \"DE\" or \"US\")"},"email":{"type":"string","description":"Email: The email - address for this new contact handle"},"fax":{"type":"string","nullable":true,"description":"Fax: The fax number for this new contact handle"},"firstname":{"type":"string","nullable":true,"description":"First name: The given name of the new contact (may be empty for an organization handle)"},"lastname":{"type":"string","nullable":true,"description":"Last name: The family name of the new contact (may be empty for an organization handle)"},"middlename":{"type":"string","nullable":true,"description":"Middle name: The middle name of the new contact (may be empty for an organization handle)"},"organization":{"type":"string","nullable":true,"description":"Organization: The organization the new contact will be created for (may be empty for a personal handle)"},"phone":{"type":"string","description":"Phone: The telephone number for this new contact handle"},"registry":{"type":"string"},"state":{"type":"string","nullable":true,"description":"State: The federal state for this new contact handle"},"status":{"type":"array","description":"Contact status","items":{"type":"string","nullable":true,"description":"Contact status"}},"street":{"type":"array","description":"Street: The street for this new contact handle","items":{"type":"string","nullable":true,"description":"Street: The street for this new contact handle"}},"title":{"type":"string","nullable":true,"description":"Title: Title of the person for this new contact handle (e.g. Mr. or Mrs.)"},"x-au-owner-accept-validation-terms":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept validation terms: Confirm that the Registrant being validated has explicitly consented to have their details validated."},"x-au-owner-cardnumber":{"type":"string","nullable":true,"description":"Identification card number: The number of the card used to validate the Registrant."},"x-au-owner-dob":{"type":"string","format":"date","nullable":true,"description":"Date of birth: Date of Birth of the Registrant being validated."},"x-au-owner-iddate":{"type":"string","format":"date","nullable":true,"description":"Citizenship acquisition date: Date when the citizenship was acquired."},"x-au-owner-idissuer":{"type":"string","nullable":true,"enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"],"description":"State where the ID was issued: State where the ID was issued."},"x-au-owner-idnumber":{"type":"string","nullable":true,"description":"Identification number: The number of the ID used to validate the Registrant."},"x-au-owner-idtype":{"type":"string","nullable":true,"enum":["1","2","3","4","5","6"],"description":"Identification type: The type of ID used to validate the Registrant."},"x-disclose":{"type":"string","nullable":true,"description":"Disclosed: Show various fields in the contact, possible values: name, organization, address, phone, fax, email. (May be comma-separated, not supported by all registries)"},"x-undisclose":{"type":"string","nullable":true,"description":"Undisclosed: Hide various fields in the contact, possible values: name, organization, address, phone, fax, email. (May be comma-separated, not supported by all registries)"},"zip":{"type":"string","nullable":true,"description":"ZIP code: The postal code for this new contact handle"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string","description":"Auth code"},"contact":{"type":"string","description":"Contact: The ID of the new handle"},"contact_name":{"type":"string"},"roid":{"type":"string","description":"ROID: The Registry Object ID of the new handle"},"validated":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact is validated"},"verification_requested":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact verification request has been created"},"verified":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact is verified"},"x-au-validated":{"type":"integer","format":"int32","description":".AU validated"},"x-au-validated-notes":{"type":"string","description":".AU validated notes"},"x-au-validated-until":{"type":"string","format":"date-time","description":".AU validated until"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ValidateContact"}},"/contact/{contact}":{"delete":{"operationId":"deleteContact","summary":"XRRP command DeleteContact (deleteContact)","description":"This command allows you to delete an unused contact\nWarning: A contact may only be deleted if no object is associated with it\n","tags":["contact"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"contact","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteContact"},"get":{"operationId":"statusContact","summary":"XRRP command StatusContact (statusContact)","description":"\n","tags":["contact"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string"}},{"name":"auth","in":"query","schema":{"type":"string","nullable":true}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"authdomain","in":"query","description":"Owned domain name linked to the given contact to authorize the query, if the given contact belongs to a foreign entity.","schema":{"type":"string","nullable":true,"description":"Owned domain name linked to the given contact to authorize the query, if the given contact belongs to a foreign entity."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string","nullable":true,"description":"Authcode: Authorization code for this contact"},"auto_delete":{"type":"integer","format":"int32","description":"Auto Delete: Autodeletion active or enables status clientAutoDeleteProhibited."},"city":{"type":"string","description":"City: City of this contact"},"contact":{"type":"string","description":"Contact handle: Contact ID"},"contact_index":{"type":"string"},"contact_validation_issues":{"type":"string","nullable":true,"description":"Contact validation issues: Reason the contact failed validation, when known"},"contactname":{"type":"string"},"country":{"type":"string","description":"Country code: Country code of this handle"},"created_by":{"type":"string","description":"Created by: Account, where this contact was created in"},"created_date":{"type":"string","format":"date-time","description":"Created date: Date, when this contact was created"},"deletion_date":{"type":"string","format":"date-time","nullable":true,"description":"Deletion Date: Deletion date when the unlinked contact will be deleted."},"email":{"type":"string","description":"E-Mail: Email - address of this contact"},"encoding":{"type":"string","description":"Encoding: Encoding of the data in this contact"},"encoding_type":{"type":"string","description":"Encoding type"},"fax":{"type":"string","description":"Fax: FAX number of this contact"},"first_name":{"type":"string","description":"First name: First name of this contact"},"last_name":{"type":"string","description":"Last name: Last name of this contact"},"middle_name":{"type":"string","description":"Middle name: Middle (second) name of this contact"},"organization":{"type":"string","description":"Organization: Organization of this contact"},"ownerchange_status":{"type":"string","description":"Owner change status: Status of pending ownerchange"},"phone":{"type":"string","description":"Phone: Phone number of this contact"},"rating":{"type":"integer","format":"int32","description":"Rating"},"rating_reason":{"type":"string","description":"Rating reason"},"rating_reference":{"type":"string","description":"Rating reference"},"rating_risklevel":{"type":"string","description":"Rating risklevel"},"registrar":{"type":"string"},"roid":{"type":"string"},"state":{"type":"string","description":"State: State of this contact"},"status":{"type":"array","description":"Contact status","items":{"type":"string","description":"Contact status"}},"street":{"type":"array","description":"Street: Street of this contact","items":{"type":"string","description":"Street: Street of this contact"}},"title":{"type":"string","description":"Title: Title of this contact"},"updated_by":{"type":"string","description":"Updated by: Account, where the contact was last updated"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Date, when the contact was last updated"},"validated":{"type":"string","nullable":true,"description":"Validated: Is the contact validated"},"verification_requested":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact verification request has been created"},"verified":{"type":"string","nullable":true,"description":"Verified: Is the contact email address verified"},"x-au-owner-dob":{"type":"string","format":"date","description":".AU owner dob"},"x-au-owner-iddate":{"type":"string","format":"date","description":".AU owner iddate"},"x-au-owner-idissuer":{"type":"string","description":".AU owner idissuer"},"x-au-owner-idnumber":{"type":"string","description":".AU owner idnumber"},"x-au-owner-idtype":{"type":"integer","format":"int32","description":".AU owner idtype"},"x-au-validated":{"type":"integer","format":"int32","description":".AU validated"},"x-au-validated-notes":{"type":"string","description":".AU validatednotes"},"x-au-validated-until":{"type":"string","format":"date-time","description":".AU validated until"},"x-coop-verification":{"type":"string","nullable":true,"enum":["0","1"],"description":".COOP Verification-Status: Status of the .COOP-Verification"},"x-disclose":{"type":"string","nullable":true,"description":"Disclosed: Fields, which are disclosed in the whois"},"x-foreign-id":{"type":"string","description":"Foreign ID of the migrated System"},"x-undisclose":{"type":"string","nullable":true,"description":"Undisclosed: Fields, which are not disclosed in the whois"},"x-verification-data":{"type":"array","description":"Verification Data Type: The data type that matches the associated trustframework and values.","items":{"type":"string","nullable":true,"enum":["email","phone","name","address"],"description":"Verification Data Type: The data type that matches the associated trustframework and values."}},"x-verification-evidence":{"type":"array","description":"Verification Evidence: The evidence used for the associated verification. (e.g. \"passport\" for name and address)","items":{"type":"string","nullable":true,"description":"Verification Evidence: The evidence used for the associated verification. (e.g. \"passport\" for name and address)"}},"x-verification-method":{"type":"array","description":"Verification Method: The method that has been used for the associated verification.","items":{"type":"string","nullable":true,"description":"Verification Method: The method that has been used for the associated verification."}},"x-verification-reference":{"type":"array","description":"Verification Reference: The reference code for the associated verification.","items":{"type":"string","nullable":true,"description":"Verification Reference: The reference code for the associated verification."}},"x-verification-result":{"type":"array","description":"Verification Result: Was the associated verification successful?","items":{"type":"string","nullable":true,"enum":["success","failed"],"description":"Verification Result: Was the associated verification successful?"}},"x-verification-timestamp":{"type":"array","description":"Verification Timestamp: The timestamp of the associated verification.","items":{"type":"string","format":"date-time","nullable":true,"description":"Verification Timestamp: The timestamp of the associated verification."}},"x-verification-trustframework":{"type":"array","description":"Verification Trustframework: The trustframework that was used to verify the associated data type.","items":{"type":"string","nullable":true,"description":"Verification Trustframework: The trustframework that was used to verify the associated data type."}},"zip":{"type":"string","description":"ZIP code: Zip code of this contact"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusContact"},"patch":{"operationId":"modifyContact","summary":"XRRP command ModifyContact (modifyContact)","description":"This command allows you, to change the content of a contact handle.\nNote: The change will not be propagated to all registries, it may be necessary to send a ModifyDomain - command with a different handle to these registries\n","tags":["contact"],"parameters":[{"name":"contact","in":"path","required":true,"description":"Handle: ID of the contact to be modified","schema":{"type":"string","description":"Handle: ID of the contact to be modified"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addstatus":{"type":"array","items":{"type":"string","nullable":true}},"auth":{"type":"string","nullable":true,"description":"Authcode: New authorization code for this contact"},"autodelete":{"type":"string","nullable":true,"enum":["0","1"],"description":"Auto Delete: Autodelete 0 sets the contact to clientDeleteProhibited, so that it will not get deleted automatically if it is not linked with an object."},"checkonly":{"type":"string","nullable":true,"enum":["0","1"],"description":"Checkonly"},"city":{"type":"string","nullable":true,"description":"City: New city for this contact"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"country":{"type":"string","nullable":true,"description":"Country code: New country code for this contact"},"delstatus":{"type":"array","items":{"type":"string","nullable":true}},"email":{"type":"string","nullable":true,"description":"E-Mail: New email - address for this contact"},"fax":{"type":"string","nullable":true,"description":"Fax: New FAX number for this contact"},"firstname":{"type":"string","nullable":true,"description":"First name: New first name for this contact"},"lastname":{"type":"string","nullable":true,"description":"Last name: New last name for this contact"},"middlename":{"type":"string","nullable":true,"description":"Middle name: New middle (second) name for this contact"},"organization":{"type":"string","nullable":true,"description":"Organization: New organization for this contact"},"phone":{"type":"string","nullable":true,"description":"Phone: New phone number for this contact. This needs to be in the format +\u003ccountry code\u003e.\u003csubscriber number\u003e - country code: 1-3 digits, subscriber number 1-14 digits"},"preverify":{"type":"string","nullable":true,"enum":["0","1"],"description":"Preverify"},"state":{"type":"string","nullable":true,"description":"State: New state for this contact"},"status":{"type":"array","description":"Contact status","items":{"type":"string","nullable":true,"description":"Contact status"}},"street":{"type":"array","description":"Street: New street for this contact","items":{"type":"string","nullable":true,"description":"Street: New street for this contact"}},"title":{"type":"string","nullable":true,"description":"Title: New title for this contact"},"triggerda":{"type":"string","nullable":true,"enum":["1"],"description":"Trigger DA: Forces ICANN ownerchange designated agent mode if change is material and OWNERCHANGE-MODE is set to FOA. Needs activation through registrar settings."},"triggerfoa":{"type":"string","nullable":true,"enum":["1"],"description":"Trigger FOA: Forces ICANN ownerchange FOA if change is material and OWNERCHANGE-MODE is set to DESIGNATED_AGENT."},"validation":{"type":"string","nullable":true,"enum":["0","1"],"description":"Validation"},"x-au-owner-accept-validation-terms":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept validation terms: Confirm that the Registrant being validated has explicitly consented to have their details validated."},"x-au-owner-cardnumber":{"type":"string","nullable":true,"description":"Identification card number: The number of the card used to validate the Registrant."},"x-au-owner-dob":{"type":"string","format":"date","nullable":true,"description":"Date of birth: Date of Birth of the Registrant being validated."},"x-au-owner-iddate":{"type":"string","format":"date","nullable":true,"description":"Citizenship acquisition date: Date when the citizenship was acquired."},"x-au-owner-idissuer":{"type":"string","nullable":true,"enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"],"description":"State where the ID was issued: State where the ID was issued."},"x-au-owner-idnumber":{"type":"string","nullable":true,"description":"Identification number: The number of the ID used to validate the Registrant."},"x-au-owner-idtype":{"type":"string","nullable":true,"enum":["1","2","3","4","5","6"],"description":"Identification type: The type of ID used to validate the Registrant."},"x-disclose":{"type":"string","nullable":true,"description":"Disclosed: New disclose - settings for this contact, possible values:  name, organization, address, phone, fax, email. (May be comma-separated, not supported by all registries)"},"x-undisclose":{"type":"string","nullable":true,"description":"Undisclosed: New undisclose - settings for this contact, possible values:  name, organization, address, phone, fax, email. (May be comma-separated, not supported by all registries)"},"x-verification-data":{"type":"array","description":"Verification Data Type: The data type that matches the associated trustframework and values.","items":{"type":"string","nullable":true,"enum":["email","phone","name","address"],"description":"Verification Data Type: The data type that matches the associated trustframework and values."}},"x-verification-evidence":{"type":"array","description":"Verification Evidence: The evidence used for the associated verification. (e.g. \"passport\" for name and address)","items":{"type":"string","nullable":true,"enum":["idcard","passport","population_register","residence_permit","proof_of_arrival","drivers_licence","company_register","company_statement","bank_account","online_payment_account","utility_account","bank_statement","tax_statement","written_attestation","digital_attestation","postal_ver_transaction_log","email_ver_transaction_log","address_database","phone_ver_transaction_log"],"description":"Verification Evidence: The evidence used for the associated verification. (e.g. \"passport\" for name and address)"}},"x-verification-method":{"type":"array","description":"Verification Method: The method that has been used for the associated verification.","items":{"type":"string","nullable":true,"enum":["auth","electronic_document","physical_document","vdig","bvr","pvr","data","reachability"],"description":"Verification Method: The method that has been used for the associated verification."}},"x-verification-reference":{"type":"array","description":"Verification Reference: The reference code for the associated verification.","items":{"type":"string","nullable":true,"description":"Verification Reference: The reference code for the associated verification."}},"x-verification-result":{"type":"array","description":"Verification Result: Was the associated verification successful?","items":{"type":"string","nullable":true,"enum":["success","failed"],"description":"Verification Result: Was the associated verification successful?"}},"x-verification-timestamp":{"type":"array","description":"Verification Timestamp: The timestamp of the associated verification.","items":{"type":"string","format":"date-time","nullable":true,"description":"Verification Timestamp: The timestamp of the associated verification."}},"x-verification-trustframework":{"type":"array","description":"Verification Trustframework: The trustframework that was used to verify the associated data type.","items":{"type":"string","nullable":true,"description":"Verification Trustframework: The trustframework that was used to verify the associated data type."}},"zip":{"type":"string","nullable":true,"description":"ZIP code: New zip code for this contact"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"ownerchange_status":{"type":"string","description":"Owner change status: Status of pending ownerchange"},"rating":{"type":"integer","format":"int32","description":"Rating"},"rating_reason":{"type":"string","description":"Rating reason"},"rating_reference":{"type":"string","description":"Rating reference"},"rating_risklevel":{"type":"string","description":"Rating risklevel"},"status":{"type":"string","description":"Status"},"validated":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact is validated"},"verification_requested":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact verification request has been created"},"verified":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact is verified"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyContact"}},"/contact/{contact}/availability":{"get":{"operationId":"checkContact","summary":"XRRP command CheckContact (checkContact)","description":"\n","tags":["contact"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"contact","in":"path","required":true,"description":"Contact handle to be checked for availability","schema":{"type":"string","description":"Contact handle to be checked for availability"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckContact"}},"/contact/{contact}/clone":{"post":{"operationId":"cloneContact","summary":"XRRP command CloneContact (cloneContact)","description":"\n","tags":["contact"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"new":{"type":"string","nullable":true,"enum":["0","1"],"description":"Required if contact in same account should be cloned"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"contact":{"type":"string","description":"New contact: The new contact handle"},"roid":{"type":"string","description":"ROID: ROID of the new contact"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CloneContact"}},"/contact/{contact}/disclosure":{"put":{"operationId":"requestToken","summary":"XRRP command RequestToken (requestToken)","description":"\n","tags":["contact","domain"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"contacttype":{"type":"array","items":{"type":"string","nullable":true,"enum":["OWNER","ADMIN","TECH","BILLING"]}},"domain":{"type":"string"},"language":{"type":"string"},"registryaccount":{"type":"string"},"type":{"type":"string","enum":["CONTACTDISCLOSURE","REGISTRYACCOUNT"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"contact":{"type":"array","items":{"type":"string"}},"description":{"type":"array","items":{"type":"string"}},"expiry_date":{"type":"array","description":"Token expiry date","items":{"type":"string","description":"Token expiry date"}},"status":{"type":"array","items":{"type":"string"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RequestToken"}},"/contact/{contact}/registry":{"patch":{"operationId":"modifyRegistryContact_2","summary":"XRRP command ModifyRegistryContact (modifyRegistryContact_2)","description":"Explicit send a ModifyContact - request for a contact directly to the registry\nNote: This is not supported for all registries\n","tags":["contact"],"parameters":[{"name":"contact","in":"path","required":true,"description":"Contact, which shall be updated at the registry","schema":{"type":"string","description":"Contact, which shall be updated at the registry"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"registry":{"type":"string","description":"Registry, where this contact shoulsd be modified"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyRegistryContact"}},"/contact/{contact}/registry/{registry}":{"patch":{"operationId":"modifyRegistryContact","summary":"XRRP command ModifyRegistryContact (modifyRegistryContact)","description":"Explicit send a ModifyContact - request for a contact directly to the registry\nNote: This is not supported for all registries\n","tags":["contact"],"parameters":[{"name":"contact","in":"path","required":true,"description":"Contact, which shall be updated at the registry","schema":{"type":"string","description":"Contact, which shall be updated at the registry"}},{"name":"registry","in":"path","required":true,"description":"Registry, where this contact shoulsd be modified","schema":{"type":"string","description":"Registry, where this contact shoulsd be modified"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyRegistryContact"}},"/contact/{contact}/transfer":{"post":{"operationId":"transferContact","summary":"XRRP command TransferContact (transferContact)","description":"\n","tags":["contact"],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"type":"string","nullable":true},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"ack_date":{"type":"string","description":"Acknowledge date"},"current_registrar":{"type":"string","description":"Current registrar"},"request_date":{"type":"string","description":"Request date"},"requesting_registrar":{"type":"string","description":"Requesting registrar"},"transfer_status":{"type":"string","description":"Transfer status"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"TransferContact"}},"/contact/{contact}/unsync":{"get":{"operationId":"statusUnsyncRegistryContact","summary":"XRRP command StatusUnsyncRegistryContact (statusUnsyncRegistryContact)","description":"\n","tags":["contact"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Domain name for the contact sync check.","schema":{"type":"string","nullable":true,"description":"Domain name for the contact sync check."}},{"name":"contact","in":"path","required":true,"description":"Contact for the sync check.","schema":{"type":"string","nullable":true,"description":"Contact for the sync check."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"contact":{"type":"array","description":"Contact: The contact where the information is not in sync with the registry.","items":{"type":"string","description":"Contact: The contact where the information is not in sync with the registry."}},"contacttype":{"type":"array","description":"Contact Type: The contact type of the contact for the domain name.","items":{"type":"string","description":"Contact Type: The contact type of the contact for the domain name."}},"domain":{"type":"array","description":"Domain: The domain name where the contact information is not in sync with the registry.","items":{"type":"string","description":"Domain: The domain name where the contact information is not in sync with the registry."}},"errorcode":{"type":"array","description":"Error Code: Error code of the failed contact update at the registry if available.","items":{"type":"integer","format":"int32","nullable":true,"description":"Error Code: Error code of the failed contact update at the registry if available."}},"errordescription":{"type":"array","description":"Error Description: Error description of the failed contact update at the registry if available.","items":{"type":"string","description":"Error Description: Error description of the failed contact update at the registry if available."}},"zone":{"type":"array","description":"Zone: The zone of the domain.","items":{"type":"string","description":"Zone: The zone of the domain."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusUnsyncRegistryContact"}},"/contact/{trigger}/activate":{"post":{"operationId":"activateContact","summary":"XRRP command ActivateContact (activateContact)","description":"\n","tags":["contact"],"parameters":[{"name":"trigger","in":"path","required":true,"description":"Trigger: Trigger code for contact email address verification","schema":{"type":"string","description":"Trigger: Trigger code for contact email address verification"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ActivateContact"}},"/currency/rate":{"get":{"operationId":"queryExchangeRates","summary":"XRRP command QueryExchangeRates (queryExchangeRates)","description":"\n","tags":["currency"],"parameters":[{"name":"currencyfrom","in":"query","schema":{"type":"string","nullable":true}},{"name":"currencyto","in":"query","schema":{"type":"string","nullable":true}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"maxdate","in":"query","schema":{"type":"string","format":"date","nullable":true}},{"name":"mindate","in":"query","schema":{"type":"string","format":"date","nullable":true}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of exchange rates shown"},"currency_from":{"type":"array","description":"Currency from: Currency from which will be converted","items":{"type":"string","description":"Currency from: Currency from which will be converted"}},"currency_to":{"type":"array","description":"Currency to: Currency, to which will be converted","items":{"type":"string","description":"Currency to: Currency, to which will be converted"}},"date":{"type":"array","description":"Date: When was the exchange rate last updated","items":{"type":"string","format":"date","description":"Date: When was the exchange rate last updated"}},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"rate":{"type":"array","description":"Rate: The exchange rate between the two currencies","items":{"type":"number","format":"float","description":"Rate: The exchange rate between the two currencies"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryExchangeRates"}},"/currency/rate/{from}/{to}":{"get":{"operationId":"convertCurrency","summary":"XRRP command ConvertCurrency (convertCurrency)","description":"Converts a decimal amount from one currency to another currency\n","tags":["currency"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"amount","in":"query","required":true,"description":"Amount to convert","schema":{"type":"string","format":"decimal","description":"Amount to convert"}},{"name":"from","in":"path","required":true,"description":"Currency to convert from","schema":{"type":"string","description":"Currency to convert from"}},{"name":"to","in":"path","required":true,"description":"Currency to convert to","schema":{"type":"string","description":"Currency to convert to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","description":"Amount: The amount given in the request"},"converted_amount":{"type":"string","format":"decimal","description":"Converted amount: The amount after the convertion"},"from":{"type":"string","description":"From: The original currency of the amount"},"rate":{"type":"number","format":"float","description":"Rate: Convertion rate used to convert the amount"},"to":{"type":"string","description":"To: The currency the command converted the amount into"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ConvertCurrency"}},"/dnszone":{"get":{"operationId":"queryDNSZoneList","summary":"XRRP command QueryDNSZoneList (queryDNSZoneList)","description":"\n","tags":["dnszone"],"parameters":[{"name":"dnszone","in":"query","description":"DNSZONE: Filter by dnszone","schema":{"type":"string","description":"DNSZONE: Filter by dnszone"}},{"name":"external","in":"query","description":"External: Filter by external status","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"External: Filter by external status"}},{"name":"first","in":"query","description":"First result to display","schema":{"type":"integer","format":"int32","description":"First result to display"}},{"name":"limit","in":"query","description":"Limits the number of results to given number","schema":{"type":"integer","format":"int32","description":"Limits the number of results to given number"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"wide","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"orderby","in":"query","description":"Order resulting list by this column","schema":{"type":"string","enum":["name","updated_date"],"description":"Order resulting list by this column"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"dnszone":{"type":"string"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of zones shown"},"dnszone#":{"type":"string","description":"DNSZONE: Zones"},"external":{"type":"integer","format":"int32","description":"External: External status of the zone"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"status":{"type":"string","description":"Status: Zone status"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing zones"},"updated_date":{"type":"string","format":"date-time","description":"UPDATED DATE: Last Update"},"wide":{"type":"integer","format":"int32","description":"Wide: Show a detailed list or a grouped list version"},"zonetype":{"type":"string","description":"Zone type: Zone type"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDNSZoneList"},"post":{"operationId":"addDNSZone","summary":"XRRP command AddDNSZone (addDNSZone)","description":"\n","tags":["dnszone"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"dnszone":{"type":"string","description":"DNSZONE: Name of the new zone"},"masteripaddress":{"type":"array","description":"Master server IP address: IP address of master server to request ingoing zone transfers.","items":{"type":"string","nullable":true,"description":"Master server IP address: IP address of master server to request ingoing zone transfers."}},"premiumdnsset":{"type":"string","nullable":true,"enum":["ANYCAST1"],"description":"Premium DNS set: Premium DNS set"},"rr":{"type":"array","description":"Resource Records","items":{"type":"string","nullable":true,"description":"Resource Records"}},"signed":{"type":"string","nullable":true,"enum":["0","1"],"description":"Sign zone: Sign zone"},"slaveipaddress":{"type":"array","description":"Slave server IP address: IP address of slave server to allow outgoing zone transfers.","items":{"type":"string","nullable":true,"description":"Slave server IP address: IP address of slave server to allow outgoing zone transfers."}},"soaexpire":{"type":"integer","format":"int32","nullable":true,"description":"EXPIRE: A 32 bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative."},"soaminttl":{"type":"integer","format":"int32","nullable":true,"description":"MINTTL: The unsigned 32 bit minimum TTL field that should be exported with any RR from this zone."},"soamname":{"type":"string","nullable":true,"description":"MNAME: The \u003cdomain-name\u003e of the name server that was the original or primary source of data for this zone."},"soarefresh":{"type":"integer","format":"int32","nullable":true,"description":"refresh: A 32 bit time interval before the zone should be refreshed."},"soaretry":{"type":"integer","format":"int32","nullable":true,"description":"retry: A 32 bit time interval that should elapse before a failed refresh should be retried."},"soarname":{"type":"string","nullable":true,"description":"rname: A \u003cdomain-name\u003e which specifies the mailbox of the person responsible for this zone."},"soattl":{"type":"integer","format":"int32","nullable":true,"description":"SOATTL: The unsigned 32 bit TTL field that should be exported with SOA RR from this zone."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"dnssec_ksk_status":{"type":"array","description":"DNSSEC KSK status: DNSSEC KSK status","items":{"type":"string","description":"DNSSEC KSK status: DNSSEC KSK status"}},"dnssec_zsk_status":{"type":"array","description":"DNSSEC ZSK status: DNSSEC ZSK status","items":{"type":"string","description":"DNSSEC ZSK status: DNSSEC ZSK status"}},"keydata":{"type":"array","description":"DNSSEC KEY DATA: DNSSEC KEY DATA","items":{"type":"string","description":"DNSSEC KEY DATA: DNSSEC KEY DATA"}},"keydsdata_sha256":{"type":"array","description":"DNSSEC DS DATA: DNSSEC DS DATA","items":{"type":"string","description":"DNSSEC DS DATA: DNSSEC DS DATA"}},"masteripaddress":{"type":"array","description":"Master ipaddress: Master ipaddress","items":{"type":"string","description":"Master ipaddress: Master ipaddress"}},"signed":{"type":"integer","format":"int32","description":"Signed: Is zone signed "},"signer_status":{"type":"string","nullable":true,"description":"Signer status: Signer status"},"status":{"type":"array","description":"Zone status: Zone status","items":{"type":"string","description":"Zone status: Zone status"}},"type":{"type":"array","description":"DNSSEC key type: DNSSEC key type","items":{"type":"string","description":"DNSSEC key type: DNSSEC key type"}},"zonetype":{"type":"string","description":"Zone type: Zone type"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddDNSZone"}},"/dnszone/-/dynamic":{"get":{"operationId":"queryDynamicDNSList","summary":"XRRP command QueryDynamicDNSList (queryDynamicDNSList)","description":"Show details about all created dynamic dns objects.\n","tags":["dnszone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"hostname","in":"query","description":"Hostname: Search for specific host name.","schema":{"type":"string","nullable":true,"description":"Hostname: Search for specific host name."}},{"name":"status","in":"query","description":"Status: Search for specific status.","schema":{"type":"string","nullable":true,"enum":["ACTIVE","DISABLED"],"description":"Status: Search for specific status."}},{"name":"wide","in":"query","description":"Hostname: Adds more details to the output.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Hostname: Adds more details to the output."}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["HOSTNAME","STATUS","PASSWORD","UPDATEDBY","CREATEDDATE","UPDATEDDATE"],"description":"Sort the result by this column"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","description":"Created date: When the entry was created."},"hostname":{"type":"string","nullable":true,"description":"Hostname: Shows the hostname."},"password":{"type":"string","nullable":true,"description":"Password: Shows the password if WIDE = 1."},"status":{"type":"string","nullable":true,"enum":["ACTIVE","DISABLED"],"description":"Status: Shows the status."},"updated_by":{"type":"string","description":"Updated by: Who was the last one updating the entry."},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When the entry was last updated."}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count"},"created_by":{"type":"string","description":"Created by: Who created the entry."},"first":{"type":"integer","format":"int32","description":"First"},"last":{"type":"integer","format":"int32","description":"Last"},"limit":{"type":"integer","format":"int32","description":"Limit"},"total":{"type":"integer","format":"int32","description":"Total"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDynamicDNSList"}},"/dnszone/-/dynamic/{hostname}":{"delete":{"operationId":"deleteDynamicDNS","summary":"XRRP command DeleteDynamicDNS (deleteDynamicDNS)","description":"Deletes a DynamicDNS host object.\n","tags":["dnszone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"hostname","in":"path","required":true,"description":"Hostname: Dynamic DNS host name","schema":{"type":"string","nullable":true,"description":"Hostname: Dynamic DNS host name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteDynamicDNS"},"get":{"operationId":"statusDynamicDNS","summary":"XRRP command StatusDynamicDNS (statusDynamicDNS)","description":"Shows details about a dynamic DNS host object.\n","tags":["dnszone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"hostname","in":"path","required":true,"description":"Hostname: Dynamic DNS host name","schema":{"type":"string","nullable":true,"description":"Hostname: Dynamic DNS host name"}},{"name":"wide","in":"query","description":"Wide: Adds more details to the output","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Wide: Adds more details to the output"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"created_by":{"type":"string","description":"Created by: Who created the entry."},"created_date":{"type":"string","format":"date-time","description":"Created date: When the entry was created."},"hostname":{"type":"string","description":"Hostname"},"ipv4":{"type":"string","nullable":true,"description":"IPv4 address: The currently set IPv4 address (A record)."},"ipv6":{"type":"string","nullable":true,"description":"IPv6 address: The currently set IPv6 address (AAAA record)."},"password":{"type":"string","nullable":true,"description":"Password: Shows the password if WIDE = 1."},"status":{"type":"string","description":"Status"},"updated_by":{"type":"string","description":"Updated by: Who was the last one updating the entry."},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When the entry was last updated."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusDynamicDNS"},"patch":{"operationId":"modifyDynamicDNS","summary":"XRRP command ModifyDynamicDNS (modifyDynamicDNS)","description":"Modifies a DynamicDNS host object.\n","tags":["dnszone"],"parameters":[{"name":"hostname","in":"path","required":true,"description":"Hostname: Dynamic DNS host name","schema":{"type":"string","nullable":true,"description":"Hostname: Dynamic DNS host name"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"password":{"type":"string","nullable":true,"description":"Password: Sets the Dynamic DNS password"},"status":{"type":"string","nullable":true,"enum":["ACTIVE","DISABLED"],"description":"Status: Sets the status of the dynamic DNS host object."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyDynamicDNS"},"post":{"operationId":"addDynamicDNS","summary":"XRRP command AddDynamicDNS (addDynamicDNS)","description":"Adds a dynamic DNS host object.\n","tags":["dnszone"],"parameters":[{"name":"hostname","in":"path","required":true,"description":"Hostname: Dynamic DNS host name","schema":{"type":"string","nullable":true,"description":"Hostname: Dynamic DNS host name"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"password":{"type":"string","nullable":true,"description":"Hostname: Dynamic DNS password"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddDynamicDNS"}},"/dnszone/-/dynamic/{hostname}/{ip}":{"put":{"operationId":"updateDynamicDNS","summary":"XRRP command UpdateDynamicDNS (updateDynamicDNS)","description":"Updates a dynamic DNS host object.\n","tags":["dnszone"],"parameters":[{"name":"hostname","in":"path","required":true,"description":"Hostname: Dynamic DNS host name","schema":{"type":"string","nullable":true,"description":"Hostname: Dynamic DNS host name"}},{"name":"ip","in":"path","required":true,"description":"IP: Sets the IP addresses IPv4+IPv6 to those values.","schema":{"type":"array","description":"IP: Sets the IP addresses IPv4+IPv6 to those values.","items":{"type":"string","nullable":true,"description":"IP: Sets the IP addresses IPv4+IPv6 to those values."}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clearipv4":{"type":"string","nullable":true,"enum":["0","1"],"description":"CLEARIPV4: Clears existing IPV4 addresses before setting new IP(s)"},"clearipv6":{"type":"string","nullable":true,"enum":["0","1"],"description":"CLEARIPV6: Clears existing IPV6 addresses before setting new IP(s)"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"mx":{"type":"string","nullable":true,"description":"IP: Sets the MX entry to this value."},"password":{"type":"string","nullable":true,"description":"Hostname: Dynamic DNS password"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"UpdateDynamicDNS"}},"/dnszone/-/mailfwd":{"get":{"operationId":"queryMailFwdList","summary":"XRRP command QueryMailFwdList (queryMailFwdList)","description":"Shows a list of existing forwards.\n","tags":["dnszone"],"parameters":[{"name":"wide","in":"query","schema":{"type":"string","nullable":true}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"dnszone","in":"query","description":"Filter by DNSZONE","schema":{"type":"string","description":"Filter by DNSZONE"}},{"name":"from","in":"query","description":"Filter by FROM","schema":{"type":"string","description":"Filter by FROM"}},{"name":"source","in":"query","description":"Filter by SOURCE","schema":{"type":"string","description":"Filter by SOURCE"}},{"name":"target","in":"query","description":"Filter by TARGET","schema":{"type":"string","description":"Filter by TARGET"}},{"name":"to","in":"query","description":"Filter by TO","schema":{"type":"string","description":"Filter by TO"}},{"name":"first","in":"query","schema":{"type":"string","nullable":true}},{"name":"limit","in":"query","schema":{"type":"string","nullable":true}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Order resulting list by this column","schema":{"type":"string","enum":["dnszone"],"description":"Order resulting list by this column"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"to0":{"type":"string"},"to1":{"type":"string"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of forwardings shown"},"dnszone":{"type":"string","description":"DNSZONE: Associated zone"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"from":{"type":"string","description":"FROM: Forwarding from"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"mailfwd_from":{"type":"array","items":{"type":"string"}},"mailfwd_to":{"type":"array","items":{"type":"string"}},"to":{"type":"string","description":"TO: Comma separated list of recipients"},"to#":{"type":"string","description":"TO#: Recipient"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing forwardings"},"wide":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryMailFwdList"},"post":{"operationId":"addMailFwd","summary":"XRRP command AddMailFwd (addMailFwd)","description":"Forward emails from one address to another. You need to use the Key-Systems nameservers for the domain of \"MAILFWD-FROM\"\n","tags":["dnszone"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"from":{"type":"string","description":"From: Email address to be forwarded"},"to":{"type":"string","description":"To: Target email address"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddMailFwd"}},"/dnszone/-/mailfwd/{from}":{"delete":{"operationId":"deleteMailFwd","summary":"XRRP command DeleteMailFwd (deleteMailFwd)","description":"Deletes an existing forward.\n","tags":["dnszone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"from","in":"path","required":true,"description":"Email address - forwarding to be deleted","schema":{"type":"string","description":"Email address - forwarding to be deleted"}},{"name":"to","in":"query","description":"Target email address","schema":{"type":"string","nullable":true,"description":"Target email address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteMailFwd"}},"/dnszone/-/webfwd":{"get":{"operationId":"queryWebFwdList","summary":"XRRP command QueryWebFwdList (queryWebFwdList)","description":"Shows a list of existing forwards.\n","tags":["dnszone"],"parameters":[{"name":"wide","in":"query","schema":{"type":"string","nullable":true}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"dnszone","in":"query","description":"Filter by DNSZONE","schema":{"type":"string","description":"Filter by DNSZONE"}},{"name":"source","in":"query","description":"Filter by SOURCE","schema":{"type":"string","description":"Filter by SOURCE"}},{"name":"target","in":"query","description":"Filter by TARGET","schema":{"type":"string","description":"Filter by TARGET"}},{"name":"type","in":"query","description":"Filter by TYPE","schema":{"type":"string","description":"Filter by TYPE"}},{"name":"https","in":"query","description":"Filter by HTTPS","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Filter by HTTPS"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Order resulting list by this column","schema":{"type":"string","nullable":true,"enum":["source","target","type"],"description":"Order resulting list by this column"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"webfwd":{"type":"string","description":"WEBFWD: Forwarding"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of forwardings shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"keepuripath":{"type":"array","description":"Keepuripath: Keepuripath","items":{"type":"integer","format":"int32","description":"Keepuripath: Keepuripath"}},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"source":{"type":"array","description":"Zone to be forwarded","items":{"type":"string","description":"Zone to be forwarded"}},"target":{"type":"array","description":"Target of the forwarding (i.e. http://www.example.org)","items":{"type":"string","nullable":true,"description":"Target of the forwarding (i.e. http://www.example.org)"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing forwardings"},"type":{"type":"array","description":"Type of redirection used","items":{"type":"string","enum":["RD","MRD"],"description":"Type of redirection used"}},"webfwd_from":{"type":"array","description":"Zone to be forwarded","items":{"type":"string","description":"Zone to be forwarded"}},"webfwd_to":{"type":"array","description":"Target of the forwarding (i.e. http://www.example.org)","items":{"type":"string","description":"Target of the forwarding (i.e. http://www.example.org)"}},"webfwd_type":{"type":"array","description":"Type of redirection used","items":{"type":"string","enum":["RD","MRD"],"description":"Type of redirection used"}},"wide":{"type":"array","description":"Wide: Expand query list","items":{"type":"integer","format":"int32","description":"Wide: Expand query list"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryWebFwdList"},"post":{"operationId":"addWebFwd","summary":"XRRP command AddWebFwd (addWebFwd)","description":"Add a new forward.\n","tags":["dnszone"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"content":{"type":"array","description":"Content: Static web content (relevant for TYPE=SELF)","items":{"type":"string","description":"Content: Static web content (relevant for TYPE=SELF)"}},"https":{"type":"string","nullable":true,"enum":["0","1"],"description":"Enable https: Enable https redirecting to forwarding target, default is 0"},"keepuripath":{"type":"string","nullable":true,"enum":["0","1"],"description":"Keep URI path: Keep URI path while redirecting to forwarding target"},"source":{"type":"string","description":"Zone: Zone to be forwarded"},"target":{"type":"string","description":"Target: Target of the forwarding"},"type":{"type":"string","enum":["RD","TRD","MRD","SELF"],"description":"Type: Static content"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddWebFwd"}},"/dnszone/-/webfwd/{source}":{"delete":{"operationId":"deleteWebFwd","summary":"XRRP command DeleteWebFwd (deleteWebFwd)","description":"Deletes an existing forward.\n","tags":["dnszone"],"parameters":[{"name":"source","in":"path","required":true,"description":"Redirected zone to be deleted","schema":{"type":"string","description":"Redirected zone to be deleted"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteWebFwd"}},"/dnszone/{dnszone}":{"delete":{"operationId":"deleteDNSZone","summary":"XRRP command DeleteDNSZone (deleteDNSZone)","description":"\n","tags":["dnszone"],"parameters":[{"name":"dnszone","in":"path","required":true,"description":"DNSZONE: Name of the zone to delete","schema":{"type":"string","description":"DNSZONE: Name of the zone to delete"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteDNSZone"},"get":{"operationId":"statusDNSZone","summary":"XRRP command StatusDNSZone (statusDNSZone)","description":"\n","tags":["dnszone"],"parameters":[{"name":"dnszone","in":"path","required":true,"description":"DNSZONE: Name of the zone","schema":{"type":"string","description":"DNSZONE: Name of the zone"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"active":{"type":"integer","format":"int32","description":"Zone active: Zone active"},"dnssec_ksk_status":{"type":"array","description":"DNSSEC KSK status: DNSSEC KSK status","items":{"type":"string","description":"DNSSEC KSK status: DNSSEC KSK status"}},"dnssec_zsk_status":{"type":"array","description":"DNSSEC ZSK status: DNSSEC ZSK status","items":{"type":"string","description":"DNSSEC ZSK status: DNSSEC ZSK status"}},"dnszone":{"type":"string","description":"DNSZONE: DNSZONE"},"external":{"type":"integer","format":"int32","description":"Display if the zone is considered external"},"keydata":{"type":"array","description":"DNSSEC KEY DATA: DNSSEC KEY DATA","items":{"type":"string","description":"DNSSEC KEY DATA: DNSSEC KEY DATA"}},"keydsdata_sha256":{"type":"array","description":"DNSSEC DS DATA: DNSSEC DS DATA","items":{"type":"string","description":"DNSSEC DS DATA: DNSSEC DS DATA"}},"masteripaddress":{"type":"array","description":"Master ipaddress: Master ipaddress","items":{"type":"string","description":"Master ipaddress: Master ipaddress"}},"rrstotal":{"type":"string"},"signed":{"type":"integer","format":"int32","description":"Signed: Is zone signed "},"signer_status":{"type":"string","nullable":true,"description":"Signer status: Signer status"},"slaveipaddress":{"type":"array","description":"Slave ipaddress: Slave ipaddress","items":{"type":"string","description":"Slave ipaddress: Slave ipaddress"}},"soaexpire":{"type":"string","nullable":true,"description":"SOA Expire: SOA Expire"},"soaminttl":{"type":"string","nullable":true,"description":"SOA Minttl: SOA Minttl"},"soamname":{"type":"string","nullable":true,"description":"SOA Mname: SOA Mname"},"soarefresh":{"type":"string","nullable":true,"description":"SOA Refresh: SOA Refresh"},"soaretry":{"type":"string","nullable":true,"description":"SOA Retry: SOA Retry"},"soarname":{"type":"string","nullable":true,"description":"SOA Rname: SOA Rname"},"soaserial":{"type":"string","nullable":true,"description":"SOA Serial: SOA Serial"},"soattl":{"type":"string","nullable":true},"status":{"type":"string"},"type":{"type":"array","description":"DNSSEC key type: DNSSEC key type","items":{"type":"string","description":"DNSSEC key type: DNSSEC key type"}},"wwwtargetdata":{"type":"string"},"wwwtargettype":{"type":"string"},"zonetype":{"type":"string","description":"Zone type: Zone type"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusDNSZone"},"patch":{"operationId":"modifyDNSZone","summary":"XRRP command ModifyDNSZone (modifyDNSZone)","description":"\n","tags":["dnszone"],"parameters":[{"name":"dnszone","in":"path","required":true,"description":"Name of the zone to modify","schema":{"type":"string","description":"Name of the zone to modify"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addmasteripaddress":{"type":"array","description":"Add master server IP address: Add IP address of master server to request ingoing zone transfers.","items":{"type":"string","nullable":true,"description":"Add master server IP address: Add IP address of master server to request ingoing zone transfers."}},"addrr":{"type":"array","description":"Set of new resource records","items":{"type":"string","description":"Set of new resource records"}},"addslaveipaddress":{"type":"array","description":"Add slave server IP address: Add IP address of slave server to allow outgoing zone transfers.","items":{"type":"string","nullable":true,"description":"Add slave server IP address: Add IP address of slave server to allow outgoing zone transfers."}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"delallrr":{"type":"array","description":"DELALLRR: Wildcard delete records from zone","items":{"type":"string","description":"DELALLRR: Wildcard delete records from zone"}},"delmasteripaddress":{"type":"array","description":"Delete master server IP address: Delete IP address of master server to request ingoing zone transfers.","items":{"type":"string","nullable":true,"description":"Delete master server IP address: Delete IP address of master server to request ingoing zone transfers."}},"delrr":{"type":"array","description":"ressource record: Set of resource records to delete from zone","items":{"type":"string","description":"ressource record: Set of resource records to delete from zone"}},"delslaveipaddress":{"type":"array","description":"Delete slave server IP address: Delete IP address of slave server to disallow outgoing zone transfers.","items":{"type":"string","nullable":true,"description":"Delete slave server IP address: Delete IP address of slave server to disallow outgoing zone transfers."}},"finishkskrollover":{"type":"integer","format":"int32","description":"Finish KSK rollover: Keytag of KSK whose rollover should be finished."},"masteripaddress":{"type":"array","description":"Master server IP address: IP address of master server to request ingoing zone transfers.","items":{"type":"string","nullable":true,"description":"Master server IP address: IP address of master server to request ingoing zone transfers."}},"premiumdnsset":{"type":"string","nullable":true,"enum":["ANYCAST1"],"description":"Premium DNS set: Premium DNS set"},"rollover":{"type":"string","nullable":true,"enum":["ZSK","KSK"],"description":"Rollover: Rollover"},"rr":{"type":"array","description":"Set of resource records to exchange","items":{"type":"string","description":"Set of resource records to exchange"}},"signed":{"type":"string","nullable":true,"enum":["0","1"],"description":"Sign zone: Sign zone"},"slaveipaddress":{"type":"array","description":"Slave server IP address: IP address of slave server to allow outgoing zone transfers.","items":{"type":"string","nullable":true,"description":"Slave server IP address: IP address of slave server to allow outgoing zone transfers."}},"soaexpire":{"type":"integer","format":"int32","nullable":true,"description":"EXPIRE: A 32 bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative."},"soaminttl":{"type":"integer","format":"int32","nullable":true,"description":"MINTTL: The unsigned 32 bit minimum TTL field that should be exported with any RR from this zone."},"soamname":{"type":"string","nullable":true,"description":"MNAME: The \u003cdomain-name\u003e of the name server that was the original or primary source of data for this zone."},"soarefresh":{"type":"integer","format":"int32","nullable":true,"description":"refresh: A 32 bit time interval before the zone should be refreshed."},"soaretry":{"type":"integer","format":"int32","nullable":true,"description":"retry: A 32 bit time interval that should elapse before a failed refresh should be retried."},"soarname":{"type":"string","nullable":true,"description":"rname: A \u003cdomain-name\u003e which specifies the mailbox of the person responsible for this zone."},"soaserial":{"type":"integer","format":"int32","nullable":true,"description":"serial: The unsigned 32 bit version number of the original copy of the zone. Zone transfers preserve this alue. This value wraps and should be compared using sequence space  arithmetic."},"soattl":{"type":"integer","format":"int32","nullable":true,"description":"SOATTL: The unsigned 32 bit TTL field that should be exported with SOA RR from this zone."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"masteripaddress":{"type":"array","description":"Master ipaddress: Master ipaddress","items":{"type":"string","description":"Master ipaddress: Master ipaddress"}},"signed":{"type":"integer","format":"int32","description":"Signed: Is zone signed "},"zonetype":{"type":"string","description":"Zone type: Zone type"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyDNSZone"}},"/dnszone/{dnszone}/availability":{"get":{"operationId":"checkDNSZone","summary":"XRRP command CheckDNSZone (checkDNSZone)","description":"\n","tags":["dnszone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"dnszone","in":"path","required":true,"description":"DNSZone to be checked for availability","schema":{"type":"string","description":"DNSZone to be checked for availability"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckDNSZone"}},"/dnszone/{dnszone}/export":{"get":{"operationId":"exportDNSZone","summary":"XRRP command ExportDNSZone (exportDNSZone)","description":"\n","tags":["dnszone"],"parameters":[{"name":"dnszone","in":"path","required":true,"description":"DNSZONE: Name of the zone","schema":{"type":"string","description":"DNSZONE: Name of the zone"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"dnszone":{"type":"string"},"line":{"type":"array","items":{"type":"string"}},"line#":{"type":"string","description":"LINE#: BIND Zone File"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ExportDNSZone"}},"/dnszone/{dnszone}/fetch":{"get":{"operationId":"fetchDNSZone","summary":"XRRP command FetchDNSZone (fetchDNSZone)","description":"\n","tags":["dnszone"],"parameters":[{"name":"dnszone","in":"path","required":true,"description":"DNSZone to be queried.","schema":{"type":"string","description":"DNSZone to be queried."}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"querytype":{"type":"string"},"rr#":{"type":"string","description":"RESOURCE RECORD: Resource records of relevant zone."},"soaexpire":{"type":"string"},"soaminttl":{"type":"string"},"soamname":{"type":"string"},"soarefresh":{"type":"string"},"soaretry":{"type":"string"},"soarname":{"type":"string"},"soaserial":{"type":"string"},"soattl":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"FetchDNSZone"}},"/dnszone/{dnszone}/import":{"post":{"operationId":"importDNSZone","summary":"XRRP command ImportDNSZone (importDNSZone)","description":"\n","tags":["dnszone"],"parameters":[{"name":"dnszone","in":"path","required":true,"description":"DNSZONE: Name of the zone","schema":{"type":"string","description":"DNSZONE: Name of the zone"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"line":{"type":"array","description":"BIND Zone File","items":{"type":"string","description":"BIND Zone File"}},"overwrite":{"type":"string","nullable":true,"enum":["0","1"],"description":"Overwrite existing zone with same name."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ImportDNSZone"}},"/dnszone/{dnszone}/rr":{"get":{"operationId":"queryDNSZoneRRList","summary":"XRRP command QueryDNSZoneRRList (queryDNSZoneRRList)","description":"\n","tags":["dnszone"],"parameters":[{"name":"dnszone","in":"path","required":true,"description":"Name of the zone","schema":{"type":"string","description":"Name of the zone"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"content","in":"query","description":"Filter by resource data (content)","schema":{"type":"string","description":"Filter by resource data (content)"}},{"name":"name","in":"query","description":"Filter by name","schema":{"type":"string","description":"Filter by name"}},{"name":"prio","in":"query","description":"Filter by MX Prio","schema":{"type":"integer","format":"int32","description":"Filter by MX Prio"}},{"name":"ttl","in":"query","description":"Filter by TTL","schema":{"type":"integer","format":"int32","description":"Filter by TTL"}},{"name":"type","in":"query","description":"Filter records by type","schema":{"type":"string","description":"Filter records by type"}},{"name":"first","in":"query","description":"First result to display","schema":{"type":"integer","format":"int32","description":"First result to display"}},{"name":"limit","in":"query","description":"Limits the number of results to given number","schema":{"type":"integer","format":"int32","description":"Limits the number of results to given number"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Order resulting list by this column","schema":{"type":"string","enum":["name","type","content","prio","ttl","changed_date"],"description":"Order resulting list by this column"}},{"name":"wide","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string","description":"RR CONTENT: RR Content"},"locked":{"type":"integer","format":"int32","description":"RR LOCKED: RR Locked"},"name":{"type":"string","description":"RR Name: RR Name"},"prio":{"type":"integer","format":"int32"},"rr":{"type":"string"},"ttl":{"type":"integer","format":"int32","description":"RR TTL: RR TTL"},"type":{"type":"string","description":"RR TYPE: RR Type"},"updated_date":{"type":"string","format":"date-time","nullable":true,"description":"RR UPDATED DATE: RR Updated date"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of records shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"rr#":{"type":"string","description":"Resource Record: Resource Records"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing resource records"},"wide":{"type":"integer","format":"int32","description":"Wide: Show a detailed list or a grouped list version"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDNSZoneRRList"}},"/dnszone/{dnszone}/statistic":{"get":{"operationId":"queryDNSZoneStatisticList","summary":"XRRP command QueryDNSZoneStatisticList (queryDNSZoneStatisticList)","description":"\n","parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"dnszone","in":"path","required":true,"description":"Name of the zone","schema":{"type":"string","description":"Name of the zone"}},{"name":"first","in":"query","description":"First result to display","schema":{"type":"integer","format":"int32","description":"First result to display"}},{"name":"limit","in":"query","description":"Limits the number of results to given number","schema":{"type":"integer","format":"int32","description":"Limits the number of results to given number"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Order resulting list by this column","schema":{"type":"string","enum":["timestamp"],"description":"Order resulting list by this column"}},{"name":"wide","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"noerror":{"type":"integer","format":"int32","description":"NoError: Number of accesses without error"},"notimp":{"type":"integer","format":"int32","description":"Notimp: Number of accesses that had a NotImplemented error"},"nxdomain":{"type":"integer","format":"int32","description":"NXDomain: Number of accesses that had a NonExistetentDomain error"},"period":{"type":"string","description":"Period: Period of statistics entry"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp: DNS statistics day"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number entries shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing entries for the zone"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDNSZoneStatisticList"}},"/domain":{"get":{"operationId":"queryDomainList","summary":"XRRP command QueryDomainList (queryDomainList)","description":"\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Filter the result by this string (wildcards allowed)","schema":{"type":"string","description":"Filter the result by this string (wildcards allowed)"}},{"name":"domainidn","in":"query","description":"Filter the result by this string (wildcards allowed)","schema":{"type":"string","description":"Filter the result by this string (wildcards allowed)"}},{"name":"days","in":"query","description":"SHOWRENEWED","schema":{"type":"integer","format":"int32","description":"SHOWRENEWED"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","DOMAINIDN","DOMAINCREATEDDATE","DOMAINREGISTRATIONEXPIRATIONDATE","DOMAINRENEWALDATE","DOMAINZONE","ZONE","RENEWALMODE","TRANSFERMODE","DOMAINUPDATEDDATE","X-TRANSFERLOCK-UNTIL"],"description":"Sort the result by this column"}},{"name":"renewalmode","in":"query","description":"The Renewalmode selected for this domain","schema":{"type":"string","nullable":true,"enum":["DEFAULT","AUTORENEW","AUTOEXPIRE","AUTODELETE","RENEWONCE","AUTORENEWMONTHLY","EXPIREAUCTION","RENEWONCETHENAUTODELETE","RENEWONCETHENAUTOEXPIRE"],"description":"The Renewalmode selected for this domain"}},{"name":"type","in":"query","description":"Select the dataset based on different criterias","schema":{"type":"string","nullable":true,"enum":["DEFAULT","SHOWGRACE","SHOWRENEW","SHOWRENEWED","SHOWSUBLAYER","SHOWMERGEDLAYER","SHOWSUSPENDED","SHOWUNVERIFIED","SHOWUNVALIDATED","SHOWERRP","ALL","SHOWTRANSFERLOCK","SHOWGTLDOWNERTRUSTEESERVICE"],"description":"Select the dataset based on different criterias"}},{"name":"zone","in":"query","description":"Show only domains matching this zone","schema":{"type":"string","nullable":true,"description":"Show only domains matching this zone"}},{"name":"registrar","in":"query","description":"Show only domains of this registrar.","schema":{"type":"string","nullable":true,"description":"Show only domains of this registrar."}},{"name":"nameserver","in":"query","description":"Show only domains with this nameserver for TYPE=ALL","schema":{"type":"string","nullable":true,"description":"Show only domains with this nameserver for TYPE=ALL"}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domains that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domains that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domains that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domains that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domains that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domains that are associated with this zone tag."}}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"mindomainupdateddate","in":"query","description":"Filter for domains updated on or after this date","schema":{"type":"string","format":"date","nullable":true,"description":"Filter for domains updated on or after this date"}},{"name":"maxdomainupdateddate","in":"query","description":"Filter for domains updated on or before this date","schema":{"type":"string","format":"date","nullable":true,"description":"Filter for domains updated on or before this date"}},{"name":"x-de-verificationdeadlinebeforedeletion","in":"query","description":"Filter for .de domains where the DENIC verification-before-deletion deadline has a value","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Filter for .de domains where the DENIC verification-before-deletion deadline has a value"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"admincontact":{"type":"string","nullable":true,"description":"Admin contact"},"billingcontact":{"type":"string","nullable":true,"description":"Billing contact"},"domain":{"type":"string","description":"Domain: A domain matching the search - filter"},"domain_auth_code":{"type":"string","nullable":true,"description":"Domain auth code"},"domain_created_by":{"type":"string","description":"Created by: Account, in which the domain was created"},"domain_created_date":{"type":"string","format":"date-time","description":"Created date: The date, when the domain was created"},"domain_idn":{"type":"string","description":"Domain IDN: The UTF-8 - version of the domain"},"domain_registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date: When will the domain expire"},"domain_renewal_date":{"type":"string","format":"date-time","description":"Renewal date: When must the domain be renewed"},"domain_status":{"type":"string","description":"Domain status"},"domain_transfer_date":{"type":"string","nullable":true,"description":"Domain transfer date"},"domain_updated_by":{"type":"string","description":"Updated by: Account, who did the last modification on this domain"},"domain_updated_date":{"type":"string","format":"date-time","description":"Updated date: The date, when the domain was last updated"},"domain_zone":{"type":"string","description":"Zone: Zone of the domain name"},"domaincomment":{"type":"string","nullable":true,"description":"Domain comment"},"domaintags":{"type":"string","nullable":true,"description":"Domain tags"},"executiondate":{"type":"string","format":"date-time","description":"Execution date"},"nameserver":{"type":"string","nullable":true,"description":"Nameserver"},"ownercontact":{"type":"string","nullable":true,"description":"Owner contact"},"paid_until":{"type":"string","format":"date-time","description":"Paid until date: Date until the domain has been paid within the system."},"registrar":{"type":"string","description":"Registrar: Registrar account of the domain"},"renewalmode":{"type":"string","description":"Renewal mode: The current renewalmode of the domain"},"roid":{"type":"string","description":"ROID: Registry Object ID for this domain"},"status":{"type":"string","description":"Status"},"techcontact":{"type":"string","nullable":true,"description":"Tech contact"},"transfermode":{"type":"string","description":"Transfer mode: The current transfer mode of the domain"},"validated":{"type":"integer","format":"int32","description":"Validated"},"verified":{"type":"integer","format":"int32","description":"Owner contact verified: Verified owner contact"},"x-time-to-suspension":{"type":"string","format":"date-time","nullable":true,"description":"Suspension date: The date when the domain will be suspended if the email verification is not done"},"zone":{"type":"string","description":"Zone"}}}},"property":{"type":"object","properties":{"amount":{"type":"array","description":"Amount: Amount charged for the renewal","items":{"type":"string","format":"decimal","description":"Amount: Amount charged for the renewal"}},"column":{"type":"array","description":"List columns","items":{"type":"string","description":"List columns"}},"contact":{"type":"array","description":"Owner contact: Owner contact of the domain","items":{"type":"string","description":"Owner contact: Owner contact of the domain"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of domains shown"},"currency":{"type":"array","description":"Currency: The currency used to charge the renewal","items":{"type":"string","description":"Currency: The currency used to charge the renewal"}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of domains matching the criteria"},"type":{"type":"array","description":"Type: Why was the domain renewed","items":{"type":"string","enum":["RENEW","TRANSFER"],"description":"Type: Why was the domain renewed"}},"vat":{"type":"array","description":"V.A.T.: V.A.T. charged for the renewal","items":{"type":"string","format":"decimal","description":"V.A.T.: V.A.T. charged for the renewal"}},"x-de-verificationdeadlinebeforedeletion":{"type":"array","description":"DENIC verification deadline before deletion: The deadline by which DENIC verification must be completed before the domain is deleted.","items":{"type":"string","format":"date-time","nullable":true,"description":"DENIC verification deadline before deletion: The deadline by which DENIC verification must be completed before the domain is deleted."}},"x-domain-comment":{"type":"array","description":"Domain comment: Domain specific comment, to be reflected in QueryDomainList and FTP CSV domain list file.","items":{"type":"string","nullable":true,"description":"Domain comment: Domain specific comment, to be reflected in QueryDomainList and FTP CSV domain list file."}},"x-gtld-owner-trustee-active":{"type":"array","description":"GLTD trustee active: Is GLTD trustee active.","items":{"type":"string","format":"date","nullable":true,"description":"GLTD trustee active: Is GLTD trustee active."}},"x-gtld-owner-trustee-service-start":{"type":"array","description":"GLTD trustee service start date: GLTD trustee service charging fee start date.","items":{"type":"string","format":"date","nullable":true,"description":"GLTD trustee service start date: GLTD trustee service charging fee start date."}},"x-transferlock-until":{"type":"array","description":"Transfer lock until: The date until the transfer lock is set.","items":{"type":"string","format":"date-time","nullable":true,"description":"Transfer lock until: The date until the transfer lock is set."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDomainList"},"post":{"operationId":"addDomain","summary":"XRRP command AddDomain (addDomain)","description":"This commands invokes several processes:\nIt checks if the domainname is available at the registry, creates the contacthandles in the registry and starts the registration at the registry.\n","tags":["domain"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"admincontact":{"type":"array","description":"Admin contact: Contact handle of the administrative contact of the domain, also referred to as 'Admin-C'. The administrator is authorized by the registrant to make administrative decisions over the domain name and serves as secondary contact for the domain. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set.","items":{"type":"string","nullable":true,"description":"Admin contact: Contact handle of the administrative contact of the domain, also referred to as 'Admin-C'. The administrator is authorized by the registrant to make administrative decisions over the domain name and serves as secondary contact for the domain. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set."}},"auth":{"type":"string","nullable":true,"description":"Authentication code: The authorization code to be set for the domain (not supported by all registries)"},"billingcontact":{"type":"array","description":"Billing contact: Contact handle of the billing contact of the domain, also referred to as 'Billing-C'. The billing contact is the person or organisation who will usually be contacted by the registry with issues regarding the billing of the domain unless a registry-registrar model is followed. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set.","items":{"type":"string","nullable":true,"description":"Billing contact: Contact handle of the billing contact of the domain, also referred to as 'Billing-C'. The billing contact is the person or organisation who will usually be contacted by the registry with issues regarding the billing of the domain unless a registry-registrar model is followed. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set."}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"dnssec":{"type":"array","description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e","items":{"type":"string","nullable":true,"description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e"}},"dnssecdsdata":{"type":"array","description":"DSDATA: Syntax: \u003ckeytag\u003e \u003calgorithm\u003e \u003cdigestType\u003e \u003cdigest\u003e","items":{"type":"string","nullable":true,"description":"DSDATA: Syntax: \u003ckeytag\u003e \u003calgorithm\u003e \u003cdigestType\u003e \u003cdigest\u003e"}},"domain":{"type":"string","description":"Domain: The domain to be created"},"domaintag":{"type":"array","description":"Domain Tag: The domain tags that will be associated with this domain.","items":{"type":"string","nullable":true,"description":"Domain Tag: The domain tags that will be associated with this domain."}},"jobqueue":{"type":"string","nullable":true,"enum":["0","1"],"description":"Queue the command and process it in non-real time"},"nameserver":{"type":"array","description":"Nameserver: First nameserver to be used for this domain","items":{"type":"string","nullable":true,"description":"Nameserver: First nameserver to be used for this domain"}},"ownercontact0":{"type":"string","description":"Owner contact: Contact handle of the domain owner, also referred to as 'Owner-C', domain holder or registrant. The registrant is responsible for nominating the administrative, technical and billing contacts and the contractual partner of the respective registry as well as the legally responsible party for the use of the domain name. Certain parts of the contact information will appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set."},"period":{"type":"integer","format":"int32","description":"Period: How many years the domain should be created (not supported by all registries)"},"renewalmode":{"type":"string","nullable":true,"enum":["DEFAULT","AUTORENEW","AUTOEXPIRE","AUTODELETE","RENEWONCE","RENEWONCETHENAUTODELETE","RENEWONCETHENAUTOEXPIRE","EXPIREAUCTION"],"description":"Renewalmode: The domains mode for renewals"},"techcontact":{"type":"array","description":"Tech contact: Contact handle of the technical contact of the domain, also referred to as 'Tech-C'. The technical contact is usually the individual responsible for the website using the domain name e.g. the webmaster. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set.","items":{"type":"string","nullable":true,"description":"Tech contact: Contact handle of the technical contact of the domain, also referred to as 'Tech-C'. The technical contact is usually the individual responsible for the website using the domain name e.g. the webmaster. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set."}},"transferlock":{"type":"string","enum":["0","1"],"description":"Transfer lock: Determines if the domain is allowed for transfers (not supported by all registries)"},"x-accept-premiumprice":{"type":"string","nullable":true,"enum":["0","1"]},"x-accept-ssl-requirement":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept SSL requirements for this TLD: .app, .page, .dev, .new, .day, .channel, .boo, .foo, .zip, .mov, .nexus, .dad, .phd, .prof, .esq, .rsvp, .meme, .ing, .eat, .fly and .here are a more secure domains, meaning that HTTPS is required for all .app/.page/.dev/.new/.day/.channel/.boo/.foo/.zip/.mov/.nexus/.dad/.phd/.prof/.esq/.rsvp/.meme/.ing/.eat/.fly/.here websites. You can buy your .app/.page/.dev/.new/.day/.channel/.boo/.foo/.zip/.mov/.nexus/.dad/.phd/.prof/.esq/.rsvp/.meme/.ing/.eat/.fly/.here domain name now, but in order for it to work properly in browsers you must first configure HTTPS serving. For more information about configuring HTTPS, including resources to obtain an SSL certificate, please visit our wiki"},"x-ae-eligibility-id-type":{"type":"string","nullable":true,"description":"Registrant Eligibility ID Type: The identification type used for the registrant eligibility name, in case the legal name differs from the registrant's name."},"x-ae-eligibility-name":{"type":"string","nullable":true,"description":"Registrant Eligibility Name: The eligibility name in case the legal name differs from the registrant's name"},"x-ae-eligibility-type":{"type":"string","nullable":true,"enum":["TradeLicense","FreeTradeLicense","Trademark","FreezoneTrademark","TradeLicenseIT","FreezoneTradeLicenseIT","TrademarkIT","FreezoneTrademarkIT","Legacy","LegacyApproved","Citizen","PermanentResident","SportingOrganisation","CharitableOrganisation","ReligiousOrganisation","University","TechnicalCollege","School","Academy","GovernmentApproved"],"description":"Registrant Eligibility Type: Specify what makes the registrant eligible to register the domain name."},"x-ae-policy-reason":{"type":"string","nullable":true,"enum":["1","2","3","4","5","6","7","8","9"],"description":"Policy Reason: The appropriate policy reason number"},"x-ae-registrant-id-type":{"type":"string","nullable":true,"enum":["TradeLicense"],"description":"Registrant ID Type: The identification type of the registrant."},"x-ae-registrant-name":{"type":"string","description":"Registrant Name: Registrant's name; This element MUST contain an english readable string for the Registrants name."},"x-aero-ens-auth-id":{"type":"string","description":"ENS auth ID: The .AERO ID which can be applied for at http://www.information.aero"},"x-aero-ens-auth-key":{"type":"string","description":"ENS auth key: The respective password to the .AERO ID"},"x-afnic-code":{"type":"string","nullable":true,"description":"Reserved authorization code: Authorization code for reserved names"},"x-allocation-token":{"type":"string","nullable":true,"description":"Allocation Token: Allocation Token provided by the registry"},"x-amsterdam-legalform":{"type":"string","nullable":true,"enum":["ANDERS","BGG","BRO","BV","BVI/O","COOP","CV","EENMANSZAAK","EESV","KERK","MAATSCHAP","NV","OWM","PERSOON","REDR","STICHTING","VERENIGING","VOF"],"description":"Legal form: The legal form used for the contacts"},"x-amsterdam-legalformregno":{"type":"string","nullable":true,"description":"Legal form registration number"},"x-ar-dni":{"type":"string","nullable":true,"description":"CUIT or DNI: To register domains in Argentinia , a local presence is required. Required is to have CUIT (Argentinian tax ID number) or DNI (identification number for people)"},"x-ari-block":{"type":"string","nullable":true,"enum":["0","1"],"description":"Blocked registration: Register defensive, not resolving in DNS"},"x-au-domain-idnumber":{"type":"string","nullable":true,"description":"Identification number: Specify the identification number as appropriate"},"x-au-domain-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA","PRIVATE"],"description":"Identification type: This is the identification type of the registrant."},"x-au-domain-relation":{"type":"string","enum":["1","2"],"description":"Eligibility type relationship: This indicates the relationship between the Eligibility Type (e.g. business name) and domain name"},"x-au-domain-relationtype":{"type":"string","enum":["IncorporatedAssociation","NonProfitOrganisation","Charity","TradeUnion","IndustryBody","PoliticalParty","religiouschurchgroup","GovernmentSchool","IndigenousCorporation","RegisteredOrganisation","Trust","CommonwealthEntity","StatutoryBody","CompanyLimitedByGuarantee","NonDistributingCooperative","NonTradingCooperative","CharitableTrust","PublicPrivateAncillaryFund","governmentbody","foreignembassyorconsulate"],"description":"Eligibility type: Specify what makes the registrant eligible to register the domain name"},"x-au-eligibility-idnumber":{"type":"string","nullable":true,"description":"Identification number for the Eligibility: Specify the identification number as appropriate"},"x-au-eligibility-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA","CRICOS"],"description":"Identification type (optional, for trade marks): This is the identification type of the elibibility."},"x-au-eligibility-name":{"type":"string","nullable":true,"description":"Eligibility Name: The Eligibility name"},"x-au-id-warranty":{"type":"string","enum":["1","0"],"description":"The Applicant is an Australian Citizen or Resident: The Registrant of an .id.au Domain must warrant that they are an Australian Resident or Citizen"},"x-au-owner-organization":{"type":"string","description":"Owner Organization or Name: The Organization(Registrant) name"},"x-az-comregid":{"type":"string","nullable":true,"description":"Company registration number"},"x-az-vat-number":{"type":"string","nullable":true,"description":"VAT or TAX ID"},"x-bayern-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BAYERN trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-be-contact-lang":{"type":"string","nullable":true,"enum":["en","fr","nl"],"description":"Contact language: Language the owner wishes to communicate with the registry (Default = en)"},"x-berlin-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BERLIN trustee TAC: determine if the local presence service is to be used to register this domain"},"x-bg-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BG trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-bg-comregid":{"type":"string","nullable":true,"description":"VAT ID or tax no. of Legal entity"},"x-bg-idcard":{"type":"string","nullable":true,"description":"ID Card Number of the representative person"},"x-bg-tmid":{"type":"string","nullable":true,"description":"Trademark ID"},"x-br-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .COM.BR trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-br-register-number":{"type":"string","nullable":true,"description":"Brazil Legal ID: Brazil legal ID. You need to provide us with your CPF or CNPJ number if you dont want to use our local presence service."},"x-ca-disclose":{"type":"string","nullable":true,"enum":["0","1"],"description":"Disclose contact data in WHOIS"},"x-ca-legal-type":{"type":"string","enum":["ABO","ASS","CCO","CCT","EDU","GOV","HOP","INB","LAM","LGR","MAJ","OMK","PLT","PRT","RES","TDM","TRD","TRS"],"description":"Registrant legal types"},"x-ca-trademark":{"type":"string","nullable":true,"enum":["0","1"],"description":"Is a registered trademark: Describes if the domain is a registered trademark or not."},"x-challenge-answer":{"type":"array","description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains","items":{"type":"string","nullable":true,"description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains"}},"x-challenge-question":{"type":"array","description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains","items":{"type":"string","nullable":true,"description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains"}},"x-channel-accept-highly-regulated-tac":{"type":"string","enum":["0","1"],"description":"Accept .CHANNEL additional terms and conditions: .channel is exclusively for content creators and publishers to monetise their content. All .channel domains must present the user with a website where the creator can monetise their content or audience. No other use cases are allowed. By registering a .channel domain, you agree to follow the .channel Registration Policy. Please visit g.co/registry/channelRegistration for the full policy."},"x-cn-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .CN trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-cn-owner-id-number":{"type":"string","nullable":true,"description":"Owner ID Number: ID number"},"x-cn-owner-id-type":{"type":"string","nullable":true,"enum":["SFZ","HZ","GAJMTX","TWJMTX","WJLSFZ","GAJZZ","TWJZZ","JGZ","QT","ORG","YYZZ","TYDM","BDDM","JDDWFW","SYDWFR","WGCZJG","SHTTFR","ZJCS","MBFQY","JJHFR","LSZY","WGZHWH","WLCZJG","SFJD","JWJG","SHFWJG","MBXXBX","YLJGZY","GZJGZY","BJWSXX","QTTYDM","ZCWYHDJZ","NCJTJJZZDJZ","CHNSHXYDMZS","GATLYCZDBJGPZZ","WGZHXWJGZ","JWFZFDBJGDJZ","GAXWZNDJZZDJZ","QTJWJGDJZ"],"description":"Owner identity type: Identity type of the ID card"},"x-cn-owner-type":{"type":"string","nullable":true,"enum":["I","E"],"description":"Owner type: Identity type owner"},"x-cnnic-owner-id-code":{"type":"string","nullable":true,"description":"Owner identity code: Identity code of the ID card"},"x-cnnic-owner-id-type":{"type":"string","nullable":true,"enum":["SFZ","HZ","GAJMTX","TWJMTX","WJLSFZ","GAJZZ","TWJZZ","JGZ","QT","ORG","YYZZ","TYDM","BDDM","JDDWFW","SYDWFR","WGCZJG","SHTTFR","ZJCS","MBFQY","JJHFR","LSZY","WGZHWH","WLCZJG","SFJD","JWJG","SHFWJG","MBXXBX","YLJGZY","GZJGZY","BJWSXX","QTTYDM","GATJZZ","ZZJGDMZ"],"description":"Owner identity type: Identity type of the ID card"},"x-company-reg-id":{"type":"string","nullable":true,"description":"Company registration ID"},"x-company-vat-id":{"type":"string","nullable":true,"description":"Company V.A.T. ID"},"x-coop-eligibility":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .COOP eligibility requirements: Accept that my organization meets at least one of the .COOP eligibility requirements. For more information, please visit our wiki."},"x-cr-date-of-birth":{"type":"string","nullable":true,"description":"Date of birth: Date of birth"},"x-cz-ident-data":{"type":"string","nullable":true,"description":"Identification data: Identification data"},"x-cz-ident-type":{"type":"string","nullable":true,"enum":["op","passport","mpsv","ico","birthday"],"description":"Identification Type: The identification type used for the domain registrant"},"x-de-abuse-contact":{"type":"string","nullable":true,"description":"Abuse Contact: URI Contact for abuse contact that will be shown on DENIC whois"},"x-de-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1","2"],"description":"Accept .DE trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-de-general-request":{"type":"string","nullable":true,"description":"General Request: URI Contact for general requests that will be shown on DENIC whois"},"x-de-holder-person":{"type":"string","nullable":true,"enum":["0","1"],"description":"Ownercontact Person: Sets the contact type for the ownercontact of the .de domain to person."},"x-de-nsentry":{"type":"array","description":"Nsentry: Enables the use of nsentrys instead of nameservers for .de domains","items":{"type":"string","nullable":true,"description":"Nsentry: Enables the use of nsentrys instead of nameservers for .de domains"}},"x-dk-accept-tac":{"type":"string","enum":["0","1"],"description":".DK acknowledgement: Accept .DK additional terms and conditions"},"x-dk-mobile-phone":{"type":"string","nullable":true,"description":"Mobile phone number: Additional phone number field if required."},"x-dk-secondary-email":{"type":"string","nullable":true,"description":"Secondary EMail address: Additional EMail address which will be displayed in the registry Whois, overwriting the original EMail address of the owner contact. This extension is subject to validation."},"x-dk-sole-proprietorship":{"type":"string","description":"Sole Proprietorship: Companies with sole proprietorship (owned by a single individual) have the same protection rights as an individual. This extension can thus be used to hide EMail addresses to be hidden from the public Whois."},"x-dk-user-cvr":{"type":"string","nullable":true,"description":"Contact VAT number: Danish VAT number - Required for X-DK-USER-TYPEs COMPANY, ASSOCIATION and PUBLIC ORGANIZATION from Denmark. Optional if the owner contact does not reside in Denmark."},"x-dk-user-pnumber":{"type":"string","nullable":true,"description":"Contact production unit number: Production unit number - Optional extension used for validation for Danish companies with more physical addresses related to a single VAT number."},"x-dk-user-type":{"type":"string","enum":["INDIVIDUAL","COMPANY","ASSOCIATION","PUBLIC_ORGANIZATION"],"description":"Contact type: The owner contact's user type"},"x-do-idcard":{"type":"string","nullable":true,"description":"ID card"},"x-domain-comment":{"type":"string","nullable":true,"description":"Domain Comment: Domain specific comment, to be reflected in QueryDomainList and FTP CSV domain list file."},"x-ee-admin-birthday":{"type":"string","nullable":true,"description":"ADMIN BDAY: Birthdays ADMIN"},"x-ee-admin-ident":{"type":"string","nullable":true,"description":"ADMIN ID: Identifications Number for ADMIN"},"x-ee-admin-tin":{"type":"string","nullable":true,"description":"ADMIN TIN: TIN for ADMIN"},"x-ee-owner-birthday":{"type":"string","nullable":true,"description":"OWNER BDAY: Birthdays OWNER"},"x-ee-owner-ident":{"type":"string","nullable":true,"description":"OWNER ID: Identifications Number for OWNER"},"x-ee-owner-tin":{"type":"string","nullable":true,"description":"OWNER TIN: TIN for OWNER"},"x-ee-reserved-pw":{"type":"string","nullable":true,"description":"Reserved PW: Required if registering a reserved or won domain"},"x-ee-tech-birthday":{"type":"string","nullable":true,"description":"TECH BDAY: Birthdays TECH"},"x-ee-tech-ident":{"type":"string","nullable":true,"description":"TECH ID: Identifications Number for TECH"},"x-ee-tech-tin":{"type":"string","nullable":true,"description":"TECH TIN: TIN for TECH"},"x-es-admin-identificacion":{"type":"string","nullable":true,"description":"Admin identification: The ID card or passport number."},"x-es-admin-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Admin legal form: The legal form used for the admin contact"},"x-es-admin-tipo-identificacion":{"type":"string","nullable":true,"enum":["0","1","2","3","4"],"description":"Admin type identification: Indicates the type of identification"},"x-es-billing-identificacion":{"type":"string","nullable":true,"description":"Billing identification: The ID card or passport number."},"x-es-billing-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Billing legal form: The legal form used for the billing contact"},"x-es-billing-tipo-identificacion":{"type":"string","nullable":true,"enum":["0","1","2","3","4"],"description":"Billing type identification: Indicates the type of identification"},"x-es-owner-identificacion":{"type":"string","nullable":true,"description":"Owner identification: The ID card or passport number."},"x-es-owner-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Owner legal form: The legal form used for the owner contact"},"x-es-owner-tipo-identificacion":{"type":"string","nullable":true,"enum":["0","1","2","3","4"],"description":"Owner type identification: Indicates the type of identification"},"x-es-tech-identificacion":{"type":"string","nullable":true,"description":"Tech identification: The ID card or passport number."},"x-es-tech-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Tech legal form: The legal form used for the tech contact"},"x-es-tech-tipo-identificacion":{"type":"string","nullable":true,"enum":["0","1","2","3","4"],"description":"Tech type identification: Indicates the type of identification"},"x-eu-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .EU trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-eu-naturalperson":{"type":"string","nullable":true,"enum":["0","1"],"description":"Natural person: Determines, if the registrant is a natural person or a company"},"x-eu-registrant-citizenship":{"type":"string","nullable":true,"enum":["at","be","bg","cz","cy","de","dk","es","ee","fi","fr","gr","hr","hu","ie","is","it","li","lt","lu","lv","mt","nl","no","pl","pt","ro","se","sk","si",""],"description":"Registrant citizenship: Citizenship of the owner"},"x-eu-registrant-lang":{"type":"string","nullable":true,"enum":["bg","cs","da","de","el","en","es","et","fi","fr","ga","hr","hu","it","lt","lv","mt","nl","pl","pt","ro","sk","sl","sv"],"description":"Registrant language: Language the owner wishes to communicate with the registry (Default = en)"},"x-faitid-admin-birthdate":{"type":"string","format":"date","nullable":true,"description":"Admin birthdate: date of birth; mandatory for individuals"},"x-faitid-admin-city":{"type":"string","nullable":true,"description":"Admin city: Extension representing the city"},"x-faitid-admin-country":{"type":"string","nullable":true,"description":"Admin country: Extension representing the country"},"x-faitid-admin-passportinfo":{"type":"string","nullable":true,"description":"Admin passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-admin-state":{"type":"string","nullable":true,"description":"Admin state: Extension representing the state"},"x-faitid-admin-street":{"type":"array","description":"Admin street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Admin street: Extension representing the street"}},"x-faitid-admin-tin":{"type":"string","nullable":true,"description":"Admin TIN: tax payer ID, mandatory for organizations"},"x-faitid-admin-zip":{"type":"string","nullable":true,"description":"Admin zip code: Extension representing the zip code"},"x-faitid-billing-birthdate":{"type":"string","format":"date","nullable":true,"description":"Billing birthdate: date of birth; mandatory for individuals"},"x-faitid-billing-city":{"type":"string","nullable":true,"description":"Billing city: Extension representing the city"},"x-faitid-billing-country":{"type":"string","nullable":true,"description":"Billing country: Extension representing the country"},"x-faitid-billing-passportinfo":{"type":"string","nullable":true,"description":"Billing passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-billing-state":{"type":"string","nullable":true,"description":"Billing state: Extension representing the state"},"x-faitid-billing-street":{"type":"array","description":"Billing street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Billing street: Extension representing the street"}},"x-faitid-billing-tin":{"type":"string","nullable":true,"description":"Billing TIN: tax payer ID, mandatory for organizations"},"x-faitid-billing-zip":{"type":"string","nullable":true,"description":"Billing zip code: Extension representing the zip code"},"x-faitid-owner-birthdate":{"type":"string","format":"date","nullable":true,"description":"Owner birthdate: date of birth; mandatory for individuals"},"x-faitid-owner-city":{"type":"string","nullable":true,"description":"Owner city: Extension representing the city"},"x-faitid-owner-country":{"type":"string","nullable":true,"description":"Owner country: Extension representing the country"},"x-faitid-owner-passportinfo":{"type":"string","nullable":true,"description":"Owner passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-owner-state":{"type":"string","nullable":true,"description":"Owner state: Extension representing the state"},"x-faitid-owner-street":{"type":"array","description":"Owner street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Owner street: Extension representing the street"}},"x-faitid-owner-tin":{"type":"string","nullable":true,"description":"Owner TIN: tax payer ID, mandatory for organizations"},"x-faitid-owner-zip":{"type":"string","nullable":true,"description":"Owner zip code: Extension representing the zip code"},"x-faitid-tech-birthdate":{"type":"string","format":"date","nullable":true,"description":"Tech birthdate: date of birth; mandatory for individuals"},"x-faitid-tech-city":{"type":"string","nullable":true,"description":"Tech city: Extension representing the city"},"x-faitid-tech-country":{"type":"string","nullable":true,"description":"Tech country: Extension representing the country"},"x-faitid-tech-passportinfo":{"type":"string","nullable":true,"description":"Tech passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-tech-state":{"type":"string","nullable":true,"description":"Tech state: Extension representing the state"},"x-faitid-tech-street":{"type":"array","description":"Tech street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Tech street: Extension representing the street"}},"x-faitid-tech-tin":{"type":"string","nullable":true,"description":"Tech TIN: tax payer ID, mandatory for organizations"},"x-faitid-tech-zip":{"type":"string","nullable":true,"description":"Tech zip code: Extension representing the zip code"},"x-fee-amount":{"type":"array","description":"Amount of the fee extension.","items":{"type":"string","format":"decimal","nullable":true,"description":"Amount of the fee extension."}},"x-fee-application":{"type":"string","format":"decimal","nullable":true,"description":"None refundable amount of the fee extension."},"x-fee-currency":{"type":"string","nullable":true,"description":"Currency of the fee extension. Default is the own account currency."},"x-feedback-selfservice":{"type":"string","nullable":true,"enum":["0","1"],"description":"Activate Self-Service Domain: Determines, if Self-Service is activated."},"x-fi-birthdate":{"type":"string","nullable":true,"description":"Birthdate: Birthdate"},"x-fi-company-reg-id":{"type":"string","nullable":true,"description":"Business ID or Reg. Number: Local business Entity (registered at the Finnish Trade Register or a corporation within the Finnish republic) ID-Code Business ID or Reg.Number"},"x-fi-contact-type":{"type":"string","nullable":true,"enum":["0","1","2","3","4","5","6","7"],"description":"Type of contact: Type of contact"},"x-fi-personal-id":{"type":"string","nullable":true,"description":"Personal Identity Number: Finnish Personal Identity Number"},"x-fr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .FR trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-fr-announce":{"type":"string","nullable":true,"description":"Number of page announce JO: will contain the date of publication in the official gazette (the announce attribute shows the number of the announcement, the page attribute shows the page number of this announcement)."},"x-fr-birthcity":{"type":"string","nullable":true,"description":"Birthcity: Contains the contact's place of birth."},"x-fr-birthdate":{"type":"string","nullable":true,"description":"Birthdate: Contains the contact's date of birth. Date format YYYY-MM-DD"},"x-fr-birthpc":{"type":"string","nullable":true,"description":"Birthplace postcode: Contains the postcode of the place of birth (or at least the department code)."},"x-fr-birthplace":{"type":"string","nullable":true,"description":"Birthplace country code : Contains the country code of the contacts place of birth."},"x-fr-date-association":{"type":"string","nullable":true,"description":"contain the date of publication in the official gazette: Will contain the date of publication in the official gazette Date format YYYY-MM-DD  (the \"announce\" attribute shows the number of the announcement)."},"x-fr-date-publication-jo":{"type":"string","nullable":true,"description":"contain the date of publication in the official gazette: The page attribute shows the page number of this announcement. Date format YYY-MM-DD"},"x-fr-duns":{"type":"string","nullable":true,"description":"DUNS number: Short for Data Universal Numbering System; refers to a new identifier that can be sent for an Eligibility Verification at European level. Format has to follow X-XXX-XXXX (Only numbers are allowed)."},"x-fr-local":{"type":"string","nullable":true,"description":"Local identifier: A local identifier specific to a country of the European Economic Area."},"x-fr-no-pre-zonecheck":{"type":"string","nullable":true,"enum":["0","1"],"description":"Suppress DNS precheck: Determines, if the system should do a DNS precheck before sending the command to the registry."},"x-fr-numero-de-page-announce-jo":{"type":"string","nullable":true,"description":"page number of this announcement: Contains the date of publication in the official gazette (the announce attribute shows the number of the announcement, the page attribute shows the page number of this announcement)."},"x-fr-restrict-pub":{"type":"string","nullable":true,"enum":["0","1"],"description":"Restrict publication: Restrict publication"},"x-fr-siren-or-siret":{"type":"string","nullable":true,"description":"SIREN code: Contain the SIREN code."},"x-fr-trademark":{"type":"string","nullable":true,"description":"Trademark number: Contain a trademark number."},"x-fr-vatid":{"type":"string","nullable":true,"description":"VAT number: Contain the VAT number."},"x-fr-waldec":{"type":"string","nullable":true,"description":"Waldec linked to an association: Indicates the identifier Waldec linked to an association. If this identifier is provided, this is sufficient to identify an association."},"x-gay-accept-requirements":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .GAY Protection-Requirements: Accept, that the domain will NOT be used for inciting violence, bullying, harassing, or hate speech and NOT be used by recognized hate groups. DotGay donates 20% from each new domain registered to their partners, GLAAD and CenterLink."},"x-hamburg-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .HAMBURG trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-hk-domain-category":{"type":"string","nullable":true,"enum":["I","O"],"description":"Domain category: Legal Type of all Domain Contacts"},"x-hk-owner-age-over-18":{"type":"string","nullable":true,"enum":["no","yes"],"description":"Owner age over 18 years: Only mandatory if domain category is individual."},"x-hk-owner-document-number":{"type":"string","nullable":true,"description":"Owner document number: Domain owner/registrant document number."},"x-hk-owner-document-origin-country":{"type":"string","description":"Owner document origin country: The country for the owner/registrant document origin (please use the country code, e.g. \"de\" or \"us\")."},"x-hk-owner-document-type":{"type":"string","nullable":true,"enum":["HKID","OTHID","PASSNO","BIRTHCERT","OTHIDV","BR","CI","CRS","HKSARG","HKORDINANCE","OTHORG"],"description":"Owner document type: Domain owner/registrant document type."},"x-hk-owner-other-document-type":{"type":"string","nullable":true,"description":"Owner other document type: Domain owner/registrant other document type. This field is mandatory if the value for owner document type (X-HK-OWNER-DOCUMENT-TYPE) is OTHIDV (Others Individual Document) or OTHORG (Others Organization Document)."},"x-hr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .HR trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-hr-comregid":{"type":"string","nullable":true,"description":"VAT ID / tax no.: VAT ID / tax no., mandatory for companies"},"x-hr-idcard":{"type":"string","nullable":true,"description":"Passport no.: Passport no., mandatory for individuals"},"x-hu-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .HU trustee TAC: Accept Trustees Assistance Corporation (TAC)"},"x-hu-accept-trustee-tac-non-eu-member":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .HU trustee TAC (non EU member): Determines, if local presence service is to be used to register this domain"},"x-hu-idcard-or-passport-number":{"type":"string","nullable":true,"description":"ID-card or passport number: ID-card or passport number"},"x-hu-tax-number":{"type":"string","nullable":true,"description":"Tax number: Tax Number"},"x-hu-vat-number":{"type":"string","nullable":true,"description":"VAT number: Value added tax (VAT) Number"},"x-id-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .ID trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-idn-language":{"type":"string","nullable":true,"description":"IDN Language"},"x-ie-contact-type":{"type":"string","nullable":true,"enum":["COM","CHA","OTH"],"description":"Registrant/Owner type: Company/Charity/Other (Default = OTH)"},"x-ie-cro-number":{"type":"string","nullable":true,"description":"CRO Number: Companies Registration Office (CRO) number"},"x-ie-language":{"type":"string","nullable":true,"enum":["EN","FR"],"description":"Registrant/Owner language: Language the owner wishes to communicate with the registry (Default = EN)"},"x-ie-supporting-number":{"type":"string","nullable":true,"description":"Charity number: Charity/Supporting number"},"x-il-organization-number":{"type":"string","nullable":true,"description":"Company ID: Required Company ID for legal entities to register a .IL domain name."},"x-in-nexus-connection-type":{"type":"string","nullable":true,"enum":["ENTITY","COMM","MKTG","CONTENT","EDU","CULTURE","OTHER"],"description":"Nexus connection to India: The Nexus connection of the registrant to India as required by NIXI for .IN registrations."},"x-in-nexus-declaration":{"type":"string","nullable":true,"enum":["0","1"],"description":"Nexus declaration attestation: Attestation that the registrant has a valid Nexus connection to India as required by NIXI for .IN registrations."},"x-intended-use":{"type":"string","description":"Intended Use: Text for intended use of the domain"},"x-iq-company-number":{"type":"string","description":"Company registration number: Company registration number(legal owner)"},"x-ir-company-number":{"type":"string","nullable":true,"description":"Company registration number: Company registration number(legal owner)"},"x-ir-idcard":{"type":"string","nullable":true,"description":"ID card number: ID card number (private owner)"},"x-ir-idcard-issuer":{"type":"string","nullable":true,"description":"ID card issuer: ID card issuer (private owner)"},"x-ir-registration-center":{"type":"string","nullable":true,"description":"Company registration center: Company registration center (legal owner)"},"x-ir-registration-center-state":{"type":"string","nullable":true,"description":"State or province of the company registration center: State or province of the company registration center(legal owner)"},"x-it-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .IT trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-it-consentforpublishing":{"type":"string","enum":["0","1"],"description":"ConsentForPublishing: Boolean value to allow the publication of contacts personal data. Values allowed: 1 to allow, 0 to deny."},"x-it-entity-type":{"type":"string","nullable":true,"enum":["1","2","3","4","5","6","7"],"description":"Entity Type: Numeric value to identify Registrant typology."},"x-it-nationality":{"type":"string","nullable":true,"description":"Registrants Nationality country code: The requesters nationality"},"x-it-pin":{"type":"string","nullable":true,"description":"Registrants taxcode: If the requester is an Italian natural person it contains his/her Codice Fiscale. For foreigners it can contain a document number. For associations without VAT number and tax code it must be equal to \"n.a.\". In all the other cases it must be equal to VAT number (in the 11 numbers format for Italian Nationality) or the numeric Codice Fiscale."},"x-it-sect3-liability":{"type":"string","enum":["0","1"],"description":"Accept Sect. 3 of registrar contract: This value is needed to indicate the acceptance of Section 3 in the .IT registrar contract."},"x-it-sect5-personal-data-for-registration":{"type":"string","enum":["0","1"],"description":"Accept Sect. 5 of registrar contract: This value is needed to indicate the acceptance of Section 5 in the .IT registrar contract."},"x-it-sect6-personal-data-for-diffusion":{"type":"string","enum":["0","1"],"description":"Accept Sect. 6 of registrar contract: This value is needed to indicate the acceptance of Section 6 in the .IT registrar contract."},"x-it-sect7-explicit-acceptance":{"type":"string","enum":["0","1"],"description":"Accept Sect. 7 of registrar contract: This value is needed to indicate the acceptance of Section 7 in the .IT registrar contract."},"x-jp-address":{"type":"string","description":"Organization address Japanese: Organization address Japanese, e.g. 東京都千代田区西神田3-8-1 千代田ファーストビル東館13F"},"x-jp-idn-contact":{"type":"string","nullable":true,"description":"Japanse Owner contact: Optional owner and public contact for .JP IDN domain names"},"x-jp-kana-organization":{"type":"string","description":"Organization name Japanese KANA: Organization name Japanese KANA"},"x-jp-name":{"type":"string","description":"Contact first name and last name Japanese: Name of the person responsible for registration (in Japanese)"},"x-jp-registration-address":{"type":"string","description":"Organization registration address: Address of the head or principal office as listed in the registry, using the official prefecture notation without abbreviations."},"x-jp-registration-date":{"type":"string","format":"date","description":"Organization registration date: Organization registration date, e.g. 2023-10-30"},"x-jp-title":{"type":"string","description":"The title of the registrant Japanese: The title of the registrant in Japanese, e.g. 取締役"},"x-jp-type":{"type":"string","description":"Organization type Japanese: Specify the organization type (Japanice) of the organization. Please refer to the following document: https://jprs.jp/jppartners/doc/organization_immediate.html"},"x-kr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":".KR Trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-kr-ctfy-no":{"type":"string","nullable":true,"description":"Certification number: Registrant certification number"},"x-kr-ctfy-type":{"type":"string","nullable":true,"enum":["BUSINESS","BUSINESSIND","CORP","UNIQUE","SCHOOL","PASSPORT","ETC"],"description":"Certificate type: Certificate type for Korean domains"},"x-launch-accepted-date":{"type":"string","format":"date","nullable":true,"description":"Accepted date: TMDB claims notice acceptance date"},"x-launch-code":{"type":"array","description":"Validator code: Non TMCH validator Code","items":{"type":"string","nullable":true,"description":"Validator code: Non TMCH validator Code"}},"x-launch-expiry-date":{"type":"string","format":"date","nullable":true,"description":"Expiry date: TMDB expiry date of the claims notice"},"x-launch-notice-id":{"type":"string","nullable":true,"description":"Notice ID: Notice ID"},"x-launch-validator-id":{"type":"array","description":"Validator ID: Non TMCH validator ID","items":{"type":"string","nullable":true,"description":"Validator ID: Non TMCH validator ID"}},"x-lt-company-number":{"type":"string","nullable":true,"description":"Company number: Company number"},"x-ltda-authorityname":{"type":"string","nullable":true,"description":"Authority Name"},"x-ltda-licensenumber":{"type":"string","nullable":true,"description":"License Number"},"x-lv-admin-regnr":{"type":"string","nullable":true,"description":"Domain Admin's Registration Number: Registration Number of Latvian citizen for Admincontact"},"x-lv-owner-regnr":{"type":"string","nullable":true,"description":"Domain Owner's Registration Number: Registration Number of Latvian citizen for Ownercontact"},"x-lv-vatnr":{"type":"string","nullable":true,"description":"VAT ID Number (Only for organizations): VAT Number of Legal Latvian contact only for Owners"},"x-mk-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .MK trustee TAC: Determines if the local presence service is to be used to register this domain"},"x-mk-owner-idnumber":{"type":"string","nullable":true,"description":"Owner ID Number: Personal or organizational identification number"},"x-mo-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .MO trustee TAC: Determines if the local presence service is to be used to register this domain"},"x-mt-vatid":{"type":"string","nullable":true,"description":"VAT - ID: X-MT-VATID for FF"},"x-music-accept-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":".MUSIC acknowledgement: I fully understand and agree that the Registry has the right to audit this attestation declaration and an audit failure can lead to immediate suspension or revocation, without refund, of any or all .MUSIC domains connected to the registrant."},"x-my-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .COM.MY trustee TAC: Determines if the local presence service is to be used to register this domain"},"x-my-admin-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Admin date of birth: Natural person date of birth"},"x-my-admin-identificationnumber":{"type":"string","nullable":true,"description":"Admin identification number: Natural person identification number"},"x-my-admin-organization-registration-number":{"type":"string","nullable":true,"description":"Admin Organization registration number: Admin organization registration number"},"x-my-admin-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Admin Organization type: Admin organization type"},"x-my-billing-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Billing date of birth: Natural person date of birth"},"x-my-billing-identificationnumber":{"type":"string","nullable":true,"description":"Billing identification number: Natural person identification number"},"x-my-billing-organization-registration-number":{"type":"string","nullable":true,"description":"Billing Organization registration number: Billing organization registration number"},"x-my-billing-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Billing Organization type: Billing organization type"},"x-my-owner-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Owner date of birth: Natural person date of birth"},"x-my-owner-identificationnumber":{"type":"string","nullable":true,"description":"Owner identification number: Natural person identification number"},"x-my-owner-organization-registration-number":{"type":"string","nullable":true,"description":"Owner Organization registration number: Owner organization registration number"},"x-my-owner-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Owner Organization type: Owner organization type"},"x-my-tech-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Tech date of birth: Natural person date of birth"},"x-my-tech-identificationnumber":{"type":"string","nullable":true,"description":"Tech identification number: Natural person identification number"},"x-my-tech-organization-registration-number":{"type":"string","nullable":true,"description":"Tech Organization registration number: Tech organization registration number"},"x-my-tech-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Tech Organization type: Tech organization type"},"x-name-emailforward":{"type":"string","nullable":true,"description":"Email forwarding"},"x-ne-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .NE trustee TAC: Determines if the local presence service is to be used to register this domain"},"x-nicse-idnumber":{"type":"string","nullable":true,"description":"Personal or organisational number: Personal or organisational number."},"x-nicse-vatid":{"type":"string","nullable":true,"description":"VAT number: VAT number."},"x-nl-legalform":{"type":"string","nullable":true,"enum":["ANDERS","BGG","BRO","BV","BVI/O","COOP","CV","EENMANSZAAK","EESV","KERK","MAATSCHAP","NV","OWM","PERSOON","REDR","STICHTING","VERENIGING","VOF"],"description":"Legal form: The legal form used for the contacts"},"x-nl-legalformregno":{"type":"string","nullable":true,"description":"Legal form registration number"},"x-no-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .NO trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-no-organization-number":{"type":"string","nullable":true,"description":"Norwegian Organization Number: Required Norway Central Coordinating Register Number for legal entities to register a .NO domain name."},"x-no-person-identifier":{"type":"string","nullable":true,"description":"Norid Person ID: Required personal ID to register a private .PRIV.NO domain name."},"x-nu-iis-idno":{"type":"string","description":"Id Number: Identification Number"},"x-nu-iis-vatno":{"type":"string","nullable":true,"description":"Vatnumber: Vatnumber"},"x-nyc-extcontact":{"type":"string","nullable":true,"enum":["ADMIN","BILLING","OWNER","TECH"],"description":"New York ExtContact: Mentioned contact must have a valid physical address in the City of New York"},"x-nz-privacy":{"type":"string","nullable":true,"enum":["PUBLIC","PRIVATE"],"description":"Domain WHOIS privacy setting: If PRIVATE is chosen, owner data will not be shown in WHOIS (Default = PRIVATE for Individuals, PUBLIC for Organizations)"},"x-owner-birthdate":{"type":"string","format":"date","nullable":true,"description":"Owner contact date of birth: Date of birth of the owner contact in the format YYYY-MM-DD"},"x-personal-id":{"type":"string","nullable":true,"description":"Personal identification"},"x-pl-consentforpublishing":{"type":"string","nullable":true,"enum":["0","1"],"description":"Consent for publishing: Boolean value to allow the publication of contacts personal data. Values allowed: 1 to allow, 0 to deny."},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code: This parameter will be used to get the promotion - pricing, please have a look into the newsletter to see if any promotion is active"},"x-pt-legitimacy":{"type":"string","nullable":true,"enum":["2","3"],"description":"Registrant legal types: Indicates the legitimacy on registering this domain."},"x-pt-owner-identification":{"type":"string","description":"Fiscal Identification Nr (Owner): The Fiscal Identification Number of the owner contact."},"x-pt-owner-mobile":{"type":"string","nullable":true,"description":"Mobile number (Owner): The mobile number of the owner contact."},"x-pt-registration-basis":{"type":"string","nullable":true,"enum":["1","2","3"],"description":"Registrant registration basis: Indicates the registration basis for registering this domain."},"x-pt-tech-identification":{"type":"string","description":"Fiscal Identification Nr (Tech): The Fiscal Identification Number of the technical contact."},"x-pt-tech-mobile":{"type":"string","nullable":true,"description":"Mobile number (Tech): The mobile number of the technical contact."},"x-qa-eligibility-id":{"type":"string","nullable":true,"description":"Registrant Eligibility ID: The identification corresponding to the provided eligibility type."},"x-qa-eligibility-type":{"type":"string","nullable":true,"enum":["TradeLicense","FreeTradeLicense","Trademark","FreezoneTrademark","TradeLicenseIT","FreezoneTradeLicenseIT","TrademarkIT","FreezoneTrademarkIT","Legacy","LegacyApproved","Citizen","PermanentResident","SportingOrganisation","CharitableOrganisation","ReligiousOrganisation","University","TechnicalCollege","School","Academy","GovernmentApproved"],"description":"Registrant Eligibility Type: Specify what makes the registrant eligible to register the domain name."},"x-qa-registrant-name":{"type":"string","description":"Registrant Name: Registrant's name; This element MUST contain an english readable string for the Registrants name."},"x-record-mx":{"type":"array","description":"MX - record: Add MX - records of this domain","items":{"type":"string","nullable":true,"description":"MX - record: Add MX - records of this domain"}},"x-request-authcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Request authentication code generation: Request a new authentication code"},"x-ro-company-number":{"type":"string","nullable":true,"description":"Company number: Company number"},"x-ro-idcard-or-passport-number":{"type":"string","nullable":true,"description":"ID-card or passport number: ID-card or passport number"},"x-ro-vat-number":{"type":"string","nullable":true,"description":"VAT number: Value added tax (VAT) Number"},"x-rs-admin-company-number":{"type":"string","nullable":true,"description":"Company reg. number: Admin Company number for non-private registrations"},"x-rs-admin-idcard":{"type":"string","nullable":true,"description":"Passport no.: Admin Passport no., mandatory for individuals"},"x-rs-owner-company-number":{"type":"string","nullable":true,"description":"Company reg. number: Owner Company number for non-private registrations"},"x-rs-owner-idcard":{"type":"string","nullable":true,"description":"Passport no.: Owner Passport no., mandatory for individuals"},"x-rs-tech-company-number":{"type":"string","nullable":true,"description":"Company reg. number: Tech Company number for non-private registrations"},"x-rs-tech-idcard":{"type":"string","nullable":true,"description":"Passport no.: Tech Passport no., mandatory for individuals"},"x-rs-vat":{"type":"string","nullable":true,"description":"VAT number: VAT (fiscal) No. for non-private registrations"},"x-ru-birthdate":{"type":"string","nullable":true,"description":"Customer-s birth date: Customer-s birth date in the format DD.MM.YYYY (figures)."},"x-ru-code":{"type":"string","nullable":true,"description":"TIN taxpayers identification: TIN (taxpayers identification number) of the Customers organization. This field must contain a ten digit number (the last figure is a control figure) Required for organizations incorporated in the Russian Federation."},"x-ru-firstname":{"type":"string","nullable":true,"description":"Firstname in Russian: Customers first name in Russian. To be filled with Russian and Latin letters, no dots. Maximum length is 64 characters."},"x-ru-kpp":{"type":"string","nullable":true,"description":"Reason code: The reason code  for the Customers organization registering. This field must contain a nine digit number. Required for organizations incorporated in the Russian Federation."},"x-ru-lastname":{"type":"string","nullable":true,"description":"Lastname in Russian: Customers last name in Russian. To be filled with Russian and Latin letters, no dots. Maximum length is 64 characters."},"x-ru-middlename":{"type":"string","nullable":true,"description":"Middlename in Russian: Customers middle name in Russian. To be filled with Russian and Latin letters, no dots. Maximum length is 64 characters."},"x-ru-organization":{"type":"string","nullable":true,"description":"Organisation in Russian: Customers organization name in Russian. This field can contain Russian and Latin letters, figures, punctuation marks and spaces. Minimal length is two words, maximum length is 256 characters."},"x-ru-passportdata":{"type":"string","nullable":true,"description":"Customer-s passport data: This field is filled in Russian and can contain Russian and Latin letters, figures, punctuation marks and spaces. Minimal length is two words, maximum length is 256 characters: Document number, Issued by, Issued Date"},"x-ruhr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .RUHR trustee TAC: Determinruhr if the local presence service is to be used to register this domain"},"x-se-disclose-email":{"type":"string","nullable":true,"enum":["0","1"],"description":"Disclose email: Hide or show email."},"x-se-disclose-fax":{"type":"string","nullable":true,"enum":["0","1"],"description":"Disclose fax: Hide or show fax."},"x-se-disclose-voice":{"type":"string","nullable":true,"enum":["0","1"],"description":"Disclose voice: Hide or show voice."},"x-sg-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".SG trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-sg-admin-singpassid":{"type":"string","nullable":true,"description":"Singpass ID of individual admin: The contact identity card (SingPass ID) for an individual local presence in Singapore (Format: S1234567D)"},"x-sg-rcbid":{"type":"string","nullable":true,"description":"Company/Identity Registration ID: For companies located in Singapore, the corresponding company registration number has to be given OR the contact identity card for a local presence in Singapore (Format: S1234567D)"},"x-sk-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .SK trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-sk-contact-ident-number":{"type":"string","nullable":true,"description":"Company number: Company-Ident-Number for Companies. Not required for Persons"},"x-sk-contact-legal-form":{"type":"string","nullable":true,"enum":["CORP","PERS"],"description":"Legal form: PERS for private persons or CORP for Companies"},"x-srl-authorityname":{"type":"string","nullable":true,"description":"Authority Name"},"x-srl-licensenumber":{"type":"string","nullable":true,"description":"License Number"},"x-swiss-owner-type":{"type":"string","nullable":true,"enum":["P","O"],"description":"Owner type: Identity type owner"},"x-swiss-uid":{"type":"string","description":"UID / UPI: Enterprise ID of the Owners Organization"},"x-tatar-admin":{"type":"string","nullable":true,"description":"Admin International: The required international admin contact"},"x-tatar-admin-birthday":{"type":"string","nullable":true,"description":"Admin Birthday: Birthday of the Admin contact"},"x-tatar-admin-pass":{"type":"string","nullable":true,"description":"Admin Pass Validity: The validity date of the pass of the admin contact"},"x-tatar-admin-tin":{"type":"string","nullable":true,"description":"Admin Organisation Nr: International TIN/VAT for the admin contact"},"x-tatar-billing":{"type":"string","nullable":true,"description":"Billing International: The required international billing contact"},"x-tatar-billing-birthday":{"type":"string","nullable":true,"description":"Billing Birthday: Birthday of the Billing contact"},"x-tatar-billing-pass":{"type":"string","nullable":true,"description":"Billing Pass Validity: The validity date of the pass of the billing contact"},"x-tatar-billing-tin":{"type":"string","nullable":true,"description":"Billing Organisation Nr: International TIN/VAT for the billing contact"},"x-tatar-domain-description":{"type":"string","nullable":true,"description":"Domain Description: Domain Description"},"x-tatar-owner":{"type":"string","nullable":true,"description":"Owner International: The required international owner contact"},"x-tatar-owner-birthday":{"type":"string","nullable":true,"description":"Owner Birthday: Birthday of the Owner contact"},"x-tatar-owner-pass":{"type":"string","nullable":true,"description":"Owner Pass Validity: The validity date of the pass of the owner contact"},"x-tatar-owner-tin":{"type":"string","nullable":true,"description":"Owner Organisation Nr: International TIN/VAT for the owner contact"},"x-tatar-tech":{"type":"string","nullable":true,"description":"Tech International: The required international tech contact"},"x-tatar-tech-birthday":{"type":"string","nullable":true,"description":"Tech Birthday: Birthday of the Tech contact"},"x-tatar-tech-pass":{"type":"string","nullable":true,"description":"Tech Pass Validity: The validity date of the pass of the tech contact"},"x-tatar-tech-tin":{"type":"string","nullable":true,"description":"Tech Organisation Nr: International TIN/VAT for the tech contact"},"x-tel-publish-whois":{"type":"string","nullable":true,"enum":["0","1"],"description":"Publish whois: Show private details in the whois, only available for private persons"},"x-tel-whois-phone":{"type":"string","description":"Reseller phone: The phone number of the reseller to be shown in the WHOIS. This needs to be in the format +XX.XXXXXXXXX and will only be shown if X-WHOIS-RSP is set."},"x-tel-whoistype":{"type":"string","nullable":true,"enum":["Natural","Legal"],"description":"Registrant - type: Defines what type of user the registrant is"},"x-tr-citid":{"type":"string","nullable":true,"description":"Citizen ID: Citizen ID if registrant is a private person (can register name-surname.com.tr)"},"x-tr-comregid":{"type":"string","nullable":true,"description":"Company registration ID"},"x-tr-taxnumber":{"type":"string","nullable":true,"description":"Tax number: Tax number"},"x-tr-taxoffice":{"type":"string","nullable":true,"description":"Tax office: Tax office"},"x-tr-tmid":{"type":"string","nullable":true,"description":"Trademark ID"},"x-travel-industry":{"type":"string","nullable":true,"enum":["N","Y"],"description":"Travel industry: Choosing yes implies, that the Registrant is part of the travel industry."},"x-tw-company-number":{"type":"string","nullable":true,"description":"Company number: Company number length must be min: 6 chars max: 32 chars"},"x-ua-tm-date":{"type":"string","format":"date","nullable":true,"description":"Trademark date"},"x-ua-tm-number":{"type":"string","nullable":true,"description":"Trademark Number"},"x-uk-owner-corporate-number":{"type":"string","nullable":true,"description":"Owner Corporate Number: Describes the corporate number for owner contact"},"x-uk-owner-corporate-type":{"type":"string","nullable":true,"enum":["OTHER","FOTHER","IND","FIND","FCORP","LTD","PLC","LLP","IP","CRC","GOV","PTNR","RCHAR","SCH","STAT","STRA"],"description":"Owner Corporate Type: Describes the corporate type for owner contact"},"x-uk-trading-name":{"type":"string","nullable":true,"description":"Trading Name: Trading name for the registrant. Optional."},"x-unitedtld-regulatory-data":{"type":"string","nullable":true,"description":"UnitedTLD Regulatory Body Information: Extension containing information about the regulatory body"},"x-us-nexus-apppurpose":{"type":"string","nullable":true,"enum":["P1","P2","P3","P4","P5"],"description":"Application purpose: Purpose of the application"},"x-us-nexus-category":{"type":"string","nullable":true,"enum":["C11","C12","C21","C31","C32"],"description":"US-NEXUS category: Categorization of the entity requesting the application"},"x-us-nexus-validator":{"type":"string","nullable":true,"description":"US-NEXUS validator country: Specify the two-letter country-code of the registrant (if Nexus Category is either C31 or C32)"},"x-vn-owner-birthday":{"type":"string","format":"date","nullable":true,"description":"Birthday of domain owner YYYY-MM-DD (i.e. 1970-12-01): Birthday of domain owner"},"x-vn-owner-identification":{"type":"string","nullable":true,"description":"Identification Number: Identification Number. For private persons, you have to use the identity card number and for organizations use the VAT number."},"x-whois-banner":{"type":"array","description":"Whois banner: Modifies a freetext - line in the whois (not supported by all registries)","items":{"type":"string","nullable":true,"description":"Whois banner: Modifies a freetext - line in the whois (not supported by all registries)"}},"x-whois-privacy":{"type":"string","nullable":true,"enum":["0","1"],"description":"Whois Privacy: Enable WhoisProxy to prevent disclosure of the contact data in whois."},"x-whois-rsp":{"type":"string","nullable":true,"description":"RSP tag: The company, responsible for managing this domain (usually the reseller, not supported by all registries)"},"x-whois-url":{"type":"string","nullable":true,"description":"URL: The website - URL of the responsible reseller (not supported by all registries)"},"x-xxx-community-id":{"type":"string","nullable":true,"description":".XXX Sponsored Community Member ID: .XXX Sponsored Community Member ID"},"x-xxx-defensive":{"type":"string","nullable":true,"enum":["0","1"],"description":".XXX Non-Resolving Registration: Domain will be a defensive registration and Domain will not resolve!"},"x-zuerich-agreement":{"type":"string","enum":["0","1"],"description":"I accept the local laws of Canton of Zurich, in particular to the TLDV ordinance: I accept the local laws of Canton of Zurich, in particular to the TLDV ordinance"},"x-zuerich-uid":{"type":"string","description":"Enterprise Identification Number (UID): Registrants must be either a Zurich Public Authority (including the Canton and City of Zurich and related entities) or a legal entity (Rechtseinheit) in possession of a commercial registration number (Unternehmens-Identifikationsnummer) with a registration in the Commercial Register of the Canton of Zurich. If you're a Zurich Public Authority, you can add the word 'PUBLIC' in the UID field. You can check your UID number in https://www.zefix.ch/en/search/entity/welcome"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"activation_target":{"type":"string","description":"Activation target"},"activation_type":{"type":"string","description":"Activation type"},"claim_portal_url":{"type":"array","description":"Claim Portal URL: URL to a webinterface, which displays the claims notice, in order to accept (to proceed with), or to decline (to abort) the relevant domain registration.","items":{"type":"string","description":"Claim Portal URL: URL to a webinterface, which displays the claims notice, in order to accept (to proceed with), or to decline (to abort) the relevant domain registration."}},"claim_url":{"type":"array","description":"Claim URL: Claimsnotice download URL","items":{"type":"string","description":"Claim URL: Claimsnotice download URL"}},"created_date":{"type":"string","format":"date-time","description":"Created date: Date the domain was registered"},"document_generator_uri":{"type":"string","description":"Document generator uri"},"document_upload_target":{"type":"string","description":"Document upload target"},"document_upload_type":{"type":"string","description":"Document upload type"},"faquri":{"type":"string","description":"Faquri"},"job_id":{"type":"array","items":{"type":"string"}},"promotions":{"type":"array","items":{"type":"string"}},"registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date: Date the domain will expire"},"renewal_date":{"type":"string","format":"date-time","description":"Renewal date: Date when the domain must be renewed"},"roid":{"type":"string","description":"Registry object ID: A unique identifier for this object"},"status":{"type":"string","description":"Status: Shows the current state of the domain registration"},"x-document-status":{"type":"string","description":"X-document-status"},"x-fee-amount":{"type":"string","format":"decimal","description":"X-FEE-AMOUNT: The amount debited from your account balance for the domain name registration."},"x-fee-application":{"type":"string","format":"decimal","description":"X-FEE-APPLICATION: The non-refundable amount debited from your account balance for the domain name registration."},"x-fee-currency":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."},"x-hu-eaf-url":{"type":"string","description":"X-hu-eaf-url"},"x-name-emailforward":{"type":"string","enum":["pending"],"description":"X-NAME-EMAILFORWARD: Indicates, that the email - forwarding will be set up asynchron, you will receive an event once this was done"},"x-ngo-verification-link":{"type":"string","description":"X-ngo-verification-link"},"x-ngo-verification-until":{"type":"string","format":"date","description":"X-ngo-verification-until"},"x-time-to-suspension":{"type":"string","format":"date-time","description":"X-time-to-suspension"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddDomain"}},"/domain/-/application":{"get":{"operationId":"queryDomainApplicationList","summary":"XRRP command QueryDomainApplicationList (queryDomainApplicationList)","description":"List all applications in your account\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Search applications for this domain (wildcard allowed)","schema":{"type":"string","nullable":true,"description":"Search applications for this domain (wildcard allowed)"}},{"name":"class","in":"query","description":"Search applications belonging to this class (wildcard allowed)","schema":{"type":"string","nullable":true,"description":"Search applications belonging to this class (wildcard allowed)"}},{"name":"status","in":"query","description":"Search for applications with this status","schema":{"type":"string","nullable":true,"enum":["UNPAID","PAID","REQUESTED","PROCESSING","SUCCESSFUL","FAILED","INVALID","HOLD","UNPAIDREQUESTED","UNPAIDPROCESSING","DELETED"],"description":"Search for applications with this status"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","APPLICATION","STATUS","CLASS","CREATEDDATE","UPDATEDDATE","FINALIZATIONDATE"],"description":"Sort the result by this column"}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"wide","in":"query","description":"Show a detailed list or a grouped list version","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show a detailed list or a grouped list version"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"application":{"type":"integer","format":"int32","description":"Application ID: ID of the application (registrar - unique)"},"class":{"type":"string","description":"Class: Class of the application"},"created_date":{"type":"string","format":"date-time","description":"Created date: Date the application was issued"},"domain":{"type":"string","description":"Domain: Domain, the application was issued for"},"finalization_date":{"type":"string","format":"date-time","nullable":true,"description":"Finalization date: Backorder finalization date of the domain name"},"status":{"type":"string","description":"Status: Status of the application"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Date the application was last updated"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of applications shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing applications"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDomainApplicationList"}},"/domain/-/application/availability":{"get":{"operationId":"checkDomainApplication","summary":"XRRP command CheckDomainApplication (checkDomainApplication)","description":"\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","required":true,"description":"Domain to be checked for availability","schema":{"type":"string","description":"Domain to be checked for availability"}},{"name":"class","in":"query","description":"Application class to check availability for domain name.","schema":{"type":"string","description":"Application class to check availability for domain name."}},{"name":"x-idn-language","in":"query","description":"IDN encoding used for the domainname","schema":{"type":"string","nullable":true,"description":"IDN encoding used for the domainname"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"x-fee-amount":{"type":"array","description":"X-FEE-AMOUNT: The amount that will be charged.","items":{"type":"string","format":"decimal","description":"X-FEE-AMOUNT: The amount that will be charged."}},"x-fee-application":{"type":"array","description":"X-FEE-APPLICATION: The non-refundable amount that will be charged.","items":{"type":"string","format":"decimal","description":"X-FEE-APPLICATION: The non-refundable amount that will be charged."}},"x-fee-class":{"type":"array","description":"X-FEE-CURRENCY: The class of the X-FEE-DOMAIN.","items":{"type":"string","description":"X-FEE-CURRENCY: The class of the X-FEE-DOMAIN."}},"x-fee-command":{"type":"array","description":"X-FEE-CURRENCY: The command for the X-FEE prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The command for the X-FEE prices."}},"x-fee-currency":{"type":"array","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values.","items":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."}},"x-fee-domain":{"type":"array","description":"X-FEE-CURRENCY: The domain name for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The domain name for the prices."}},"x-fee-launchphase":{"type":"array","description":"X-FEE-CURRENCY: The launchphase for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The launchphase for the prices."}},"x-fee-period":{"type":"array","description":"X-FEE-CURRENCY: The period for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The period for the prices."}},"x-fee-periodtype":{"type":"array","description":"X-FEE-CURRENCY: The periodtype for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The periodtype for the prices."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckDomainApplication"}},"/domain/-/application/class":{"get":{"operationId":"queryApplicationList","summary":"XRRP command QueryApplicationList (queryApplicationList)","description":"List all applications currently available\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"wide","in":"query","description":"Show more or less details","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details"}},{"name":"zone","in":"query","description":"Search applications by zone","schema":{"type":"string","nullable":true,"description":"Search applications by zone"}},{"name":"domain","in":"query","description":"Search applications by domain","schema":{"type":"string","nullable":true,"description":"Search applications by domain"}},{"name":"showallfuture","in":"query","description":"Show all comming applications even if more than 14 days in the future.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show all comming applications even if more than 14 days in the future."}},{"name":"showallpast","in":"query","description":"Show all applications even if more than 5 days in the past and already completed.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show all applications even if more than 5 days in the past and already completed."}},{"name":"application","in":"query","description":"Searchpattern for specific applications","schema":{"type":"string","nullable":true,"description":"Searchpattern for specific applications"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","description":"If the phase is active at the moment"},"application":{"type":"string","description":"The application class name"},"application_type":{"type":"string","description":"The type of the application. Can be sunrise, landrush, golive or other."},"check_domain_syntax":{"type":"string","description":"The given domain name must match with this regular expression in order to be accepted."},"description":{"type":"string","description":"The application class description"},"evidence_required":{"type":"string"},"idn_allowed":{"type":"string","description":"If IDN domain names allowed"},"launch_date":{"type":"string","format":"date-time","nullable":true,"description":"The date when the application phase officially starts at the registry."},"launch_type":{"type":"string","description":"The type launch type. Can be registration (First come first served) or application."},"max_period":{"type":"string","description":"The maximum registration period allowed"},"min_period":{"type":"string","description":"The minimum registration period allowed"},"paid":{"type":"string","description":"Will the application be paid directly or later"},"pay_date":{"type":"string","description":"On this date, the application will be billed if it is not yet paid"},"period_end":{"type":"string","format":"date-time","description":"The end date of the application phase"},"period_start":{"type":"string","format":"date-time","description":"The start date of the application phase"},"tmch_enabled":{"type":"string","description":"Value is set to 1, if the TMCH support is enabled."},"tmch_phase_type":{"type":"string","description":"Describes the phase type (sunrise / claims)."},"tmch_smd_required":{"type":"string","description":"Value is set to 1, if a SMD file is required."},"zone":{"type":"string","description":"Zone (TLD) of the domain"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of applications shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of applications"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryApplicationList"}},"/domain/-/application/{application}":{"delete":{"operationId":"deleteDomainApplication","summary":"XRRP command DeleteDomainApplication (deleteDomainApplication)","description":"Delete a domain application\n","tags":["domain"],"parameters":[{"name":"domain","in":"query","description":"The application domain name","schema":{"type":"string","description":"The application domain name"}},{"name":"class","in":"query","description":"Application class: Application class","schema":{"type":"string","nullable":true,"description":"Application class: Application class"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"application","in":"path","required":true,"description":"The application to be deleted","schema":{"type":"integer","format":"int32","description":"The application to be deleted"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: The domain of the deleted application"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteDomainApplication"},"get":{"operationId":"statusDomainApplication_2","summary":"XRRP command StatusDomainApplication (statusDomainApplication_2)","description":"This command enables you to check the actual status and all data of an application.\n","tags":["domain"],"parameters":[{"name":"domain","in":"query","description":"The domain to get details for","schema":{"type":"string","description":"The domain to get details for"}},{"name":"class","in":"query","description":"Application class: Application class","schema":{"type":"string","nullable":true,"description":"Application class: Application class"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"application","in":"path","required":true,"description":"ID of the application to check","schema":{"type":"integer","format":"int32","description":"ID of the application to check"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"admin_contact":{"type":"string","description":"Admin contact: Administrative contact used for the application"},"application_id":{"type":"integer","format":"int32","description":"Application ID: The ID of your domain application."},"auth_code":{"type":"string","description":"Authentication code: Authentication code of the domain."},"billing_contact":{"type":"string","description":"Billing contact: Billing contact used for the application"},"class":{"type":"string","enum":["CO_GRANDFATHERING","CO_LANDRUSH","CO_LIVE"],"description":"Application class: Type of application"},"created_date":{"type":"string","format":"date-time","description":"Created date: Creation date of domain application."},"domain":{"type":"string","description":"Domain: Domain name for the application"},"nameserver":{"type":"array","description":"Nameserver","items":{"type":"string","nullable":true,"description":"Nameserver"}},"owner_contact":{"type":"string","description":"Owner contact: Owner contact used for the application"},"period":{"type":"integer","format":"int32","description":"Period: Period the domain shall be registered"},"roid":{"type":"string","description":"Roid"},"smdid":{"type":"string","description":"SMD ID: Shows the SMD:ID field of the relevant SMD file (if set)."},"status":{"type":"string","enum":["UNPAID","PAID","REQUESTED","PROCESSING","SUCCESSFUL","FAILED","INVALID","HOLD","UNPAIDREQUESTED","UNPAIDPROCESSING"],"description":"Status: The current status of the application."},"tech_contact":{"type":"string","description":"Tech contact: Technical contact used for the application"},"update_date":{"type":"string","format":"date-time","description":"Updated date: Date of last update of the application."},"x-amsterdam-legalform":{"type":"string","description":".AMSTERDAM legalform"},"x-amsterdam-legalformregno":{"type":"integer","format":"int32","description":".AMSTERDAM legalformregno"},"x-au-domain-idnumber":{"type":"string","nullable":true,"description":"Identification number: Specify the identification number as appropriate"},"x-au-domain-idtype":{"type":"string","nullable":true,"description":"Identification type: This is the identification type of the registrant.  Specify 'ABN', 'ACN', or 'OTHER'. 'OTHER' refers to ARBN or Inc Association Number"},"x-au-domain-relation":{"type":"string","nullable":true,"enum":["1","2"],"description":"Eligibility type relationship: This indicates the relationship between the Eligibility Type (e.g. business name) and domain name"},"x-au-domain-relationtype":{"type":"string","description":"Eligibility type: The Eligibility Type"},"x-au-eligibility-idnumber":{"type":"string","description":"Identification number for the Eligibility: Specify the identification number as appropriate"},"x-au-eligibility-idtype":{"type":"string","nullable":true,"description":"Identification type: This is the identification type of the elibibility."},"x-au-eligibility-name":{"type":"string","description":"Eligibility Name: The Eligibility name"},"x-au-ext-given":{"type":"integer","format":"int32","description":".AU ext given"},"x-au-grandfathering-tld":{"type":"string","description":".AU grandfathering tld"},"x-au-import-token":{"type":"integer","format":"int32","description":".AU import token"},"x-au-owner-organization":{"type":"string","nullable":true,"description":"Owner Organization: The Organization name"},"x-au-priority-token":{"type":"string","description":".AU priority token"},"x-backorder-auction-status":{"type":"string","enum":["PENDING","WON","LOST","FAILED","SUCCESSFUL"],"description":"Backorder auction status: Backorder auction status"},"x-backorder-finalization-date":{"type":"string","format":"date-time","description":"Backorder finalization date: Backorder finalization date of the domain name"},"x-domain-blocking-ipr-id":{"type":"string","nullable":true,"description":"IPR Number"},"x-domain-roid":{"type":"string","description":"Domain Registry Roid"},"x-intended-use":{"type":"string","description":"intended use"},"x-launch-accepted-date":{"type":"string","format":"date-time","description":"launch accepted date"},"x-launch-expiry-date":{"type":"string","description":"launch expiry date"},"x-launch-notice-id":{"type":"string","description":"launch notice id"},"x-nicse-idnumber":{"type":"string","description":"Personal or organisational number: Personal or organisational number."},"x-nicse-vatid":{"type":"string","description":"VAT number: VAT number"},"x-nu-iis-idno":{"type":"string","description":"ID number: ID number"},"x-nu-iis-vatno":{"type":"string","nullable":true,"description":"Vatnumber: VAT number."},"x-swiss-owner-type":{"type":"string","description":".SWISS owner type"},"x-swiss-uid":{"type":"string","description":".SWISS uid"},"x-trademark-entitlement":{"type":"string","description":"Trademark Entitlement: Trademark Entitlement"},"x-trademark-locality":{"type":"string","description":"Trademark Locality: Trademark Locality"},"x-trademark-name":{"type":"string","description":"Trademark Name: Trademark Name"},"x-trademark-number":{"type":"string","description":"Trademark Number: Trademark Number"},"x-trademark-reg-date":{"type":"string","format":"date-time","description":"Trademark Registration date: Trademark Registration date"},"x-trademark-right-type":{"type":"string","description":"Trademark Right Type: Trademark Right Type"},"x-xxx-sunrise-b-on-expiry-action":{"type":"string","nullable":true,"description":"ON-EXPIRY-ACTION: CONVERTTOADULTBLOCKPLUS"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusDomainApplication"},"patch":{"operationId":"modifyDomainApplication","summary":"XRRP command ModifyDomainApplication (modifyDomainApplication)","description":"\n","tags":["domain"],"parameters":[{"name":"application","in":"path","required":true,"description":"Application ID: The application to be modified","schema":{"type":"integer","format":"int32","description":"Application ID: The application to be modified"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"admincontact0":{"type":"string","description":"Admin contact: Administrative contact"},"auth":{"type":"string","nullable":true,"description":"Auth: domain auth code"},"billingcontact0":{"type":"string","description":"Billing contact: Billing contact"},"class":{"type":"string","nullable":true,"description":"Application class: Application class"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"domain":{"type":"string","description":"Domain: Domain name to be registered"},"nameserver":{"type":"array","description":"Nameserver: Nameserver to be used for this domain","items":{"type":"string","nullable":true,"description":"Nameserver: Nameserver to be used for this domain"}},"ownercontact0":{"type":"string","description":"Owner contact: Owner contact"},"pay":{"type":"string","nullable":true,"enum":["0","1"],"description":"Pay domain fee: Pay domain fee"},"period":{"type":"integer","format":"int32","description":"Period: How many years you want to apply for this domain"},"smdfile":{"type":"array","description":"SMDFILE: TMCH SMD file","items":{"type":"string","nullable":true,"description":"SMDFILE: TMCH SMD file"}},"techcontact0":{"type":"string","description":"Tech contact: Technical contact"},"trademark":{"type":"string","nullable":true,"description":"Trademark ID: Loads the SMD file from the database by ID if your trademark is handled within this system already."},"x-accept-premiumprice":{"type":"string","nullable":true,"enum":["0","1"]},"x-au-domain-idnumber":{"type":"string","nullable":true,"description":"Identification number: Specify the identification number as appropriate"},"x-au-domain-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA","PRIVATE"],"description":"Identification type: This is the identification type of the registrant.  Specify 'ABN', 'ACN', or 'OTHER'. 'OTHER' refers to ARBN or Inc Association Number"},"x-au-domain-relation":{"type":"string","enum":["1","2"],"description":"Eligibility type relationship: This indicates the relationship between the Eligibility Type (e.g. business name) and domain name"},"x-au-domain-relationtype":{"type":"string","enum":["Company","RegisteredBusiness","SoleTrader","Partnership","TrademarkOwner","PendingTMOwner","CitizenResident","IncorporatedAssociation","Club","NonProfitOrganisation","Charity","TradeUnion","IndustryBody","CommercialStatutoryBody","PoliticalParty","religiouschurchgroup","HigherEducationInstitution","ResearchOrganisation","GovernmentSchool","ChildCareCentre","Preschool","NationalBody","TrainingOrganisation","NonGovernmentSchool","UnincorporatedAssociation","IndustryOrganisation","egistrableBody","IndigenousCorporation","RegisteredOrganisation","Cooperative","Trust","EducationalInstitution","CommonwealthEntity","StatutoryBody","TradingCooperative","CompanyLimitedByGuarantee","NonDistributingCooperative","NonTradingCooperative","CharitableTrust","PublicPrivateAncillaryFund","PeakStateTerritoryBody","NotForProfitCommunityGroup"],"description":"Eligibility type: Specify what makes the registrant eligible to register the domain name"},"x-au-eligibility-idnumber":{"type":"string","nullable":true,"description":"Identification number for the Eligibility: Specify the identification number as appropriate"},"x-au-eligibility-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA"],"description":"Identification type: This is the identification type of the elibibility."},"x-au-eligibility-name":{"type":"string","nullable":true,"description":"Eligibility Name: The Eligibility name"},"x-au-grandfathering-tld":{"type":"string","enum":["com.au","net.au","org.au","asn.au","id.au"],"description":"Namespace of the grandfathering domain: Defines the Namespace the grandfathering domain is in"},"x-au-import-token":{"type":"string","nullable":true,"enum":["0","1"],"description":"If the Grandfathering Domain is managed via RRPProxy, the Details like the .au Priority Token can be Imported automatically by RRPProxy: RRPProxy will need a dedicated Agreement that the Requester of this domain is actually eligible to order this domain and owns the grandfathering domain."},"x-au-owner-organization":{"type":"string","nullable":true,"description":"Owner Organization: The Organization(Registrant) name"},"x-au-priority-token":{"type":"string","nullable":true,"description":"Priority Token: Priotity Token / Grandfathering Token as Provided by auDA"},"x-bayern-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BAYERN trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-berlin-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BERLIN trustee TAC: determine if the local presence service is to be used to register this domain"},"x-br-register-number":{"type":"string","nullable":true,"description":"Brazil Legal ID: A brazil legal ID, either CNPJ for organization or CPF for person"},"x-cnnic-owner-id-code":{"type":"string","nullable":true,"description":"Owner identity code: Identity code of the ID card"},"x-cnnic-owner-id-type":{"type":"string","nullable":true,"enum":["SFZ","HZ","GAJMTX","TWJMTX","WJLSFZ","GAJZZ","TWJZZ","JGZ","QT","ORG","YYZZ","TYDM","BDDM","JDDWFW","SYDWFR","WGCZJG","SHTTFR","ZJCS","MBFQY","JJHFR","LSZY","WGZHWH","WLCZJG","SFJD","JWJG","SHFWJG","MBXXBX","YLJGZY","GZJGZY","BJWSXX","QTTYDM","GATJZZ","ZZJGDMZ"],"description":"Owner identity type: Identity type of the ID card"},"x-domain-blocking-ipr-id":{"type":"string","nullable":true,"description":"IPR Number: Sunrise B XXX: IPR-ID to convert to ADULTBLOCK"},"x-faitid-admin-birthdate":{"type":"string","format":"date","nullable":true,"description":"Admin birthdate: date of birth; mandatoryfor individuals"},"x-faitid-admin-city":{"type":"string","nullable":true,"description":"Admin city: Extension representing the city"},"x-faitid-admin-country":{"type":"string","nullable":true,"description":"Admin country: Extension representing the country"},"x-faitid-admin-passportinfo":{"type":"string","nullable":true,"description":"Admin passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-admin-state":{"type":"string","nullable":true,"description":"Admin state: Extension representing the state"},"x-faitid-admin-street":{"type":"array","description":"Admin street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Admin street: Extension representing the street"}},"x-faitid-admin-tin":{"type":"string","nullable":true,"description":"Admin TIN: tax payer ID, mandatory for organizations"},"x-faitid-admin-zip":{"type":"string","nullable":true,"description":"Admin zip code: Extension representing the zip code"},"x-faitid-billing-birthdate":{"type":"string","format":"date","nullable":true,"description":"Billing birthdate: date of birth; mandatoryfor individuals"},"x-faitid-billing-city":{"type":"string","nullable":true,"description":"Billing city: Extension representing the city"},"x-faitid-billing-country":{"type":"string","nullable":true,"description":"Billing country: Extension representing the country"},"x-faitid-billing-passportinfo":{"type":"string","nullable":true,"description":"Billing passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-billing-state":{"type":"string","nullable":true,"description":"Billing state: Extension representing the state"},"x-faitid-billing-street":{"type":"array","description":"Billing street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Billing street: Extension representing the street"}},"x-faitid-billing-tin":{"type":"string","nullable":true,"description":"Billing TIN: tax payer ID, mandatory for organizations"},"x-faitid-billing-zip":{"type":"string","nullable":true,"description":"Billing zip code: Extension representing the zip code"},"x-faitid-owner-birthdate":{"type":"string","format":"date","nullable":true,"description":"Owner birthdate: date of birth; mandatoryfor individuals"},"x-faitid-owner-city":{"type":"string","nullable":true,"description":"Owner city: Extension representing the city"},"x-faitid-owner-country":{"type":"string","nullable":true,"description":"Owner country: Extension representing the country"},"x-faitid-owner-passportinfo":{"type":"string","nullable":true,"description":"Owner passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-owner-state":{"type":"string","nullable":true,"description":"Owner state: Extension representing the state"},"x-faitid-owner-street":{"type":"array","description":"Owner street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Owner street: Extension representing the street"}},"x-faitid-owner-tin":{"type":"string","nullable":true,"description":"Owner TIN: tax payer ID, mandatory for organizations"},"x-faitid-owner-zip":{"type":"string","nullable":true,"description":"Owner zip code: Extension representing the zip code"},"x-faitid-tech-birthdate":{"type":"string","format":"date","nullable":true,"description":"Tech birthdate: date of birth; mandatoryfor individuals"},"x-faitid-tech-city":{"type":"string","nullable":true,"description":"Tech city: Extension representing the city"},"x-faitid-tech-country":{"type":"string","nullable":true,"description":"Tech country: Extension representing the country"},"x-faitid-tech-passportinfo":{"type":"string","nullable":true,"description":"Tech Passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-tech-state":{"type":"string","nullable":true,"description":"Tech state: Extension representing the state"},"x-faitid-tech-street":{"type":"array","description":"Tech street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Tech street: Extension representing the street"}},"x-faitid-tech-tin":{"type":"string","nullable":true,"description":"Tech TIN: tax payer ID, mandatory for organizations"},"x-faitid-tech-zip":{"type":"string","nullable":true,"description":"Tech zip code: Extension representing the zip code"},"x-fee-amount":{"type":"array","description":"Amount of the fee extension.","items":{"type":"string","format":"decimal","nullable":true,"description":"Amount of the fee extension."}},"x-fee-application":{"type":"string","format":"decimal","nullable":true,"description":"None refundable amount of the fee extension."},"x-fee-currency":{"type":"string","nullable":true,"description":"Currency of the fee extension. Default is the own account currency."},"x-idn-language":{"type":"string","nullable":true,"description":"IDN Language: IDN language tag"},"x-intended-use":{"type":"string","description":"Intended Use: Text for intended use of the domain"},"x-launch-accepted-date":{"type":"string","format":"date","nullable":true,"description":"Accepted date: TMDB claims notice acceptance date"},"x-launch-expiry-date":{"type":"string","format":"date","nullable":true,"description":"Expiry date: TMDB expiry date of the claims notice"},"x-launch-notice-id":{"type":"string","nullable":true,"description":"Notice ID: Notice ID"},"x-ltda-authorityname":{"type":"string","nullable":true,"description":"Authority Name"},"x-ltda-licensenumber":{"type":"string","nullable":true,"description":"License Number"},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code: This parameter will be used to get the promotion - pricing, please have a look into the newsletter to see if any promotion is active"},"x-reference-url":{"type":"string","description":"Reference URL: Registrants current url"},"x-ruhr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .RUHR trustee TAC: Determinruhr if the local presence service is to be used to register this domain"},"x-srl-authorityname":{"type":"string","nullable":true,"description":"Authority Name"},"x-srl-licensenumber":{"type":"string","nullable":true,"description":"License Number"},"x-swiss-owner-type":{"type":"string","nullable":true,"enum":["P","O"],"description":"Owner type: Identity type owner"},"x-swiss-uid":{"type":"string","description":"UID / UPI: Enterprise ID of the Owners Organization"},"x-trademark-id":{"type":"string","description":"Trademark ID: The ID of the trademark, as issued by the trademark authority"},"x-trademark-issuer":{"type":"string","description":"Trademark Issuer: The name of the trademark authority that issued the trademark"},"x-trademark-transliteration-info":{"type":"string","description":"Trademark Transliteration Info: Explanation why transliteration from SMD to some-label is valid"},"x-xxx-sunrise-b-on-expiry-action":{"type":"string","nullable":true,"enum":["CONVERTTOADULTBLOCK","CONVERTTOADULTBLOCKPLUS","EXPIRE"],"description":"ON-EXPIRY-ACTION: Action on expire."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"application":{"type":"integer","format":"int32","description":"Application: ID of the updated application (equal to APPLICATION ID)"},"application_id":{"type":"integer","format":"int32","description":"Application ID: ID of the updated application (equal to APPLICATION)"},"domain":{"type":"string","description":"Domain: Domain this application was issued for"},"status":{"type":"string","enum":["UNPAID"],"description":"Status: Status of the updated application"},"x-fee-amount":{"type":"string","format":"decimal","description":"X-FEE-AMOUNT: The amount debited from your account balance for the domain name registration."},"x-fee-application":{"type":"string","format":"decimal","description":"X-FEE-APPLICATION: The non-refundable amount debited from your account balance for the domain name registration."},"x-fee-currency":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyDomainApplication"}},"/domain/-/application/{application}/pay":{"patch":{"operationId":"payDomainApplication","summary":"XRRP command PayDomainApplication (payDomainApplication)","description":"\n","tags":["domain"],"parameters":[{"name":"application","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"x-accept-premiumprice":{"type":"string","nullable":true,"enum":["0","1"]},"x-fee-amount":{"type":"array","description":"Amount of the fee extension.","items":{"type":"string","format":"decimal","nullable":true,"description":"Amount of the fee extension."}},"x-fee-application":{"type":"string","format":"decimal","nullable":true,"description":"None refundable amount of the fee extension."},"x-fee-currency":{"type":"string","nullable":true,"description":"Currency of the fee extension. Default is the own account currency."},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code: This parameter will be used to get the promotion - pricing, please have a look into the newsletter to see if any promotion is active"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"domain":{"type":"string"},"x-fee-amount":{"type":"string","format":"decimal","description":"X-FEE-AMOUNT: The amount debited from your account balance for the domain name registration."},"x-fee-application":{"type":"string","format":"decimal","description":"X-FEE-APPLICATION: The non-refundable amount debited from your account balance for the domain name registration."},"x-fee-currency":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"PayDomainApplication"}},"/domain/-/availability":{"get":{"operationId":"checkDomains","summary":"XRRP command CheckDomains (checkDomains)","description":"This is exactly the same as CheckDomain, however with a multiple domain name check. You can submit a CheckDomains for up to 32 domain names. Simply enter the respective domains with the TLD.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Domain name to be checked","schema":{"type":"array","description":"Domain name to be checked","items":{"type":"string","description":"Domain name to be checked"}}},{"name":"x-idn-language","in":"query","description":"IDN language tag for ACE encoded domain names","schema":{"type":"string","nullable":true,"description":"IDN language tag for ACE encoded domain names"}},{"name":"zonetag","in":"query","description":"Zone Tag: The zone tag that should be used for domain checks for the string given in domain0.","schema":{"type":"string","nullable":true,"description":"Zone Tag: The zone tag that should be used for domain checks for the string given in domain0."}},{"name":"x-fee-command","in":"query","description":"Command name for fee extension check.","schema":{"type":"array","description":"Command name for fee extension check.","items":{"type":"string","nullable":true,"description":"Command name for fee extension check."}}},{"name":"first","in":"query","description":"First: Can be used to allow pagination of zone tags with more than 32 entries.","schema":{"type":"integer","format":"int32","nullable":true,"description":"First: Can be used to allow pagination of zone tags with more than 32 entries."}},{"name":"x-fee-domain","in":"query","description":"Domain name for fee extension check.","schema":{"type":"array","description":"Domain name for fee extension check.","items":{"type":"string","nullable":true,"description":"Domain name for fee extension check."}}},{"name":"limit","in":"query","description":"Limit: Can be used to limit checks for a zone tag. Default and maximum is 32.","schema":{"type":"integer","format":"int32","nullable":true,"description":"Limit: Can be used to limit checks for a zone tag. Default and maximum is 32."}},{"name":"x-fee-period","in":"query","description":"Period for fee extension check. Default is 1.","schema":{"type":"array","description":"Period for fee extension check. Default is 1.","items":{"type":"integer","format":"int32","nullable":true,"description":"Period for fee extension check. Default is 1."}}},{"name":"orderby","in":"query","description":"Order by: Order the zone tag by this setting. Default is POPULARITY","schema":{"type":"string","nullable":true,"enum":["POPULARITY","PERFORMANCE","ALPHABETICAL"],"description":"Order by: Order the zone tag by this setting. Default is POPULARITY"}},{"name":"x-fee-periodtype","in":"query","description":"Periodtype for fee extension check. Default is YEAR.","schema":{"type":"array","description":"Periodtype for fee extension check. Default is YEAR.","items":{"type":"string","nullable":true,"description":"Periodtype for fee extension check. Default is YEAR."}}},{"name":"order","in":"query","description":"Order: Default is ascending.","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"Order: Default is ascending."}},{"name":"x-fee-currency","in":"query","description":"Currency for the fee extension check. Default is the own account currency.","schema":{"type":"array","description":"Currency for the fee extension check. Default is the own account currency.","items":{"type":"string","nullable":true,"description":"Currency for the fee extension check. Default is the own account currency."}}},{"name":"x-fee-launchphase","in":"query","description":"Launchphase for the fee extension check. Default is no launchphase.","schema":{"type":"array","description":"Launchphase for the fee extension check. Default is no launchphase.","items":{"type":"string","nullable":true,"description":"Launchphase for the fee extension check. Default is no launchphase."}}},{"name":"x-allocation-token","in":"query","description":"Allocation token provided by the registry","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Allocation token provided by the registry"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"aftermarket_currency":{"type":"string","nullable":true,"description":"Premium Price Currency if aftermarket possible: Premium Price Currency if Aftermarket is possible for domain"},"aftermarket_info":{"type":"string","nullable":true,"description":"Information if Aftermarket is possible: Information if Aftermarket is possible"},"aftermarket_price":{"type":"string","format":"decimal","nullable":true,"description":"Premium Price if aftermarket possible: Premium Price if Aftermarket is possible for domain"},"column":{"type":"array","description":"List columns","items":{"type":"string","description":"List columns"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of domains shown"},"domain":{"type":"array","description":"Domain","items":{"type":"string","description":"Domain"}},"domaincheck":{"type":"array","description":"Domaincheck: Returns the availability in the format \"\u003cCODE\u003e \u003cDESCRIPTION\u003e\"","items":{"type":"string","description":"Domaincheck: Returns the availability in the format \"\u003cCODE\u003e \u003cDESCRIPTION\u003e\""}},"domainchecktime":{"type":"array","description":"Seconds used: How many seconds did the check need to finish","items":{"type":"number","format":"float","description":"Seconds used: How many seconds did the check need to finish"}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of domains matching the criteria"},"x-allocation-token":{"type":"string","nullable":true,"description":"Allocation Token: Allocation Token"},"x-fee-amount":{"type":"array","description":"X-FEE-AMOUNT: The amount that will be charged.","items":{"type":"string","format":"decimal","nullable":true,"description":"X-FEE-AMOUNT: The amount that will be charged."}},"x-fee-application":{"type":"array","description":"X-FEE-APPLICATION: The non-refundable amount that will be charged.","items":{"type":"string","format":"decimal","nullable":true,"description":"X-FEE-APPLICATION: The non-refundable amount that will be charged."}},"x-fee-class":{"type":"array","description":"X-FEE-CURRENCY: The class of the X-FEE-DOMAIN.","items":{"type":"string","description":"X-FEE-CURRENCY: The class of the X-FEE-DOMAIN."}},"x-fee-command":{"type":"array","description":"X-FEE-CURRENCY: The command for the X-FEE prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The command for the X-FEE prices."}},"x-fee-currency":{"type":"array","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values.","items":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."}},"x-fee-domain":{"type":"array","description":"X-FEE-CURRENCY: The domain name for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The domain name for the prices."}},"x-fee-launchphase":{"type":"array","description":"X-FEE-CURRENCY: The launchphase for the prices.","items":{"type":"string","nullable":true,"description":"X-FEE-CURRENCY: The launchphase for the prices."}},"x-fee-period":{"type":"array","description":"X-FEE-CURRENCY: The period for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The period for the prices."}},"x-fee-periodtype":{"type":"array","description":"X-FEE-CURRENCY: The periodtype for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The periodtype for the prices."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckDomains"},"post":{"operationId":"checkDomains_2","summary":"XRRP command CheckDomains (checkDomains_2)","description":"This is exactly the same as CheckDomain, however with a multiple domain name check. You can submit a CheckDomains for up to 32 domain names. Simply enter the respective domains with the TLD.\n","tags":["domain"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"domain":{"type":"array","description":"Domain name to be checked","items":{"type":"string","description":"Domain name to be checked"}},"first":{"type":"integer","format":"int32","nullable":true,"description":"First: Can be used to allow pagination of zone tags with more than 32 entries."},"limit":{"type":"integer","format":"int32","nullable":true,"description":"Limit: Can be used to limit checks for a zone tag. Default and maximum is 32."},"order":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"Order: Default is ascending."},"orderby":{"type":"string","nullable":true,"enum":["POPULARITY","PERFORMANCE","ALPHABETICAL"],"description":"Order by: Order the zone tag by this setting. Default is POPULARITY"},"x-allocation-token":{"type":"string","nullable":true,"enum":["0","1"],"description":"Allocation token provided by the registry"},"x-fee-command":{"type":"array","description":"Command name for fee extension check.","items":{"type":"string","nullable":true,"description":"Command name for fee extension check."}},"x-fee-currency":{"type":"array","description":"Currency for the fee extension check. Default is the own account currency.","items":{"type":"string","nullable":true,"description":"Currency for the fee extension check. Default is the own account currency."}},"x-fee-domain":{"type":"array","description":"Domain name for fee extension check.","items":{"type":"string","nullable":true,"description":"Domain name for fee extension check."}},"x-fee-launchphase":{"type":"array","description":"Launchphase for the fee extension check. Default is no launchphase.","items":{"type":"string","nullable":true,"description":"Launchphase for the fee extension check. Default is no launchphase."}},"x-fee-period":{"type":"array","description":"Period for fee extension check. Default is 1.","items":{"type":"integer","format":"int32","nullable":true,"description":"Period for fee extension check. Default is 1."}},"x-fee-periodtype":{"type":"array","description":"Periodtype for fee extension check. Default is YEAR.","items":{"type":"string","nullable":true,"description":"Periodtype for fee extension check. Default is YEAR."}},"x-idn-language":{"type":"string","nullable":true,"description":"IDN language tag for ACE encoded domain names"},"zonetag":{"type":"string","nullable":true,"description":"Zone Tag: The zone tag that should be used for domain checks for the string given in domain0."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"aftermarket_currency":{"type":"string","nullable":true,"description":"Premium Price Currency if aftermarket possible: Premium Price Currency if Aftermarket is possible for domain"},"aftermarket_info":{"type":"string","nullable":true,"description":"Information if Aftermarket is possible: Information if Aftermarket is possible"},"aftermarket_price":{"type":"string","format":"decimal","nullable":true,"description":"Premium Price if aftermarket possible: Premium Price if Aftermarket is possible for domain"},"column":{"type":"array","description":"List columns","items":{"type":"string","description":"List columns"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of domains shown"},"domain":{"type":"array","description":"Domain","items":{"type":"string","description":"Domain"}},"domaincheck":{"type":"array","description":"Domaincheck: Returns the availability in the format \"\u003cCODE\u003e \u003cDESCRIPTION\u003e\"","items":{"type":"string","description":"Domaincheck: Returns the availability in the format \"\u003cCODE\u003e \u003cDESCRIPTION\u003e\""}},"domainchecktime":{"type":"array","description":"Seconds used: How many seconds did the check need to finish","items":{"type":"number","format":"float","description":"Seconds used: How many seconds did the check need to finish"}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of domains matching the criteria"},"x-allocation-token":{"type":"string","nullable":true,"description":"Allocation Token: Allocation Token"},"x-fee-amount":{"type":"array","description":"X-FEE-AMOUNT: The amount that will be charged.","items":{"type":"string","format":"decimal","nullable":true,"description":"X-FEE-AMOUNT: The amount that will be charged."}},"x-fee-application":{"type":"array","description":"X-FEE-APPLICATION: The non-refundable amount that will be charged.","items":{"type":"string","format":"decimal","nullable":true,"description":"X-FEE-APPLICATION: The non-refundable amount that will be charged."}},"x-fee-class":{"type":"array","description":"X-FEE-CURRENCY: The class of the X-FEE-DOMAIN.","items":{"type":"string","description":"X-FEE-CURRENCY: The class of the X-FEE-DOMAIN."}},"x-fee-command":{"type":"array","description":"X-FEE-CURRENCY: The command for the X-FEE prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The command for the X-FEE prices."}},"x-fee-currency":{"type":"array","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values.","items":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."}},"x-fee-domain":{"type":"array","description":"X-FEE-CURRENCY: The domain name for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The domain name for the prices."}},"x-fee-launchphase":{"type":"array","description":"X-FEE-CURRENCY: The launchphase for the prices.","items":{"type":"string","nullable":true,"description":"X-FEE-CURRENCY: The launchphase for the prices."}},"x-fee-period":{"type":"array","description":"X-FEE-CURRENCY: The period for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The period for the prices."}},"x-fee-periodtype":{"type":"array","description":"X-FEE-CURRENCY: The periodtype for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The periodtype for the prices."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckDomains"}},"/domain/-/bycontact/{contact}":{"get":{"operationId":"queryDomainListByContact","summary":"XRRP command QueryDomainListByContact (queryDomainListByContact)","description":"Search all domains using a specific contact handle managed in your account\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"contact","in":"path","required":true,"description":"Contact: The contact to be searched for","schema":{"type":"string","description":"Contact: The contact to be searched for"}},{"name":"showmergetype","in":"query","description":"Returns only one row for each domain with a comma seperated list of all types.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Returns only one row for each domain with a comma seperated list of all types."}},{"name":"type","in":"query","description":"Type: Show only entries for this contact type","schema":{"type":"string","enum":["ADMIN","OWNER","TECH","BILLING"],"description":"Type: Show only entries for this contact type"}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domains that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domains that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domains that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domains that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domains that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domains that are associated with this zone tag."}}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is DOMAIN.","schema":{"type":"string","nullable":true,"enum":["DOMAIN","TYPE"],"description":"Order the results for the corresponding column. Default is DOMAIN."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: Domain using the given contact handle"},"type":{"type":"string","enum":["ADMIN","OWNER","TECH","BILLING"],"description":"Type: Type the contact is used for"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of domains with this contact shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of domains using this contact"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDomainListByContact"}},"/domain/-/claims":{"get":{"operationId":"checkClaims","summary":"XRRP command CheckClaims (checkClaims)","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Domain name to be checked","schema":{"type":"array","description":"Domain name to be checked","items":{"type":"string","description":"Domain name to be checked"}}},{"name":"class","in":"query","description":"Application class","schema":{"type":"string","nullable":true,"description":"Application class"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"claim_exists":{"type":"array","description":"Claim exists: Returns the 1 if claim exists or 0 if not exists","items":{"type":"string","description":"Claim exists: Returns the 1 if claim exists or 0 if not exists"}},"claim_key":{"type":"array","description":"Claim key: The claim key","items":{"type":"string","description":"Claim key: The claim key"}},"claim_url":{"type":"array","description":"Claim URL: Claimsnotice download URL","items":{"type":"string","description":"Claim URL: Claimsnotice download URL"}},"claim_validator_id":{"type":"array","description":"Claim Validator Identifier: The claim key","items":{"type":"string","description":"Claim Validator Identifier: The claim key"}},"runtime":{"type":"string","description":"The check runtime"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckClaims"},"post":{"operationId":"checkClaims_2","summary":"XRRP command CheckClaims (checkClaims_2)","tags":["domain"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"class":{"type":"string","nullable":true,"description":"Application class"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"domain":{"type":"array","description":"Domain name to be checked","items":{"type":"string","description":"Domain name to be checked"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"claim_exists":{"type":"array","description":"Claim exists: Returns the 1 if claim exists or 0 if not exists","items":{"type":"string","description":"Claim exists: Returns the 1 if claim exists or 0 if not exists"}},"claim_key":{"type":"array","description":"Claim key: The claim key","items":{"type":"string","description":"Claim key: The claim key"}},"claim_url":{"type":"array","description":"Claim URL: Claimsnotice download URL","items":{"type":"string","description":"Claim URL: Claimsnotice download URL"}},"claim_validator_id":{"type":"array","description":"Claim Validator Identifier: The claim key","items":{"type":"string","description":"Claim Validator Identifier: The claim key"}},"runtime":{"type":"string","description":"The check runtime"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckClaims"}},"/domain/-/expire":{"get":{"operationId":"queryDomainExpireList","summary":"XRRP command QueryDomainExpireList (queryDomainExpireList)","description":"Shows a list of all domain names that are currently marked for deletion or that will expire.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"days","in":"query","description":"Set the number of days for the expiring domain list (1-93)","schema":{"type":"integer","format":"int32","nullable":true,"description":"Set the number of days for the expiring domain list (1-93)"}},{"name":"mindate","in":"query","description":"Set the minimum date for the list result where the days will be added. Default is the current date.","schema":{"type":"string","format":"date-time","nullable":true,"description":"Set the minimum date for the list result where the days will be added. Default is the current date."}},{"name":"includesub","in":"query","description":"Includes all domains of all subreseller acccounts","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Includes all domains of all subreseller acccounts"}},{"name":"onlysub","in":"query","description":"Shows only the domains of all subreseller acccounts. Can only used with the includesub parameter.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows only the domains of all subreseller acccounts. Can only used with the includesub parameter."}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domains that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domains that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domains that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domains that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domains that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domains that are associated with this zone tag."}}},{"name":"zone","in":"query","description":"Pattern match for zone","schema":{"type":"string","nullable":true,"description":"Pattern match for zone"}},{"name":"domain","in":"query","description":"Pattern match for domain name","schema":{"type":"string","nullable":true,"description":"Pattern match for domain name"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","ZONE","EXPIRATIONDATE"],"description":"Sort the result by this column"}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"wide","in":"query","description":"Show a detailed list or a grouped list version","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show a detailed list or a grouped list version"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: The domain name that is up for a renewal"},"expirationdate":{"type":"string","format":"date-time","description":"Expirationdate: The expiration date of the domain"},"zone":{"type":"string","description":"Zone: The zone of the domain"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of accountings shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"registrar":{"type":"array","description":"Registrar: The owning registrar of the domain","items":{"type":"string","description":"Registrar: The owning registrar of the domain"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing accountings"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDomainExpireList"}},"/domain/-/expireauction":{"get":{"operationId":"queryExpireAuctionDomainsList","summary":"XRRP command QueryExpireAuctionDomainsList (queryExpireAuctionDomainsList)","description":"Search for domains that are expired and are in auction. This command is used to get a list of domains that are expired and are in auction, based on the given filters.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"registryaccount","in":"query","description":"Filter the result by this string","schema":{"type":"string","nullable":true,"description":"Filter the result by this string"}},{"name":"domain","in":"query","description":"Filter the result by this string","schema":{"type":"string","nullable":true,"description":"Filter the result by this string"}},{"name":"x-auction","in":"query","description":"Filter the result by this number","schema":{"type":"string","nullable":true,"enum":["0","1","2","3"],"description":"Filter the result by this number"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is column1.","schema":{"type":"string","nullable":true,"enum":["REGISTRYACCOUNT","DOMAIN","X-AUCTION","REGISTRATION-EXPIRATION-DATE"],"description":"Order the results for the corresponding column. Default is column1."}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"domain":{"type":"array","description":"Domain name: ...","items":{"type":"string","description":"Domain name: ..."}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"querydate":{"type":"array","description":"Query Date: ...","items":{"type":"string","format":"date","description":"Query Date: ..."}},"registration-expiration-date":{"type":"array","description":"Domain Expiration Date: ...","items":{"type":"string","format":"date-time","description":"Domain Expiration Date: ..."}},"registryaccount":{"type":"array","description":"Account Name: ...","items":{"type":"string","description":"Account Name: ..."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"},"x-auction":{"type":"array","description":"Expire Auction Level: ...","items":{"type":"integer","format":"int32","description":"Expire Auction Level: ..."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryExpireAuctionDomainsList"}},"/domain/-/foreigntransfer":{"get":{"operationId":"queryForeignTransferList","summary":"XRRP command QueryForeignTransferList (queryForeignTransferList)","description":"\n","tags":["domain"],"parameters":[{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Search for transfers with this domain (wildcard allowed)","schema":{"type":"string","nullable":true,"description":"Search for transfers with this domain (wildcard allowed)"}},{"name":"transferstatus","in":"query","description":"Search for transfers with this status (wildcard allowed)","schema":{"type":"string","nullable":true,"description":"Search for transfers with this status (wildcard allowed)"}},{"name":"requestingregistrar","in":"query","description":"Search for transfers with this requesting registrar (wildcard allowed)","schema":{"type":"string","nullable":true,"description":"Search for transfers with this requesting registrar (wildcard allowed)"}},{"name":"zone","in":"query","description":"Search for transfers with this zone (wildcard allowed)","schema":{"type":"string","nullable":true,"description":"Search for transfers with this zone (wildcard allowed)"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","TRANSFERSTATUS","REQUESTINGREGISTRAR","ZONE","TRANSFERDATE"],"description":"Sort the result by this column"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"actions":{"type":"string"},"domain":{"type":"string"},"requestingregistrar":{"type":"string"},"transferdate":{"type":"string","format":"date-time"},"transferstatus":{"type":"string"}}}},"property":{"type":"object","properties":{"column":{"type":"array","description":"List columns","items":{"type":"string","description":"List columns"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of foreign transfers shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of foreign transfers"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryForeignTransferList"}},"/domain/-/history":{"get":{"operationId":"queryDomainHistoryList","summary":"XRRP command QueryDomainHistoryList (queryDomainHistoryList)","description":"Search for deleted domain names.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"mindate","in":"query","description":"Search for deleted domain names starting the given mindate. Default is one month in the past.","schema":{"type":"string","format":"date-time","description":"Search for deleted domain names starting the given mindate. Default is one month in the past."}},{"name":"maxdate","in":"query","description":"Search for deleted domain names until the given maxdate. Default is the current date.","schema":{"type":"string","format":"date-time","description":"Search for deleted domain names until the given maxdate. Default is the current date."}},{"name":"historyid","in":"query","description":"Search for a single historyid entry","schema":{"type":"integer","format":"int32","description":"Search for a single historyid entry"}},{"name":"domain","in":"query","description":"Search for a specific deleted domain name pattern","schema":{"type":"string","description":"Search for a specific deleted domain name pattern"}},{"name":"reason","in":"query","description":"Search for deleted domains with a specific reason","schema":{"type":"string","description":"Search for deleted domains with a specific reason"}},{"name":"status","in":"query","description":"Search for deleted domains within a specific domain status.","schema":{"type":"string","nullable":true,"enum":["REDEMPTIONPERIOD","PENDINGDELETE"],"description":"Search for deleted domains within a specific domain status."}},{"name":"zone","in":"query","description":"Search for deleted domain names of a specific TLD","schema":{"type":"string","description":"Search for deleted domain names of a specific TLD"}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domains that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domains that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domains that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domains that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domains that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domains that are associated with this zone tag."}}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is historyid.","schema":{"type":"string","nullable":true,"enum":["HISTORYID","DELETEDDATE","REASON","DOMAIN"],"description":"Order the results for the corresponding column. Default is historyid."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","description":"Reason: The reason for the deletion of the domain name."},"status":{"type":"string","description":"Status: The current status of the domain name (none, pendingDelete, redemtionGrace,)"},"status_until":{"type":"string","format":"date","nullable":true,"description":"Status until"},"zone":{"type":"string","description":"Zone: The zone of the deleted domain name."}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"deleteddate":{"type":"array","description":"Deletion date: The date when the domain was deleted.","items":{"type":"string","format":"date-time","description":"Deletion date: The date when the domain was deleted."}},"domain":{"type":"array","description":"Domain: The domain name.","items":{"type":"string","description":"Domain: The domain name."}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"historyid":{"type":"array","description":"History ID: The unique history ID of the deleted domain name.","items":{"type":"integer","format":"int32","description":"History ID: The unique history ID of the deleted domain name."}},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"status_date":{"type":"array","description":"Status Date: The date until this status ends.","items":{"type":"string","format":"date","description":"Status Date: The date until this status ends."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDomainHistoryList"}},"/domain/-/ownerchange":{"get":{"operationId":"queryOwnerchangeList","summary":"XRRP command QueryOwnerchangeList (queryOwnerchangeList)","description":"\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Filter the result by this string (wildcards allowed)","schema":{"type":"string","description":"Filter the result by this string (wildcards allowed)"}},{"name":"status","in":"query","description":"Filter the result by this string (wildcards allowed)","schema":{"type":"string","description":"Filter the result by this string (wildcards allowed)"}},{"name":"trigger","in":"query","description":"Filter the result by this trigger code","schema":{"type":"string","nullable":true,"description":"Filter the result by this trigger code"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","nullable":true,"description":"Domain: A domain matching the search - filter"},"gaining_registrant":{"type":"string","description":"Gaining registrant: Ownerchange gaining registrant"},"losing_registrant":{"type":"string","description":"Losing registrant: Ownerchange losing registrant"},"request_date":{"type":"string","format":"date-time","description":"Request date"},"request_expiration_date":{"type":"string","format":"date-time","description":"Request expiration date"},"status":{"type":"integer","format":"int32","description":"Status: Ownerchange status"},"template_en":{"type":"string","description":"Template en"}}}},"property":{"type":"object","properties":{"contact_changes":{"type":"array","description":"Contact changes","items":{"type":"string","description":"Contact changes"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of domains shown"},"expiration_date":{"type":"string","format":"date","description":"Expiration date: Ownerchange expiration date"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"requested_date":{"type":"string","format":"date","description":"Requested date: Ownerchange request date"},"template_de":{"type":"array","description":"Template de","items":{"type":"string","description":"Template de"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of domains matching the criteria"},"transferlock_remove_until_date":{"type":"string","format":"date-time","description":"Transferlock remove until date"},"transferlock_until_date":{"type":"string","format":"date-time","description":"Transferlock until date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryOwnerchangeList"}},"/domain/-/ownerchange/activate":{"post":{"operationId":"activateOwnerchange","summary":"XRRP command ActivateOwnerchange (activateOwnerchange)","description":"\n","tags":["domain"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["APPROVE","DENY","CANCEL","REMOVETRANSFERLOCK"],"description":"Action: Ownerchange options"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"domain":{"type":"string","nullable":true,"description":"Domain: Domain name to be used in combination with ACTION=CANCEL"},"transferlock":{"type":"string","nullable":true,"enum":["0","1"],"description":"Transferlock: Request transferlock after ownerchange"},"trigger":{"type":"string","description":"Trigger: Trigger code to activate"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ActivateOwnerchange"}},"/domain/-/pinlock":{"get":{"operationId":"queryDomainPinLockList","summary":"XRRP command QueryDomainPinLockList (queryDomainPinLockList)","description":"\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Domain: Searchpattern for domain names in the list.","schema":{"type":"string","nullable":true,"description":"Domain: Searchpattern for domain names in the list."}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN"],"description":"Sort the result by this column"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","nullable":true,"description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","nullable":true,"description":"Limit: Show only this many items in the response"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"domain":{"type":"array","description":"Domain: The domain name.","items":{"type":"string","description":"Domain: The domain name."}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"pinlock_renewaldate":{"type":"array","description":"Renewal date: Renewal date of the trustee service.","items":{"type":"string","format":"date","description":"Renewal date: Renewal date of the trustee service."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDomainPinLockList"}},"/domain/-/premium":{"get":{"operationId":"queryPremiumDomainList","summary":"XRRP command QueryPremiumDomainList (queryPremiumDomainList)","description":"Search for premium domain pricings\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"zone","in":"query","description":"Search for premium domain prices for the given zone","schema":{"type":"string","nullable":true,"description":"Search for premium domain prices for the given zone"}},{"name":"domain","in":"query","description":"Search for premium domain prices for the given domain name","schema":{"type":"string","nullable":true,"description":"Search for premium domain prices for the given domain name"}},{"name":"type","in":"query","description":"Determines if the premium domain prices for the own account are show, or if the own defined premium prices are shown (only available in subreseller system)!","schema":{"type":"string","nullable":true,"enum":["DEFAULT","OWN"],"description":"Determines if the premium domain prices for the own account are show, or if the own defined premium prices are shown (only available in subreseller system)!"}},{"name":"registryaccount","in":"query","description":"Only show prices for this registryaccount in type OWN.","schema":{"type":"string","nullable":true,"description":"Only show prices for this registryaccount in type OWN."}},{"name":"launchphase","in":"query","description":"Show premium domain prices for this launchphase!","schema":{"type":"string","nullable":true,"description":"Show premium domain prices for this launchphase!"}},{"name":"showzones","in":"query","description":"Only show the zones where premium domains exist in.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Only show the zones where premium domains exist in."}},{"name":"showlaunchphases","in":"query","description":"Only show the launchphases where premium domains exist in.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Only show the launchphases where premium domains exist in."}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is domain.","schema":{"type":"string","nullable":true,"enum":["DOMAIN","UNIT"],"description":"Order the results for the corresponding column. Default is domain."}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: Domain"}}}},"property":{"type":"object","properties":{"application":{"type":"array","description":"Application: Application fee","items":{"type":"string","format":"decimal","nullable":true,"description":"Application: Application fee"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of prices shown"},"currency":{"type":"array","description":"Currency: Currency","items":{"type":"string","description":"Currency: Currency"}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"launchphase":{"type":"string","nullable":true,"description":"Launchphase: Zone"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"periodtype":{"type":"array","description":"Periodtype: Periodtype of the price","items":{"type":"string","description":"Periodtype: Periodtype of the price"}},"registryaccount":{"type":"string","nullable":true,"description":"Registryaccount"},"restore":{"type":"array","description":"Restore: Restore fee","items":{"type":"string","format":"decimal","nullable":true,"description":"Restore: Restore fee"}},"setup":{"type":"array","description":"Setup: Setup fee","items":{"type":"string","format":"decimal","nullable":true,"description":"Setup: Setup fee"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing registry account prices"},"trade":{"type":"array","description":"Trade: Trade fee","items":{"type":"string","format":"decimal","nullable":true,"description":"Trade: Trade fee"}},"transfer":{"type":"array","description":"Transfer: Transfer fee","items":{"type":"string","format":"decimal","nullable":true,"description":"Transfer: Transfer fee"}},"unit":{"type":"array","description":"Unit: Unit fee","items":{"type":"string","format":"decimal","nullable":true,"description":"Unit: Unit fee"}},"zone":{"type":"array","description":"Zone: Zone","items":{"type":"string","description":"Zone: Zone"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryPremiumDomainList"}},"/domain/-/premium/registered":{"get":{"operationId":"queryRegisteredPremiumDomainList","summary":"XRRP command QueryRegisteredPremiumDomainList (queryRegisteredPremiumDomainList)","description":"\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Filter the result by this string (wildcards allowed)","schema":{"type":"string","description":"Filter the result by this string (wildcards allowed)"}},{"name":"domainidn","in":"query","description":"Filter the result by this string (wildcards allowed)","schema":{"type":"string","description":"Filter the result by this string (wildcards allowed)"}},{"name":"renewalmode","in":"query","description":"The Renewalmode selected for this domain","schema":{"type":"string","nullable":true,"enum":["DEFAULT","AUTORENEW","AUTOEXPIRE","AUTODELETE","RENEWONCE","AUTORENEWMONTHLY","EXPIREAUCTION","RENEWONCETHENAUTODELETE","RENEWONCETHENAUTOEXPIRE"],"description":"The Renewalmode selected for this domain"}},{"name":"zone","in":"query","description":"Show only domains matching this zone","schema":{"type":"string","nullable":true,"description":"Show only domains matching this zone"}},{"name":"registrar","in":"query","description":"Show only domains of this registrar.","schema":{"type":"string","nullable":true,"description":"Show only domains of this registrar."}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domains that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domains that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domains that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domains that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domains that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domains that are associated with this zone tag."}}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"includesub","in":"query","description":"Includes all premium domains of all subreseller acccounts","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Includes all premium domains of all subreseller acccounts"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"onlysub","in":"query","description":"Shows only the premium domains of all subreseller acccounts. Can only used with the includesub parameter.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows only the premium domains of all subreseller acccounts. Can only used with the includesub parameter."}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","DOMAINIDN","DOMAINCREATEDDATE","DOMAINREGISTRATIONEXPIRATIONDATE","DOMAINRENEWALDATE","DOMAINZONE","ZONE","RENEWALMODE","TRANSFERMODE"],"description":"Sort the result by this column"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: A domain matching the search - filter"},"domain_created_by":{"type":"string","description":"Created by: Account, in which the domain was created"},"domain_created_date":{"type":"string","format":"date-time","description":"Created date: The date, when the domain was created"},"domain_idn":{"type":"string","description":"Domain IDN: The UTF-8 - version of the domain"},"domain_registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date: When will the domain expire"},"domain_renewal_date":{"type":"string","format":"date-time","description":"Renewal date: When must the domain be renewed"},"domain_updated_by":{"type":"string","description":"Updated by: Account, who did the last modification on this domain"},"domain_updated_date":{"type":"string","format":"date-time","description":"Updated date: The date, when the domain was last updated"},"domain_zone":{"type":"string","description":"Zone: Zone of the domain name"},"registrar":{"type":"string","description":"Registrar: Registrar account of the domain"},"renewalmode":{"type":"string","description":"Renewal mode: The current renewalmode of the domain"},"roid":{"type":"string","description":"ROID: Registry Object ID for this domain"},"transfermode":{"type":"string","description":"Transfer mode: The current transfer mode of the domain"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of domains shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"status":{"type":"string","description":"Status"},"total":{"type":"integer","format":"int32","description":"Total: Total number of domains matching the criteria"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryRegisteredPremiumDomainList"}},"/domain/-/prices":{"get":{"operationId":"domainPrices","summary":"XRRP command DomainPrices (domainPrices)","description":"The DomainPrices command can be used to get all prices for a domainname for all types and periods.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","required":true,"description":"Domain the prices should be calculated for","schema":{"type":"string","description":"Domain the prices should be calculated for"}},{"name":"x-promotion-code","in":"query","description":"Promotion code to be used for calculating the prices","schema":{"type":"string","nullable":true,"description":"Promotion code to be used for calculating the prices"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"currency":{"type":"array","description":"Currency: Currency of the prices for this domain","items":{"type":"string","description":"Currency: Currency of the prices for this domain"}},"domain":{"type":"array","description":"Domain: The domain for the pricingis","items":{"type":"string","description":"Domain: The domain for the pricingis"}},"exchangerate":{"type":"array","description":"Exchange rate: Exchange rate used to calculate the domain price","items":{"type":"number","format":"float","description":"Exchange rate: Exchange rate used to calculate the domain price"}},"nonrefundable":{"type":"array","description":"NONREFUNDABLE: The nonrefundable part of the price","items":{"type":"string","format":"decimal","description":"NONREFUNDABLE: The nonrefundable part of the price"}},"period":{"type":"array","description":"Period: The period of the price","items":{"type":"integer","format":"int32","description":"Period: The period of the price"}},"periodtype":{"type":"array","description":"Periodtype: The periodtype for this price.","items":{"type":"string","description":"Periodtype: The periodtype for this price."}},"premium":{"type":"array","description":"Premium domain name: Price is a premium domain price","items":{"type":"string","enum":["0","1"],"description":"Premium domain name: Price is a premium domain price"}},"price":{"type":"array","description":"Price: The amount that will be charged.","items":{"type":"string","format":"decimal","description":"Price: The amount that will be charged."}},"promotion":{"type":"array","description":"Promotion used: Promotion is used to calculate the price","items":{"type":"string","enum":["0","1"],"description":"Promotion used: Promotion is used to calculate the price"}},"type":{"type":"array","description":"Type: The type of the price.","items":{"type":"string","description":"Type: The type of the price."}},"vat":{"type":"array","description":"VAT: The vat amount that will be charged for this price.","items":{"type":"string","format":"decimal","description":"VAT: The vat amount that will be charged for this price."}},"vatnonrefundable":{"type":"array","description":"VATNONREFUNDABLE: The nonrefundable part of the vat","items":{"type":"string","format":"decimal","description":"VATNONREFUNDABLE: The nonrefundable part of the vat"}},"vatpercent":{"type":"array","description":"VAT percentage: VAT % that will be charged","items":{"type":"number","format":"float","description":"VAT percentage: VAT % that will be charged"}},"zone":{"type":"array","description":"Zone: Zone of the domain","items":{"type":"string","description":"Zone: Zone of the domain"}},"zonecurrency":{"type":"array","description":"Zone currency: Price currency of the zone","items":{"type":"string","description":"Zone currency: Price currency of the zone"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DomainPrices"}},"/domain/-/renew":{"get":{"operationId":"queryDomainRenewList","summary":"XRRP command QueryDomainRenewList (queryDomainRenewList)","description":"Shows a list of all domain names that are currently set for an automated renewal.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"days","in":"query","description":"Set the number of days for the renew domain list (1-93)","schema":{"type":"integer","format":"int32","nullable":true,"description":"Set the number of days for the renew domain list (1-93)"}},{"name":"mindate","in":"query","description":"Set the minimum date for the list result where the days will be added. Default is the current date.","schema":{"type":"string","format":"date-time","nullable":true,"description":"Set the minimum date for the list result where the days will be added. Default is the current date."}},{"name":"includesub","in":"query","description":"Includes all domains of all subreseller acccounts","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Includes all domains of all subreseller acccounts"}},{"name":"onlysub","in":"query","description":"Shows only the domains of all subreseller acccounts. Can only used with the includesub parameter.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows only the domains of all subreseller acccounts. Can only used with the includesub parameter."}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domains that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domains that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domains that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domains that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domains that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domains that are associated with this zone tag."}}},{"name":"zone","in":"query","description":"Pattern match for zone","schema":{"type":"string","nullable":true,"description":"Pattern match for zone"}},{"name":"domain","in":"query","description":"Pattern match for domain name","schema":{"type":"string","nullable":true,"description":"Pattern match for domain name"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","ZONE","RENEWALDATE"],"description":"Sort the result by this column"}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"wide","in":"query","description":"Show a detailed list or a grouped list version","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show a detailed list or a grouped list version"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: The domain name that is up for a renewal"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of accountings shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"registrar":{"type":"array","description":"Registrar: The owning registrar of the domain","items":{"type":"string","description":"Registrar: The owning registrar of the domain"}},"renewaldate":{"type":"array","description":"Renewaldate: The renewal date of the domain","items":{"type":"string","format":"date-time","description":"Renewaldate: The renewal date of the domain"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing accountings"},"zone":{"type":"array","description":"Zone: The zone of the domain","items":{"type":"string","description":"Zone: The zone of the domain"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDomainRenewList"}},"/domain/-/transfer":{"get":{"operationId":"queryTransferList","summary":"XRRP command QueryTransferList (queryTransferList)","description":"\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Search for transfers with this domain (wildcard allowed)","schema":{"type":"string","nullable":true,"description":"Search for transfers with this domain (wildcard allowed)"}},{"name":"domaintransferstatus","in":"query","description":"Search for transfers with this status (wildcard allowed)","schema":{"type":"string","nullable":true,"enum":["FAILED","FOREIGN_PENDING","INITIATED","PENDING","REQUESTED","REQUEST_CONFIRMED","TRADE","TRADEPENDING","USERTRANSFER","WHOIS_SUCCESSFUL","INCOMING"],"description":"Search for transfers with this status (wildcard allowed)"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","DOMAINTRANSFERSTATUS"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"string"}},"column":{"type":"array","description":"List columns","items":{"type":"string","description":"List columns"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of transfers shown"},"domain":{"type":"array","description":"Domain: Domain with a transfer in progress","items":{"type":"string","description":"Domain: Domain with a transfer in progress"}},"domaintransferstatus":{"type":"array","description":"Status: Status of the transfer in progress","items":{"type":"string","enum":["FAILED","FOREIGN_PENDING","INITIATED","PENDING","REQUESTED","REQUEST_CONFIRMED","TRADE","TRADEPENDING","USERTRANSFER","WHOIS_SUCCESSFUL"],"description":"Status: Status of the transfer in progress"}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing transfers"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryTransferList"}},"/domain/-/trusteedomain":{"get":{"operationId":"queryTrusteeDomainList","summary":"XRRP command QueryTrusteeDomainList (queryTrusteeDomainList)","description":"Search for domain names that use an active trustee service.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","description":"Domain: Searchpattern for domain names in the list.","schema":{"type":"string","nullable":true,"description":"Domain: Searchpattern for domain names in the list."}},{"name":"trusteetype","in":"query","description":"Trustee type: Searchpattern for the trustee service type.","schema":{"type":"string","nullable":true,"description":"Trustee type: Searchpattern for the trustee service type."}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN","RENEWALDATE","TRUSTEETYPE"],"description":"Sort the result by this column"}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domains that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domains that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domains that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domains that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domains that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domains that are associated with this zone tag."}}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","nullable":true,"description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","nullable":true,"description":"Limit: Show only this many items in the response"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: The domain name."}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"owner_address1":{"type":"array","description":"Street: Address of the domain owner contact.","items":{"type":"string","description":"Street: Address of the domain owner contact."}},"owner_address2":{"type":"array","description":"Street: Address of the domain owner contact.","items":{"type":"string","description":"Street: Address of the domain owner contact."}},"owner_name":{"type":"array","description":"Last name: Name of the domain owner contact.","items":{"type":"string","description":"Last name: Name of the domain owner contact."}},"owner_organization":{"type":"array","description":"Organization: Organization of the domain owner contact.","items":{"type":"string","description":"Organization: Organization of the domain owner contact."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"},"trustee_renewal_date":{"type":"array","description":"Renewal date: Renewal date of the trustee service.","items":{"type":"string","format":"date-time","description":"Renewal date: Renewal date of the trustee service."}},"trustee_type":{"type":"array","description":"Type: The trustee type assigned to the domain name.","items":{"type":"string","description":"Type: The trustee type assigned to the domain name."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryTrusteeDomainList"}},"/domain/{domain}":{"delete":{"operationId":"deleteDomain","summary":"XRRP command DeleteDomain (deleteDomain)","description":"\n","tags":["domain"],"parameters":[{"name":"jobqueue","in":"query","description":"Queue the command and process it in non-real time","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Queue the command and process it in non-real time"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","description":"Action: How to delete the domain","schema":{"type":"string","enum":["INSTANT","AUTODELETE","AUTOEXPIRE","AUTOAPPROVE","PUSH"],"description":"Action: How to delete the domain"}},{"name":"target","in":"query","description":"Target: The target for push","schema":{"type":"string","nullable":true,"description":"Target: The target for push"}},{"name":"token","in":"query","description":"Token: The one time authorization token for protected domain names.","schema":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."}},{"name":"x-bg-comregid","in":"query","description":"VAT ID or tax no. of Legal entity","schema":{"type":"string","nullable":true,"description":"VAT ID or tax no. of Legal entity"}},{"name":"x-bg-idcard","in":"query","description":"ID Card Number of the representative person","schema":{"type":"string","nullable":true,"description":"ID Card Number of the representative person"}},{"name":"x-bg-applicationdate","in":"query","description":"Registry's application date of domain registration in format yyyy-mm-dd","schema":{"type":"string","nullable":true,"description":"Registry's application date of domain registration in format yyyy-mm-dd"}},{"name":"x-bg-applicationno","in":"query","description":"Registry's application no. of the domain registration","schema":{"type":"string","nullable":true,"description":"Registry's application no. of the domain registration"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"add-grace-deletion":{"type":"integer","format":"int32","description":"Add-grace-deletion"},"addgracedeletions":{"type":"string"},"deletion_date":{"type":"string","format":"date-time"},"faquri":{"type":"string","description":"Faquri"},"job_id":{"type":"string"},"payback":{"type":"string"},"roid":{"type":"string"},"status":{"type":"string"},"transfer_status":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteDomain"},"get":{"operationId":"statusDomain","summary":"XRRP command StatusDomain (statusDomain)","description":"This command enables you to check the actual status of a Domain in your portfolio: When it was registered, who registered it, the expiration time and a lot more like the extensions used to register it.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"The domain to get details for","schema":{"type":"string","description":"The domain to get details for"}},{"name":"auth","in":"query","description":"Authentication code: The authorization code for the domain","schema":{"type":"string","nullable":true,"description":"Authentication code: The authorization code for the domain"}},{"name":"showdomainrgp","in":"query","description":"Show domain in RGP: Show deleted domains in the redemption grace period","schema":{"type":"string","enum":["0","1"],"description":"Show domain in RGP: Show deleted domains in the redemption grace period"}},{"name":"x-fee-command","in":"query","description":"Command name for fee extension check.","schema":{"type":"string","nullable":true,"description":"Command name for fee extension check."}},{"name":"x-fee-period","in":"query","description":"Period for fee extension check. Default is 1.","schema":{"type":"integer","format":"int32","nullable":true,"description":"Period for fee extension check. Default is 1."}},{"name":"x-fee-periodtype","in":"query","description":"Periodtype for fee extension check. Default is YEAR.","schema":{"type":"string","nullable":true,"description":"Periodtype for fee extension check. Default is YEAR."}},{"name":"x-fee-currency","in":"query","description":"Currency for the fee extension check. Default is the own account currency.","schema":{"type":"string","nullable":true,"description":"Currency for the fee extension check. Default is the own account currency."}},{"name":"x-fee-launchphase","in":"query","description":"Launchphase for the fee extension check. Default is no launchphase.","schema":{"type":"string","nullable":true,"description":"Launchphase for the fee extension check. Default is no launchphase."}},{"name":"x-validation","in":"query","description":"Flag to enable additional Validations","schema":{"type":"string","nullable":true,"enum":["1"],"description":"Flag to enable additional Validations"}},{"name":"hosttype","in":"query","description":"Optional parameter for additional host information.","schema":{"type":"string","nullable":true,"description":"Optional parameter for additional host information."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"activation_target":{"type":"string","description":"Activation target"},"activation_type":{"type":"string","description":"Activation type"},"admin_contact":{"type":"array","description":"Administrative contact: Administrative contact(s) of this domain","items":{"type":"string","description":"Administrative contact: Administrative contact(s) of this domain"}},"admin_contact_city":{"type":"array","description":"Admin contact city","items":{"type":"string","description":"Admin contact city"}},"admin_contact_country":{"type":"array","description":"Admin contact country","items":{"type":"string","description":"Admin contact country"}},"admin_contact_email":{"type":"array","description":"Admin contact email","items":{"type":"string","description":"Admin contact email"}},"admin_contact_encoding_type":{"type":"array","description":"Admin contact encoding type","items":{"type":"string","description":"Admin contact encoding type"}},"admin_contact_fax":{"type":"array","description":"Admin contact fax","items":{"type":"string","description":"Admin contact fax"}},"admin_contact_first_name":{"type":"array","description":"Admin contact first name","items":{"type":"string","description":"Admin contact first name"}},"admin_contact_last_name":{"type":"array","description":"Admin contact last name","items":{"type":"string","description":"Admin contact last name"}},"admin_contact_middle_name":{"type":"array","description":"Admin contact middle name","items":{"type":"string","description":"Admin contact middle name"}},"admin_contact_organization":{"type":"array","description":"Admin contact organization","items":{"type":"string","description":"Admin contact organization"}},"admin_contact_phone":{"type":"array","description":"Admin contact phone","items":{"type":"string","description":"Admin contact phone"}},"admin_contact_state":{"type":"array","description":"Admin contact state","items":{"type":"string","description":"Admin contact state"}},"admin_contact_street0":{"type":"array","description":"Admin contact street0","items":{"type":"string","nullable":true,"description":"Admin contact street0"}},"admin_contact_street1":{"type":"string","nullable":true,"description":"Admin contact street1"},"admin_contact_street2":{"type":"string","nullable":true,"description":"Admin contact street2"},"admin_contact_title":{"type":"array","description":"Admin contact title","items":{"type":"string","description":"Admin contact title"}},"admin_contact_validated":{"type":"string","nullable":true,"description":"Validated: Is the admin contact validated"},"admin_contact_validation_issues":{"type":"string","nullable":true,"description":"Admin contact validation issues: Reason the admin contact failed validation, when known"},"admin_contact_verification_requested":{"type":"string","nullable":true,"enum":["0","1"],"description":"Admin contact verification request has been created"},"admin_contact_verified":{"type":"string","nullable":true,"description":"Verified: Is the admin contact email address verified"},"admin_contact_zip":{"type":"array","description":"Admin contact zip","items":{"type":"string","description":"Admin contact zip"}},"auth":{"type":"string","nullable":true,"description":"Authentication code: The authcode for this domain, if supported by registry"},"autorenew":{"type":"integer","format":"int32","description":"Autorenew"},"billing_contact":{"type":"array","description":"Billing contact: Billing contact(s) of this domain","items":{"type":"string","description":"Billing contact: Billing contact(s) of this domain"}},"billing_contact_city":{"type":"array","description":"Billing contact city","items":{"type":"string","description":"Billing contact city"}},"billing_contact_country":{"type":"array","description":"Billing contact country","items":{"type":"string","description":"Billing contact country"}},"billing_contact_email":{"type":"array","description":"Billing contact email","items":{"type":"string","description":"Billing contact email"}},"billing_contact_encoding_type":{"type":"array","description":"Billing contact encoding type","items":{"type":"string","description":"Billing contact encoding type"}},"billing_contact_fax":{"type":"array","description":"Billing contact fax","items":{"type":"string","description":"Billing contact fax"}},"billing_contact_first_name":{"type":"array","description":"Billing contact first name","items":{"type":"string","description":"Billing contact first name"}},"billing_contact_last_name":{"type":"array","description":"Billing contact last name","items":{"type":"string","description":"Billing contact last name"}},"billing_contact_middle_name":{"type":"array","description":"Billing contact middle name","items":{"type":"string","description":"Billing contact middle name"}},"billing_contact_organization":{"type":"array","description":"Billing contact organization","items":{"type":"string","description":"Billing contact organization"}},"billing_contact_phone":{"type":"array","description":"Billing contact phone","items":{"type":"string","description":"Billing contact phone"}},"billing_contact_state":{"type":"array","description":"Billing contact state","items":{"type":"string","description":"Billing contact state"}},"billing_contact_street0":{"type":"array","description":"Billing contact street0","items":{"type":"string","nullable":true,"description":"Billing contact street0"}},"billing_contact_street1":{"type":"string","nullable":true,"description":"Billing contact street1"},"billing_contact_street2":{"type":"string","nullable":true,"description":"Billing contact street2"},"billing_contact_title":{"type":"string","description":"Billing contact title"},"billing_contact_validated":{"type":"string","nullable":true,"description":"Validated: Is the billing contact validated"},"billing_contact_validation_issues":{"type":"string","nullable":true,"description":"Billing contact validation issues: Reason the billing contact failed validation, when known"},"billing_contact_verification_requested":{"type":"string","nullable":true,"enum":["0","1"],"description":"Billing contact verification request has been created"},"billing_contact_verified":{"type":"string","nullable":true,"description":"Verified: Is the billing contact email address verified"},"billing_contact_zip":{"type":"array","description":"Billing contact zip","items":{"type":"string","description":"Billing contact zip"}},"bundle_domain":{"type":"array","description":"Bundle domains: All domains that are bundled with this domain. Changes to one domain of the bundle apply to all other bundled domains, some exceptions (DNSSEC,...) might occur.","items":{"type":"string","description":"Bundle domains: All domains that are bundled with this domain. Changes to one domain of the bundle apply to all other bundled domains, some exceptions (DNSSEC,...) might occur."}},"created_by":{"type":"string","description":"Created by: Who created the domain in our system (EXTERNAL if it created by a transfer-in)"},"created_date":{"type":"string","format":"date-time","description":"Created date: When the domain was created at the registry if data available, otherwise: in our system"},"deletion_date":{"type":"string","format":"date-time","description":"Deletion date: The date on which the domain will be automatically deleted if it is set to AutoDelete or AutoExpire."},"dnssec":{"type":"array","description":"DNSSEC KEYDATA: DNSSEC Public key","items":{"type":"string","description":"DNSSEC KEYDATA: DNSSEC Public key"}},"dnssecdsdata":{"type":"array","description":"DNSSEC DSDATA: DNSSEC Delegation Signer (DS)","items":{"type":"string","description":"DNSSEC DSDATA: DNSSEC Delegation Signer (DS)"}},"document_generator_uri":{"type":"array","description":"Document generator uri","items":{"type":"string","description":"Document generator uri"}},"document_upload_target":{"type":"array","description":"Document upload target","items":{"type":"string","description":"Document upload target"}},"document_upload_type":{"type":"array","description":"Document upload type","items":{"type":"string","description":"Document upload type"}},"domain":{"type":"string","description":"Domain: ACE encoded version of the domainname"},"domain_idn":{"type":"string","description":"Domain IDN: UTF-8 encoded version of the domainname"},"domaintag":{"type":"array","description":"Domain Tag: The domain tags associated with the domain.","items":{"type":"string","description":"Domain Tag: The domain tags associated with the domain."}},"error":{"type":"string","description":"Error"},"faquri":{"type":"array","description":"Faquri","items":{"type":"string","description":"Faquri"}},"host":{"type":"array","description":"Host: Nameserver linked with this domain","items":{"type":"string","description":"Host: Nameserver linked with this domain"}},"keyset":{"type":"string","description":"Keyset"},"nameserver":{"type":"array","description":"Nameserver: Nameserver used for this domain","items":{"type":"string","description":"Nameserver: Nameserver used for this domain"}},"namestoreroid":{"type":"string"},"nsset":{"type":"string","description":"Nsset"},"owner_contact":{"type":"string","description":"Owner contact: Owner contact of the domain"},"owner_contact_city":{"type":"array","description":"Owner contact city","items":{"type":"string","description":"Owner contact city"}},"owner_contact_country":{"type":"array","description":"Owner contact country","items":{"type":"string","description":"Owner contact country"}},"owner_contact_email":{"type":"array","description":"Owner contact email","items":{"type":"string","description":"Owner contact email"}},"owner_contact_encoding_type":{"type":"array","description":"Owner contact encoding type","items":{"type":"string","description":"Owner contact encoding type"}},"owner_contact_fax":{"type":"array","description":"Owner contact fax","items":{"type":"string","description":"Owner contact fax"}},"owner_contact_first_name":{"type":"array","description":"Owner contact first name","items":{"type":"string","description":"Owner contact first name"}},"owner_contact_last_name":{"type":"array","description":"Owner contact last name","items":{"type":"string","description":"Owner contact last name"}},"owner_contact_middle_name":{"type":"string","description":"Owner contact middle name"},"owner_contact_organization":{"type":"array","description":"Owner contact organization","items":{"type":"string","description":"Owner contact organization"}},"owner_contact_phone":{"type":"array","description":"Owner contact phone","items":{"type":"string","description":"Owner contact phone"}},"owner_contact_state":{"type":"string","description":"Owner contact state"},"owner_contact_street0":{"type":"array","description":"Owner contact street0","items":{"type":"string","nullable":true,"description":"Owner contact street0"}},"owner_contact_street1":{"type":"string","nullable":true,"description":"Owner contact street1"},"owner_contact_street2":{"type":"string","nullable":true,"description":"Owner contact street2"},"owner_contact_title":{"type":"string","description":"Owner contact title"},"owner_contact_validated":{"type":"string","nullable":true,"description":"Validated: Is the owner contact validated"},"owner_contact_validation_issues":{"type":"string","nullable":true,"description":"Owner contact validation issues: Reason the owner contact failed validation, when known"},"owner_contact_verification_requested":{"type":"string","nullable":true,"enum":["0","1"],"description":"Owner contact verification request has been created"},"owner_contact_verified":{"type":"string","nullable":true,"description":"Verified: Is the owner contact email address verified"},"owner_contact_zip":{"type":"array","description":"Owner contact zip","items":{"type":"string","description":"Owner contact zip"}},"ownerchange_status":{"type":"string","description":"Owner change status: Status of pending ownerchange"},"paiduntil_date":{"type":"string","format":"date-time"},"pending_job":{"type":"array","items":{"type":"string"}},"registrar":{"type":"string","description":"Registrar: The registrar currently managing the domain in the RRPproxy - system"},"registrar_transfer_date":{"type":"string","format":"date-time","nullable":true,"description":"Transfer date: Last time, the domain was transfered (is available)"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Expiration date: The domain will expire in the registry on this date"},"renewal_date":{"type":"string","format":"date-time","description":"Renewal date: The domain must be renewed , when it should not be deleted on this date"},"renewalmode":{"type":"string","enum":["DEFAULT","AUTORENEW","AUTODELETE","AUTOEXPIRE","AUTORENEWMONTHLY","AUTORENEWQUATERLY","EXPIREAUCTION","RENEWONCE","RENEWONCETHENAUTODELETE","RENEWONCETHENAUTOEXPIRE"],"description":"Renewal mode: What happens with this domain on its renewal date"},"rgp_enddate":{"type":"string","format":"date-time","description":"RGP enddate"},"rgp_status":{"type":"array","description":"RGP Status: Registry Grace Period (RGP) Status of the domain","items":{"type":"string","description":"RGP Status: Registry Grace Period (RGP) Status of the domain"}},"roid":{"type":"string","nullable":true,"description":"ROID: The ROID (Registry Object ID) is an unique identifier for the domain and will stay the same during the entire lifecycle in RRPproxy"},"status":{"type":"array","description":"Status: Status of the domain","items":{"type":"string","description":"Status: Status of the domain"}},"tech_contact":{"type":"array","description":"Technical contact: Technical contact(s) of this domain","items":{"type":"string","description":"Technical contact: Technical contact(s) of this domain"}},"tech_contact_city":{"type":"array","description":"Tech contact city","items":{"type":"string","description":"Tech contact city"}},"tech_contact_country":{"type":"array","description":"Tech contact country","items":{"type":"string","description":"Tech contact country"}},"tech_contact_email":{"type":"array","description":"Tech contact email","items":{"type":"string","description":"Tech contact email"}},"tech_contact_encoding_type":{"type":"array","description":"Tech contact encoding type","items":{"type":"string","description":"Tech contact encoding type"}},"tech_contact_fax":{"type":"array","description":"Tech contact fax","items":{"type":"string","description":"Tech contact fax"}},"tech_contact_first_name":{"type":"array","description":"Tech contact first name","items":{"type":"string","description":"Tech contact first name"}},"tech_contact_last_name":{"type":"array","description":"Tech contact last name","items":{"type":"string","description":"Tech contact last name"}},"tech_contact_middle_name":{"type":"array","description":"Tech contact middle name","items":{"type":"string","description":"Tech contact middle name"}},"tech_contact_organization":{"type":"array","description":"Tech contact organization","items":{"type":"string","description":"Tech contact organization"}},"tech_contact_phone":{"type":"array","description":"Tech contact phone","items":{"type":"string","description":"Tech contact phone"}},"tech_contact_state":{"type":"array","description":"Tech contact state","items":{"type":"string","description":"Tech contact state"}},"tech_contact_street0":{"type":"array","description":"Tech contact street0","items":{"type":"string","nullable":true,"description":"Tech contact street0"}},"tech_contact_street1":{"type":"string","nullable":true,"description":"Tech contact street1"},"tech_contact_street2":{"type":"string","nullable":true,"description":"Tech contact street2"},"tech_contact_title":{"type":"array","description":"Tech contact title","items":{"type":"string","description":"Tech contact title"}},"tech_contact_validated":{"type":"string","nullable":true,"description":"Validated: Is the tech contact validated"},"tech_contact_validation_issues":{"type":"string","nullable":true,"description":"Tech contact validation issues: Reason the tech contact failed validation, when known"},"tech_contact_verification_requested":{"type":"string","nullable":true,"enum":["0","1"],"description":"Tech contact verification request has been created"},"tech_contact_verified":{"type":"string","nullable":true,"description":"Verified: Is the tech contact email address verified"},"tech_contact_zip":{"type":"array","description":"Tech contact zip","items":{"type":"string","description":"Tech contact zip"}},"temp_contact":{"type":"string","nullable":true,"description":"Temp contact"},"transfer":{"type":"string","description":"Transfer status: Status of a transfer (currently only for .DE - domains)"},"transfer_lock":{"type":"string","enum":["0","1"],"description":"Transfer lock: Shows if domain is locked for transfers or not."},"transfermode":{"type":"string","enum":["DEFAULT","AUTOAPPROVE","AUTODENY"],"description":"Transfer mode: How should the domain be treated on outgoing transfer - requests (DEFAULT = registrar's setting)"},"updated_by":{"type":"string","description":"Updated by: Who was the last one updating the domain"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When the domain was last updated, if never it's the same like the created date"},"x-accept-premium-price":{"type":"integer","format":"int32","description":"X-accept-premium-price"},"x-accept-premiumprice":{"type":"integer","format":"int32","description":"X-accept-premiumprice"},"x-accept-ssl-requirement":{"type":"integer","format":"int32","description":"X-accept-ssl-requirement"},"x-accept-trade":{"type":"integer","format":"int32","description":"X-accept-trade"},"x-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-accept-trustee-tac"},"x-ae-registrant-warranty-statement":{"type":"integer","format":"int32","description":"X-ae-registrant-warranty-statement"},"x-aero-ens-auth-id":{"type":"string","description":"ENS auth ID: The AERO ID is needed to register a domain in aviation. You can apply for it at http://www.information.aero."},"x-aero-ens-auth-key":{"type":"string","description":"ENS auth key: The respective password for the .AERO ID"},"x-afnic-code":{"type":"string","description":"X-afnic-code"},"x-allocation-token":{"type":"string","nullable":true,"description":"Allocation Token: Allocation Token provided by the registry"},"x-allow-clienthold":{"type":"integer","format":"int32","description":"X-allow-clienthold"},"x-amsterdam-legalform":{"type":"string","description":"X-amsterdam-legalform"},"x-amsterdam-legalformregno":{"type":"string","description":"X-amsterdam-legalformregno"},"x-ar-dni":{"type":"string","description":"X-ar-dni"},"x-ari-block":{"type":"integer","format":"int32","description":"X-ari-block"},"x-asia-ced-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-asia-ced-accept-trustee-tac"},"x-asia-maintainerurl":{"type":"string","description":"X-asia-maintainerurl"},"x-asiaidn-appdate":{"type":"string","format":"date","description":"X-asiaidn-appdate"},"x-asiaidn-cclocality":{"type":"string","description":"X-asiaidn-cclocality"},"x-asiaidn-class":{"type":"string","description":"X-asiaidn-class"},"x-asiaidn-entitlement":{"type":"string","description":"X-asiaidn-entitlement"},"x-asiaidn-form":{"type":"string","description":"X-asiaidn-form"},"x-asiaidn-name":{"type":"string","description":"X-asiaidn-name"},"x-asiaidn-number":{"type":"string","description":"X-asiaidn-number"},"x-asiaidn-regdate":{"type":"string","format":"date","description":"X-asiaidn-regdate"},"x-asiaidn-type":{"type":"string","description":"X-asiaidn-type"},"x-at-new-owner-name":{"type":"string"},"x-at-owner-name":{"type":"string"},"x-at-owner-organization":{"type":"string"},"x-at-verification-action-date":{"type":"string","format":"date-time","description":"X-at-verification-action-date"},"x-at-verification-status":{"type":"string","description":"X-at-verification-status"},"x-au-current-registrant-existent":{"type":"integer","format":"int32","description":"X-au-current-registrant-existent"},"x-au-domain-idnumber":{"type":"string","nullable":true,"description":"Identification number: Specify the identification number as appropriate"},"x-au-domain-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA"],"description":"Identification type: This is the identification type of the registrant.  Specify 'ABN', 'ACN', or 'OTHER'. 'OTHER' refers to ARBN or Inc Association Number"},"x-au-domain-relation":{"type":"string","nullable":true,"enum":["1","2"],"description":"Eligibility type relationship: This indicates the relationship between the Eligibility Type (e.g. business name) and domain name"},"x-au-domain-relationtype":{"type":"string","description":"Eligibility type: The Eligibility Type"},"x-au-eligibility-id-number":{"type":"string","description":"X-au-eligibility-id-number"},"x-au-eligibility-id-type":{"type":"string","description":"X-au-eligibility-id-type"},"x-au-eligibility-idnumber":{"type":"string","description":"Identification number for the Eligibility: Specify the identification number as appropriate"},"x-au-eligibility-idtype":{"type":"string","enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA","CRICOS"],"description":"Identification type: This is the identification type of the elibibility."},"x-au-eligibility-name":{"type":"string","description":"Eligibility Name: The Eligibility name"},"x-au-eligibility-type":{"type":"string","description":"X-au-eligibility-type"},"x-au-eligible-for-renewal":{"type":"integer","format":"int32","description":"X-au-eligible-for-renewal"},"x-au-id-warranty":{"type":"integer","format":"int32","description":"X-au-id-warranty"},"x-au-ineligibility-reason":{"type":"string","description":"X-au-ineligibility-reason"},"x-au-owner-organization":{"type":"string","nullable":true,"description":"Owner Organization: The Organization name"},"x-au-registrant-id":{"type":"integer","format":"int32","description":"X-au-registrant-id"},"x-au-registrant-id-number":{"type":"string","description":"X-au-registrant-id-number"},"x-au-registrant-id-type":{"type":"string","description":"X-au-registrant-id-type"},"x-au-registrant-name":{"type":"string","description":"X-au-registrant-name"},"x-auction":{"type":"string","nullable":true,"enum":["0","1","2","3"],"description":"Auction: Shows the status of the domain name in the auction domain lifecycle"},"x-auction-hold":{"type":"integer","format":"int32","description":"X-auction-hold"},"x-auth-expiry-date":{"type":"string","format":"date-time","description":"X-auth-expiry-date"},"x-authcode-expiration":{"type":"string","format":"date"},"x-aution":{"type":"integer","format":"int32","description":"X-aution"},"x-ax-business-registration":{"type":"integer","format":"int32","description":"X-ax-business-registration"},"x-az-comregid":{"type":"integer","format":"int32","description":"X-az-comregid"},"x-az-vat-number":{"type":"integer","format":"int32","description":"X-az-vat-number"},"x-backorder-finalization-date":{"type":"string","format":"date-time","description":"X-backorder-finalization-date"},"x-bank-verification":{"type":"string","format":"date-time","description":"X-bank-verification"},"x-bayern-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-bayern-accept-trustee-tac"},"x-be-accept-special-tac":{"type":"integer","format":"int32"},"x-be-owner":{"type":"string"},"x-be-owner-name":{"type":"string"},"x-be-requestauthcode":{"type":"integer","format":"int32","description":"X-be-requestauthcode"},"x-berlin-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-berlin-accept-trustee-tac"},"x-bg-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-bg-accept-trustee-tac"},"x-bg-applicationdate":{"type":"string","format":"date","description":"X-bg-applicationdate"},"x-bg-applicationno":{"type":"integer","format":"int32","description":"X-bg-applicationno"},"x-bg-comregid":{"type":"string","description":"X-bg-comregid"},"x-bg-idcard":{"type":"string","description":"X-bg-idcard"},"x-bg-tmid":{"type":"integer","format":"int32","description":"X-bg-tmid"},"x-br-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".COM.BR trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-br-accept-trustree-tac":{"type":"integer","format":"int32","description":"X-br-accept-trustree-tac"},"x-br-concurrent-application":{"type":"integer","format":"int32","description":"X-br-concurrent-application"},"x-br-register-number":{"type":"string","description":"X-br-register-number"},"x-br-ticket-number":{"type":"integer","format":"int32"},"x-ca-disclose":{"type":"integer","format":"int32","description":"X-ca-disclose"},"x-ca-legal-type":{"type":"string","description":"X-ca-legal-type"},"x-ca-trademark":{"type":"integer","format":"int32","description":"X-ca-trademark"},"x-ca-webnames-domain-id":{"type":"integer","format":"int32","description":"X-ca-webnames-domain-id"},"x-ca-webnames-registrant-id":{"type":"integer","format":"int32","description":"X-ca-webnames-registrant-id"},"x-ch-owner-name":{"type":"string"},"x-challenge-answer":{"type":"string","description":"X-challenge-answer"},"x-challenge-answer0":{"type":"string","description":"X-challenge-answer0"},"x-challenge-answer1":{"type":"string","description":"X-challenge-answer1"},"x-challenge-answer2":{"type":"string","description":"X-challenge-answer2"},"x-challenge-question":{"type":"string","description":"X-challenge-question"},"x-challenge-question0":{"type":"string","description":"X-challenge-question0"},"x-challenge-question1":{"type":"string","description":"X-challenge-question1"},"x-challenge-question2":{"type":"string","description":"X-challenge-question2"},"x-china-cn-domainname":{"type":"string","description":"X-china-cn-domainname"},"x-cl-rut":{"type":"integer","format":"int32","description":"X-cl-rut"},"x-cn-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".CN trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-cn-icp":{"type":"integer","format":"int32","description":"X-cn-icp"},"x-cn-no-website":{"type":"integer","format":"int32","description":"X-cn-no-website"},"x-cn-owner-id-number":{"type":"string","description":"X-cn-owner-id-number"},"x-cn-owner-id-type":{"type":"string","description":"X-cn-owner-id-type"},"x-cn-owner-type":{"type":"string","description":"X-cn-owner-type"},"x-cnnic-admin-id-code":{"type":"string","description":"X-cnnic-admin-id-code"},"x-cnnic-admin-id-type":{"type":"string","description":"X-cnnic-admin-id-type"},"x-cnnic-billing-id-code":{"type":"string","description":"X-cnnic-billing-id-code"},"x-cnnic-billing-id-type":{"type":"string","description":"X-cnnic-billing-id-type"},"x-cnnic-owner-id-code":{"type":"string","description":"X-cnnic-owner-id-code"},"x-cnnic-owner-id-type":{"type":"string","description":"X-cnnic-owner-id-type"},"x-cnnic-tech-id-code":{"type":"string","description":"X-cnnic-tech-id-code"},"x-cnnic-tech-id-type":{"type":"string","description":"X-cnnic-tech-id-type"},"x-cnrtrade-real-owner":{"type":"string","description":".CNRTRADE real owner: The real owner contact, when the local presence service is activated"},"x-cnrtrade-real-tech":{"type":"string","description":".CNRTRADE real tech: The real tech contact, when the local presence service is activated"},"x-co-applicant-capacity":{"type":"string","description":"X-co-applicant-capacity"},"x-co-tm-country":{"type":"string","description":"X-co-tm-country"},"x-co-tm-name":{"type":"string","description":"X-co-tm-name"},"x-co-tm-registration-number":{"type":"string","description":"X-co-tm-registration-number"},"x-coat-owner-name":{"type":"string"},"x-company-reg-id":{"type":"string","description":"X-company-reg-id"},"x-company-vat-id":{"type":"string","description":"X-company-vat-id"},"x-coop-eligibility":{"type":"integer","format":"int32","description":"X-coop-eligibility"},"x-coza-autorenew":{"type":"string","description":"X-coza-autorenew"},"x-coza-transfer-cost":{"type":"string","format":"decimal","description":"X-coza-transfer-cost"},"x-cz-ident-data":{"type":"string","description":"X-cz-ident-data"},"x-cz-ident-type":{"type":"string","description":"X-cz-ident-type"},"x-de-abuse-contact":{"type":"string","description":"X-de-abuse-contact"},"x-de-accept-trustee-tac":{"type":"string","enum":["0","1","2"],"description":".DE trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-de-general-request":{"type":"string","description":"X-de-general-request"},"x-de-holder-person":{"type":"integer","format":"int32","description":"X-de-holder-person"},"x-de-nsentry":{"type":"array","description":"X-DE-NSENTRY: Nsentry values used for .DE domains instead of nameservers.","items":{"type":"string","description":"X-DE-NSENTRY: Nsentry values used for .DE domains instead of nameservers."}},"x-de-verificationdeadlinebeforededelegation":{"type":"string","format":"date-time","description":"X-de-verificationdeadlinebeforededelegation"},"x-de-verificationdeadlinebeforedeletion":{"type":"string","format":"date-time","description":"X-de-verificationdeadlinebeforedeletion"},"x-dispute":{"type":"string"},"x-dk-domain-model":{"type":"string","description":"X-dk-domain-model"},"x-dk-mobile-phone":{"type":"string","description":"X-dk-mobile-phone"},"x-dk-registrant-validated":{"type":"integer","format":"int32","description":"X-dk-registrant-validated"},"x-dk-secondary-email":{"type":"string","description":"X-dk-secondary-email"},"x-dk-sole-proprietorship":{"type":"string","description":"X-dk-sole-proprietorship"},"x-dk-tac-token":{"type":"string","description":"X-dk-tac-token"},"x-dk-tac-url":{"type":"string","description":"X-dk-tac-url"},"x-dk-user-cvr":{"type":"string","description":"X-dk-user-cvr"},"x-dk-user-ean":{"type":"string","description":"X-dk-user-ean"},"x-dk-user-pnumber":{"type":"string","description":"X-dk-user-pnumber"},"x-dk-user-type":{"type":"string","description":"X-dk-user-type"},"x-dnsbe-contact-type":{"type":"string","description":"X-dnsbe-contact-type"},"x-do-idcard":{"type":"string","description":"X-do-idcard"},"x-document-status":{"type":"array","description":"X-document-status","items":{"type":"string","description":"X-document-status"}},"x-domain-comment":{"type":"string","nullable":true,"description":"Domain comment: Domain specific comment, to be reflected in QueryDomainList and FTP CSV domain list file."},"x-domain-roid":{"type":"string","description":"Registry Object ID (ROID): The Registry Object ID is an unique identifier for the domain from the registry."},"x-domainpinlock":{"type":"string","description":"X-domainpinlock"},"x-ee-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-ee-accept-trustee-tac"},"x-ee-add-trustee":{"type":"integer","format":"int32","description":"X-ee-add-trustee"},"x-ee-admin-birthday":{"type":"string","description":"X-ee-admin-birthday"},"x-ee-admin-ident":{"type":"string","description":"X-ee-admin-ident"},"x-ee-admin-tin":{"type":"string","description":"X-ee-admin-tin"},"x-ee-admin-vat":{"type":"integer","format":"int32","description":"X-ee-admin-vat"},"x-ee-owner-birthday":{"type":"string","description":"X-ee-owner-birthday"},"x-ee-owner-ident":{"type":"string","description":"X-ee-owner-ident"},"x-ee-owner-tin":{"type":"string","description":"X-ee-owner-tin"},"x-ee-tech-birthday":{"type":"string","description":"X-ee-tech-birthday"},"x-ee-tech-ident":{"type":"string","description":"X-ee-tech-ident"},"x-ee-tech-tin":{"type":"string","description":"X-ee-tech-tin"},"x-errp-email":{"type":"string","description":"X-errp-email"},"x-errp-phone":{"type":"string","description":"X-errp-phone"},"x-errp-rsp":{"type":"string","description":"X-errp-rsp"},"x-errp-tac-url":{"type":"string","description":"X-errp-tac-url"},"x-es-accept-special-tac":{"type":"integer","format":"int32","description":"X-es-accept-special-tac"},"x-es-admin-identificacion":{"type":"string","description":"Admin identification"},"x-es-admin-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Admin legal form: The legal form used for the owner contact"},"x-es-admin-tipo-identificacion":{"type":"integer","format":"int32","description":"Type of admin identification"},"x-es-autorenew":{"type":"string","description":"X-es-autorenew"},"x-es-billing-identificacion":{"type":"string","description":"Billing identification"},"x-es-billing-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Tech legal form: The legal form used for the tech contact"},"x-es-billing-tipo-identificacion":{"type":"integer","format":"int32","description":"Type of billing identification"},"x-es-identificacion":{"type":"integer","format":"int32","description":"X-es-identificacion"},"x-es-legalform":{"type":"string","description":"Legal Form"},"x-es-owner-identificacion":{"type":"string","description":"Owner identification"},"x-es-owner-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Owner legal form: The legal form used for the owner contact"},"x-es-owner-tipo-identificacion":{"type":"integer","format":"int32","description":"Type of owner identification"},"x-es-paid":{"type":"integer","format":"int32","description":"X-es-paid"},"x-es-person":{"type":"integer","format":"int32","description":"X-es-person"},"x-es-peticion":{"type":"integer","format":"int32","description":"X-es-peticion"},"x-es-reference-domain":{"type":"string","description":"X-es-reference-domain"},"x-es-registrant-identificacion":{"type":"string","description":"Registrant identification"},"x-es-registrant-tipo-identificacion":{"type":"integer","format":"int32","description":"Type of registrant identification"},"x-es-status":{"type":"string","description":"X-es-status"},"x-es-tech-identificacion":{"type":"string","description":"Tech identification number"},"x-es-tech-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Tech legal form: The legal form used for the tech contact"},"x-es-tech-tipo-identificacion":{"type":"integer","format":"int32","description":"Type of tech identification"},"x-es-tipo-identificacion":{"type":"integer","format":"int32","description":"X-es-tipo-identificacion"},"x-eu-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".EU trustee TAC: Determines, if the Key-Systems local presence service is active this domain"},"x-eu-cloned-from":{"type":"string","description":"X-eu-cloned-from"},"x-eu-contact-type":{"type":"string","description":"X-eu-contact-type"},"x-eu-deleteauthcode":{"type":"integer","format":"int32","description":"X-eu-deleteauthcode"},"x-eu-naturalperson":{"type":"integer","format":"int32","description":"X-eu-naturalperson"},"x-eu-owner":{"type":"string","description":".EU owner: Owner of the domain as seen by the registry, if this needs to be changed, a trade is required"},"x-eu-registrant-citizenship":{"type":"string","description":"X-eu-registrant-citizenship"},"x-eu-registrant-lang":{"type":"string","enum":["bg","cs","da","de","el","en","es","et","fi","fr","ga","hr","hu","it","lt","lv","mt","nl","pl","pt","ro","sk","sl","sv"],"description":".EU registrant language: Language the registry uses to communicate with the owner (registrant) of the domain"},"x-eu-requestauthcode":{"type":"integer","format":"int32","description":"X-eu-requestauthcode"},"x-eu-status":{"type":"string","nullable":true,"description":".EU special status: Comma-separated list of special status that may get returned by the registry (including onHold, quarantined, seized and suspended)"},"x-faitid-admin-birthdate":{"type":"string","format":"date","nullable":true,"description":"Admin birthdate: date of birth; mandatory for individuals"},"x-faitid-admin-city":{"type":"string","nullable":true,"description":"Admin city: Extension representing the city"},"x-faitid-admin-country":{"type":"string","nullable":true,"description":"Admin country: Extension representing the country"},"x-faitid-admin-passportinfo":{"type":"string","nullable":true,"description":"Admin passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-admin-state":{"type":"string","nullable":true,"description":"Admin state: Extension representing the state"},"x-faitid-admin-street#":{"type":"array","description":"Admin street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Admin street: Extension representing the street"}},"x-faitid-admin-street0":{"type":"string","description":"X-faitid-admin-street0"},"x-faitid-admin-tin":{"type":"string","nullable":true,"description":"Admin TIN: tax payer ID, mandatory for organizations"},"x-faitid-admin-zip":{"type":"string","nullable":true,"description":"Admin zip code: Extension representing the zip code"},"x-faitid-billing-birthdate":{"type":"string","format":"date","nullable":true,"description":"Billing birthdate: date of birth; mandatory for individuals"},"x-faitid-billing-city":{"type":"string","nullable":true,"description":"Billing city: Extension representing the city"},"x-faitid-billing-country":{"type":"string","nullable":true,"description":"Billing country: Extension representing the country"},"x-faitid-billing-passportinfo":{"type":"string","nullable":true,"description":"Billing passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-billing-state":{"type":"string","nullable":true,"description":"Billing state: Extension representing the state"},"x-faitid-billing-street#":{"type":"array","description":"Billing street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Billing street: Extension representing the street"}},"x-faitid-billing-street0":{"type":"string","description":"X-faitid-billing-street0"},"x-faitid-billing-tin":{"type":"string","nullable":true,"description":"Billing TIN: tax payer ID, mandatory for organizations"},"x-faitid-billing-zip":{"type":"string","nullable":true,"description":"Billing zip code: Extension representing the zip code"},"x-faitid-owner-birthdate":{"type":"string","format":"date","nullable":true,"description":"Owner birthdate: date of birth; mandatory for individuals"},"x-faitid-owner-city":{"type":"string","nullable":true,"description":"Owner city: Extension representing the city"},"x-faitid-owner-country":{"type":"string","nullable":true,"description":"Owner country: Extension representing the country"},"x-faitid-owner-passportinfo":{"type":"string","nullable":true,"description":"Owner passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-owner-state":{"type":"string","nullable":true,"description":"Owner state: Extension representing the state"},"x-faitid-owner-street#":{"type":"array","description":"Owner street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Owner street: Extension representing the street"}},"x-faitid-owner-street0":{"type":"string","description":"X-faitid-owner-street0"},"x-faitid-owner-tin":{"type":"string","nullable":true,"description":"Owner TIN: tax payer ID, mandatory for organizations"},"x-faitid-owner-zip":{"type":"string","nullable":true,"description":"Owner zip code: Extension representing the zip code"},"x-faitid-tech-birthdate":{"type":"string","format":"date","nullable":true,"description":"Tech birthdate: date of birth; mandatory for individuals"},"x-faitid-tech-city":{"type":"string","nullable":true,"description":"Tech city: Extension representing the city"},"x-faitid-tech-country":{"type":"string","nullable":true,"description":"Tech country: Extension representing the country"},"x-faitid-tech-passportinfo":{"type":"string","nullable":true,"description":"Tech passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-tech-state":{"type":"string","nullable":true,"description":"Tech state: Extension representing the state"},"x-faitid-tech-street#":{"type":"array","description":"Tech street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Tech street: Extension representing the street"}},"x-faitid-tech-street0":{"type":"string","description":"X-faitid-tech-street0"},"x-faitid-tech-tin":{"type":"string","nullable":true,"description":"Tech TIN: tax payer ID, mandatory for organizations"},"x-faitid-tech-zip":{"type":"string","nullable":true,"description":"Tech zip code: Extension representing the zip code"},"x-fee-amount":{"type":"string","format":"decimal","nullable":true,"description":"X-FEE-AMOUNT: The amount that will be charged."},"x-fee-application":{"type":"string","format":"decimal","nullable":true,"description":"X-FEE-APPLICATION: The non-refundable amount that will be charged."},"x-fee-class":{"type":"string","description":"X-FEE-CURRENCY: The class of the X-FEE-DOMAIN."},"x-fee-command":{"type":"string","description":"X-FEE-CURRENCY: The command for the X-FEE prices."},"x-fee-currency":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."},"x-fee-domain":{"type":"string","description":"X-FEE-CURRENCY: The domain name for the prices."},"x-fee-launchphase":{"type":"string","nullable":true,"description":"X-FEE-CURRENCY: The launchphase for the prices."},"x-fee-period":{"type":"string","description":"X-FEE-CURRENCY: The period for the prices."},"x-fee-periodtype":{"type":"string","description":"X-FEE-CURRENCY: The periodtype for the prices."},"x-fee-tier":{"type":"array","description":"X-fee-tier","items":{"type":"string","nullable":true,"description":"X-fee-tier"}},"x-feedback-selfservice":{"type":"integer","format":"int32","description":"X-feedback-selfservice"},"x-fi-birthdate":{"type":"string","format":"date","description":"X-fi-birthdate"},"x-fi-company-reg-id":{"type":"string","description":"X-fi-company-reg-id"},"x-fi-contact-type":{"type":"integer","format":"int32","description":"X-fi-contact-type"},"x-fi-non-violation-confirmation":{"type":"integer","format":"int32","description":"X-fi-non-violation-confirmation"},"x-fi-personal-id":{"type":"string","description":"X-fi-personal-id"},"x-fr-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".FR trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-fr-announce":{"type":"string","description":"X-fr-announce"},"x-fr-birthcity":{"type":"string","description":"Birthcity: Contains the contact's place of birth."},"x-fr-birthdate":{"type":"string","format":"date","description":"Birthdate: Contains the contact's date of birth."},"x-fr-birthpc":{"type":"integer","format":"int32","description":"Birthplace postcode: Contains the postcode of the place of birth (or at least the department code)."},"x-fr-birthplace":{"type":"string","description":"Birthplace country code : Contains the country code of the contact's place of birth."},"x-fr-date-association":{"type":"string","description":"X-fr-date-association"},"x-fr-date-publication-jo":{"type":"string","description":"contain the date of publication in the official gazette: The \"page\" attribute shows the page number of this announcement."},"x-fr-duns":{"type":"string","description":"X-fr-duns"},"x-fr-idstatus":{"type":"string","description":"X-fr-idstatus"},"x-fr-legal-status":{"type":"string","description":"X-fr-legal-status"},"x-fr-local":{"type":"string","description":"X-fr-local"},"x-fr-no-pre-zonecheck":{"type":"integer","format":"int32","description":"X-fr-no-pre-zonecheck"},"x-fr-numero-de-page-announce-jo":{"type":"integer","format":"int32","description":"page number of this announcement: Contains the date of publication in the official gazette (the \"announce\" attribute shows the number of the announcement, the \"page\" attribute shows the page number of this announcement)."},"x-fr-owner-key":{"type":"string"},"x-fr-real-trustee-authcode":{"type":"string","description":"X-fr-real-trustee-authcode"},"x-fr-registrant-identification-status":{"type":"string","description":"Eligibility Status of the registrant: Describes the ID Status of the registrant"},"x-fr-registrant-reachable-mail":{"type":"string","description":"Reachability Status of the registrant: Describes, if the registrant is reachable via e-mail"},"x-fr-restrict-pub":{"type":"integer","format":"int32","description":"Restrict publication: Restrict publication"},"x-fr-restrict-public":{"type":"integer","format":"int32","description":"X-fr-restrict-public"},"x-fr-siren-or-siret":{"type":"integer","format":"int32","description":"SIREN code: Contain the SIREN code."},"x-fr-ticket":{"type":"string"},"x-fr-trademark":{"type":"integer","format":"int32","description":"Trademark number: Contain a trademark number."},"x-fr-trustee-change-initiated":{"type":"integer","format":"int32","description":"X-fr-trustee-change-initiated"},"x-fr-vatid":{"type":"string","description":"VAT number: Contain the VAT number."},"x-fr-waldec":{"type":"string","description":"X-fr-waldec"},"x-fulfillment":{"type":"string","description":"X-fulfillment"},"x-gay-accept-requirements":{"type":"integer","format":"int32","description":"X-gay-accept-requirements"},"x-gd-auction-delete":{"type":"integer","format":"int32","description":"X-gd-auction-delete"},"x-gtld-owner-trustee-active":{"type":"integer","format":"int32","description":"X-gtld-owner-trustee-active"},"x-gtld-owner-trustee-service-start":{"type":"string","format":"date","description":"X-gtld-owner-trustee-service-start"},"x-hamburg-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-hamburg-accept-trustee-tac"},"x-hk-bundle-domain-name":{"type":"string","nullable":true,"description":"Bundle domain name: Bundle domain name"},"x-hk-contract-version":{"type":"string","description":"Contract Version: The contract version from HKDNR ('HKDNR latest version\n' or 'Old contract'). Important for Nameserver Modifications, because under 'Old contract' there will be invoiced a fee for those."},"x-hk-domain-category":{"type":"string","description":"Domain category: I for individual domain, O for organization domain."},"x-hk-owner-age-over-18":{"type":"string","description":"Owner/registrant age over 18: Owner/registrant age over 18"},"x-hk-owner-document-number":{"type":"string","description":"Owner document number: Owner/registrant document number."},"x-hk-owner-document-origin-country":{"type":"string","description":"Owner document origin country: Owner/registrant document origin country."},"x-hk-owner-document-type":{"type":"string","description":"Owner document type: Domain owner/registrant document type."},"x-hk-owner-other-document-type":{"type":"string","description":"Owner other document type: Owner/registrant other document type."},"x-hk-tracking-number":{"type":"string","description":"Tracking Number: The Tracking Number from HKDNR (NDN######)."},"x-hr-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-hr-accept-trustee-tac"},"x-hr-comregid":{"type":"string","description":"X-hr-comregid"},"x-hr-idcard":{"type":"string","description":"X-hr-idcard"},"x-hu-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".HU trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-hu-accept-trustee-tac-non-eu-member":{"type":"string","enum":["0","1"],"description":"Accept .HU trustee TAC (non EU member): Determines, if local presence service is to be used to register this domain"},"x-hu-idcard-or-passport-number":{"type":"string","description":"ID-card or passport number: ID-card or passport number"},"x-hu-tax-number":{"type":"string","description":"Tax number: TAX Number"},"x-hu-vat-number":{"type":"string","description":"VAT number: Value added tax (VAT) Number"},"x-id-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-id-accept-trustee-tac"},"x-idn-language":{"type":"string","description":"X-idn-language"},"x-idn-namevariant":{"type":"array","description":"IDN namevariant: Additional domain variant names for IDNs","items":{"type":"string","description":"IDN namevariant: Additional domain variant names for IDNs"}},"x-ie-applicant":{"type":"string","description":"X-ie-applicant"},"x-ie-applicant-class":{"type":"string","description":"X-ie-applicant-class"},"x-ie-contact-type":{"type":"string","description":"X-ie-contact-type"},"x-ie-cro-number":{"type":"string","description":"X-ie-cro-number"},"x-ie-domain-category":{"type":"string","description":"X-ie-domain-category"},"x-ie-language":{"type":"string","description":"X-ie-language"},"x-ie-owner-remarks":{"type":"string","description":"X-ie-owner-remarks"},"x-ie-supporting-number":{"type":"string","description":"X-ie-supporting-number"},"x-ie-ticket-id":{"type":"string","description":"X-ie-ticket-id"},"x-ie-ticket-status":{"type":"string","description":"X-ie-ticket-status"},"x-ie-validation-status":{"type":"string","description":"X-ie-validation-status"},"x-il-organization-number":{"type":"string","description":"X-il-organization-number"},"x-in-accept-special-tac":{"type":"integer","format":"int32"},"x-info-accept-special-tac":{"type":"integer","format":"int32"},"x-intended-use":{"type":"string","description":"X-intended-use"},"x-internal-errp-deletion-phase":{"type":"integer","format":"int32","description":"X-internal-errp-deletion-phase"},"x-internal-errp-dns-interruption":{"type":"integer","format":"int32","description":"X-internal-errp-dns-interruption"},"x-ipr-appdate":{"type":"string","format":"date-time"},"x-ipr-cclocality":{"type":"string"},"x-ipr-class":{"type":"integer","format":"int32"},"x-ipr-entitlement":{"type":"string"},"x-ipr-form":{"type":"string"},"x-ipr-name":{"type":"string"},"x-ipr-number":{"type":"integer","format":"int32"},"x-ipr-preverified":{"type":"string"},"x-ipr-regdate":{"type":"string","format":"date-time"},"x-ipr-type":{"type":"string"},"x-is-ownercontact-auth":{"type":"string","description":"X-is-ownercontact-auth"},"x-is-split":{"type":"integer","format":"int32","description":"X-is-split"},"x-is-validation":{"type":"integer","format":"int32","description":"X-is-validation"},"x-it-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".IT trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-it-consentforpublishing":{"type":"string","enum":["0","1"],"description":"ConsentForPublishing: Boolean value to allow the publication of contacts personal data."},"x-it-entity-type":{"type":"integer","format":"int32","description":"Registrant typology: Numeric value to identify Registrant typology.Allowed values:\n1. Italian and foreign natural persons\n2. Companies/one man companies\n3. Freelance workers/professionals\n4. non-profit organizations\n5. public organizations\n6. other subjects\n7. foreigners who match 2-6"},"x-it-entitytype":{"type":"integer","format":"int32","description":"X-it-entitytype"},"x-it-ignoreowner":{"type":"integer","format":"int32"},"x-it-pin":{"type":"string","description":"Domain name registrants Taxcode: If the requester is an Italian natural person it contains his/her Codice Fiscale. For foreigners it can contain a\ndocument number. For associations without VAT number and tax code it must\nbe equal to \"n.a.\". In all the other cases it must be equal to VAT number (in the 11\nnumbers format for Italian Nationality) or the\nnumeric Codice Fiscale."},"x-it-sect3-liability":{"type":"integer","format":"int32","description":"Accept Sect. 3 of registrar contract: This value is needed to indicate the acceptance of Section 3 in the .IT registrar contract."},"x-it-sect5-personal-data-for-registration":{"type":"integer","format":"int32","description":"Accept Sect. 5 of registrar contract: This value is needed to indicate the acceptance of Section 5 in the .IT registrar contract."},"x-it-sect6-personal-data-for-diffusion":{"type":"integer","format":"int32","description":"Accept Sect. 6 of registrar contract: This value is needed to indicate the acceptance of Section 6 in the .IT registrar contract."},"x-it-sect7-explicit-acceptance":{"type":"integer","format":"int32","description":"Accept Sect. 7 of registrar contract: This value is needed to indicate the acceptance of Section 7 in the .IT registrar contract."},"x-it-trustee-change-initiated":{"type":"integer","format":"int32","description":"X-it-trustee-change-initiated"},"x-jobs-companyurl":{"type":"string","description":"Company's website: You have to provide an existing website of the company. Best would be the same as the requested domain name but with a different tld (e.g. .COM, .NET, .ORG, ...)"},"x-jobs-hraname":{"type":"string","description":"X-jobs-hraname"},"x-jobs-industryclassification":{"type":"integer","format":"int32","description":"X-jobs-industryclassification"},"x-jobs-industrytype":{"type":"string","description":"Type of industry"},"x-kr-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".KR Trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-kr-ctfy-no":{"type":"string","description":"Certification number: Registrant certification number"},"x-kr-ctfy-type":{"type":"string","enum":["BUSINESS","BUSINESSIND","CORP","UNIQUE","SCHOOL","ETC"],"description":"Certificate type"},"x-launch-accepted-date":{"type":"string","format":"date","description":"X-launch-accepted-date"},"x-launch-expiry-date":{"type":"string","format":"date","description":"X-launch-expiry-date"},"x-launch-notice-id":{"type":"string","description":"X-launch-notice-id"},"x-law-accreditation-body":{"type":"string","description":"X-law-accreditation-body"},"x-law-accreditation-id":{"type":"string","description":"X-law-accreditation-id"},"x-law-accreditation-year":{"type":"integer","format":"int32","description":"X-law-accreditation-year"},"x-law-jurisdiction-country":{"type":"string","description":"X-law-jurisdiction-country"},"x-law-jurisdiction-province":{"type":"string","description":"X-law-jurisdiction-province"},"x-li-owner-name":{"type":"string"},"x-lotto-membership-id":{"type":"string","description":"X-lotto-membership-id"},"x-lotto-verification-code":{"type":"string","description":"X-lotto-verification-code"},"x-lt-company-number":{"type":"string","description":"X-lt-company-number"},"x-lt-registrant-id":{"type":"string","description":"X-lt-registrant-id"},"x-ltda-authorityname":{"type":"string","description":"Authority Name"},"x-ltda-licensenumber":{"type":"string","description":"License Number"},"x-lu-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".LU trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-lu-skip-dns-precheck":{"type":"integer","format":"int32","description":"X-lu-skip-dns-precheck"},"x-lv-admin-regnr":{"type":"string","description":"X-lv-admin-regnr"},"x-lv-owner-regnr":{"type":"string","description":"X-lv-owner-regnr"},"x-lv-owner-vatnr":{"type":"integer","format":"int32","description":"X-lv-owner-vatnr"},"x-lv-vatnr":{"type":"string","description":"X-lv-vatnr"},"x-mobi-sunrise-trademark-country":{"type":"string"},"x-mobi-sunrise-trademark-filing-date":{"type":"string","format":"date"},"x-mobi-sunrise-trademark-name":{"type":"string"},"x-mobi-sunrise-trademark-number":{"type":"integer","format":"int32"},"x-mobi-sunrise-trademark-registration-date":{"type":"string","format":"date"},"x-mobi-trademark-country":{"type":"string"},"x-mobi-trademark-filing-date":{"type":"string","format":"date"},"x-mobi-trademark-name":{"type":"string"},"x-mobi-trademark-number":{"type":"integer","format":"int32"},"x-mobi-trademark-registration-date":{"type":"string","format":"date"},"x-mt-vatid":{"type":"string","description":"X-mt-vatid"},"x-my-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .COM.MY trustee TAC: Determines, if the local presence service is active for this domain"},"x-my-buisness-number":{"type":"string","description":"X-my-buisness-number"},"x-my-business-number":{"type":"string","description":"X-my-business-number"},"x-my-organization-type":{"type":"string","description":"X-my-organization-type"},"x-my-per-date-of-birth":{"type":"string","description":"X-my-per-date-of-birth"},"x-my-per-identity":{"type":"string","description":"X-my-per-identity"},"x-my-race":{"type":"string","description":"X-my-race"},"x-name-consentid":{"type":"integer","format":"int32"},"x-name-emailforward":{"type":"string"},"x-name-noemail":{"type":"integer","format":"int32"},"x-ngo-verification-link":{"type":"string","description":"X-ngo-verification-link"},"x-ngo-verification-until":{"type":"string","format":"date-time","description":"X-ngo-verification-until"},"x-nicse-contractnumber":{"type":"string"},"x-nicse-idnumber":{"type":"string","description":"X-nicse-idnumber"},"x-nicse-password":{"type":"string"},"x-nicse-passwordexpiration":{"type":"string","format":"date"},"x-nicse-typeofname":{"type":"string"},"x-nicse-vatid":{"type":"string","description":"VAT number: VAT number."},"x-nl-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".NL trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-nl-legalform":{"type":"string","enum":["ANDERS","BGG","BRO","BV","BVI/O","COOP","CV","EENMANSZAAK","EESV","KERK","MAATSCHAP","NV","OWM","PERSOON","REDR","STICHTING","VERENIGING","VOF"],"description":"Legal form: The legal form used for the contacts"},"x-nl-legalformregno":{"type":"string","nullable":true,"description":"Legal form registration number: Legal form registration number"},"x-no-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .NO trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-no-org-contact":{"type":"string","description":"X-no-org-contact"},"x-no-organization-number":{"type":"string","description":"X-no-organization-number"},"x-no-person-identifier":{"type":"string","description":"X-no-person-identifier"},"x-nu-force-trade":{"type":"integer","format":"int32","description":"X-nu-force-trade"},"x-nu-iis-idno":{"type":"string","nullable":true,"description":"ID number: ID number."},"x-nu-iis-vatno":{"type":"string","nullable":true,"description":"Vatnumber: VAT number."},"x-nu-owner-name":{"type":"string"},"x-nu-owner-organization":{"type":"string","description":"X-nu-owner-organization"},"x-nyc-extcontact":{"type":"string","description":"X-nyc-extcontact"},"x-nz-privacy":{"type":"string","description":"Domain WHOIS privacy setting"},"x-old-ns#":{"type":"array","items":{"type":"string"}},"x-orat-owner-name":{"type":"string"},"x-orat-owner-organization":{"type":"string"},"x-orderid":{"type":"integer","format":"int32","description":"X-orderid"},"x-organic-verification-link":{"type":"string","description":".ORGANIC Verification Link: Verification Link for .ORGANIC Registrations"},"x-owner-birthdate":{"type":"string","format":"date","nullable":true,"description":"Owner contact date of birth: Date of birth of the owner contact in the format YYYY-MM-DD"},"x-ownerchange-autoapprove":{"type":"string","description":"X-OWNERCHANGE-AUTOAPPROVE"},"x-personal-id":{"type":"string","description":"X-personal-id"},"x-pl-consentforpublishing":{"type":"string","nullable":true,"enum":["0","1"],"description":"Consent For Publishing: Boolean value to allow the publication of contacts personal data."},"x-prevent-tor":{"type":"integer","format":"int32","description":"X-prevent-tor"},"x-pro-authority":{"type":"string","description":"X-pro-authority"},"x-pro-authority-website":{"type":"string","description":"X-pro-authority-website"},"x-pro-av-license-authority":{"type":"string","description":"X-pro-av-license-authority"},"x-pro-av-license-authority-website":{"type":"string","description":"X-pro-av-license-authority-website"},"x-pro-av-license-holder-birthdate":{"type":"string","format":"date","description":"X-pro-av-license-holder-birthdate"},"x-pro-av-license-iso-countrycode":{"type":"string","description":"X-pro-av-license-iso-countrycode"},"x-pro-av-license-issue-date":{"type":"string","format":"date","description":"X-pro-av-license-issue-date"},"x-pro-av-license-number":{"type":"string","description":"X-pro-av-license-number"},"x-pro-av-professiontype":{"type":"string","description":"X-pro-av-professiontype"},"x-pro-license-number":{"type":"string","description":"X-pro-license-number"},"x-pro-profession":{"type":"string","description":"X-pro-profession"},"x-promotion-code":{"type":"string","description":"Promotion code: Promotion - parameter used to get the promotion - pricing (if available)"},"x-pt-autorenew":{"type":"string","enum":["0","1"],"description":"Autorenew the domain if present: The registrar wants the domain to be auto renewed for 1 year when it comes to the expiration date."},"x-pt-brand-date":{"type":"string","description":"X-pt-brand-date"},"x-pt-brand-number":{"type":"string","description":"X-pt-brand-number"},"x-pt-brand-way-registry":{"type":"string","description":"X-pt-brand-way-registry"},"x-pt-identification":{"type":"string","description":"X-pt-identification"},"x-pt-legitimacy":{"type":"string","description":"Registrant legal types: Registrant legal types indicates the legitimacy on registering this domain."},"x-pt-owner-id":{"type":"string","description":"PT Registrant ID: The current registrant contact id"},"x-pt-owner-identification":{"type":"string","description":"Owner contact Fiscal Identification Number: Contains the owner contact Fiscal Identification Number."},"x-pt-owner-mobile":{"type":"string","description":"Mobile number (Owner): Contains the mobile number of the owner contact."},"x-pt-owner-visible":{"type":"integer","format":"int32","description":"X-pt-owner-visible"},"x-pt-registration-basis":{"type":"string","description":"Registrant registration basis: Registrant registration basis"},"x-pt-tech-identification":{"type":"string","description":"Tech contact Fiscal Identification Number: Contains the tech contact Fiscal Identification Number."},"x-pt-tech-mobile":{"type":"string","description":"Mobile number (Tech): Contains the mobile number of the tech contact."},"x-pw-application-contact-email-address":{"type":"string","description":"X-pw-application-contact-email-address"},"x-pw-application-contact-person":{"type":"string","description":"X-pw-application-contact-person"},"x-pw-application-contact-telephone-number":{"type":"string","description":"X-pw-application-contact-telephone-number"},"x-pw-rights-owner-city":{"type":"string","description":"X-pw-rights-owner-city"},"x-pw-rights-owner-country":{"type":"string","description":"X-pw-rights-owner-country"},"x-pw-rights-owner-name":{"type":"string","description":"X-pw-rights-owner-name"},"x-pw-rights-owner-postal-code":{"type":"integer","format":"int32","description":"X-pw-rights-owner-postal-code"},"x-pw-rights-owner-state":{"type":"string","description":"X-pw-rights-owner-state"},"x-pw-rights-owner-street":{"type":"string","description":"X-pw-rights-owner-street"},"x-qa-eligibility-id":{"type":"string","description":"Registrant Eligibility ID: The ID number associated with the registrant's eligibility type."},"x-qa-eligibility-type":{"type":"string","description":"Registrant Eligibility Type: The type that makes the registrant eligible to register this domain name."},"x-qa-registrant-name":{"type":"string","description":"Registrant Name: English readable version of the registrant's name."},"x-real-submit":{"type":"integer","format":"int32","description":"X-real-submit"},"x-record-mx#":{"type":"array","description":"MX - record: The MX - records of this domain","items":{"type":"string","description":"MX - record: The MX - records of this domain"}},"x-reference-url":{"type":"string","description":"X-reference-url"},"x-registrant-language":{"type":"string","description":"X-registrant-language"},"x-registry-lock":{"type":"string","nullable":true,"enum":["0","1"],"description":"Registry Lock: Verisign Registry Lock Service"},"x-registry-status":{"type":"array","description":"Registry Status: Status of the domain at the Registry","items":{"type":"string","description":"Registry Status: Status of the domain at the Registry"}},"x-ro-company-number":{"type":"string","description":"X-ro-company-number"},"x-ro-idcard-or-passport-number":{"type":"string","description":"X-ro-idcard-or-passport-number"},"x-ro-trade-token":{"type":"string","description":"X-ro-trade-token"},"x-ro-vat-number":{"type":"integer","format":"int32","description":"VAT number: Value added tax (VAT) Number"},"x-rrpcctld-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".RRPCCTLD trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-rrpcctld-real-owner":{"type":"string","description":".RRPCCTLD real owner: The real owner contact, when the local presence service is activated"},"x-rrpcctld-real-tech":{"type":"string","description":".RRPCCTLD real tech: The real tech contact, when the local presence service is activated"},"x-rrpgtld-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".RRPGTLD trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-rrpgtld-real-owner":{"type":"string","description":".RRPGTLD real owner: The real owner contact, when the local presence service is activated"},"x-rrpgtld-real-tech":{"type":"string","description":".RRPGTLD real tech: The real tech contact, when the local presence service is activated"},"x-rs-admin-company-number":{"type":"string","description":"X-rs-admin-company-number"},"x-rs-admin-idcard":{"type":"string","description":"X-rs-admin-idcard"},"x-rs-company-number":{"type":"integer","format":"int32","description":"X-rs-company-number"},"x-rs-owner-company-number":{"type":"string","description":"X-rs-owner-company-number"},"x-rs-owner-idcard":{"type":"string","description":"X-rs-owner-idcard"},"x-rs-tech-company-number":{"type":"string","description":"X-rs-tech-company-number"},"x-rs-tech-idcard":{"type":"string","description":"X-rs-tech-idcard"},"x-rs-vat":{"type":"string","description":"X-rs-vat"},"x-ru-birthdate":{"type":"string","description":"Customer-s birth date: Customer's birth date in the format DD.MM.YYYY (figures)."},"x-ru-code":{"type":"string","description":"TIN taxpayers identification number: TIN (taxpayers identification number) of the Customers organization. This field must contain a ten digit number (the last figure is a control figure)\nRequired for organizations incorporated in the Russian Federation."},"x-ru-contract":{"type":"string","description":"RU Contract ID: Displays the contract number at the registry."},"x-ru-firstname":{"type":"string","description":"X-ru-firstname"},"x-ru-kpp":{"type":"integer","format":"int32","description":"The reason code  for the Customers organization registering: The reason code  for the Customers organization registering. This field must contain a nine digit number.\nRequired for organizations incorporated in the Russian Federation."},"x-ru-lastname":{"type":"string","description":"X-ru-lastname"},"x-ru-middlename":{"type":"string","description":"X-ru-middlename"},"x-ru-organization":{"type":"string","description":"X-ru-organization"},"x-ru-passportdata":{"type":"string","description":"X-ru-passportdata"},"x-ruhr-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-ruhr-accept-trustee-tac"},"x-se-client-delete":{"type":"integer","format":"int32"},"x-se-disclose-email":{"type":"integer","format":"int32","description":"Disclose email: Disclose email."},"x-se-disclose-fax":{"type":"integer","format":"int32","description":"Disclose fax: Disclose fax."},"x-se-disclose-voice":{"type":"integer","format":"int32","description":"Disclose voice: Disclose voice."},"x-se-force-trade":{"type":"integer","format":"int32","description":"X-se-force-trade"},"x-sg-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".SG trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-sg-account-transfer-authcode":{"type":"string","description":".SG Account (IPMIRROR) transfer auth code"},"x-sg-admin-singpassid":{"type":"string","nullable":true,"description":"Singpass ID of individual admin: The contact identity card (SingPass ID) for an individual local presence in Singapore (Format: S1234567D)"},"x-sg-domainholdtype":{"type":"integer","format":"int32","description":"X-sg-domainholdtype"},"x-sg-rcbid":{"type":"string","description":".SG RCBID"},"x-sg-sunrise-fax-sentto":{"type":"string","description":"X-sg-sunrise-fax-sentto"},"x-sg-transfer-out-code":{"type":"string","nullable":true,"description":"Code for transfer out"},"x-sg-transfer-out-code-exp-date":{"type":"string","nullable":true,"description":"Expiration date for transfer out code"},"x-sg-trustee-tag":{"type":"integer","format":"int32","description":"X-sg-trustee-tag"},"x-sg-verification-status":{"type":"string","nullable":true,"description":"Verification status"},"x-si-verification-action-date":{"type":"string","format":"date-time","description":"X-si-verification-action-date"},"x-si-verification-status":{"type":"string","description":"X-si-verification-status"},"x-sk-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":"Accept .SK trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-sk-company-number":{"type":"string","description":"X-sk-company-number"},"x-sk-contact-ident-number":{"type":"string","description":"X-sk-contact-ident-number"},"x-sk-contact-legal-form":{"type":"string","description":"X-sk-contact-legal-form"},"x-sk-idcard-or-passport-number":{"type":"integer","format":"int32","description":"X-sk-idcard-or-passport-number"},"x-sk-legal-form":{"type":"string","description":"X-sk-legal-form"},"x-so-pvrc":{"type":"string","description":"X-so-pvrc"},"x-so-tm-entitlement":{"type":"string","description":"X-so-tm-entitlement"},"x-so-tm-locality":{"type":"string","description":"X-so-tm-locality"},"x-so-tm-name":{"type":"string","description":"X-so-tm-name"},"x-so-tm-number":{"type":"integer","format":"int32","description":"X-so-tm-number"},"x-srl-authorityname":{"type":"string","description":"Authority Name"},"x-srl-licensenumber":{"type":"string","description":"License Number"},"x-swiss-owner-type":{"type":"string","description":"X-swiss-owner-type"},"x-swiss-uid":{"type":"string","description":"X-swiss-uid"},"x-symantec-auth-status":{"type":"string","description":"X-symantec-auth-status"},"x-symantec-expiration-date":{"type":"string","format":"date-time","description":"X-symantec-expiration-date"},"x-symantec-order-id":{"type":"string","description":"X-symantec-order-id"},"x-symantec-order-status":{"type":"string","description":"X-symantec-order-status"},"x-tatar-admin":{"type":"string","description":"Admin International: The required international admin contact"},"x-tatar-admin-birthday":{"type":"string","description":"Admin Birthday: Birthday of the Admin contact"},"x-tatar-admin-pass":{"type":"string","description":"Admin Pass Validity: The validity date of the pass of the admin contact"},"x-tatar-admin-tin":{"type":"string","description":"Admin Organisation Nr: International TIN/VAT for the admin contact"},"x-tatar-billing":{"type":"string","description":"Billing International: The required international billing contact"},"x-tatar-billing-birthday":{"type":"string","description":"Billing Birthday: Birthday of the Billing contact"},"x-tatar-billing-pass":{"type":"string","description":"Billing Pass Validity: The validity date of the pass of the billing contact"},"x-tatar-billing-tin":{"type":"string","description":"Billing Organisation Nr: International TIN/VAT for the billing contact"},"x-tatar-domain-description":{"type":"string","description":"Domain Description: Domain Description"},"x-tatar-owner":{"type":"string","description":"Owner International: The required international owner contact"},"x-tatar-owner-birthday":{"type":"string","description":"Owner Birthday: Birthday of the Owner contact"},"x-tatar-owner-pass":{"type":"string","description":"Owner Pass Validity: The validity date of the pass of the owner contact"},"x-tatar-owner-tin":{"type":"string","description":"Owner Organisation Nr: International TIN/VAT for the owner contact"},"x-tatar-tech":{"type":"string","description":"Tech International: The required international tech contact"},"x-tatar-tech-birthday":{"type":"string","description":"Tech Birthday: Birthday of the Tech contact"},"x-tatar-tech-pass":{"type":"string","description":"Tech Pass Validity: The validity date of the pass of the tech contact"},"x-tatar-tech-tin":{"type":"string","description":"Tech Organisation Nr: International TIN/VAT for the tech contact"},"x-tel-new-username":{"type":"string","description":"X-tel-new-username"},"x-tel-password":{"type":"string","description":"CTH - password: Password needed to login to the \"Community TEL Hosting\""},"x-tel-publish-whois":{"type":"integer","format":"int32","description":"Publish whois: Show private details in the whois, only available for private persons"},"x-tel-username":{"type":"string","description":"CTH - username: Username needed to login to the \"Community TEL Hosting\""},"x-tel-whois-phone":{"type":"string","description":"Reseller phone: The phone number of the reseller"},"x-tel-whoistype":{"type":"string","enum":["Natural","Legal"],"description":"Registrant - type: Defines what type of user the registrant is"},"x-time-to-suspension":{"type":"string","format":"date-time","description":"Time to suspension date"},"x-tr-citid":{"type":"string","description":"X-tr-citid"},"x-tr-comregid":{"type":"string","description":"X-tr-comregid"},"x-tr-taxnumber":{"type":"string","description":"X-tr-taxnumber"},"x-tr-taxoffice":{"type":"string","description":"X-tr-taxoffice"},"x-tr-tmid":{"type":"string","description":"X-tr-tmid"},"x-trademark-entitlement":{"type":"string","description":"X-trademark-entitlement"},"x-trademark-locality":{"type":"string","description":"X-trademark-locality"},"x-trademark-name":{"type":"string","description":"X-trademark-name"},"x-trademark-number":{"type":"integer","format":"int32","description":"X-trademark-number"},"x-trademark-pvrc":{"type":"string","description":"X-trademark-pvrc"},"x-trademark-reg-date":{"type":"string","description":"X-trademark-reg-date"},"x-trademark-right-type":{"type":"string","description":"X-trademark-right-type"},"x-transfer-until":{"type":"string","format":"date-time","description":"X-transfer-until"},"x-transferid":{"type":"integer","format":"int32","description":"X-transferid"},"x-transferlock-until":{"type":"string","format":"date-time","description":"Transferlock until: The domain is locked for transfer until this date"},"x-travel-industry":{"type":"string","description":"X-travel-industry"},"x-travel-uin":{"type":"integer","format":"int32","description":"X-travel-uin"},"x-trustee-comment":{"type":"string"},"x-tw-company-number":{"type":"string","description":"X-tw-company-number"},"x-ua-tm-date":{"type":"string","format":"date","description":"X-ua-tm-date"},"x-ua-tm-number":{"type":"string","description":"X-ua-tm-number"},"x-uk-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-uk-accept-trustee-tac"},"x-uk-owner-corporate-number":{"type":"string","description":"X-uk-owner-corporate-number"},"x-uk-owner-corporate-type":{"type":"string","description":"X-uk-owner-corporate-type"},"x-uk-trading-name":{"type":"string","description":"X-uk-trading-name"},"x-unitedtld-regulatory-data":{"type":"string","description":"X-unitedtld-regulatory-data"},"x-us-accept-special-tac":{"type":"integer","format":"int32"},"x-us-nexus-apppurpose":{"type":"string","enum":["P1","P2","P3","P4","P5"],"description":"Application purpose: Purpose of the application"},"x-us-nexus-category":{"type":"string","enum":["C11","C12","C21","C31","C32"],"description":"US-NEXUS category: Categorization of the entity requesting the application"},"x-us-nexus-validator":{"type":"string","description":"US-NEXUS validator country: Specify the two-letter country-code of the registrant (if Nexus Category is either C31 or C32)"},"x-useproxy":{"type":"integer","format":"int32","description":"X-useproxy"},"x-validation-code":{"type":"string","description":"Validation code: Response Code of the additional Validation"},"x-validation-description":{"type":"string","description":"Validation description: Response of the additional Validation"},"x-verification":{"type":"string","format":"date-time","description":"X-verification"},"x-vn-owner-birthday":{"type":"string","format":"date","description":"X-vn-owner-birthday"},"x-vn-owner-identificacion":{"type":"string","description":"X-vn-owner-identificacion"},"x-vn-owner-identification":{"type":"string","description":"X-vn-owner-identification"},"x-wdrp-rsp":{"type":"string","description":"X-wdrp-rsp"},"x-whoiprivacy":{"type":"integer","format":"int32","description":"X-whoiprivacy"},"x-whois-banner#":{"type":"array","description":"Whois banner: A freetext - line in the whois","items":{"type":"string","description":"Whois banner: A freetext - line in the whois"}},"x-whois-privacy":{"type":"string","description":"Whois proxy: Privacy service to hide ownerdata in whois"},"x-whois-rsp":{"type":"string","description":"RSP tag: The company, responsible for managing this domain"},"x-whois-url":{"type":"string","description":"URL: The website - URL of the responsible reseller"},"x-whoisprivacy":{"type":"integer","format":"int32","description":"WHOIS privacy: WHOIS privacy"},"x-xxx-community-id":{"type":"string","description":"X-xxx-community-id"},"x-xxx-defensive":{"type":"integer","format":"int32","description":"X-xxx-defensive"},"x-xxx-ipr-cc":{"type":"string","description":"X-xxx-ipr-cc"},"x-xxx-ipr-entitlement":{"type":"string","description":"X-xxx-ipr-entitlement"},"x-xxx-ipr-name":{"type":"string","description":"X-xxx-ipr-name"},"x-xxx-ipr-number":{"type":"string","description":"X-xxx-ipr-number"},"x-xxx-ipr-reg-date":{"type":"string","format":"date","description":"X-xxx-ipr-reg-date"},"x-za-voting-accepted":{"type":"integer","format":"int32","description":"X-za-voting-accepted"},"x-zacr-autorenew":{"type":"string","description":"X-zacr-autorenew"},"x-zuerich-agreement":{"type":"integer","format":"int32","description":"X-zuerich-agreement"},"x-zuerich-uid":{"type":"string","description":"X-zuerich-uid"},"zone":{"type":"string","description":"Zone: Zone (TLD) of the domain"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusDomain"},"patch":{"operationId":"modifyDomain","summary":"XRRP command ModifyDomain (modifyDomain)","description":"This command allows you to modify the contact data of the domain or the nameservers. It also allows you to set or remove a transfer lock or other special parameters associated with the domain.\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"Domain: The domain to be created","schema":{"type":"string","description":"Domain: The domain to be created"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accept-trade":{"type":"string","enum":["0","1"],"description":"Accept trade"},"addadmincontact":{"type":"array","items":{"type":"string"}},"addbillingcontact":{"type":"array","items":{"type":"string"}},"adddnssec":{"type":"array","description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e","items":{"type":"string","description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e"}},"adddnssecdsdata":{"type":"array","items":{"type":"string","nullable":true}},"adddomaintag":{"type":"array","description":"Domain Tag: The domains tags that will be added to the domain.","items":{"type":"string","nullable":true,"description":"Domain Tag: The domains tags that will be added to the domain."}},"addnameserver":{"type":"array","items":{"type":"string"}},"addownercontact0":{"type":"string"},"addstatus":{"type":"array","items":{"type":"string"}},"addtechcontact":{"type":"array","items":{"type":"string"}},"admincontact":{"type":"array","description":"Admin contact: Contact handle of the administrative contact of the domain, also referred to as 'Admin-C'. The administrator is authorized by the registrant to make administrative decisions over the domain name and serves as secondary contact for the domain. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set.","items":{"type":"string","nullable":true,"description":"Admin contact: Contact handle of the administrative contact of the domain, also referred to as 'Admin-C'. The administrator is authorized by the registrant to make administrative decisions over the domain name and serves as secondary contact for the domain. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set."}},"auth":{"type":"string","nullable":true,"description":"Authentication code: The authorization code to be set for the domain (not supported by all registries)"},"billingcontact":{"type":"array","description":"Billing contact: Contact handle of the billing contact of the domain, also referred to as 'Billing-C'. The billing contact is the person or organisation who will usually be contacted by the registry with issues regarding the billing of the domain unless a registry-registrar model is followed. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set.","items":{"type":"string","nullable":true,"description":"Billing contact: Contact handle of the billing contact of the domain, also referred to as 'Billing-C'. The billing contact is the person or organisation who will usually be contacted by the registry with issues regarding the billing of the domain unless a registry-registrar model is followed. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set."}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"deladmincontact":{"type":"array","items":{"type":"string"}},"delbillingcontact":{"type":"array","items":{"type":"string"}},"deldnssec":{"type":"array","description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e","items":{"type":"string","description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e"}},"deldnssecdsdata":{"type":"array","items":{"type":"string","nullable":true}},"deldomaintag":{"type":"array","description":"Domain Tag: The domain tags that will be deleted from the domain.","items":{"type":"string","nullable":true,"description":"Domain Tag: The domain tags that will be deleted from the domain."}},"delnameserver":{"type":"array","items":{"type":"string"}},"delownercontact0":{"type":"string"},"delstatus":{"type":"array","description":"Remove Status","items":{"type":"string","description":"Remove Status"}},"deltechcontact":{"type":"array","items":{"type":"string"}},"dnssec":{"type":"array","description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e","items":{"type":"string","nullable":true,"description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e"}},"dnssecdelall":{"type":"string","enum":["0","1"],"description":"Remove all keys"},"dnssecdsdata":{"type":"array","description":"DSDATA: Syntax: \u003ckeytag\u003e \u003calgorithm\u003e \u003cdigestType\u003e \u003cdigest\u003e","items":{"type":"string","nullable":true,"description":"DSDATA: Syntax: \u003ckeytag\u003e \u003calgorithm\u003e \u003cdigestType\u003e \u003cdigest\u003e"}},"domaintag":{"type":"array","description":"Domain Tag: The domain tags that will be associated with this domain.","items":{"type":"string","nullable":true,"description":"Domain Tag: The domain tags that will be associated with this domain."}},"jobqueue":{"type":"string","nullable":true,"enum":["0","1"],"description":"Queue the command and process it in non-real time"},"nameserver":{"type":"array","description":"Nameserver: First nameserver to be used for this domain","items":{"type":"string","nullable":true,"description":"Nameserver: First nameserver to be used for this domain"}},"ownercontact0":{"type":"string","description":"Owner contact: Contact handle of the domain owner, also referred to as 'Owner-C', domain holder or registrant. The registrant is responsible for nominating the administrative, technical and billing contacts and the contractual partner of the respective registry as well as the legally responsible party for the use of the domain name. Certain parts of the contact information will appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set."},"period":{"type":"integer","format":"int32","nullable":true,"description":"Trade period: Renewal period for the trade."},"renewalmode":{"type":"string","nullable":true,"enum":["DEFAULT","AUTORENEW","AUTOEXPIRE","AUTODELETE","RENEWONCE","RENEWONCETHENAUTODELETE","RENEWONCETHENAUTOEXPIRE","EXPIREAUCTION"],"description":"Renewalmode: The domains mode for renewals"},"status":{"type":"array","description":"Status: Submit a new domain status or delete an existing one.","items":{"type":"string","nullable":true,"enum":["registrar-lock","registrar-hold","clientTransferProhibited","clientRenewProhibited","clientDeleteProhibited","clientUpdateProhibited","clientHold"],"description":"Status: Submit a new domain status or delete an existing one."}},"techcontact":{"type":"array","description":"Tech contact: Contact handle of the technical contact of the domain, also referred to as 'Tech-C'. The technical contact is usually the individual responsible for the website using the domain name e.g. the webmaster. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set.","items":{"type":"string","nullable":true,"description":"Tech contact: Contact handle of the technical contact of the domain, also referred to as 'Tech-C'. The technical contact is usually the individual responsible for the website using the domain name e.g. the webmaster. Certain parts of the contact information appear in the WHOIS database of most registries. Contact handles may be managed separately via the contact admin or the corresponding API command set."}},"token":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."},"transferlock":{"type":"string","enum":["0","1"],"description":"Determines if the domain is allowed for transfers (not supported by all registries)"},"transfermode":{"type":"string","nullable":true,"enum":["DEFAULT","AUTOAPPROVE","AUTODENY"],"description":"Transfermode: The domains mode for transfers"},"triggerda":{"type":"string","nullable":true,"enum":["1"],"description":"Trigger DA: Forces ICANN ownerchange designated agent mode if change is material and OWNERCHANGE-MODE is set to FOA. Needs activation through registrar settings."},"triggerfoa":{"type":"string","nullable":true,"enum":["1"],"description":"Trigger FOA: Forces ICANN ownerchange FOA if change is material and OWNERCHANGE-MODE is set to DESIGNATED_AGENT."},"x-accept-nschange":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept fees for nameserver changes: Accepts the additional fees for nameserver changes. If zone .hk there will be charges only if contract version is 'Old contract'."},"x-ae-eligibility-id-type":{"type":"string","nullable":true,"description":"Registrant Eligibility ID Type: The identification type used for the registrant eligibility name, in case the legal name differs from the registrant's name."},"x-ae-eligibility-name":{"type":"string","nullable":true,"description":"Registrant Eligibility Name: The eligibility name in case the legal name differs from the registrant's name"},"x-ae-eligibility-type":{"type":"string","nullable":true,"enum":["TradeLicense","FreeTradeLicense","Trademark","FreezoneTrademark","TradeLicenseIT","FreezoneTradeLicenseIT","TrademarkIT","FreezoneTrademarkIT","Legacy","LegacyApproved","Citizen","PermanentResident","SportingOrganisation","CharitableOrganisation","ReligiousOrganisation","University","TechnicalCollege","School","Academy","GovernmentApproved"],"description":"Registrant Eligibility Type: Specify what makes the registrant eligible to register the domain name."},"x-ae-explanation":{"type":"string","nullable":true,"description":"Update Explanation: The explanation as to the purpose of the update, for example a correction of a spelling mistake"},"x-ae-policy-reason":{"type":"string","nullable":true,"enum":["1","2","3","4","5","6","7","8","9"],"description":"Policy Reason: The appropriate policy reason number"},"x-ae-registrant-id-type":{"type":"string","nullable":true,"enum":["TradeLicense"],"description":"Registrant ID Type: The identification type of the registrant."},"x-ae-registrant-name":{"type":"string","nullable":true,"description":"Registrant Name: Registrant's name; This element MUST contain an english readable string for the Registrants name."},"x-aero-ens-auth-id":{"type":"string","description":"ENS auth ID: The .AERO ID which can be applied for at http://www.information.aero"},"x-aero-ens-auth-key":{"type":"string","description":"ENS auth key: The respective password to the .AERO ID"},"x-amsterdam-legalform":{"type":"string","nullable":true,"enum":["ANDERS","BGG","BRO","BV","BVI/O","COOP","CV","EENMANSZAAK","EESV","KERK","MAATSCHAP","NV","OWM","PERSOON","REDR","STICHTING","VERENIGING","VOF"],"description":"Legal form: The legal form used for the contacts"},"x-amsterdam-legalformregno":{"type":"string","nullable":true,"description":"Legal form registration number"},"x-au-data-correction":{"type":"string","nullable":true,"enum":["0","1"],"description":"Perform Data Correction: Confirm that with this modification, extention data will be updated only to perform a correction"},"x-au-domain-idnumber":{"type":"string","nullable":true,"description":"Identification number: Specify the identification number as appropriate"},"x-au-domain-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA","PRIVATE"],"description":"Identification type: This is the identification type of the registrant.  Specify 'ABN', 'ACN', or 'OTHER'. 'OTHER' refers to ARBN or Inc Association Number"},"x-au-domain-relation":{"type":"string","nullable":true,"enum":["1","2"],"description":"Eligibility type relationship: This indicates the relationship between the Eligibility Type (e.g. business name) and domain name"},"x-au-domain-relationtype":{"type":"string","enum":["IncorporatedAssociation","NonProfitOrganisation","Charity","TradeUnion","IndustryBody","PoliticalParty","religiouschurchgroup","GovernmentSchool","IndigenousCorporation","RegisteredOrganisation","Trust","CommonwealthEntity","StatutoryBody","CompanyLimitedByGuarantee","NonDistributingCooperative","NonTradingCooperative","CharitableTrust","PublicPrivateAncillaryFund","governmentbody","foreignembassyorconsulate"],"description":"Eligibility type: Specify what makes the registrant eligible to register the domain name"},"x-au-eligibility-idnumber":{"type":"string","nullable":true,"description":"Identification number for the Eligibility: Specify the identification number as appropriate"},"x-au-eligibility-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA","CRICOS"],"description":"Identification type (optional, for trade marks): This is the identification type of the elibibility."},"x-au-eligibility-name":{"type":"string","nullable":true,"description":"Eligibility Name: The Eligibility name"},"x-au-id-warranty":{"type":"string","enum":["1","0"],"description":"The Applicant is an Australian Citizen or Resident: The Registrant of an .id.au Domain must warrant that they are an Australian Resident or Citizen"},"x-au-owner-organization":{"type":"string","nullable":true,"description":"Owner Organization or Name: The Organization name"},"x-auction":{"type":"string","nullable":true,"enum":["0"],"description":"Remove Auction: Removes auction mode from a domain in the first five days of the auction lifecylce when X-AUCTION is set to 1. To remove the domain from auction enter 0 here."},"x-bayern-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BAYERN trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-be-contact-lang":{"type":"string","nullable":true,"enum":["en","fr","nl"],"description":"Contact language: Language the owner wishes to communicate with the registry (Default = en)"},"x-be-requestauthcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Request Authcode: Request a new authentication code (Setting this to 1 will not initiate the trade but needs to be given with ACCEPT-TRADE)"},"x-berlin-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BERLIN trustee TAC: determine if the local presence service is to be used to register this domain"},"x-bg-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BG trustee TAC: Accept Trustees Assistance Corporation (TAC)"},"x-bg-applicationdate":{"type":"string","nullable":true,"description":"Registry's application date of domain registration in format yyyy-mm-dd"},"x-bg-applicationno":{"type":"string","nullable":true,"description":"Registry's application no. of the domain registration"},"x-bg-comregid":{"type":"string","nullable":true,"description":"VAT ID or tax no. of Legal entity"},"x-bg-idcard":{"type":"string","nullable":true,"description":"ID Card Number of the representative person"},"x-br-register-number":{"type":"string","nullable":true,"description":"Brazil Tax Payer ID: Brazil Tax Payer ID of domain owner (only used for an ownerchange)."},"x-ca-disclose":{"type":"string","nullable":true,"enum":["0","1"],"description":"Disclose contact data in WHOIS"},"x-ca-legal-type":{"type":"string","enum":["ABO","ASS","CCO","CCT","EDU","GOV","HOP","INB","LAM","LGR","MAJ","OMK","PLT","PRT","RES","TDM","TRD","TRS"],"description":"Registrant legal types"},"x-ca-trademark":{"type":"string","nullable":true,"enum":["0","1"],"description":"Is a registered trademark: Describes if the domain is a registered trademark or not."},"x-challenge-answer":{"type":"array","description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains","items":{"type":"string","nullable":true,"description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains"}},"x-challenge-question":{"type":"array","description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains","items":{"type":"string","nullable":true,"description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains"}},"x-cn-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .CN trustee TAC: Determines, if the local presence service is to be used to modify this domain"},"x-cn-owner-id-number":{"type":"string","nullable":true,"description":"Owner ID Number: ID number"},"x-cn-owner-id-type":{"type":"string","nullable":true,"enum":["SFZ","HZ","GAJMTX","TWJMTX","WJLSFZ","GAJZZ","TWJZZ","JGZ","QT","ORG","YYZZ","TYDM","BDDM","JDDWFW","SYDWFR","WGCZJG","SHTTFR","ZJCS","MBFQY","JJHFR","LSZY","WGZHWH","WLCZJG","SFJD","JWJG","SHFWJG","MBXXBX","YLJGZY","GZJGZY","BJWSXX","QTTYDM"],"description":"Owner identity type: Identity type of the ID card"},"x-cn-owner-type":{"type":"string","nullable":true,"enum":["I","E"],"description":"Owner type: Identity type owner"},"x-cnnic-owner-id-code":{"type":"string","nullable":true,"description":"Owner identity code: Identity code of the ID card"},"x-cnnic-owner-id-type":{"type":"string","nullable":true,"enum":["SFZ","HZ","GAJMTX","TWJMTX","WJLSFZ","GAJZZ","TWJZZ","JGZ","QT","ORG","YYZZ","TYDM","BDDM","JDDWFW","SYDWFR","WGCZJG","SHTTFR","ZJCS","MBFQY","JJHFR","LSZY","WGZHWH","WLCZJG","SFJD","JWJG","SHFWJG","MBXXBX","YLJGZY","GZJGZY","BJWSXX","QTTYDM","GATJZZ","ZZJGDMZ"],"description":"Owner identity type: Identity type of the ID card"},"x-company-vat-id":{"type":"string","nullable":true,"description":"Company V.A.T. ID"},"x-cr-date-of-birth":{"type":"string","nullable":true,"description":"Date of birth: Date of birth"},"x-cz-ident-data":{"type":"string","nullable":true,"description":"Identification data: Identification data"},"x-cz-ident-type":{"type":"string","nullable":true,"enum":["op","passport","mpsv","ico","birthday"],"description":"Identification Type: The identification type used for the domain registrant"},"x-de-abuse-contact":{"type":"string","nullable":true,"description":"Abuse Contact: URI Contact for abuse contact that will be shown on DENIC whois"},"x-de-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1","2"],"description":"Accept .DE trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-de-general-request":{"type":"string","nullable":true,"description":"General Request: URI Contact for general requests that will be shown on DENIC whois"},"x-de-holder-person":{"type":"string","nullable":true,"enum":["0","1"],"description":"Ownercontact Person: Sets the contact type for the ownercontact of the .de domain to person."},"x-de-nsentry":{"type":"array","description":"Nsentry: Enables the use of nsentrys instead of nameservers for .de domains","items":{"type":"string","nullable":true,"description":"Nsentry: Enables the use of nsentrys instead of nameservers for .de domains"}},"x-dk-mobile-phone":{"type":"string","nullable":true,"description":"Mobile phone number: Additional phone number field if required."},"x-dk-secondary-email":{"type":"string","nullable":true,"description":"Secondary EMail address: Additional EMail address which will be displayed in the registry Whois, overwriting the original EMail address of the owner contact. This extension is subject to validation."},"x-dk-sole-proprietorship":{"type":"string","description":"Sole Proprietorship: Companies with sole proprietorship (owned by a single individual) have the same protection rights as an individual. This extension can thus be used to hide EMail addresses to be hidden from the public Whois."},"x-dk-user-cvr":{"type":"string","nullable":true,"description":"Contact VAT number: Danish VAT number - Required for X-DK-USER-TYPEs COMPANY, ASSOCIATION and PUBLIC ORGANIZATION from Denmark. Optional if the owner contact does not reside in Denmark."},"x-dk-user-pnumber":{"type":"string","nullable":true,"description":"Contact production unit number: Production unit number - Optional extension used for validation for Danish companies with more physical addresses related to a single VAT number."},"x-dk-user-type":{"type":"string","nullable":true,"enum":["INDIVIDUAL","COMPANY","ASSOCIATION","PUBLIC_ORGANIZATION"],"description":"Contact type: The owner contact's user type. Can only be changed in the context of a change of registrant."},"x-domain-comment":{"type":"string","nullable":true,"description":"Domain Comment: Domain specific comment, to be reflected in QueryDomainList and FTP CSV domain list file."},"x-ee-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .EE trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-ee-admin-birthday":{"type":"string","nullable":true,"description":"ADMIN BDAY: Birthdays ADMIN"},"x-ee-admin-ident":{"type":"string","nullable":true,"description":"ADMIN ID: Identifications Number for ADMIN"},"x-ee-owner-birthday":{"type":"string","nullable":true,"description":"OWNER BDAY: Birthdays OWNER"},"x-ee-owner-ident":{"type":"string","nullable":true,"description":"OWNER ID: Identifications Number for OWNER"},"x-ee-owner-tin":{"type":"string","nullable":true,"description":"OWNER TIN: TIN for OWNER"},"x-ee-reserved-pw":{"type":"string","nullable":true,"description":"Reserved PW: Required if changing registrant during a dispute"},"x-ee-tech-birthday":{"type":"string","nullable":true,"description":"TECH BDAY: Birthdays TECH"},"x-ee-tech-ident":{"type":"string","nullable":true,"description":"TECH ID: Identifications Number for TECH"},"x-ee-tech-tin":{"type":"string","nullable":true,"description":"TECH TIN: TIN for TECH"},"x-es-admin-identificacion":{"type":"string","nullable":true,"description":"Admin identification: The ID card or passport number."},"x-es-admin-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Admin legal form: The legal form used for the owner contact"},"x-es-admin-tipo-identificacion":{"type":"string","nullable":true,"enum":["0","1","2","3","4"],"description":"Admin type identification: Indicates the type of identification"},"x-es-billing-identificacion":{"type":"string","nullable":true,"description":"Billing identification: The ID card or passport number."},"x-es-billing-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Billing legal form: The legal form used for the owner contact"},"x-es-billing-tipo-identificacion":{"type":"string","nullable":true,"enum":["0","1","2","3","4"],"description":"Billing type identification: Indicates the type of identification"},"x-es-owner-identificacion":{"type":"string","nullable":true,"description":"Owner identification: The ID card or passport number."},"x-es-owner-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Owner legal form: The legal form used for the owner contact"},"x-es-owner-tipo-identificacion":{"type":"string","nullable":true,"enum":["0","1","2","3","4"],"description":"Owner type identification: Indicates the type of identification"},"x-es-requestauthcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Request Authcode: Request a new authentication code (available for 10 days)"},"x-es-tech-identificacion":{"type":"string","nullable":true,"description":"Tech identification: The ID card or passport number."},"x-es-tech-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Tech legal form: The legal form used for the owner contact"},"x-es-tech-tipo-identificacion":{"type":"string","nullable":true,"enum":["0","1","2","3","4"],"description":"Tech type identification: Indicates the type of identification"},"x-eu-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .EU trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-eu-deleteauthcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Delete Authcode: Delete a set authcode from the domain"},"x-eu-naturalperson":{"type":"string","nullable":true,"enum":["0","1"],"description":"Natural person: Determines, if the registrant is a natural person or a company"},"x-eu-registrant-citizenship":{"type":"string","nullable":true,"enum":["at","be","bg","cz","cy","de","dk","es","ee","fi","fr","gr","hr","hu","ie","is","it","li","lt","lu","lv","mt","nl","no","pl","pt","ro","se","sk","si",""],"description":"Registrant Citizenship: Citizenship of the owner"},"x-eu-registrant-lang":{"type":"string","nullable":true,"enum":["bg","cs","da","de","el","en","es","et","fi","fr","ga","hr","hu","it","lt","lv","mt","nl","pl","pt","ro","sk","sl","sv"],"description":"Registrant language: Language the owner wishes to communicate with the registry (Default = en)"},"x-eu-requestauthcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Request Authcode: Request a new authentication code"},"x-faitid-admin-birthdate":{"type":"string","format":"date","nullable":true,"description":"Admin birthdate: date of birth; mandatoryfor individuals"},"x-faitid-admin-city":{"type":"string","nullable":true,"description":"Admin city: Extension representing the city"},"x-faitid-admin-country":{"type":"string","nullable":true,"description":"Admin country: Extension representing the country"},"x-faitid-admin-passportinfo":{"type":"string","nullable":true,"description":"Admin passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-admin-state":{"type":"string","nullable":true,"description":"Admin state: Extension representing the state"},"x-faitid-admin-street":{"type":"array","description":"Admin street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Admin street: Extension representing the street"}},"x-faitid-admin-tin":{"type":"string","nullable":true,"description":"Admin TIN: tax payer ID, mandatory for organizations"},"x-faitid-admin-zip":{"type":"string","nullable":true,"description":"Admin zip owner: Extension representing the zip code"},"x-faitid-billing-birthdate":{"type":"string","format":"date","nullable":true,"description":"Billing birthdate: date of birth; mandatoryfor individuals"},"x-faitid-billing-city":{"type":"string","nullable":true,"description":"Billing city: Extension representing the city"},"x-faitid-billing-country":{"type":"string","nullable":true,"description":"Billing country: Extension representing the country"},"x-faitid-billing-passportinfo":{"type":"string","nullable":true,"description":"Billing passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-billing-state":{"type":"string","nullable":true,"description":"Billing state: Extension representing the state"},"x-faitid-billing-street":{"type":"array","description":"Billing street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Billing street: Extension representing the street"}},"x-faitid-billing-tin":{"type":"string","nullable":true,"description":"Billing TIN: tax payer ID, mandatory for organizations"},"x-faitid-billing-zip":{"type":"string","nullable":true,"description":"Billing zip code: Extension representing the zip code"},"x-faitid-owner-birthdate":{"type":"string","format":"date","nullable":true,"description":"Owner birthdate: date of birth; mandatoryfor individuals"},"x-faitid-owner-city":{"type":"string","nullable":true,"description":"Owner city: Extension representing the city"},"x-faitid-owner-country":{"type":"string","nullable":true,"description":"Owner country: Extension representing the country"},"x-faitid-owner-passportinfo":{"type":"string","nullable":true,"description":"Owner passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-owner-state":{"type":"string","nullable":true,"description":"Owner state: Extension representing the state"},"x-faitid-owner-street":{"type":"array","description":"Onwer street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Onwer street: Extension representing the street"}},"x-faitid-owner-tin":{"type":"string","nullable":true,"description":"Owner TIN: tax payer ID, mandatory for organizations"},"x-faitid-owner-zip":{"type":"string","nullable":true,"description":"Owner zip code: Extension representing the zip code"},"x-faitid-tech-birthdate":{"type":"string","format":"date","nullable":true,"description":"Tech birthdate: date of birth; mandatoryfor individuals"},"x-faitid-tech-city":{"type":"string","nullable":true,"description":"Tech city: Extension representing the city"},"x-faitid-tech-country":{"type":"string","nullable":true,"description":"Tech country: Extension representing the country"},"x-faitid-tech-passportinfo":{"type":"string","nullable":true,"description":"Tech passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-tech-state":{"type":"string","nullable":true,"description":"Tech state: Extension representing the state"},"x-faitid-tech-street":{"type":"array","description":"Tech street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Tech street: Extension representing the street"}},"x-faitid-tech-tin":{"type":"string","nullable":true,"description":"Tech TIN: tax payer ID, mandatory for organizations"},"x-faitid-tech-zip":{"type":"string","nullable":true,"description":"Tech zip code: Extension representing the zip code"},"x-feedback-selfservice":{"type":"string","nullable":true,"enum":["0","1"],"description":"Activate Self-Service Domain: Determines, if Self-Service is activated."},"x-fi-birthdate":{"type":"string","nullable":true,"description":"Birthdate: Birthdate"},"x-fi-company-reg-id":{"type":"string","nullable":true,"description":"Business ID or Reg. Number: Local business Entity (registered at the Finnish Trade Register or a corporation within the Finnish republic) ID-Code Business ID or Reg.Number"},"x-fi-personal-id":{"type":"string","nullable":true,"description":"Personal Identity Number: Finnish Personal Identity Number"},"x-fi-requestauthcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Request Authcode: Request a new authentication code"},"x-fr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .FR trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-fr-announce":{"type":"string","nullable":true,"description":"Number of page announce JO: will contain the date of publication in the official gazette (the announce attribute shows the number of the announcement, the page attribute shows the\npage number of this announcement)."},"x-fr-birthcity":{"type":"string","nullable":true,"description":"Birthcity: Contains the contact's place of birth."},"x-fr-birthdate":{"type":"string","nullable":true,"description":"Birthdate: Contains the contact's date of birth."},"x-fr-birthpc":{"type":"string","nullable":true,"description":"Birthplace postcode: Contains the postcode of the place of birth (or at least the department code)."},"x-fr-birthplace":{"type":"string","nullable":true,"description":"Birthplace country code: Contains the country code of the contact's place of birth."},"x-fr-date-association":{"type":"string","nullable":true,"description":"contain the date of publication in the official gazette: Will contain the date of publication in the official gazette (the \"announce\" attribute shows the number of the announcement."},"x-fr-date-publication-jo":{"type":"string","nullable":true,"description":"contain the date of publication in the official gazette: The page attribute shows the page number of this announcement."},"x-fr-duns":{"type":"string","nullable":true,"description":"DUNS number: Short for Data Universal Numbering System; refers to a new identifier that can be sent for an Eligibility Verification at European level. Format has to follow X-XXX-XXXX (Only numbers are allowed)."},"x-fr-local":{"type":"string","nullable":true,"description":"Local identifier: A local identifier specific to a country of the European Economic Area."},"x-fr-numero-de-page-announce-jo":{"type":"string","nullable":true,"description":"page number of this announcement: Contains the date of publication in the official gazette (the announce attribute shows the number of the announcement, the page attribute shows the page number of this announcement)."},"x-fr-restrict-pub":{"type":"string","nullable":true,"enum":["0","1"],"description":"Restrict publication: Restrict publication"},"x-fr-set-registrant-identification-status":{"type":"string","nullable":true,"enum":["0","1"],"description":"Set the identification status of the domain owner: Used to determine the identification status of the domain owner"},"x-fr-set-registrant-reachable-mail":{"type":"string","nullable":true,"enum":["0","1"],"description":"Reachability status of the domain owner: Used to indicate the reachability of the domain owner via email"},"x-fr-siren-or-siret":{"type":"string","nullable":true,"description":"SIREN code: Contain the SIREN code."},"x-fr-trademark":{"type":"string","nullable":true,"description":"Trademark number: Contain a trademark number."},"x-fr-vatid":{"type":"string","nullable":true,"description":"VAT number: Contain the VAT number."},"x-fr-waldec":{"type":"string","nullable":true,"description":"Waldec linked to an association: Indicates the identifier Waldec linked to an association. If this identifier is provided, this is sufficient to identify an association."},"x-gr-requestauthcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Request Authcode: Request a new authentication code"},"x-hamburg-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .HAMBURG trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-hk-domain-category":{"type":"string","nullable":true,"enum":["I","O"],"description":"Domain category: I for individual domain, O for organization domain (only used for an ownerchange)."},"x-hk-new-bundle-domain-name":{"type":"string","nullable":true,"description":"Bundle Domain Name: Bundle Domain Name"},"x-hk-owner-age-over-18":{"type":"string","nullable":true,"enum":["no","yes"],"description":"Owner age over 18 years: Only mandatory if domain category is individual (only used for an ownerchange)."},"x-hk-owner-document-number":{"type":"string","nullable":true,"description":"Owner document number: Domain owner/registrant document number (only used for an ownerchange)."},"x-hk-owner-document-origin-country":{"type":"string","nullable":true,"description":"Owner document origin country: The country for the owner/registrant document origin (please use the country code, e.g. \"de\" or \"us\")."},"x-hk-owner-document-type":{"type":"string","nullable":true,"enum":["HKID","OTHID","PASSNO","BIRTHCERT","OTHIDV","BR","CI","CRS","HKSARG","HKORDINANCE","OTHORG"],"description":"Owner document type: Domain owner/registrant document type (only used for an ownerchange)."},"x-hk-owner-other-document-type":{"type":"string","nullable":true,"description":"Owner other document type: Domain owner/registrant other document type. This field is mandatory if the value for owner document type (X-HK-OWNER-DOCUMENT-TYPE) is OTHIDV (Others Individual Document) or OTHORG (Others Organization Document). Only used for an ownerchange."},"x-hr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .HR trustee TAC: Accept Trustees Assistance Corporation (TAC)"},"x-hr-comregid":{"type":"string","nullable":true,"description":"VAT ID / tax no.: VAT ID / tax no., mandatory for companies"},"x-hr-idcard":{"type":"string","nullable":true,"description":"Passport no.: Passport no., mandatory for individuals"},"x-hu-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .HU trustee TAC: Accept Trustees Assistance Corporation (TAC)"},"x-hu-idcard-or-passport-number":{"type":"string","nullable":true,"description":"ID-card or passport number: ID-card or passport number"},"x-hu-tax-number":{"type":"string","nullable":true,"description":"Tax number: Tax Number"},"x-hu-vat-number":{"type":"string","nullable":true,"description":"VAT number: Value added tax (VAT) Number"},"x-id-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .ID trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-ie-contact-type":{"type":"string","nullable":true,"enum":["COM","CHA","OTH"],"description":"Registrant/Owner type: Company/Charity/Other (Default = OTH)"},"x-ie-cro-number":{"type":"string","nullable":true,"description":"CRO Number: Companies Registration Office (CRO) number"},"x-ie-language":{"type":"string","nullable":true,"enum":["bg","cs","da","de","el","en","es","et","fi","fr","ga","hu","it","lt","lv","mt","nl","pl","pt","ro","sk","sl","sv"],"description":"Registrant/Owner language: Language the owner wishes to communicate with the registry (Default = EN)"},"x-ie-supporting-number":{"type":"string","nullable":true,"description":"Charity number: Charity/Supporting number"},"x-il-organization-number":{"type":"string","nullable":true,"description":"Company ID: Required Company ID for legal entities to register a .IL domain name."},"x-intended-use":{"type":"string","description":"Intended Use: Text for intended use of the domain"},"x-it-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .IT trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-it-consentforpublishing":{"type":"string","enum":["0","1"],"description":"ConsentForPublishing: Boolean value to allow the publication of contacts personal data. Values allowed: 1 to allow, 0 to deny."},"x-it-entity-type":{"type":"string","nullable":true,"enum":["1","2","3","4","5","6","7"],"description":"Entity Type: Numeric value to identify Registrant typology."},"x-it-ignoreowner":{"type":"string","nullable":true,"enum":["0","1"]},"x-it-nationality":{"type":"string","nullable":true,"description":"Registrants Nationality country code: The requesters nationality"},"x-it-pin":{"type":"string","nullable":true,"description":"Registrants taxcode: If the requester is an Italian natural person it contains his/her Codice Fiscale. For foreigners it can contain a\ndocument number. For associations without VAT number and tax code it must\nbe equal to \"n.a.\". In all the other cases it must be equal to VAT number (in the 11\nnumbers format for Italian Nationality) or the\nnumeric Codice Fiscale."},"x-it-sect3-liability":{"type":"string","enum":["0","1"],"description":"Accept Sect. 3 of registrar contract: This value is needed to indicate the acceptance of Section 3 in the .IT registrar contract."},"x-it-sect5-personal-data-for-registration":{"type":"string","enum":["0","1"],"description":"Accept Sect. 5 of registrar contract: This value is needed to indicate the acceptance of Section 5 in the .IT registrar contract."},"x-it-sect6-personal-data-for-diffusion":{"type":"string","enum":["0","1"],"description":"Accept Sect. 6 of registrar contract: This value is needed to indicate the acceptance of Section 6 in the .IT registrar contract."},"x-it-sect7-explicit-acceptance":{"type":"string","enum":["0","1"],"description":"Accept Sect. 7 of registrar contract: This value is needed to indicate the acceptance of Section 7 in the .IT registrar contract."},"x-jp-address":{"type":"string","description":"Organization address Japanese: Organization address Japanese, e.g. 東京都千代田区西神田3-8-1 千代田ファーストビル東館13F"},"x-jp-kana-organization":{"type":"string","description":"Organization name Japanese KANA: Organization name Japanese KANA"},"x-jp-registration-address":{"type":"string","description":"Organization registration address: Address of the head or principal office as listed in the registry, using the official prefecture notation without abbreviations."},"x-jp-registration-date":{"type":"string","format":"date","description":"Organization registration date: Organization registration date, e.g. 2023-10-30"},"x-jp-type":{"type":"string","description":"Organization type Japanese: Specify the organization type (Japanice) of the organization. Please refer to the following document: https://jprs.jp/jppartners/doc/organization_immediate.html"},"x-kr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":".KR Trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-kr-ctfy-no":{"type":"string","nullable":true,"description":"Certification number: Registrant certification number"},"x-kr-ctfy-type":{"type":"string","nullable":true,"enum":["BUSINESS","BUSINESSIND","CORP","UNIQUE","SCHOOL","ETC"],"description":"Certificate type: Certificate type for Korean domains"},"x-lt-requestauthcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Request Authcode: Request a new authentication code (Setting this to 1 will not initiate the transfer but needs to be provided to the TransferDomain command)"},"x-ltda-authorityname":{"type":"string","nullable":true,"description":"Authority Name"},"x-ltda-licensenumber":{"type":"string","nullable":true,"description":"License Number"},"x-lv-admin-regnr":{"type":"string","nullable":true,"description":"X-LV-ADMIN-REGNR: Registration Number of Latvian citizen for Admincontact"},"x-lv-owner-regnr":{"type":"string","nullable":true,"description":"X-LV-OWNER-REGNR: Registration Number of Latvian citizen for Ownercontact"},"x-lv-vatnr":{"type":"string","nullable":true,"description":"X-LV-VATNR: VAT Number of Legal Latvian contact only for Owners"},"x-mk-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .MK trustee TAC: Determines if the local presence service is to be used to register this domain"},"x-mk-owner-idnumber":{"type":"string","nullable":true,"description":"Owner ID Number: Personal or organizational identification number"},"x-mo-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .MO trustee TAC: Determines if the local presence service is to be used to register this domain"},"x-my-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .COM.MY trustee TAC: Determines if the local presence service is to be used to register this domain"},"x-my-admin-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Admin date of birth: Natural person date of birth"},"x-my-admin-identificationnumber":{"type":"string","nullable":true,"description":"Admin identification number: Natural person identification number"},"x-my-admin-organization-registration-number":{"type":"string","nullable":true,"description":"Admin Organization registration number: Admin organization registration number"},"x-my-admin-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Admin Organization type: Admin organization type"},"x-my-billing-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Billing date of birth: Natural person date of birth"},"x-my-billing-identificationnumber":{"type":"string","nullable":true,"description":"Billing identification number: Natural person identification number"},"x-my-billing-organization-registration-number":{"type":"string","nullable":true,"description":"Billing Organization registration number: Billing organization registration number"},"x-my-billing-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Billing Organization type: Billing organization type"},"x-my-owner-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Owner date of birth: Natural person date of birth"},"x-my-owner-identificationnumber":{"type":"string","nullable":true,"description":"Owner identification number: Natural person identification number"},"x-my-owner-organization-registration-number":{"type":"string","nullable":true,"description":"Owner Organization registration number: Owner organization registration number"},"x-my-owner-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Owner Organization type: Owner organization type"},"x-my-tech-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Tech date of birth: Natural person date of birth"},"x-my-tech-identificationnumber":{"type":"string","nullable":true,"description":"Tech identification number: Natural person identification number"},"x-my-tech-organization-registration-number":{"type":"string","nullable":true,"description":"Tech Organization registration number: Tech organization registration number"},"x-my-tech-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Tech Organization type: Tech organization type"},"x-name-emailforward":{"type":"string","nullable":true,"description":"Email forwarding: Forward emails to this address"},"x-ne-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .NE trustee TAC: Determines if the local presence service is to be used to register this domain"},"x-nicse-idnumber":{"type":"string","nullable":true,"description":"Personal or organisational number: Personal or organisational number."},"x-nicse-vatid":{"type":"string","nullable":true,"description":"VAT number: VAT number."},"x-nl-legalform":{"type":"string","nullable":true,"enum":["ANDERS","BGG","BRO","BV","BVI/O","COOP","CV","EENMANSZAAK","EESV","KERK","MAATSCHAP","NV","OWM","PERSOON","REDR","STICHTING","VERENIGING","VOF"],"description":"Legal form: The legal form used for the contacts"},"x-nl-legalformregno":{"type":"string","nullable":true,"description":"Legal form registration number: Legal form registration number used in the contacts"},"x-no-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .NO trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-no-organization-number":{"type":"string","nullable":true,"description":"Norwegian Organization Number: Required Norway Central Coordinating Register Number for legal entities to register a .NO domain name."},"x-no-person-identifier":{"type":"string","nullable":true,"description":"Norid Person ID: Required personal ID to register a private .PRIV.NO domain name."},"x-nu-iis-idno":{"type":"string","description":"Id Number: Identification Number, only applicable for Trades"},"x-nu-iis-vatno":{"type":"string","nullable":true,"description":"VAT number: VAT number."},"x-nz-privacy":{"type":"string","nullable":true,"enum":["PUBLIC","PRIVATE"],"description":"Domain WHOIS privacy setting: If PRIVATE is chosen, owner data will not be shown in WHOIS (Default = PRIVATE for Individuals, PUBLIC for Organizations)"},"x-pl-consentforpublishing":{"type":"string","nullable":true,"enum":["0","1"],"description":"Consent for publishing: Boolean value to allow the publication of contacts personal data. Values allowed: 1 to allow, 0 to deny."},"x-pt-owner-identification":{"type":"string","nullable":true,"description":"Fiscal Identification Nr (Owner): The Fiscal Identification Number of the owner contact."},"x-pt-owner-mobile":{"type":"string","nullable":true,"description":"Mobile number (Owner): The mobile number of the owner contact."},"x-pt-tech-identification":{"type":"string","nullable":true,"description":"Fiscal Identification Nr (Tech): The Fiscal Identification Number of the technical contact."},"x-pt-tech-mobile":{"type":"string","nullable":true,"description":"Mobile number (Tech): The mobile number of the technical contact."},"x-qa-eligibility-id":{"type":"string","nullable":true,"description":"Registrant Eligibility ID: The identification corresponding to the provided eligibility type."},"x-qa-eligibility-type":{"type":"string","nullable":true,"enum":["TradeLicense","FreeTradeLicense","Trademark","FreezoneTrademark","TradeLicenseIT","FreezoneTradeLicenseIT","TrademarkIT","FreezoneTrademarkIT","Legacy","LegacyApproved","Citizen","PermanentResident","SportingOrganisation","CharitableOrganisation","ReligiousOrganisation","University","TechnicalCollege","School","Academy","GovernmentApproved"],"description":"Registrant Eligibility Type: Specify what makes the registrant eligible to register the domain name."},"x-qa-registrant-name":{"type":"string","description":"Registrant Name: Registrant's name; This element MUST contain an english readable string for the Registrants name."},"x-request-authcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Request authentication code generation: Request a new authentication code"},"x-ro-company-number":{"type":"string","nullable":true,"description":"Company number: Company number"},"x-ro-idcard-or-passport-number":{"type":"string","nullable":true,"description":"ID-card or passport number: ID-card or passport number"},"x-ro-trade-token":{"type":"string","nullable":true,"description":"TRADE-Authorization-Key: Authorization-Key to initiate a TRADE"},"x-ro-vat-number":{"type":"string","nullable":true,"description":"VAT number: Value added tax (VAT) Number"},"x-rs-admin-company-number":{"type":"string","nullable":true,"description":"Company reg. number: Admin Company number for non-private registrations"},"x-rs-admin-idcard":{"type":"string","nullable":true,"description":"Passport no.: Admin Passport no., mandatory for individuals"},"x-rs-owner-company-number":{"type":"string","nullable":true,"description":"Company reg. number: Owner Company number for non-private registrations"},"x-rs-owner-idcard":{"type":"string","nullable":true,"description":"Passport no.: Owner Passport no., mandatory for individuals"},"x-rs-tech-company-number":{"type":"string","nullable":true,"description":"Company reg. number: Tech Company number for non-private registrations"},"x-rs-tech-idcard":{"type":"string","nullable":true,"description":"Passport no.: Tech Passport no., mandatory for individuals"},"x-rs-vat":{"type":"string","nullable":true,"description":"VAT number: VAT (fiscal) No. for non-private registrations"},"x-ru-birthdate":{"type":"string","nullable":true,"description":"Customer-s birth date: Customer-s birth date in the format DD.MM.YYYY (figures)."},"x-ru-code":{"type":"string","nullable":true,"description":"TIN taxpayers identification: TIN (taxpayers identification number) of the Customers organization. This field must contain a ten digit number (the last figure is a control figure)\nRequired for organizations incorporated in the Russian Federation."},"x-ru-kpp":{"type":"string","nullable":true,"description":"Reason code: The reason code  for the Customers organization registering. This field must contain a nine digit number.\nRequired for organizations incorporated in the Russian Federation."},"x-ru-passportdata":{"type":"string","nullable":true,"description":"Customer-s passport data: This field is filled in Russian and can\ncontain Russian and Latin letters, figures, punctuation marks and    spaces. Minimal length is two words, maximum length is 256 characters:\nDocument number, Issued by, Issued Date"},"x-ruhr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .RUHR trustee TAC: Determinruhr if the local presence service is to be used to register this domain"},"x-se-disclose-email":{"type":"string","nullable":true,"enum":["0","1"],"description":"Disclose email: Hide or show email."},"x-se-disclose-fax":{"type":"string","nullable":true,"enum":["0","1"],"description":"Disclose fax: Hide or show fax."},"x-se-disclose-voice":{"type":"string","nullable":true,"enum":["0","1"],"description":"Disclose voice: Hide or show voice."},"x-sg-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".SG trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-sg-admin-singpassid":{"type":"string","nullable":true,"description":"Singpass ID of individual admin: The contact identity card (SingPass ID) for an individual local presence in Singapore (Format: S1234567D)"},"x-sg-rcbid":{"type":"string","nullable":true,"description":"Company/Identity Registration ID: For companies located in Singapore, the corresponding company registration number has to be given OR contact identity card for a local presence in Singapore (Format: S1234567D)"},"x-sk-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .SK trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-sk-contact-ident-number":{"type":"string","nullable":true,"description":"Company number: Company-Ident-Number for Companies. Not required for Persons"},"x-sk-contact-legal-form":{"type":"string","nullable":true,"enum":["CORP","PERS"],"description":"Legal form: PERS for private persons or CORP for Companies"},"x-srl-authorityname":{"type":"string","nullable":true,"description":"Authority Name"},"x-srl-licensenumber":{"type":"string","nullable":true,"description":"License Number"},"x-swiss-owner-type":{"type":"string","nullable":true,"enum":["P","O"],"description":"Owner type: Identity type owner"},"x-swiss-uid":{"type":"string","description":"UID / UPI: Enterprise ID of the Owners Organization"},"x-tatar-domain-description":{"type":"string","nullable":true,"description":"Domain Description: Domain Description"},"x-tel-publish-whois":{"type":"string","nullable":true,"enum":["0","1"],"description":"Publish whois: Show private details in the whois, only available for private persons"},"x-tel-whois-phone":{"type":"string","description":"Reseller phone: The phone number of the reseller to be shown in the WHOIS. This needs to be in the format +XX.XXXXXXXXX and will only be shown if X-WHOIS-RSP is set."},"x-tel-whoistype":{"type":"string","nullable":true,"enum":["Natural","Legal"],"description":"Registrant - type: Defines what type of user the registrant is"},"x-tw-company-number":{"type":"string","nullable":true,"description":"Company number: Company number length must be min: 6 chars max: 32 chars"},"x-uk-owner-corporate-number":{"type":"string","nullable":true,"description":"UK Corporate Number for owner contact: Describes the corporate number for owner contact"},"x-uk-owner-corporate-type":{"type":"string","nullable":true,"enum":["OTHER","FOTHER","IND","FIND","FCORP","LTD","PLC","LLP","IP","CRC","GOV","PTNR","RCHAR","SCH","STAT","STRA"],"description":"Owner Corporate Type: Describes the corporate type for owner contact"},"x-uk-trading-name":{"type":"string","nullable":true,"description":"Trading Name: Trading name for the registrant. Optional."},"x-unitedtld-regulatory-data":{"type":"string","nullable":true,"description":"UnitedTLD Regulatory Body Information: Extension containing information about the regulatory body"},"x-us-nexus-apppurpose":{"type":"string","nullable":true,"enum":["P1","P2","P3","P4","P5"],"description":"Application purpose: Purpose of the application"},"x-us-nexus-category":{"type":"string","nullable":true,"enum":["C11","C12","C21","C31","C32"],"description":"US-NEXUS category: Categorization of the entity requesting the application"},"x-us-nexus-validator":{"type":"string","nullable":true,"description":"US-NEXUS validator country: Specify the two-letter country-code of the registrant (if Nexus Category is either C31 or C32)"},"x-vn-owner-birthday":{"type":"string","format":"date","nullable":true,"description":"Birthday of domain owner YYYY-MM-DD (i.e. 1970-12-01): Birthday of domain owner"},"x-vn-owner-identification":{"type":"string","nullable":true,"description":"Identification Number: Identification Number. For private persons, you have to use the identity card number and for organizations use the VAT number."},"x-whois-banner":{"type":"array","description":"Whois banner: Modifies a freetext - line in the whois (not supported by all registries)","items":{"type":"string","nullable":true,"description":"Whois banner: Modifies a freetext - line in the whois (not supported by all registries)"}},"x-whois-privacy":{"type":"string","nullable":true,"enum":["0","1"],"description":"Whois Privacy: Enable WhoisProxy to prevent disclosure of the contact data in whois."},"x-whois-rsp":{"type":"string","nullable":true,"description":"RSP tag: The company, responsible for managing this domain (usually the reseller, not supported by all registries)"},"x-whois-url":{"type":"string","nullable":true,"description":"URL: The website - URL of the responsible reseller (not supported by all registries)"},"x-xxx-community-id":{"type":"string","nullable":true,"description":".XXX Sponsored Community Member ID: .XXX Sponsored Community Member ID"},"x-xxx-defensive":{"type":"string","nullable":true,"enum":["0","1"],"description":".XXX Non-Resolving Registration: Domain will be a defensive registration and Domain will not resolve!"},"x-zuerich-agreement":{"type":"string","enum":["0","1"],"description":"I accept the local laws of Canton of Zurich, in particular to the TLDV ordinance: I accept the local laws of Canton of Zurich, in particular to the TLDV ordinance"},"x-zuerich-uid":{"type":"string","description":"Enterprise Identification Number (UID): Registrants must be either a Zurich Public Authority (including the Canton and City of Zurich and related entities) or a legal entity (Rechtseinheit) in possession of a commercial registration number (Unternehmens-Identifikationsnummer) with a registration in the Commercial Register of the Canton of Zurich. If you're a Zurich Public Authority, you can add the word 'PUBLIC' in the UID field. You can check your UID number in https://www.zefix.ch/en/search/entity/welcome"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"document_generator_uri":{"type":"string","description":"Document generator uri"},"document_upload_target":{"type":"string","description":"Document upload target"},"document_upload_type":{"type":"string","description":"Document upload type"},"domain":{"type":"string","description":"Domain: The modified domain name"},"error":{"type":"string","description":"Error"},"faquri":{"type":"string","description":"Faquri"},"job_id":{"type":"string","description":"Job id: If the modification - job is still pending, the corresponding job has this id"},"ownerchange_status":{"type":"string","description":"Owner change status: Status of pending ownerchange"},"roid":{"type":"string","description":"ROID: The ROID of the modified domain"},"status":{"type":"string","description":"Status: The current status of the domain"},"x-document-status":{"type":"string","description":"X-document-status"},"x-es-new-admincontact":{"type":"string","description":"X-es-new-admincontact"},"x-es-new-billingcontact":{"type":"string","description":"X-es-new-billingcontact"},"x-es-new-ownercontact":{"type":"string","description":"X-es-new-ownercontact"},"x-es-new-techcontact":{"type":"string","description":"X-es-new-techcontact"},"x-gtld-owner-trustee-active":{"type":"string","description":"X-GTLD-OWNER-TRUSTEE-ACTIVE: Forced global trustee for missing owner contact."},"x-gtld-owner-trustee-service-start":{"type":"string","format":"date","description":"X-GTLD-OWNER-TRUSTEE-SERVICE-START: When will the forced global trustee begin billing."},"x-lv-admin-regnr":{"type":"string","nullable":true,"description":"X-LV-ADMIN-REGNR: Registration Number of Latvian citizen for Admincontact"},"x-lv-owner-regnr":{"type":"string","nullable":true,"description":"X-LV-OWNER-REGNR: Registration Number of Latvian citizen for Ownercontact"},"x-lv-vatnr":{"type":"string","nullable":true,"description":"X-LV-VATNR: VAT Number of Legal Latvian contact only for Owners"},"x-ngo-verification-link":{"type":"string","description":"X-ngo-verification-link"},"x-ngo-verification-until":{"type":"string","format":"date","description":"X-ngo-verification-until"},"x-ownerchange-autoapprove":{"type":"string","description":"X-OWNERCHANGE-AUTOAPPROVE: Trustee contact id"},"x-time-to-suspension":{"type":"string","format":"date-time","description":"X-time-to-suspension"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyDomain"}},"/domain/{domain}/activate/{type}":{"post":{"operationId":"activateDomain","summary":"XRRP command ActivateDomain (activateDomain)","description":"This command enables you to activate a domain by completing a pending domain operation\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"The domain for which the pending operation should be finished","schema":{"type":"string","description":"The domain for which the pending operation should be finished"}},{"name":"type","in":"path","required":true,"description":"The type of the pending domain operation","schema":{"type":"string","enum":["ADD","TRANSFER","TRANSITION"],"description":"The type of the pending domain operation"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["APPROVE","DENY"],"description":"The action to apply to the pending domain operation"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ActivateDomain"}},"/domain/{domain}/activation-info/{type}/{token}":{"get":{"operationId":"getDomainActivationInfo","summary":"XRRP command GetDomainActivationInfo (getDomainActivationInfo)","description":"This command retrieves the information required to activate a domain\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"The domain to get the activation info for","schema":{"type":"string","description":"The domain to get the activation info for"}},{"name":"type","in":"path","required":true,"description":"The type of operation to get the activation info for","schema":{"type":"string","enum":["ADD","TRANSFER","TRANSITION"],"description":"The type of operation to get the activation info for"}},{"name":"token","in":"path","required":true,"description":"Token: The unique token for getting the activation info","schema":{"type":"string","description":"Token: The unique token for getting the activation info"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"city":{"type":"string","nullable":true,"description":"City: City of the owner contact"},"country":{"type":"string","nullable":true,"description":"Country code: Country code of the owner contact"},"email":{"type":"string","nullable":true,"description":"E-Mail: Email address of the owner contact"},"fax":{"type":"string","nullable":true,"description":"Fax: Fax number of the owner contact"},"first_name":{"type":"string","nullable":true,"description":"First name: First name of the owner contact"},"last_name":{"type":"string","nullable":true,"description":"Last name: Last name of the owner contact"},"middle_name":{"type":"string","nullable":true,"description":"Middle name: Middle (second) name of the owner contact"},"organization":{"type":"string","nullable":true,"description":"Organization: Organization name of the owner contact"},"owner":{"type":"string","nullable":true,"description":"Contact handle: Owner Contact ID"},"phone":{"type":"string","nullable":true,"description":"Phone: Phone number of the owner contact"},"registryaccount_city":{"type":"string","nullable":true,"description":"Registryaccount city: City of the registry account"},"registryaccount_country":{"type":"string","nullable":true,"description":"Registryaccount country code: Country code of the registry account"},"registryaccount_organization":{"type":"string","nullable":true,"description":"Registryaccount organization: Organization name of the registry account"},"registryaccount_street":{"type":"string","nullable":true,"description":"Registryaccount street: Street of the registry account"},"registryaccount_zip":{"type":"string","nullable":true,"description":"Registryaccount ZIP code: Zip code of the registry account"},"reseller_organization":{"type":"string","nullable":true,"description":"Reseller organization: Organization name of the reseller"},"state":{"type":"string","nullable":true,"description":"State: State of the owner contact"},"street":{"type":"string","nullable":true,"description":"Street: Street of the owner contact"},"title":{"type":"string","nullable":true,"description":"Title: Title of the owner contact"},"zip":{"type":"string","nullable":true,"description":"ZIP code: Zip code of the owner contact"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"GetDomainActivationInfo"}},"/domain/{domain}/application":{"post":{"operationId":"addDomainApplication","summary":"XRRP command AddDomainApplication (addDomainApplication)","description":"\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"Domain: Domain name to be registered","schema":{"type":"string","description":"Domain: Domain name to be registered"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"admincontact0":{"type":"string","description":"Admin contact: Administrative contact"},"auth":{"type":"string","nullable":true,"description":"Auth: domain auth code"},"billingcontact0":{"type":"string","description":"Billing contact: Billing contact"},"class":{"type":"string","nullable":true,"description":"Application class: Application class"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"nameserver":{"type":"array","description":"Nameserver: Nameserver to be used for this domain","items":{"type":"string","nullable":true,"description":"Nameserver: Nameserver to be used for this domain"}},"ownercontact0":{"type":"string","description":"Owner contact: Owner contact"},"period":{"type":"integer","format":"int32","description":"Period: How many years you want to apply for this domain"},"smdfile":{"type":"array","description":"SMDFILE: TMCH SMD file","items":{"type":"string","nullable":true,"description":"SMDFILE: TMCH SMD file"}},"techcontact0":{"type":"string","description":"Tech contact: Technical contact"},"trademark":{"type":"string","nullable":true,"description":"Trademark ID: Loads the SMD file from the database by ID if your trademark is handled within this system already."},"x-accept-premiumprice":{"type":"string","nullable":true,"enum":["0","1"]},"x-accept-ssl-requirement":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept SSL requirements for this TLD: .app, .page, .dev, .new, .day, .channel, .boo, .foo, .zip, .mov, .nexus, .dad, .phd, .prof, .esq, .rsvp, .meme, .ing, .eat, .fly and .here are a more secure domains, meaning that HTTPS is required for all .app/.page/.dev/.new/.day/.channel/.boo/.foo/.zip/.mov/.nexus/.dad/.phd/.prof/.esq/.rsvp/.meme/.ing/.eat/.fly/.here websites. You can buy your .app/.page/.dev/.new/.day/.channel/.boo/.foo/.zip/.mov/.nexus/.dad/.phd/.prof/.esq/.rsvp/.meme/.ing/.eat/.fly/.here domain name now, but in order for it to work properly in browsers you must first configure HTTPS serving. For more information about configuring HTTPS, including resources to obtain an SSL certificate, please visit our wiki"},"x-allocation-token":{"type":"string","nullable":true,"description":"Allocation Token: Allocation Token provided by the registry"},"x-amsterdam-legalform":{"type":"string","nullable":true,"enum":["ANDERS","BGG","BRO","BV","BVI/O","COOP","CV","EENMANSZAAK","EESV","KERK","MAATSCHAP","NV","OWM","PERSOON","REDR","STICHTING","VERENIGING","VOF"],"description":"Legal form: The legal form used for the contacts"},"x-amsterdam-legalformregno":{"type":"string","nullable":true,"description":"Legal form registration number"},"x-ari-block":{"type":"string","nullable":true,"enum":["0","1"],"description":"Blocked registration: Register defensive, not resolving in DNS"},"x-au-domain-idnumber":{"type":"string","nullable":true,"description":"Identification number: Specify the identification number as appropriate"},"x-au-domain-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA","PRIVATE"],"description":"Identification type: This is the identification type of the registrant.  Specify 'ABN', 'ACN', or 'OTHER'. 'OTHER' refers to ARBN or Inc Association Number"},"x-au-domain-relation":{"type":"string","nullable":true,"enum":["1","2"],"description":"Eligibility type relationship: This indicates the relationship between the Eligibility Type (e.g. business name) and domain name"},"x-au-domain-relationtype":{"type":"string","nullable":true,"enum":["Company","RegisteredBusiness","SoleTrader","Partnership","TrademarkOwner","PendingTMOwner","CitizenResident","IncorporatedAssociation","Club","NonProfitOrganisation","Charity","TradeUnion","IndustryBody","CommercialStatutoryBody","PoliticalParty","religiouschurchgroup","HigherEducationInstitution","ResearchOrganisation","GovernmentSchool","ChildCareCentre","Preschool","NationalBody","TrainingOrganisation","NonGovernmentSchool","UnincorporatedAssociation","IndustryOrganisation","egistrableBody","IndigenousCorporation","RegisteredOrganisation","Cooperative","Trust","EducationalInstitution","CommonwealthEntity","StatutoryBody","TradingCooperative","CompanyLimitedByGuarantee","NonDistributingCooperative","NonTradingCooperative","CharitableTrust","PublicPrivateAncillaryFund","PeakStateTerritoryBody","NotForProfitCommunityGroup"],"description":"Eligibility type: Specify what makes the registrant eligible to register the domain name"},"x-au-eligibility-idnumber":{"type":"string","nullable":true,"description":"Identification number for the Eligibility: Specify the identification number as appropriate"},"x-au-eligibility-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA"],"description":"Identification type: This is the identification type of the elibibility."},"x-au-eligibility-name":{"type":"string","nullable":true,"description":"Eligibility Name: The Eligibility name"},"x-au-grandfathering-tld":{"type":"string","enum":["com.au","net.au","org.au","asn.au","id.au"],"description":"Namespace of the grandfathering domain: Defines the Namespace the grandfathering domain is in"},"x-au-import-token":{"type":"string","nullable":true,"enum":["0","1"],"description":"If the Grandfathering Domain is managed via RRPProxy, the Details like the .au Priority Token can be Imported automatically by RRPProxy: RRPProxy will need a dedicated Agreement that the Requester of this domain is actually eligible to order this domain and owns the grandfathering domain."},"x-au-owner-organization":{"type":"string","nullable":true,"description":"Owner Organization: The Organization(Registrant) name"},"x-au-priority-token":{"type":"string","nullable":true,"description":"Priority Token: Priotity Token / Grandfathering Token as Provided by auDA"},"x-bayern-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BAYERN trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-berlin-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .BERLIN trustee TAC: determine if the local presence service is to be used to register this domain"},"x-br-register-number":{"type":"string","nullable":true,"description":"Brazil Legal ID: A brazil legal ID, either CNPJ for organization or CPF for person"},"x-challenge-answer":{"type":"array","description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains","items":{"type":"string","nullable":true,"description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains"}},"x-challenge-question":{"type":"array","description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains","items":{"type":"string","nullable":true,"description":"Challenge for uniregistry - domains: Answer to challenge for uniregistry - domains"}},"x-channel-accept-highly-regulated-tac":{"type":"string","enum":["0","1"],"description":"Accept .CHANNEL additional terms and conditions: .channel is exclusively for content creators and publishers to monetise their content. All .channel domains must present the user with a website where the creator can monetise their content or audience. No other use cases are allowed. By registering a .channel domain, you agree to follow the .channel Registration Policy. Please visit g.co/registry/channelRegistration for the full policy."},"x-cnnic-owner-id-code":{"type":"string","nullable":true,"description":"Owner identity code: Identity code of the ID card"},"x-cnnic-owner-id-type":{"type":"string","nullable":true,"enum":["SFZ","HZ","GAJMTX","TWJMTX","WJLSFZ","GAJZZ","TWJZZ","JGZ","QT","ORG","YYZZ","TYDM","BDDM","JDDWFW","SYDWFR","WGCZJG","SHTTFR","ZJCS","MBFQY","JJHFR","LSZY","WGZHWH","WLCZJG","SFJD","JWJG","SHFWJG","MBXXBX","YLJGZY","GZJGZY","BJWSXX","QTTYDM","GATJZZ","ZZJGDMZ"],"description":"Owner identity type: Identity type of the ID card"},"x-domain-blocking-ipr-id":{"type":"string","nullable":true,"description":"IPR Number: IPR-Number of the XXX-SUNRISE-B application"},"x-faitid-admin-birthdate":{"type":"string","format":"date","nullable":true,"description":"Admin birthdate: date of birth; mandatoryfor individuals"},"x-faitid-admin-city":{"type":"string","nullable":true,"description":"Admin city: Extension representing the city"},"x-faitid-admin-country":{"type":"string","nullable":true,"description":"Admin country: Extension representing the country"},"x-faitid-admin-passportinfo":{"type":"string","nullable":true,"description":"Admin passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-admin-state":{"type":"string","nullable":true,"description":"Admin state: Extension representing the state"},"x-faitid-admin-street":{"type":"array","description":"Admin street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Admin street: Extension representing the street"}},"x-faitid-admin-tin":{"type":"string","nullable":true,"description":"Admin TIN: tax payer ID, mandatory for organizations"},"x-faitid-admin-zip":{"type":"string","nullable":true,"description":"Admin zip code: Extension representing the zip code"},"x-faitid-billing-birthdate":{"type":"string","format":"date","nullable":true,"description":"Billing birthdate: date of birth; mandatoryfor individuals"},"x-faitid-billing-city":{"type":"string","nullable":true,"description":"Billing city: Extension representing the city"},"x-faitid-billing-country":{"type":"string","nullable":true,"description":"Billing country: Extension representing the country"},"x-faitid-billing-passportinfo":{"type":"string","nullable":true,"description":"Billing passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-billing-state":{"type":"string","nullable":true,"description":"Billing state: Extension representing the state"},"x-faitid-billing-street":{"type":"array","description":"Billing street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Billing street: Extension representing the street"}},"x-faitid-billing-tin":{"type":"string","nullable":true,"description":"Billing TIN: tax payer ID, mandatory for organizations"},"x-faitid-billing-zip":{"type":"string","nullable":true,"description":"Billing zip code: Extension representing the zip code"},"x-faitid-owner-birthdate":{"type":"string","format":"date","nullable":true,"description":"Owner birthdate: date of birth; mandatoryfor individuals"},"x-faitid-owner-city":{"type":"string","nullable":true,"description":"Owner city: Extension representing the city"},"x-faitid-owner-country":{"type":"string","nullable":true,"description":"Owner country: Extension representing the country"},"x-faitid-owner-passportinfo":{"type":"string","nullable":true,"description":"Owner passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-owner-state":{"type":"string","nullable":true,"description":"Owner state: Extension representing the state"},"x-faitid-owner-street":{"type":"array","description":"Owner street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Owner street: Extension representing the street"}},"x-faitid-owner-tin":{"type":"string","nullable":true,"description":"Owner TIN: tax payer ID, mandatory for organizations"},"x-faitid-owner-zip":{"type":"string","nullable":true,"description":"Owner zip code: Extension representing the zip code"},"x-faitid-tech-birthdate":{"type":"string","format":"date","nullable":true,"description":"Tech birthdate: date of birth; mandatoryfor individuals"},"x-faitid-tech-city":{"type":"string","nullable":true,"description":"Tech city: Extension representing the city"},"x-faitid-tech-country":{"type":"string","nullable":true,"description":"Tech country: Extension representing the country"},"x-faitid-tech-passportinfo":{"type":"string","nullable":true,"description":"Tech passportinfo: name of ID document in English and the number of the document; mandatory for individuals"},"x-faitid-tech-state":{"type":"string","nullable":true,"description":"Tech state: Extension representing the state"},"x-faitid-tech-street":{"type":"array","description":"Tech street: Extension representing the street","items":{"type":"string","nullable":true,"description":"Tech street: Extension representing the street"}},"x-faitid-tech-tin":{"type":"string","nullable":true,"description":"Tech TIN: tax payer ID, mandatory for organizations"},"x-faitid-tech-zip":{"type":"string","nullable":true,"description":"Tech zip code: Extension representing the zip code"},"x-fee-amount":{"type":"array","description":"Amount of the fee extension.","items":{"type":"string","format":"decimal","nullable":true,"description":"Amount of the fee extension."}},"x-fee-application":{"type":"string","format":"decimal","nullable":true,"description":"None refundable amount of the fee extension."},"x-fee-currency":{"type":"string","nullable":true,"description":"Currency of the fee extension. Default is the own account currency."},"x-fr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .FR trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-fr-announce":{"type":"string","nullable":true,"description":"Number of page announce JO: will contain the date of publication in the official gazette (the announce attribute shows the number of the announcement, the page attribute shows the page number of this announcement)."},"x-fr-birthcity":{"type":"string","nullable":true,"description":"Birthcity: Contains the contact's place of birth."},"x-fr-birthdate":{"type":"string","nullable":true,"description":"Birthdate: Contains the contact's date of birth."},"x-fr-birthpc":{"type":"string","nullable":true,"description":"Birthplace postcode: Contains the postcode of the place of birth (or at least the department code)."},"x-fr-birthplace":{"type":"string","nullable":true,"description":"Birthplace country code : Contains the country code of the contacts place of birth."},"x-fr-date-association":{"type":"string","nullable":true,"description":"contain the date of publication in the official gazette: Will contain the date of publication in the official gazette (the \"announce\" attribute shows the number of the announcement."},"x-fr-date-publication-jo":{"type":"string","nullable":true,"description":"contain the date of publication in the official gazette: The page attribute shows the page number of this announcement."},"x-fr-duns":{"type":"string","nullable":true,"description":"DUNS number: Short for Data Universal Numbering System; refers to a new identifier that can be sent for an Eligibility Verification at European level. Format has to follow X-XXX-XXXX (Only numbers are allowed)."},"x-fr-local":{"type":"string","nullable":true,"description":"Local identifier: A local identifier specific to a country of the European Economic Area."},"x-fr-no-pre-zonecheck":{"type":"string","nullable":true,"enum":["0","1"],"description":"Suppress DNS precheck: Determines, if the system should do a DNS precheck before sending the command to the registry."},"x-fr-numero-de-page-announce-jo":{"type":"string","nullable":true,"description":"page number of this announcement: Contains the date of publication in the official gazette (the announce attribute shows the number of the announcement, the page attribute shows the page number of this announcement)."},"x-fr-restrict-pub":{"type":"string","nullable":true,"enum":["0","1"],"description":"Restrict publication: Restrict publication"},"x-fr-siren-or-siret":{"type":"string","nullable":true,"description":"SIREN code: Contain the SIREN code."},"x-fr-trademark":{"type":"string","nullable":true,"description":"Trademark number: Contain a trademark number."},"x-fr-vatid":{"type":"string","nullable":true,"description":"VAT number: Contain the VAT number."},"x-fr-waldec":{"type":"string","nullable":true,"description":"Waldec linked to an association: Indicates the identifier Waldec linked to an association. If this identifier is provided, this is sufficient to identify an association."},"x-gay-accept-requirements":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .GAY Protection-Requirements: Accept, that the domain will NOT be used for inciting violence, bullying, harassing, or hate speech and NOT be used by recognized hate groups. DotGay donates 20% from each new domain registered to their partners, GLAAD and CenterLink. For more information, please visit our wiki."},"x-giving-landrush-condition":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .GIVING terms: As a condition to registering a domain name in the .GIVING during Landrush (December 20, 2022 through January 20, 2023), you agree that by registering your domain name, you represent and warrant that: (a) you currently use one of Blackbaud's digital giving solutions or will evaluate the free Giving Checkout™ solution offered by JustGiving from Blackbaud available at this link (https://justgiving.blackbaud.com/us/for-charities/giving-checkout) and (b) you acknowledge and agree that the Registry or the registrar can cancel the registration of the domain name if your warranty is found to be untrue, incomplete, incorrect, or misleading."},"x-hamburg-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .HAMBURG trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-idn-language":{"type":"string","nullable":true,"description":"IDN Language: IDN language tag"},"x-intended-use":{"type":"string","description":"Intended Use: Text for intended use of the domain"},"x-launch-accepted-date":{"type":"string","format":"date","nullable":true,"description":"Accepted date: TMDB claims notice acceptance date"},"x-launch-code":{"type":"array","description":"Validator code: Non TMCH validator code","items":{"type":"string","nullable":true,"description":"Validator code: Non TMCH validator code"}},"x-launch-expiry-date":{"type":"string","format":"date","nullable":true,"description":"Expiry date: TMDB expiry date of the claims notice"},"x-launch-notice-id":{"type":"string","nullable":true,"description":"Notice ID: Notice ID"},"x-launch-validator-id":{"type":"array","description":"Validator ID: Non TMCH validator ID","items":{"type":"string","nullable":true,"description":"Validator ID: Non TMCH validator ID"}},"x-ltda-authorityname":{"type":"string","nullable":true,"description":"Authority Name"},"x-ltda-licensenumber":{"type":"string","nullable":true,"description":"License Number"},"x-nicse-idnumber":{"type":"string","nullable":true,"description":"Personal or organisational number: Personal or organisational number."},"x-nicse-vatid":{"type":"string","nullable":true,"description":"VAT number: VAT number."},"x-nu-iis-idno":{"type":"string","description":"ID Number: Identification Number"},"x-nu-iis-vatno":{"type":"string","nullable":true,"description":"VAT number: VAT number"},"x-nyc-extcontact":{"type":"string","nullable":true,"enum":["ADMIN","BILLING","OWNER","TECH"],"description":"New York ExtContact: Mentioned contact must have a valid physical address in the City of New York"},"x-reference-url":{"type":"string","description":"Reference URL: Registrants current url"},"x-ruhr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .RUHR trustee TAC: Determinruhr if the local presence service is to be used to register this domain"},"x-srl-authorityname":{"type":"string","nullable":true,"description":"Authority Name"},"x-srl-licensenumber":{"type":"string","nullable":true,"description":"License Number"},"x-swiss-owner-type":{"type":"string","nullable":true,"enum":["P","O"],"description":"Owner type: Identity type owner"},"x-swiss-uid":{"type":"string","description":"UID / UPI: Enterprise ID of the Owners Organization"},"x-trademark-id":{"type":"string","description":"Trademark ID: The ID of the trademark, as issued by the trademark authority"},"x-trademark-issuer":{"type":"string","description":"Trademark Issuer: The name of the trademark authority that issued the trademark"},"x-trademark-transliteration-info":{"type":"string","description":"Trademark Transliteration Info: Explanation why transliteration from SMD to some-label is valid"},"x-unitedtld-regulatory-data":{"type":"string","description":"UnitedTLD Regulatory Body Information: Extension containing information abou the regulatory body"},"x-xxx-sunrise-b-on-expiry-action":{"type":"string","nullable":true,"description":"ON-EXPIRY-ACTION: Allowed values: EXPIRE (DEFAULT), CONVERTTOADULTBLOCK, CONVERTTOADULTBLOCKPLUS"},"x-zuerich-agreement":{"type":"string","enum":["0","1"],"description":"I accept the local laws of Canton of Zurich, in particular to the TLDV ordinance: I accept the local laws of Canton of Zurich, in particular to the TLDV ordinance"},"x-zuerich-uid":{"type":"string","description":"Enterprise Identification Number (UID): Registrants must be either a Zurich Public Authority (including the Canton and City of Zurich and related entities) or a legal entity (Rechtseinheit) in possession of a commercial registration number (Unternehmens-Identifikationsnummer) with a registration in the Commercial Register of the Canton of Zurich. If you're a Zurich Public Authority, you can add the word 'PUBLIC' in the UID field. You can check your UID number in https://www.zefix.ch/en/search/entity/welcome"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"application":{"type":"integer","format":"int32","description":"Application: ID of the new application (equal to APPLICATION ID)"},"application_id":{"type":"integer","format":"int32","description":"Application ID: ID of the new application (equal to APPLICATION)"},"domain":{"type":"string","description":"Domain: Domain this application was issued for"},"status":{"type":"string","enum":["UNPAID"],"description":"Status: Status of the new application"},"x-fee-amount":{"type":"string","format":"decimal","description":"X-FEE-AMOUNT: The amount debited from your account balance for the domain name registration."},"x-fee-application":{"type":"string","format":"decimal","description":"X-FEE-APPLICATION: The non-refundable amount debited from your account balance for the domain name registration."},"x-fee-currency":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddDomainApplication"}},"/domain/{domain}/application/{class}":{"get":{"operationId":"statusDomainApplication","summary":"XRRP command StatusDomainApplication (statusDomainApplication)","description":"This command enables you to check the actual status and all data of an application.\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"The domain to get details for","schema":{"type":"string","description":"The domain to get details for"}},{"name":"class","in":"path","required":true,"description":"Application class: Application class","schema":{"type":"string","nullable":true,"description":"Application class: Application class"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"application","in":"query","required":true,"description":"ID of the application to check","schema":{"type":"integer","format":"int32","description":"ID of the application to check"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"admin_contact":{"type":"string","description":"Admin contact: Administrative contact used for the application"},"application_id":{"type":"integer","format":"int32","description":"Application ID: The ID of your domain application."},"auth_code":{"type":"string","description":"Authentication code: Authentication code of the domain."},"billing_contact":{"type":"string","description":"Billing contact: Billing contact used for the application"},"class":{"type":"string","enum":["CO_GRANDFATHERING","CO_LANDRUSH","CO_LIVE"],"description":"Application class: Type of application"},"created_date":{"type":"string","format":"date-time","description":"Created date: Creation date of domain application."},"domain":{"type":"string","description":"Domain: Domain name for the application"},"nameserver":{"type":"array","description":"Nameserver","items":{"type":"string","nullable":true,"description":"Nameserver"}},"owner_contact":{"type":"string","description":"Owner contact: Owner contact used for the application"},"period":{"type":"integer","format":"int32","description":"Period: Period the domain shall be registered"},"roid":{"type":"string","description":"Roid"},"smdid":{"type":"string","description":"SMD ID: Shows the SMD:ID field of the relevant SMD file (if set)."},"status":{"type":"string","enum":["UNPAID","PAID","REQUESTED","PROCESSING","SUCCESSFUL","FAILED","INVALID","HOLD","UNPAIDREQUESTED","UNPAIDPROCESSING"],"description":"Status: The current status of the application."},"tech_contact":{"type":"string","description":"Tech contact: Technical contact used for the application"},"update_date":{"type":"string","format":"date-time","description":"Updated date: Date of last update of the application."},"x-amsterdam-legalform":{"type":"string","description":".AMSTERDAM legalform"},"x-amsterdam-legalformregno":{"type":"integer","format":"int32","description":".AMSTERDAM legalformregno"},"x-au-domain-idnumber":{"type":"string","nullable":true,"description":"Identification number: Specify the identification number as appropriate"},"x-au-domain-idtype":{"type":"string","nullable":true,"description":"Identification type: This is the identification type of the registrant.  Specify 'ABN', 'ACN', or 'OTHER'. 'OTHER' refers to ARBN or Inc Association Number"},"x-au-domain-relation":{"type":"string","nullable":true,"enum":["1","2"],"description":"Eligibility type relationship: This indicates the relationship between the Eligibility Type (e.g. business name) and domain name"},"x-au-domain-relationtype":{"type":"string","description":"Eligibility type: The Eligibility Type"},"x-au-eligibility-idnumber":{"type":"string","description":"Identification number for the Eligibility: Specify the identification number as appropriate"},"x-au-eligibility-idtype":{"type":"string","nullable":true,"description":"Identification type: This is the identification type of the elibibility."},"x-au-eligibility-name":{"type":"string","description":"Eligibility Name: The Eligibility name"},"x-au-ext-given":{"type":"integer","format":"int32","description":".AU ext given"},"x-au-grandfathering-tld":{"type":"string","description":".AU grandfathering tld"},"x-au-import-token":{"type":"integer","format":"int32","description":".AU import token"},"x-au-owner-organization":{"type":"string","nullable":true,"description":"Owner Organization: The Organization name"},"x-au-priority-token":{"type":"string","description":".AU priority token"},"x-backorder-auction-status":{"type":"string","enum":["PENDING","WON","LOST","FAILED","SUCCESSFUL"],"description":"Backorder auction status: Backorder auction status"},"x-backorder-finalization-date":{"type":"string","format":"date-time","description":"Backorder finalization date: Backorder finalization date of the domain name"},"x-domain-blocking-ipr-id":{"type":"string","nullable":true,"description":"IPR Number"},"x-domain-roid":{"type":"string","description":"Domain Registry Roid"},"x-intended-use":{"type":"string","description":"intended use"},"x-launch-accepted-date":{"type":"string","format":"date-time","description":"launch accepted date"},"x-launch-expiry-date":{"type":"string","description":"launch expiry date"},"x-launch-notice-id":{"type":"string","description":"launch notice id"},"x-nicse-idnumber":{"type":"string","description":"Personal or organisational number: Personal or organisational number."},"x-nicse-vatid":{"type":"string","description":"VAT number: VAT number"},"x-nu-iis-idno":{"type":"string","description":"ID number: ID number"},"x-nu-iis-vatno":{"type":"string","nullable":true,"description":"Vatnumber: VAT number."},"x-swiss-owner-type":{"type":"string","description":".SWISS owner type"},"x-swiss-uid":{"type":"string","description":".SWISS uid"},"x-trademark-entitlement":{"type":"string","description":"Trademark Entitlement: Trademark Entitlement"},"x-trademark-locality":{"type":"string","description":"Trademark Locality: Trademark Locality"},"x-trademark-name":{"type":"string","description":"Trademark Name: Trademark Name"},"x-trademark-number":{"type":"string","description":"Trademark Number: Trademark Number"},"x-trademark-reg-date":{"type":"string","format":"date-time","description":"Trademark Registration date: Trademark Registration date"},"x-trademark-right-type":{"type":"string","description":"Trademark Right Type: Trademark Right Type"},"x-xxx-sunrise-b-on-expiry-action":{"type":"string","nullable":true,"description":"ON-EXPIRY-ACTION: CONVERTTOADULTBLOCKPLUS"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusDomainApplication"}},"/domain/{domain}/auction":{"delete":{"operationId":"closeDomainAuction","summary":"XRRP command CloseDomainAuction (closeDomainAuction)","description":"External API command for auction handling\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"Domain: Domain name of the auction","schema":{"type":"string","description":"Domain: Domain name of the auction"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"modify":{"type":"string","enum":["SUCCESS","FAILED"],"description":"Modify: Result of the domain name modification process"},"renew":{"type":"string","enum":["SUCCESS","FAILED"],"description":"Renew: Result of the domain name renewal process"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CloseDomainAuction"}},"/domain/{domain}/authcode":{"patch":{"operationId":"setAuthCode","summary":"XRRP command SetAuthCode (setAuthCode)","description":"This command allows to set an authinfo for .de domains or request the authcode for .eu/.xn--e1a4c, .be, com.sg, .sg and .priv.no domains. There are different actions depending on the TLD: \nFor .de, there are two different types of authinfos. Type 1 can only be set by the current provider. Type 2 can be set by any provider and will be sent per mail to the german owner or admin. Remember that the type 2 authinfo will be charged from your account!\nAuthinfo type2 cannot be deleted!\nAll authinfo expire 30 days after creation and should only be set if the domain is up for a transfer.\nFor .eu/.xn--e1a4c/.xn--qxa6a domains, authcodes can be requested and deleted, they will expire after 1 week.\nFor .be domains, requested authcodes will be send to the owner by email and those authcodes are valid for 1 week.\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"Domain: the domain for which the authinfo will be set","schema":{"type":"string","description":"Domain: the domain for which the authinfo will be set"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","nullable":true,"enum":["SET","DELETE"],"description":"Action"},"auth":{"type":"string","nullable":true,"description":"Authentication code: the authinfo. 0, 1, I, O, o, l, are no valid characters for .de domains!"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"type":{"type":"string","nullable":true,"enum":["1","2"],"description":"Type"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string"},"auth_expiration_date":{"type":"string","format":"date-time","description":"Auth expiration date"},"error":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"SetAuthCode"}},"/domain/{domain}/availability":{"get":{"operationId":"checkDomain","summary":"XRRP command CheckDomain (checkDomain)","description":"This command checks if the desired domain name is available and may be registered at the registry.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"Domain name to be checked for availability","schema":{"type":"string","description":"Domain name to be checked for availability"}},{"name":"x-idn-language","in":"query","description":"IDN encoding used for the domainname","schema":{"type":"string","nullable":true,"description":"IDN encoding used for the domainname"}},{"name":"x-fee-command","in":"query","description":"Command name for fee extension check.","schema":{"type":"array","description":"Command name for fee extension check.","items":{"type":"string","nullable":true,"description":"Command name for fee extension check."}}},{"name":"x-fee-domain","in":"query","description":"Domain name for fee extension check.","schema":{"type":"array","description":"Domain name for fee extension check.","items":{"type":"string","nullable":true,"description":"Domain name for fee extension check."}}},{"name":"x-fee-period","in":"query","description":"Period for fee extension check. Default is 1.","schema":{"type":"array","description":"Period for fee extension check. Default is 1.","items":{"type":"integer","format":"int32","nullable":true,"description":"Period for fee extension check. Default is 1."}}},{"name":"x-fee-periodtype","in":"query","description":"Periodtype for fee extension check. Default is YEAR.","schema":{"type":"array","description":"Periodtype for fee extension check. Default is YEAR.","items":{"type":"string","nullable":true,"description":"Periodtype for fee extension check. Default is YEAR."}}},{"name":"x-fee-currency","in":"query","description":"Currency for the fee extension check. Default is the own account currency.","schema":{"type":"array","description":"Currency for the fee extension check. Default is the own account currency.","items":{"type":"string","nullable":true,"description":"Currency for the fee extension check. Default is the own account currency."}}},{"name":"x-fee-launchphase","in":"query","description":"Launchphase for the fee extension check. Default is no launchphase.","schema":{"type":"array","description":"Launchphase for the fee extension check. Default is no launchphase.","items":{"type":"string","nullable":true,"description":"Launchphase for the fee extension check. Default is no launchphase."}}},{"name":"x-allocation-token","in":"query","description":"Allocation token provided by the registry","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Allocation token provided by the registry"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"aftermarket_currency":{"type":"string","nullable":true,"description":"Premium Price Currency if aftermarket possible: Premium Price Currency if Aftermarket is possible for domain"},"aftermarket_info":{"type":"string","nullable":true,"description":"Information if Aftermarket is possible: Information if Aftermarket is possible"},"aftermarket_price":{"type":"string","format":"decimal","nullable":true,"description":"Premium Price if aftermarket possible: Premium Price if Aftermarket is possible for domain"},"error":{"type":"string","description":"Error"},"x-allocation-token":{"type":"string","nullable":true,"description":"Allocation Token: Allocation Token"},"x-amazon-link":{"type":"array","description":"Link to Amazon Registry for validation process: Link to Amazon Registry for validation process","items":{"type":"string","nullable":true,"description":"Link to Amazon Registry for validation process: Link to Amazon Registry for validation process"}},"x-fee-amount":{"type":"array","description":"X-FEE-AMOUNT: The amount that will be charged.","items":{"type":"string","format":"decimal","nullable":true,"description":"X-FEE-AMOUNT: The amount that will be charged."}},"x-fee-application":{"type":"array","description":"X-FEE-APPLICATION: The non-refundable amount that will be charged.","items":{"type":"string","format":"decimal","nullable":true,"description":"X-FEE-APPLICATION: The non-refundable amount that will be charged."}},"x-fee-class":{"type":"array","description":"X-FEE-CURRENCY: The class of the X-FEE-DOMAIN.","items":{"type":"string","description":"X-FEE-CURRENCY: The class of the X-FEE-DOMAIN."}},"x-fee-command":{"type":"array","description":"X-FEE-CURRENCY: The command for the X-FEE prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The command for the X-FEE prices."}},"x-fee-currency":{"type":"array","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values.","items":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."}},"x-fee-domain":{"type":"array","description":"X-FEE-CURRENCY: The domain name for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The domain name for the prices."}},"x-fee-launchphase":{"type":"array","description":"X-FEE-CURRENCY: The launchphase for the prices.","items":{"type":"string","nullable":true,"description":"X-FEE-CURRENCY: The launchphase for the prices."}},"x-fee-period":{"type":"array","description":"X-FEE-CURRENCY: The period for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The period for the prices."}},"x-fee-periodtype":{"type":"array","description":"X-FEE-CURRENCY: The periodtype for the prices.","items":{"type":"string","description":"X-FEE-CURRENCY: The periodtype for the prices."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckDomain"}},"/domain/{domain}/disclosure":{"put":{"operationId":"requestToken_2","summary":"XRRP command RequestToken (requestToken_2)","description":"\n","tags":["contact","domain"],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"contact":{"type":"string"},"contacttype":{"type":"array","items":{"type":"string","nullable":true,"enum":["OWNER","ADMIN","TECH","BILLING"]}},"language":{"type":"string"},"registryaccount":{"type":"string"},"type":{"type":"string","enum":["CONTACTDISCLOSURE","REGISTRYACCOUNT"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"contact":{"type":"array","items":{"type":"string"}},"description":{"type":"array","items":{"type":"string"}},"expiry_date":{"type":"array","description":"Token expiry date","items":{"type":"string","description":"Token expiry date"}},"status":{"type":"array","items":{"type":"string"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RequestToken"}},"/domain/{domain}/history":{"get":{"operationId":"statusDomainHistory","summary":"XRRP command StatusDomainHistory (statusDomainHistory)","description":"This command enables you to get domain details of a deleted domain.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"The domain to get the latest history details for","schema":{"type":"string","description":"The domain to get the latest history details for"}},{"name":"historyid","in":"query","description":"The unique history id to get details for","schema":{"type":"integer","format":"int32","description":"The unique history id to get details for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"admin_contact":{"type":"array","description":"Administrative contact: Administrative contact(s) of this domain","items":{"type":"string","nullable":true,"description":"Administrative contact: Administrative contact(s) of this domain"}},"auth":{"type":"string","nullable":true,"description":"Auth"},"billing_contact":{"type":"array","description":"Billing contact: Billing contact(s) of this domain","items":{"type":"string","nullable":true,"description":"Billing contact: Billing contact(s) of this domain"}},"created_by":{"type":"string","nullable":true,"description":"Created by: Who created the domain in our system (EXTERNAL if it created by a transfer-in)"},"created_date":{"type":"string","format":"date-time","description":"Created date: When the domain was created at the registry if data available, otherwise: in our system"},"deleted_date":{"type":"string","format":"date-time","description":"Deleted date: When the domain was deleted at the registry"},"dnssec":{"type":"array","description":"DNSSEC KEYDATA: DNSSEC Public key","items":{"type":"string","nullable":true,"description":"DNSSEC KEYDATA: DNSSEC Public key"}},"dnssecdsdata":{"type":"array","description":"DNSSEC DSDATA: DNSSEC Delegation Signer (DS)","items":{"type":"string","nullable":true,"description":"DNSSEC DSDATA: DNSSEC Delegation Signer (DS)"}},"domain":{"type":"string","description":"Domain: ACE encoded version of the domainname"},"domaintag":{"type":"array","description":"Domain Tag: The domain tags associated with the domain.","items":{"type":"string","nullable":true,"description":"Domain Tag: The domain tags associated with the domain."}},"nameserver":{"type":"array","description":"Nameserver: Nameserver used for this domain","items":{"type":"string","nullable":true,"description":"Nameserver: Nameserver used for this domain"}},"owner_contact":{"type":"string","nullable":true,"description":"Owner contact: Owner contact of the domain"},"registrar_transfer_date":{"type":"string","format":"date-time","nullable":true,"description":"Transfer date: Last time, the domain was transfered (is available)"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Expiration date: The domain will expire in the registry on this date"},"renewal_date":{"type":"string","format":"date-time","description":"Renewal date"},"rgp_enddate":{"type":"array","description":"RGP End date: The date on which the RGP status ends","items":{"type":"string","format":"date","nullable":true,"description":"RGP End date: The date on which the RGP status ends"}},"rgp_status":{"type":"array","description":"RGP Status: Registry Grace Period (RGP) Status of the domain","items":{"type":"string","nullable":true,"description":"RGP Status: Registry Grace Period (RGP) Status of the domain"}},"roid":{"type":"string","description":"ROID: The ROID (Registry Object ID) is an unique identifier for the domain and will stay the same during the entire lifecycle in the system"},"status":{"type":"array","description":"Status: Status of the domain","items":{"type":"string","nullable":true,"description":"Status: Status of the domain"}},"tech_contact":{"type":"array","description":"Technical contact: Technical contact(s) of this domain","items":{"type":"string","nullable":true,"description":"Technical contact: Technical contact(s) of this domain"}},"updated_by":{"type":"string","nullable":true,"description":"Updated by: Who was the last one updating the domain"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When the domain was last updated, if never it's the same like the created date"},"x-accept-ssl-requirement":{"type":"integer","format":"int32","description":"X-accept-ssl-requirement"},"x-am-using-trustee":{"type":"integer","format":"int32","description":"X-am-using-trustee"},"x-au-domain-idnumber":{"type":"string","description":"X-au-domain-idnumber"},"x-au-domain-idtype":{"type":"string","description":"X-au-domain-idtype"},"x-au-domain-relation":{"type":"integer","format":"int32","description":"X-au-domain-relation"},"x-au-domain-relationtype":{"type":"string","description":"X-au-domain-relationtype"},"x-au-eligibility-idnumber":{"type":"string","description":"X-au-eligibility-idnumber"},"x-au-eligibility-idtype":{"type":"string","description":"X-au-eligibility-idtype"},"x-au-eligibility-name":{"type":"string","description":"X-au-eligibility-name"},"x-au-ineligibility-reason":{"type":"string","description":"X-au-ineligibility-reason"},"x-au-owner-organization":{"type":"string","description":"X-au-owner-organization"},"x-au-priority-token":{"type":"string","description":"X-au-priority-token"},"x-auction":{"type":"integer","format":"int32","description":"X-auction"},"x-auction-hold":{"type":"integer","format":"int32","description":"X-auction-hold"},"x-auth-expiry-date":{"type":"string","format":"date-time","description":"X-auth-expiry-date"},"x-auxcontact-registrarcontact":{"type":"string","description":"X-auxcontact-registrarcontact"},"x-auxcontact-registrycontact":{"type":"string","description":"X-auxcontact-registrycontact"},"x-be-contact-lang":{"type":"string","description":"X-be-contact-lang"},"x-br-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-br-accept-trustee-tac"},"x-br-register-number":{"type":"string","description":"X-br-register-number"},"x-ca-legal-type":{"type":"string","description":"X-ca-legal-type"},"x-ca-trademark":{"type":"integer","format":"int32","description":"X-ca-trademark"},"x-challenge-answer0":{"type":"string","description":"X-challenge-answer0"},"x-challenge-answer1":{"type":"string","description":"X-challenge-answer1"},"x-challenge-answer2":{"type":"string","description":"X-challenge-answer2"},"x-challenge-question0":{"type":"string","description":"X-challenge-question0"},"x-challenge-question1":{"type":"string","description":"X-challenge-question1"},"x-challenge-question2":{"type":"string","description":"X-challenge-question2"},"x-cn-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-cn-accept-trustee-tac"},"x-coza-autorenew":{"type":"string","description":"X-coza-autorenew"},"x-de-abuse-contact":{"type":"string","description":"X-de-abuse-contact"},"x-de-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-de-accept-trustee-tac"},"x-de-general-request":{"type":"string","description":"X-de-general-request"},"x-de-holder-extension":{"type":"integer","format":"int32","description":"X-de-holder-extension"},"x-de-holder-person":{"type":"integer","format":"int32","description":"X-de-holder-person"},"x-de-nsentry0":{"type":"string","description":"X-de-nsentry0"},"x-dispute":{"type":"integer","format":"int32","description":"X-dispute"},"x-dk-admin-id":{"type":"string","description":"X-dk-admin-id"},"x-dk-owner-id":{"type":"string","description":"X-dk-owner-id"},"x-dk-user-id-number":{"type":"string","description":"X-dk-user-id-number"},"x-dk-user-type":{"type":"string","description":"X-dk-user-type"},"x-dk-vat-id":{"type":"string","description":"X-dk-vat-id"},"x-dnsbe-contact-type":{"type":"string","description":"X-dnsbe-contact-type"},"x-domain-comment":{"type":"string","description":"X-domain-comment"},"x-domain-roid":{"type":"string","description":"X-domain-roid"},"x-eppgw-admin-id":{"type":"string","description":"X-eppgw-admin-id"},"x-eppgw-admin-updated":{"type":"string","format":"date-time","description":"X-eppgw-admin-updated"},"x-eppgw-billing-id":{"type":"string","description":"X-eppgw-billing-id"},"x-eppgw-billing-updated":{"type":"string","format":"date-time","description":"X-eppgw-billing-updated"},"x-eppgw-domain-updated":{"type":"string","format":"date-time","description":"X-eppgw-domain-updated"},"x-eppgw-owner-id":{"type":"string","description":"X-eppgw-owner-id"},"x-eppgw-owner-updated":{"type":"string","format":"date-time","description":"X-eppgw-owner-updated"},"x-eppgw-reseller-id":{"type":"integer","format":"int32","description":"X-eppgw-reseller-id"},"x-eppgw-tech-id":{"type":"string","description":"X-eppgw-tech-id"},"x-eppgw-tech-updated":{"type":"string","format":"date-time","description":"X-eppgw-tech-updated"},"x-es-admin-identificacion":{"type":"string","nullable":true,"description":"X-es-admin-identificacion"},"x-es-admin-legalform":{"type":"integer","format":"int32","nullable":true,"description":"X-es-admin-legalform"},"x-es-admin-tipo-identificacion":{"type":"integer","format":"int32","nullable":true,"description":"X-es-admin-tipo-identificacion"},"x-es-autorenew":{"type":"string","description":"X-es-autorenew"},"x-es-billing-identificacion":{"type":"string","nullable":true,"description":"X-es-billing-identificacion"},"x-es-billing-legalform":{"type":"integer","format":"int32","nullable":true,"description":"X-es-billing-legalform"},"x-es-billing-tipo-identificacion":{"type":"integer","format":"int32","nullable":true,"description":"X-es-billing-tipo-identificacion"},"x-es-owner-identificacion":{"type":"string","description":"X-es-owner-identificacion"},"x-es-owner-legalform":{"type":"integer","format":"int32","description":"X-es-owner-legalform"},"x-es-owner-tipo-identificacion":{"type":"integer","format":"int32","description":"X-es-owner-tipo-identificacion"},"x-es-person":{"type":"integer","format":"int32","description":"X-es-person"},"x-es-registrant-identificacion":{"type":"string","description":"X-es-registrant-identificacion"},"x-es-registrant-tipo-identificacion":{"type":"integer","format":"int32","description":"X-es-registrant-tipo-identificacion"},"x-es-tech-identificacion":{"type":"string","nullable":true,"description":"X-es-tech-identificacion"},"x-es-tech-legalform":{"type":"integer","format":"int32","nullable":true,"description":"X-es-tech-legalform"},"x-es-tech-tipo-identificacion":{"type":"integer","format":"int32","nullable":true,"description":"X-es-tech-tipo-identificacion"},"x-eu-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-eu-accept-trustee-tac"},"x-eu-contact-type":{"type":"string","description":"X-eu-contact-type"},"x-eu-registrant-citizenship":{"type":"string","description":"X-eu-registrant-citizenship"},"x-eu-registrant-lang":{"type":"string","description":"X-eu-registrant-lang"},"x-eu-status":{"type":"string","nullable":true,"description":"X-eu-status"},"x-fee-amount":{"type":"string","format":"decimal","description":"X-fee-amount"},"x-fee-class":{"type":"string","description":"X-fee-class"},"x-fee-command":{"type":"string","description":"X-fee-command"},"x-fee-currency":{"type":"string","description":"X-fee-currency"},"x-fee-domain":{"type":"string","description":"X-fee-domain"},"x-fee-period":{"type":"integer","format":"int32","description":"X-fee-period"},"x-fee-periodtype":{"type":"string","description":"X-fee-periodtype"},"x-fee-tier":{"type":"string","description":"X-fee-tier"},"x-fi-birthdate":{"type":"string","format":"date","description":"X-fi-birthdate"},"x-fi-company-reg-id":{"type":"string","description":"X-fi-company-reg-id"},"x-fr-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-fr-accept-trustee-tac"},"x-fr-birthcity":{"type":"string","description":"X-fr-birthcity"},"x-fr-birthdate":{"type":"string","format":"date","description":"X-fr-birthdate"},"x-fr-birthpc":{"type":"integer","format":"int32","description":"X-fr-birthpc"},"x-fr-birthplace":{"type":"string","description":"X-fr-birthplace"},"x-fr-duns":{"type":"integer","format":"int32","description":"X-fr-duns"},"x-fr-no-pre-zonecheck":{"type":"integer","format":"int32","description":"X-fr-no-pre-zonecheck"},"x-fr-registrant-identification-status":{"type":"string","description":"X-fr-registrant-identification-status"},"x-fr-registrant-reachable-mail":{"type":"integer","format":"int32","description":"X-fr-registrant-reachable-mail"},"x-fr-restrict-pub":{"type":"integer","format":"int32","description":"X-fr-restrict-pub"},"x-fr-set-registrant-identification-status":{"type":"integer","format":"int32","description":"X-fr-set-registrant-identification-status"},"x-fr-set-registrant-reachable-mail":{"type":"integer","format":"int32","description":"X-fr-set-registrant-reachable-mail"},"x-fr-siren-or-siret":{"type":"string","description":"X-fr-siren-or-siret"},"x-fr-trademark":{"type":"string","description":"X-fr-trademark"},"x-fr-vatid":{"type":"string","description":"X-fr-vatid"},"x-fr-waldec":{"type":"string","description":"X-fr-waldec"},"x-gd-auction-delete":{"type":"integer","format":"int32","description":"X-gd-auction-delete"},"x-hk-domain-category":{"type":"string","description":"X-hk-domain-category"},"x-hk-owner-age-over-18":{"type":"string","description":"X-hk-owner-age-over-18"},"x-hk-owner-document-number":{"type":"string","description":"X-hk-owner-document-number"},"x-hk-owner-document-origin-country":{"type":"string","description":"X-hk-owner-document-origin-country"},"x-hk-owner-document-type":{"type":"string","description":"X-hk-owner-document-type"},"x-hk-owner-other-document-type":{"type":"string","description":"X-hk-owner-other-document-type"},"x-hu-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-hu-accept-trustee-tac"},"x-hu-idcard-or-passport-number":{"type":"string","description":"X-hu-idcard-or-passport-number"},"x-hu-vat-number":{"type":"string","description":"X-hu-vat-number"},"x-hx-proxy-contact":{"type":"string","description":"X-hx-proxy-contact"},"x-idn-language":{"type":"string","description":"X-idn-language"},"x-ie-applicant":{"type":"string","description":"X-ie-applicant"},"x-ie-applicant-class":{"type":"string","description":"X-ie-applicant-class"},"x-ie-contact-type":{"type":"string","description":"X-ie-contact-type"},"x-ie-cro-number":{"type":"integer","format":"int32","description":"X-ie-cro-number"},"x-ie-owner-remarks":{"type":"string","description":"X-ie-owner-remarks"},"x-ie-ticket-id":{"type":"string","description":"X-ie-ticket-id"},"x-ie-ticket-status":{"type":"string","description":"X-ie-ticket-status"},"x-ie-validation-status":{"type":"string","description":"X-ie-validation-status"},"x-ignore-contactverification":{"type":"integer","format":"int32","description":"X-ignore-contactverification"},"x-intended-use":{"type":"string","description":"X-intended-use"},"x-internal-errp-deletion-phase":{"type":"integer","format":"int32","description":"X-internal-errp-deletion-phase"},"x-internal-errp-dns-interruption":{"type":"integer","format":"int32","description":"X-internal-errp-dns-interruption"},"x-internal-suspension":{"type":"integer","format":"int32","description":"X-internal-suspension"},"x-ipr-type":{"type":"string","description":"X-ipr-type"},"x-it-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-it-accept-trustee-tac"},"x-it-consentforpublishing":{"type":"integer","format":"int32","description":"X-it-consentforpublishing"},"x-it-entity-type":{"type":"integer","format":"int32","description":"X-it-entity-type"},"x-it-nationality":{"type":"string","description":"X-it-nationality"},"x-it-pin":{"type":"string","description":"X-it-pin"},"x-it-sect3-liability":{"type":"integer","format":"int32","description":"X-it-sect3-liability"},"x-it-sect5-personal-data-for-registration":{"type":"integer","format":"int32","description":"X-it-sect5-personal-data-for-registration"},"x-it-sect6-personal-data-for-diffusion":{"type":"integer","format":"int32","description":"X-it-sect6-personal-data-for-diffusion"},"x-it-sect7-explicit-acceptance":{"type":"integer","format":"int32","description":"X-it-sect7-explicit-acceptance"},"x-lt-company-number":{"type":"string","description":"X-lt-company-number"},"x-lv-admin-regnr":{"type":"string","description":"X-lv-admin-regnr"},"x-lv-owner-regnr":{"type":"string","description":"X-lv-owner-regnr"},"x-moniker-id":{"type":"integer","format":"int32","description":"X-moniker-id"},"x-my-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-my-accept-trustee-tac"},"x-nicse-clientdelete":{"type":"integer","format":"int32","description":"X-nicse-clientdelete"},"x-nicse-idnumber":{"type":"string","description":"X-nicse-idnumber"},"x-nicse-vatid":{"type":"string","description":"X-nicse-vatid"},"x-nl-legalform":{"type":"string","description":"X-nl-legalform"},"x-nl-legalformregno":{"type":"string","description":"X-nl-legalformregno"},"x-nl-limited":{"type":"integer","format":"int32","description":"X-nl-limited"},"x-nl-optout":{"type":"integer","format":"int32","description":"X-nl-optout"},"x-no-accept-date":{"type":"string","description":"X-no-accept-date"},"x-no-consenting-person-name":{"type":"string","description":"X-no-consenting-person-name"},"x-no-declaration-timestamp":{"type":"string","description":"X-no-declaration-timestamp"},"x-no-declaration-version":{"type":"string","format":"decimal","description":"X-no-declaration-version"},"x-no-org-contact":{"type":"string","description":"X-no-org-contact"},"x-no-organization-number":{"type":"integer","format":"int32","description":"X-no-organization-number"},"x-no-person-identifier":{"type":"string","description":"X-no-person-identifier"},"x-no-registrant-identity":{"type":"integer","format":"int32","description":"X-no-registrant-identity"},"x-nu-auth-expirationdate":{"type":"string","format":"date-time","description":"X-nu-auth-expirationdate"},"x-nu-force-trade":{"type":"integer","format":"int32","description":"X-nu-force-trade"},"x-nu-iis-idno":{"type":"string","description":"X-nu-iis-idno"},"x-nu-owner-name":{"type":"string","description":"X-nu-owner-name"},"x-nu-owner-organization":{"type":"string","description":"X-nu-owner-organization"},"x-nz-privacy":{"type":"string","description":"X-nz-privacy"},"x-old-dnssec-dsdata":{"type":"string","description":"X-old-dnssec-dsdata"},"x-old-dnssec-keydata":{"type":"string","description":"X-old-dnssec-keydata"},"x-old-dnssec-keydata0":{"type":"string","description":"X-old-dnssec-keydata0"},"x-old-nameserver0":{"type":"string","description":"X-old-nameserver0"},"x-old-nameserver1":{"type":"string","description":"X-old-nameserver1"},"x-old-nameserver2":{"type":"string","description":"X-old-nameserver2"},"x-old-nameserver3":{"type":"string","description":"X-old-nameserver3"},"x-old-nameserver4":{"type":"string","description":"X-old-nameserver4"},"x-old-nameserver5":{"type":"string","description":"X-old-nameserver5"},"x-old-nameserver6":{"type":"string","description":"X-old-nameserver6"},"x-old-nameserver7":{"type":"string","description":"X-old-nameserver7"},"x-orderid":{"type":"integer","format":"int32","description":"X-orderid"},"x-prepayment-seconds":{"type":"integer","format":"int32","description":"X-prepayment-seconds"},"x-pt-autorenew":{"type":"integer","format":"int32","description":"X-pt-autorenew"},"x-pt-owner-identification":{"type":"string","description":"X-pt-owner-identification"},"x-pt-tech-identification":{"type":"string","description":"X-pt-tech-identification"},"x-request-authcode":{"type":"integer","format":"int32","description":"X-request-authcode"},"x-ro-company-number":{"type":"string","description":"X-ro-company-number"},"x-ro-idcard-or-passport-number":{"type":"string","description":"X-ro-idcard-or-passport-number"},"x-ro-vat-number":{"type":"string","description":"X-ro-vat-number"},"x-ru-autorenew":{"type":"integer","format":"int32","description":"X-ru-autorenew"},"x-ru-birthdate":{"type":"string","description":"X-ru-birthdate"},"x-ru-code":{"type":"string","description":"X-ru-code"},"x-ru-contract":{"type":"string","description":"X-ru-contract"},"x-ru-firstname":{"type":"string","description":"X-ru-firstname"},"x-ru-kpp":{"type":"integer","format":"int32","description":"X-ru-kpp"},"x-ru-lastname":{"type":"string","description":"X-ru-lastname"},"x-ru-middlename":{"type":"string","description":"X-ru-middlename"},"x-ru-organization":{"type":"string","description":"X-ru-organization"},"x-ru-passportdata":{"type":"string","description":"X-ru-passportdata"},"x-ru-suspend-date":{"type":"string","format":"date","description":"X-ru-suspend-date"},"x-sg-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-sg-accept-trustee-tac"},"x-sg-admin-singpassid":{"type":"string","description":"X-sg-admin-singpassid"},"x-sg-verification-status":{"type":"string","description":"X-sg-verification-status"},"x-sk-accept-trustee-tac":{"type":"integer","format":"int32","description":"X-sk-accept-trustee-tac"},"x-sk-contact-ident-number":{"type":"string","description":"X-sk-contact-ident-number"},"x-sk-contact-legal-form":{"type":"string","description":"X-sk-contact-legal-form"},"x-swiss-uid":{"type":"string","description":"X-swiss-uid"},"x-tel-publish-whois":{"type":"integer","format":"int32","description":"X-tel-publish-whois"},"x-tel-whoistype":{"type":"string","description":"X-tel-whoistype"},"x-time-to-suspension":{"type":"string","format":"date-time","description":"X-time-to-suspension"},"x-time-to-transfer-lock":{"type":"string","format":"date-time","description":"X-time-to-transfer-lock"},"x-transferlock-until":{"type":"string","format":"date-time","description":"X-transferlock-until"},"x-travel-industry":{"type":"string","description":"X-travel-industry"},"x-trustee-comment":{"type":"string","description":"X-trustee-comment"},"x-uk-next-bill":{"type":"integer","format":"int32","description":"X-uk-next-bill"},"x-uk-owner-corporate-number":{"type":"integer","format":"int32","description":"X-uk-owner-corporate-number"},"x-uk-owner-corporate-type":{"type":"string","description":"X-uk-owner-corporate-type"},"x-uk-validation":{"type":"integer","format":"int32","description":"X-uk-validation"},"x-us-nexus-apppurpose":{"type":"string","description":"X-us-nexus-apppurpose"},"x-us-nexus-category":{"type":"string","description":"X-us-nexus-category"},"x-us-nexus-validator":{"type":"string","description":"X-us-nexus-validator"},"x-useproxy":{"type":"integer","format":"int32","description":"X-useproxy"},"x-wdrp-rsp":{"type":"string","description":"X-wdrp-rsp"},"x-whois-banner0":{"type":"string","description":"X-whois-banner0"},"x-whois-banner1":{"type":"string","description":"X-whois-banner1"},"x-whois-banner2":{"type":"string","description":"X-whois-banner2"},"x-whois-privacy":{"type":"integer","format":"int32","description":"X-whois-privacy"},"x-whois-rsp":{"type":"string","description":"X-whois-rsp"},"x-whois-url":{"type":"string","description":"X-whois-url"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusDomainHistory"}},"/domain/{domain}/ownerchange":{"get":{"operationId":"queryOwnerchangeList_2","summary":"XRRP command QueryOwnerchangeList (queryOwnerchangeList_2)","description":"\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"Filter the result by this string (wildcards allowed)","schema":{"type":"string","description":"Filter the result by this string (wildcards allowed)"}},{"name":"status","in":"query","description":"Filter the result by this string (wildcards allowed)","schema":{"type":"string","description":"Filter the result by this string (wildcards allowed)"}},{"name":"trigger","in":"query","description":"Filter the result by this trigger code","schema":{"type":"string","nullable":true,"description":"Filter the result by this trigger code"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["DOMAIN"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","nullable":true,"description":"Domain: A domain matching the search - filter"},"gaining_registrant":{"type":"string","description":"Gaining registrant: Ownerchange gaining registrant"},"losing_registrant":{"type":"string","description":"Losing registrant: Ownerchange losing registrant"},"request_date":{"type":"string","format":"date-time","description":"Request date"},"request_expiration_date":{"type":"string","format":"date-time","description":"Request expiration date"},"status":{"type":"integer","format":"int32","description":"Status: Ownerchange status"},"template_en":{"type":"string","description":"Template en"}}}},"property":{"type":"object","properties":{"contact_changes":{"type":"array","description":"Contact changes","items":{"type":"string","description":"Contact changes"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of domains shown"},"expiration_date":{"type":"string","format":"date","description":"Expiration date: Ownerchange expiration date"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"requested_date":{"type":"string","format":"date","description":"Requested date: Ownerchange request date"},"template_de":{"type":"array","description":"Template de","items":{"type":"string","description":"Template de"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of domains matching the criteria"},"transferlock_remove_until_date":{"type":"string","format":"date-time","description":"Transferlock remove until date"},"transferlock_until_date":{"type":"string","format":"date-time","description":"Transferlock until date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryOwnerchangeList"}},"/domain/{domain}/pin":{"post":{"operationId":"requestDomainPin","summary":"XRRP command RequestDomainPin (requestDomainPin)","description":"\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"The domain name for the requested pin code.","schema":{"type":"string","description":"The domain name for the requested pin code."}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"language":{"type":"string","nullable":true,"enum":["EN","DE"],"description":"The language for the requested pin code."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"mobilenr":{"type":"string","description":"Mobile number: Masked mobile number where the SMS has been sent to"},"smsid":{"type":"integer","format":"int32","description":"SMS ID: ID of the SMS (only available on a successful status)"},"status":{"type":"string","description":"Status: Status of the domain pin SMS"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RequestDomainPin"},"put":{"operationId":"setDomainPinLock","summary":"XRRP command SetDomainPinLock (setDomainPinLock)","description":"\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"The domain name where pin lock will be activated.","schema":{"type":"string","description":"The domain name where pin lock will be activated."}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"authoritynumber":{"type":"string","nullable":true,"description":"The mobile number that will be used for the domain pin lock service."},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"language":{"type":"string","nullable":true,"enum":["EN","DE"],"description":"The language for the requested pin lock."},"pinlock":{"type":"string","enum":["0","1"],"description":"Flag to activate or deactivate the domain pin lock service."},"token":{"type":"string","nullable":true,"description":"The verify token to actiavte the domain pin lock service."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"info":{"type":"string","description":"Info: Information about the domain pin lock request."},"mobilenr":{"type":"string","description":"Mobile number: Masked mobile number where the activate domain pin lock SMS has been sent to"},"smsid":{"type":"integer","format":"int32","description":"SMS ID: ID of the activate domain pin lock SMS (only available on a successful status)"},"status":{"type":"string","description":"Status: Status of the activate domain pin lock SMS"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"SetDomainPinLock"}},"/domain/{domain}/premium":{"delete":{"operationId":"deletePremiumDomain","summary":"XRRP command DeletePremiumDomain (deletePremiumDomain)","description":"Delete a premium domain price and remove the domain from the premium domain list\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"The domain name of the premium price","schema":{"type":"string","nullable":true,"description":"The domain name of the premium price"}},{"name":"launchphase","in":"query","description":"launchphase for the premium domain name in application phase.","schema":{"type":"string","nullable":true,"description":"launchphase for the premium domain name in application phase."}},{"name":"registryaccount","in":"query","description":"The registryaccount for the price.","schema":{"type":"string","nullable":true,"description":"The registryaccount for the price."}},{"name":"operator","in":"query","description":"The username that will be logged in the price history","schema":{"type":"string","nullable":true,"description":"The username that will be logged in the price history"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeletePremiumDomain"},"get":{"operationId":"statusPremiumDomain","summary":"XRRP command StatusPremiumDomain (statusPremiumDomain)","description":"This command returns the premium domain prices for a domain name\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"The domain to get premium price details for","schema":{"type":"string","description":"The domain to get premium price details for"}},{"name":"launchphase","in":"query","description":"the launchphase for the premium domain name in application phase.","schema":{"type":"string","nullable":true,"description":"the launchphase for the premium domain name in application phase."}},{"name":"registryaccount","in":"query","description":"The registryaccount for the premium domain price.","schema":{"type":"string","nullable":true,"description":"The registryaccount for the premium domain price."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"application":{"type":"string","format":"decimal","nullable":true,"description":"Application: Application fee"},"currency":{"type":"string","description":"Currency: Currency"},"domain":{"type":"string","description":"Domain: Domain"},"launchphase":{"type":"string","nullable":true,"description":"Launchphase: Zone"},"periodtype":{"type":"string","description":"Periodtype: Periodtype of the price"},"restore":{"type":"string","format":"decimal","nullable":true,"description":"Restore: Restore fee"},"setup":{"type":"string","format":"decimal","nullable":true,"description":"Setup: Setup fee"},"trade":{"type":"string","format":"decimal","nullable":true,"description":"Trade: Trade fee"},"transfer":{"type":"string","format":"decimal","nullable":true,"description":"Transfer: Transfer fee"},"unit":{"type":"string","format":"decimal","nullable":true,"description":"Unit: Unit fee"},"zone":{"type":"string","description":"Zone: Zone"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusPremiumDomain"},"patch":{"operationId":"modifyPremiumDomain","summary":"XRRP command ModifyPremiumDomain (modifyPremiumDomain)","description":"Modify a premium domain price or add a pending change\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"Domain: The domain name to modify the premium price","schema":{"type":"string","nullable":true,"description":"Domain: The domain name to modify the premium price"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"application":{"type":"string","format":"decimal","nullable":true,"description":"Application: The non refundable setupfee"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"comment":{"type":"string","nullable":true,"description":"Comment: The comment that will be logged in the price history"},"currency":{"type":"string","nullable":true,"description":"Currency: The currency for the premium domain pricing"},"date":{"type":"string","format":"date","nullable":true,"description":"Execution date: The date when the change will be applied"},"launchphase":{"type":"string","nullable":true,"description":"Launchphase: The launchphase for the price"},"operator":{"type":"string","nullable":true,"description":"The username that will be logged in the price history"},"registryaccount":{"type":"string","nullable":true,"description":"Registryaccount: The registryaccount for the price."},"restore":{"type":"string","format":"decimal","nullable":true,"description":"Restore: The restore fee"},"setup":{"type":"string","format":"decimal","nullable":true,"description":"Setup: The setup fee"},"trade":{"type":"string","format":"decimal","nullable":true,"description":"Trade: The trade fee"},"transfer":{"type":"string","format":"decimal","nullable":true,"description":"Transfer: The transfer unit fee"},"unit":{"type":"string","format":"decimal","nullable":true,"description":"Unit: The unit fee"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyPremiumDomain"}},"/domain/{domain}/premium/availability":{"get":{"operationId":"checkPremiumDomain","summary":"XRRP command CheckPremiumDomain (checkPremiumDomain)","description":"Check if the given domain name is a premium domain name\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"The domain name that will be checked","schema":{"type":"string","nullable":true,"description":"The domain name that will be checked"}},{"name":"launchphase","in":"query","description":"launchphase for the premium domain name in application phase.","schema":{"type":"string","nullable":true,"description":"launchphase for the premium domain name in application phase."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"premium":{"type":"string","enum":["0","1"],"description":"Premium: Shows if the given domain name is a premium domain name"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckPremiumDomain"}},"/domain/{domain}/price":{"get":{"operationId":"domainPrice","summary":"XRRP command DomainPrice (domainPrice)","description":"The DomainPrice command can be used to get the amount that will be charged for a domain for a specific action.\n","tags":["domain"],"parameters":[{"name":"period","in":"query","description":"The period that will be calculated. Default is 1. For monthly prices use period+M as period.","schema":{"type":"string","nullable":true,"description":"The period that will be calculated. Default is 1. For monthly prices use period+M as period."}},{"name":"periodtype","in":"query","description":"The periodtype that will be uset to calculate the prices. Default is YEAR.","schema":{"type":"string","nullable":true,"description":"The periodtype that will be uset to calculate the prices. Default is YEAR."}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"Domain the price should be calculated for","schema":{"type":"string","description":"Domain the price should be calculated for"}},{"name":"type","in":"query","description":"The price for a specific action.","schema":{"type":"string","nullable":true,"enum":["ADDDOMAIN","RENEWDOMAIN","TRANSFERDOMAIN","TRADEDOMAIN","RESTOREDOMAIN","ADD","RENEW","TRANSFER","TRADE","RESTORE"],"description":"The price for a specific action."}},{"name":"x-promotion-code","in":"query","description":"Promotion code to be used for calculating the price","schema":{"type":"string","nullable":true,"description":"Promotion code to be used for calculating the price"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"annual":{"type":"string","format":"decimal","description":"Annual fee: period fee to be paid for this domain"},"application":{"type":"string","format":"decimal","nullable":true,"description":"Application fee: Non refundable setupfee for this domain"},"currency":{"type":"string","description":"Currency: Currency of the prices for this domain"},"domain":{"type":"string","description":"Domain: The domain for the pricing"},"exchangerate":{"type":"number","format":"float","nullable":true,"description":"Exchange rate: Exchange rate used to calculate the domain price"},"nonrefundable":{"type":"string","format":"decimal","nullable":true,"description":"NONREFUNDABLE: The nonrefundable part of the price for this accounting"},"period":{"type":"integer","format":"int32","description":"Period: The period amount calculated for the price"},"periodtype":{"type":"string","description":"Periodtype: The periodtype for pricing"},"premium":{"type":"string"},"price":{"type":"string","format":"decimal","nullable":true,"description":"Price: The amount that will be charged for this type and this domain from your account."},"promotion":{"type":"array","description":"Promotion: Promotion used to calculate the price","items":{"type":"string","description":"Promotion: Promotion used to calculate the price"}},"restore":{"type":"string","format":"decimal","nullable":true,"description":"Restore fee: Fee charged for restores if possible"},"setup":{"type":"string","format":"decimal","nullable":true,"description":"Setup fee: Refundabel setup fee to be paid for this domain"},"trade":{"type":"string","format":"decimal","nullable":true,"description":"Trade fee: Trade fee for this domain (if available)"},"transfer":{"type":"string","format":"decimal","nullable":true,"description":"Transfer fee: Transfer fee for this domain"},"type":{"type":"string","description":"Type: The type which is calculated. Add, renew, transfer, trade or restore."},"vat":{"type":"string","format":"decimal","nullable":true,"description":"VAT: The vat that will be charged for this type and this domain from your account."},"vatnonrefundable":{"type":"string","format":"decimal","nullable":true,"description":"VATNONREFUNDABLE: The nonrefundable part of the vat for this accounting"},"vatpercent":{"type":"number","format":"float","nullable":true,"description":"VAT: VAT % that will be charged"},"zone":{"type":"string","description":"Zone: Zone of the domain"},"zonecurrency":{"type":"string","description":"Zone currency: Price currency of the zone"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DomainPrice"}},"/domain/{domain}/prices":{"get":{"operationId":"domainPrices_2","summary":"XRRP command DomainPrices (domainPrices_2)","description":"The DomainPrices command can be used to get all prices for a domainname for all types and periods.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"Domain the prices should be calculated for","schema":{"type":"string","description":"Domain the prices should be calculated for"}},{"name":"x-promotion-code","in":"query","description":"Promotion code to be used for calculating the prices","schema":{"type":"string","nullable":true,"description":"Promotion code to be used for calculating the prices"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"currency":{"type":"array","description":"Currency: Currency of the prices for this domain","items":{"type":"string","description":"Currency: Currency of the prices for this domain"}},"domain":{"type":"array","description":"Domain: The domain for the pricingis","items":{"type":"string","description":"Domain: The domain for the pricingis"}},"exchangerate":{"type":"array","description":"Exchange rate: Exchange rate used to calculate the domain price","items":{"type":"number","format":"float","description":"Exchange rate: Exchange rate used to calculate the domain price"}},"nonrefundable":{"type":"array","description":"NONREFUNDABLE: The nonrefundable part of the price","items":{"type":"string","format":"decimal","description":"NONREFUNDABLE: The nonrefundable part of the price"}},"period":{"type":"array","description":"Period: The period of the price","items":{"type":"integer","format":"int32","description":"Period: The period of the price"}},"periodtype":{"type":"array","description":"Periodtype: The periodtype for this price.","items":{"type":"string","description":"Periodtype: The periodtype for this price."}},"premium":{"type":"array","description":"Premium domain name: Price is a premium domain price","items":{"type":"string","enum":["0","1"],"description":"Premium domain name: Price is a premium domain price"}},"price":{"type":"array","description":"Price: The amount that will be charged.","items":{"type":"string","format":"decimal","description":"Price: The amount that will be charged."}},"promotion":{"type":"array","description":"Promotion used: Promotion is used to calculate the price","items":{"type":"string","enum":["0","1"],"description":"Promotion used: Promotion is used to calculate the price"}},"type":{"type":"array","description":"Type: The type of the price.","items":{"type":"string","description":"Type: The type of the price."}},"vat":{"type":"array","description":"VAT: The vat amount that will be charged for this price.","items":{"type":"string","format":"decimal","description":"VAT: The vat amount that will be charged for this price."}},"vatnonrefundable":{"type":"array","description":"VATNONREFUNDABLE: The nonrefundable part of the vat","items":{"type":"string","format":"decimal","description":"VATNONREFUNDABLE: The nonrefundable part of the vat"}},"vatpercent":{"type":"array","description":"VAT percentage: VAT % that will be charged","items":{"type":"number","format":"float","description":"VAT percentage: VAT % that will be charged"}},"zone":{"type":"array","description":"Zone: Zone of the domain","items":{"type":"string","description":"Zone: Zone of the domain"}},"zonecurrency":{"type":"array","description":"Zone currency: Price currency of the zone","items":{"type":"string","description":"Zone currency: Price currency of the zone"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DomainPrices"}},"/domain/{domain}/push/{target}":{"patch":{"operationId":"pushDomain","summary":"XRRP command PushDomain (pushDomain)","description":"The Push Domain is used to send .DE / .AT domains to transit / billwithdraw status and to change the tag or delete a .UK domain.\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"The domain name to be pushed","schema":{"type":"string","description":"The domain name to be pushed"}},{"name":"target","in":"path","required":true,"description":"Where to push the domain","schema":{"type":"string","description":"Where to push the domain"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"token":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"job_id":{"type":"string"},"roid":{"type":"string"},"transfer_status":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"PushDomain"}},"/domain/{domain}/registration":{"post":{"operationId":"activateDomainRegistration","summary":"XRRP command ActivateDomainRegistration (activateDomainRegistration)","description":"This command enables you to activate a requested domain registration.\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"The domain to activate the registration for","schema":{"type":"string","description":"The domain to activate the registration for"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","nullable":true,"enum":["approve","deny"],"description":"Action: Action for activation"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ActivateDomainRegistration"}},"/domain/{domain}/renew":{"patch":{"operationId":"renewDomain","summary":"XRRP command RenewDomain (renewDomain)","description":"When renewing a domain please enter the domain, the period for renewal (period = 1) and the current expiration year e.g. 2010.\nNote: You can not explicitly renew domains with a maximum registration period of one year. For those domains you have to set the domain renewalmode accordingly.\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"Domain: Domain to be renewed","schema":{"type":"string","description":"Domain: Domain to be renewed"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"expiration":{"type":"integer","format":"int32","description":"Current expiration year: The current expiration year of the domain (May be checked with StatusDomain). If the domain is in auto renew grace period (a specified number of calendar days following an auto-renewal), please use the previous expiration date because the domain is at this time not renewed on RRPProxy side. This will prevent unintended two year renewals."},"jobqueue":{"type":"string","nullable":true,"enum":["0","1"],"description":"Queue the command and process it in non-real time"},"period":{"type":"integer","format":"int32","description":"Period: The amount of years, you want to renew the domain"},"x-accept-premiumprice":{"type":"string","nullable":true,"enum":["0","1"]},"x-fee-amount":{"type":"array","description":"Amount of the fee extension.","items":{"type":"string","format":"decimal","nullable":true,"description":"Amount of the fee extension."}},"x-fee-application":{"type":"string","format":"decimal","nullable":true,"description":"None refundable amount of the fee extension."},"x-fee-currency":{"type":"string","nullable":true,"description":"Currency of the fee extension. Default is the own account currency."},"x-hk-bundle-domain-name":{"type":"string","nullable":true,"description":"Bundle domain name"},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"job_id":{"type":"array","items":{"type":"string"}},"promotions":{"type":"string"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Expiration date: The new expiration date of the domain"},"status":{"type":"string","description":"Status"},"x-fee-amount":{"type":"string","format":"decimal","description":"X-FEE-AMOUNT: The amount debited from your account balance for the domain name registration."},"x-fee-application":{"type":"string","format":"decimal","description":"X-FEE-APPLICATION: The non-refundable amount debited from your account balance for the domain name registration."},"x-fee-currency":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RenewDomain"}},"/domain/{domain}/renewalmode":{"put":{"operationId":"setDomainRenewalMode","summary":"XRRP command SetDomainRenewalMode (setDomainRenewalMode)","description":"This command allows you to change the renewal mode for a domain name.\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"The domain you want to change the renewalmode for","schema":{"type":"string","description":"The domain you want to change the renewalmode for"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"renewalmode":{"type":"string","enum":["DEFAULT","AUTORENEW","AUTOEXPIRE","AUTODELETE","RENEWONCE","EXPIREAUCTION","RENEWONCETHENAUTODELETE","RENEWONCETHENAUTOEXPIRE"],"description":"Renewalmode: The domains mode for renewals"},"token":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"SetDomainRenewalMode"}},"/domain/{domain}/restore":{"patch":{"operationId":"restoreDomain","summary":"XRRP command RestoreDomain (restoreDomain)","description":"\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"reason":{"type":"string","nullable":true},"reply":{"type":"string","nullable":true},"x-accept-premiumprice":{"type":"string","nullable":true,"enum":["0","1"]},"x-fee-amount":{"type":"array","description":"Amount of the fee extension.","items":{"type":"string","format":"decimal","nullable":true,"description":"Amount of the fee extension."}},"x-fee-application":{"type":"string","format":"decimal","nullable":true,"description":"None refundable amount of the fee extension."},"x-fee-currency":{"type":"string","nullable":true,"description":"Currency of the fee extension. Default is the own account currency."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"job_id":{"type":"string"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date"},"status":{"type":"string"},"x-be-restoremode":{"type":"string","description":".BE restoremode"},"x-fee-amount":{"type":"string","format":"decimal","description":"X-FEE-AMOUNT: The amount debited from your account balance for the domain name restore."},"x-fee-application":{"type":"string","format":"decimal","description":"X-FEE-APPLICATION: The non-refundable amount debited from your account balance for the domain name restore."},"x-fee-currency":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RestoreDomain"}},"/domain/{domain}/trade":{"post":{"operationId":"tradeDomain","summary":"XRRP command TradeDomain (tradeDomain)","description":"It is not possible to change the owner name or company name of a .BE or .EU or .NL domain through the ModifyDomain command. In such a case you have to request a trade and state the new owner contact.\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"Domain name to be traded","schema":{"type":"string","description":"Domain name to be traded"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["REQUEST","APPROVE","DENY","CANCEL"]},"admincontact0":{"type":"string","nullable":true,"description":"Admin contact"},"auth":{"type":"string","nullable":true,"description":"Authorization code"},"billingcontact0":{"type":"string","nullable":true,"description":"Billing contact"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"nameserver0":{"type":"string","nullable":true,"description":"Nameserver0"},"nameserver1":{"type":"string","nullable":true,"description":"Nameserver1"},"nameserver2":{"type":"string","nullable":true},"ownercontact0":{"type":"string","description":"Owner contact"},"period":{"type":"integer","format":"int32","nullable":true,"description":"Period: Renewal period for the trade."},"techcontact0":{"type":"string","nullable":true,"description":"Tech contact"},"token":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."},"x-accept-premiumprice":{"type":"string","nullable":true,"enum":["0","1"]},"x-au-domain-idnumber":{"type":"string","nullable":true,"description":"Identification number: Specify the identification number as appropriate"},"x-au-domain-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA"],"description":"Identification type: This is the identification type of the registrant."},"x-au-domain-relation":{"type":"string","enum":["1","2"],"description":"Eligibility type relationship: This indicates the relationship between the Eligibility Type (e.g. business name) and domain name"},"x-au-domain-relationtype":{"type":"string","enum":["IncorporatedAssociation","NonProfitOrganisation","Charity","TradeUnion","IndustryBody","PoliticalParty","religiouschurchgroup","GovernmentSchool","IndigenousCorporation","RegisteredOrganisation","Trust","CommonwealthEntity","StatutoryBody","CompanyLimitedByGuarantee","NonDistributingCooperative","NonTradingCooperative","CharitableTrust","PublicPrivateAncillaryFund","governmentbody","foreignembassyorconsulate"],"description":"Eligibility type: Specify what makes the registrant eligible to register the domain name"},"x-au-eligibility-idnumber":{"type":"string","nullable":true,"description":"Identification number for the Eligibility: Specify the identification number as appropriate"},"x-au-eligibility-idtype":{"type":"string","nullable":true,"enum":["TM","ABN","ACN","OTHER","ACT","NSW","NT","QLD","SA","TAS","VIC","WA","CRICOS"],"description":"Identification type (optional, for trade marks): This is the identification type of the elibibility."},"x-au-eligibility-name":{"type":"string","nullable":true,"description":"Eligibility Name: The Eligibility name"},"x-au-owner-organization":{"type":"string","description":"Owner Organization or Name: The Organization name"},"x-be-requestauthcode":{"type":"string","nullable":true,"enum":["1","0"],"description":"Request Authcode: Request an authcode for .be domains. Setting this to 1 will not initiate the trade"},"x-bg-applicationdate":{"type":"string","nullable":true,"description":"Date of the application for domain name registration"},"x-bg-applicationno":{"type":"string","nullable":true,"description":"Number of the application for domain name registration"},"x-ca-legal-type":{"type":"string","enum":["ABO","ASS","CCO","CCT","EDU","GOV","HOP","INB","LAM","LGR","MAJ","OMK","PLT","PRT","RES","TDM","TRD","TRS"],"description":"Registrant legal types"},"x-ca-trademark":{"type":"string","nullable":true,"enum":["0","1"],"description":"Is a registered trademark: Describes if the domain is a registered trademark or not."},"x-cn-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .CN trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-cn-owner-id-number":{"type":"string","nullable":true,"description":"Owner ID Number: ID number"},"x-cn-owner-id-type":{"type":"string","nullable":true,"enum":["SFZ","HZ","GAJMTX","TWJMTX","WJLSFZ","GAJZZ","TWJZZ","JGZ","QT","ORG","YYZZ","TYDM","BDDM","JDDWFW","SYDWFR","WGCZJG","SHTTFR","ZJCS","MBFQY","JJHFR","LSZY","WGZHWH","WLCZJG","SFJD","JWJG","SHFWJG","MBXXBX","YLJGZY","GZJGZY","BJWSXX","QTTYDM"],"description":"Owner identity type: Identity type of the ID card"},"x-cn-owner-type":{"type":"string","nullable":true,"enum":["I","E"],"description":"Owner type: Identity type owner"},"x-cnnic-owner-id-code":{"type":"string","nullable":true,"description":"Owner identity code: Identity code of the ID card"},"x-cnnic-owner-id-type":{"type":"string","nullable":true,"enum":["SFZ","HZ","GAJMTX","TWJMTX","WJLSFZ","GAJZZ","TWJZZ","JGZ","QT","ORG","YYZZ","TYDM","BDDM","JDDWFW","SYDWFR","WGCZJG","SHTTFR","ZJCS","MBFQY","JJHFR","LSZY","WGZHWH","WLCZJG","SFJD","JWJG","SHFWJG","MBXXBX","YLJGZY","GZJGZY","BJWSXX","QTTYDM","GATJZZ","ZZJGDMZ"],"description":"Owner identity type: Identity type of the ID card"},"x-company-reg-id":{"type":"string","nullable":true,"description":"Company registration ID"},"x-company-vat-id":{"type":"string","nullable":true,"description":"Company V.A.T. ID"},"x-cr-date-of-birth":{"type":"string","nullable":true,"description":"Date of birth: Date of birth"},"x-do-idcard":{"type":"string","nullable":true,"description":"ID card"},"x-ee-admin-birthday":{"type":"string","nullable":true,"description":"ADMIN BDAY: Birthdays ADMIN"},"x-ee-admin-ident":{"type":"string","nullable":true,"description":"ADMIN ID: Identifications Number for ADMIN"},"x-ee-admin-tin":{"type":"string","nullable":true,"description":"ADMIN TIN: TIN for ADMIN"},"x-ee-owner-birthday":{"type":"string","nullable":true,"description":"OWNER BDAY: Birthdays OWNER"},"x-ee-owner-ident":{"type":"string","nullable":true,"description":"OWNER ID: Identifications Number for OWNER"},"x-ee-owner-tin":{"type":"string","nullable":true,"description":"OWNER TIN: TIN for OWNER"},"x-ee-reserved-pw":{"type":"string","nullable":true,"description":"Reserved PW: Required if changing registrant during a dispute"},"x-ee-tech-birthday":{"type":"string","nullable":true,"description":"TECH BDAY: Birthdays TECH"},"x-ee-tech-ident":{"type":"string","nullable":true,"description":"TECH ID: Identifications Number for TECH"},"x-ee-tech-tin":{"type":"string","nullable":true,"description":"TECH TIN: TIN for TECH"},"x-es-admin-identificacion":{"type":"string","description":"Admin Identification: Indicates the contact's registrant legal ID number (passport, national ID, VAT ID, company registration number, etc.)"},"x-es-admin-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Legal form for admin contact.: The legal form used for the owner contact"},"x-es-admin-tipo-identificacion":{"type":"string","enum":["0","1","3","4"],"description":"Admin Identification Type: Indicates the type of ID number. 0 - Other ID, 1 - DNI/NIF, 3 - NIE, 4 - VAT"},"x-es-billing-identificacion":{"type":"string","description":"Billing Identification: Indicates the contact's registrant legal ID number (passport, national ID, VAT ID, company registration number, etc.)"},"x-es-billing-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Legal form for billing contact.: The legal form used for the owner contact"},"x-es-billing-tipo-identificacion":{"type":"string","enum":["0","1","3","4"],"description":"Owner Identification Type: Indicates the type of ID number. 0 - Other ID, 1 - DNI/NIF, 3 - NIE, 4 - VAT"},"x-es-owner-identificacion":{"type":"string","description":"Owner Identification: Indicates the contact's registrant legal ID number (passport, national ID, VAT ID, company registration number, etc.)"},"x-es-owner-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Legal form for owner contact.: The legal form used for the owner contact"},"x-es-owner-tipo-identificacion":{"type":"string","enum":["0","1","3","4"],"description":"Owner Identification Type: Indicates the type of ID number. 0 - Other ID, 1 - DNI/NIF, 3 - NIE, 4 - VAT"},"x-es-tech-identificacion":{"type":"string","description":"Owner Identification: Indicates the contact's registrant legal ID number (passport, national ID, VAT ID, company registration number, etc.)"},"x-es-tech-legalform":{"type":"string","nullable":true,"enum":["1","39","47","59","68","124","150","152","164","181","197","203","229","269","286","365","434","436","439","476","510","524","525","554","560","562","566","608","612","713","717","744","745","746","747","877","878","879"],"description":"Legal form for tech contact.: The legal form used for the owner contact"},"x-es-tech-tipo-identificacion":{"type":"string","enum":["0","1","3","4"],"description":"Owner Identification Type: Indicates the type of ID number. 0 - Other ID, 1 - DNI/NIF, 3 - NIE, 4 - VAT"},"x-fee-amount":{"type":"array","description":"Amount of the fee extension.","items":{"type":"string","format":"decimal","nullable":true,"description":"Amount of the fee extension."}},"x-fee-application":{"type":"string","format":"decimal","nullable":true,"description":"None refundable amount of the fee extension."},"x-fee-currency":{"type":"string","nullable":true,"description":"Currency of the fee extension. Default is the own account currency."},"x-fi-birthdate":{"type":"string","nullable":true,"description":"Birthdate: Birthdate"},"x-fi-company-reg-id":{"type":"string","nullable":true,"description":"Business ID or Reg. Number: Local business Entity (registered at the Finnish Trade Register or a corporation within the Finnish republic) ID-Code Business ID or Reg.Number"},"x-fi-contact-type":{"type":"string","nullable":true,"enum":["0","1","2","3","4","5","6","7"],"description":"Type of contact: Type of contact"},"x-fi-personal-id":{"type":"string","nullable":true,"description":"Personal Identity Number: Finnish Personal Identity Number"},"x-fi-requestauthcode":{"type":"string","nullable":true,"description":"Request Authcode: Request Authcode for Trade"},"x-fi-transfer-key":{"type":"string","nullable":true,"description":"Transfer key: The transferkey"},"x-fr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .FR trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-fr-announce":{"type":"string","nullable":true,"description":"Number of page announce JO: will contain the date of\npublication in the official gazette (the announce attribute shows\nthe number of the announcement, the page attribute shows the\npage number of this announcement)."},"x-fr-birthcity":{"type":"string","nullable":true,"description":"Birthcity: Contains the contact's place of birth."},"x-fr-birthdate":{"type":"string","nullable":true,"description":"Birthdate: Contains the contact's date of birth."},"x-fr-birthpc":{"type":"string","nullable":true,"description":"Birthplace postcode: Contains the postcode of the place of birth (or at least the department code)."},"x-fr-birthplace":{"type":"string","nullable":true,"description":"Birthplace country code: Contains the country code of the contact's place of birth."},"x-fr-date-association":{"type":"string","nullable":true,"description":"contain the date of publication in the official gazette: Will contain the date of publication in the official gazette (the announce attribute shows the number of the announcement."},"x-fr-date-publication-jo":{"type":"string","nullable":true},"x-fr-duns":{"type":"string","nullable":true,"description":"DUNS number: Short for Data Universal Numbering System; refers to a new identifier that can be sent for an Eligibility Verification at European level. Format has to follow X-XXX-XXXX (Only numbers are allowed)."},"x-fr-local":{"type":"string","nullable":true,"description":"Local identifier: A local identifier specific to a country of the European Economic Area."},"x-fr-numero-de-page-announce-jo":{"type":"string","nullable":true},"x-fr-restrict-pub":{"type":"string","nullable":true,"enum":["0","1"]},"x-fr-siren-or-siret":{"type":"string","nullable":true},"x-fr-trademark":{"type":"string","nullable":true},"x-fr-vatid":{"type":"string","nullable":true},"x-fr-waldec":{"type":"string","nullable":true},"x-hk-domain-category":{"type":"string","nullable":true,"enum":["I","O"],"description":"Domain category: I for individual domain, O for organization domain."},"x-hk-owner-age-over-18":{"type":"string","nullable":true,"enum":["no","yes"],"description":"Owner age over 18 years: Only mandatory if domain category is individual."},"x-hk-owner-document-number":{"type":"string","nullable":true,"description":"Owner document number: Domain owner/registrant document number."},"x-hk-owner-document-origin-country":{"type":"string","description":"Owner document origin country: The country for the owner/registrant document origin (please use the country code, e.g. \"de\" or \"us\")."},"x-hk-owner-document-type":{"type":"string","nullable":true,"enum":["HKID","OTHID","PASSNO","BIRTHCERT","OTHIDV","BR","CI","CRS","HKSARG","HKORDINANCE","OTHORG"],"description":"Owner document type: Domain owner/registrant document type."},"x-hk-owner-other-document-type":{"type":"string","nullable":true,"description":"Owner other document type: Domain owner/registrant other document type. This field is mandatory if the value for owner document type (X-HK-OWNER-DOCUMENT-TYPE) is OTHIDV (Others Individual Document) or OTHORG (Others Organization Document)."},"x-hr-comregid":{"type":"string","nullable":true,"description":"VAT ID / tax no.: VAT ID / tax no., mandatory for companies"},"x-hr-idcard":{"type":"string","nullable":true,"description":"Passport no.: Passport no., mandatory for individuals"},"x-ie-contact-type":{"type":"string","nullable":true,"enum":["COM","CHA","OTH"],"description":"Registrant/Owner type: Company/Charity/Other (Default = OTH)"},"x-ie-cro-number":{"type":"string","nullable":true,"description":"CRO Number: Companies Registration Office (CRO) number"},"x-ie-language":{"type":"string","nullable":true,"enum":["bg","cs","da","de","el","en","es","et","fi","fr","ga","hu","it","lt","lv","mt","nl","pl","pt","ro","sk","sl","sv"],"description":"Registrant/Owner language: Language the owner wishes to communicate with the registry (Default = EN)"},"x-ie-supporting-number":{"type":"string","nullable":true,"description":"Charity number: Charity/Supporting number"},"x-it-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .IT trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-it-consentforpublishing":{"type":"string","enum":["0","1"],"description":"ConsentForPublishing: Boolean value to allow the publication of contacts personal data. Values allowed: 1 to allow, 0 to deny."},"x-it-entity-type":{"type":"string","nullable":true,"enum":["1","2","3","4","5","6","7"],"description":"Entity Type: Numeric value to identify Registrant typology."},"x-it-nationality":{"type":"string","nullable":true,"description":"Registrants Nationality country code: The requesters nationality"},"x-it-pin":{"type":"string","nullable":true,"description":"Registrants taxcode: If the requester is an Italian natural person it contains his/her Codice Fiscale. For foreigners it can contain a\ndocument number. For associations without VAT number and tax code it must\nbe equal to \"n.a.\". In all the other cases it must be equal to VAT number (in the 11\nnumbers format for Italian Nationality) or the\nnumeric Codice Fiscale."},"x-it-sect3-liability":{"type":"string","enum":["0","1"],"description":"Accept Sect. 3 of registrar contract: This value is needed to indicate the acceptance of Section 3 in the .IT registrar contract."},"x-it-sect5-personal-data-for-registration":{"type":"string","enum":["0","1"],"description":"Accept Sect. 5 of registrar contract: This value is needed to indicate the acceptance of Section 5 in the .IT registrar contract."},"x-it-sect6-personal-data-for-diffusion":{"type":"string","enum":["0","1"],"description":"Accept Sect. 6 of registrar contract: This value is needed to indicate the acceptance of Section 6 in the .IT registrar contract."},"x-it-sect7-explicit-acceptance":{"type":"string","enum":["0","1"],"description":"Accept Sect. 7 of registrar contract: This value is needed to indicate the acceptance of Section 7 in the .IT registrar contract."},"x-lt-company-number":{"type":"string","nullable":true,"description":"Company number: Company number"},"x-mk-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .MK trustee TAC: Determines if the local presence service is to be used to register this domain"},"x-mk-owner-idnumber":{"type":"string","nullable":true,"description":"Owner ID Number: Personal or organizational identification number"},"x-nicse-idnumber":{"type":"string","description":"Id Number: Identification Number"},"x-nicse-vatid":{"type":"string","nullable":true,"description":"Vatnumber: Vatnumber"},"x-no-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .NO trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-no-organization-number":{"type":"string","nullable":true,"description":"Norwegian Organization Number: Required Norway Central Coordinating Register Number for legal entities to register a .NO domain name."},"x-no-person-identifier":{"type":"string","nullable":true,"description":"Norid Person ID: Required personal ID to register a private .PRIV.NO domain name."},"x-nu-iis-idno":{"type":"string","description":"Id Number: Identification Number"},"x-nu-iis-vatno":{"type":"string","nullable":true,"description":"Vatnumber: Vatnumber"},"x-personal-id":{"type":"string","nullable":true,"description":"Personal identification"},"x-pt-owner-identification":{"type":"string","description":"Fiscal Identification Nr (Owner): The Fiscal Identification Number of the owner contact."},"x-ro-company-number":{"type":"string","nullable":true,"description":"Company number: Company number"},"x-ro-idcard-or-passport-number":{"type":"string","nullable":true,"description":"ID-card or passport number: ID-card or passport number"},"x-ro-trade-token":{"type":"string","nullable":true,"description":"TRADE-Authorization-Key: Authorization-Key to initiate a TRADE"},"x-ro-vat-number":{"type":"string","nullable":true,"description":"VAT number: Value added tax (VAT) Number"},"x-rs-admin-company-number":{"type":"string","nullable":true,"description":"Company reg. number: Admin Company number for non-private registrations"},"x-rs-admin-idcard":{"type":"string","nullable":true,"description":"Passport no.: Admin Passport no., mandatory for individuals"},"x-rs-owner-company-number":{"type":"string","nullable":true,"description":"Company reg. number: Owner Company number for non-private registrations"},"x-rs-owner-idcard":{"type":"string","nullable":true,"description":"Passport no.: Owner Passport no., mandatory for individuals"},"x-rs-tech-company-number":{"type":"string","nullable":true,"description":"Company reg. number: Tech Company number for non-private registrations"},"x-rs-tech-idcard":{"type":"string","nullable":true,"description":"Passport no.: Tech Passport no., mandatory for individuals"},"x-rs-vat":{"type":"string","nullable":true,"description":"VAT number: VAT (fiscal) No. for non-private registrations"},"x-sg-rcbid":{"type":"string","nullable":true,"description":"Company/Identity Registration ID: For companies located in Singapore, the corresponding company registration number has to be given OR contact identity card for a local presence in Singapore (Format: S1234567D)"},"x-vn-owner-birthday":{"type":"string","format":"date","nullable":true,"description":"Birthday of domain owner YYYY-MM-DD (i.e. 1970-12-01): Birthday of domain owner"},"x-vn-owner-identification":{"type":"string","nullable":true,"description":"Identification Number: Identification Number. For private persons, you have to use the identity card number and for organizations use the VAT number."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"admincontact":{"type":"string","description":"ADMINCONTACT: The registries admin contact handle."},"billingcontact":{"type":"string","description":"BILLINGCONTACT: The billing contact handle."},"document_upload_target":{"type":"string","description":"Document upload target"},"document_upload_type":{"type":"string","description":"Document upload type"},"faquri":{"type":"string","description":"FAQ URI"},"info":{"type":"string"},"ownerchange_status":{"type":"string","description":"Ownerchange status"},"ownercontact":{"type":"string","description":"OWNERCONTACT: The registries owner contact handle."},"registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date"},"status":{"type":"string","description":"Status"},"techcontact":{"type":"string","description":"TECHCONTACT: The tech contact handle."},"trade_status":{"type":"string","description":"Trade status"},"x-document-status":{"type":"string","description":"Document status"},"x-es-current-registrar":{"type":"string","description":"X-ES-CURRENT-REGISTRAR: Current registrar name for .ES trade handling."},"x-es-new-admincontact":{"type":"string","description":".ES new admincontact"},"x-es-new-ownercontact":{"type":"string","description":".ES new ownercontact"},"x-fee-amount":{"type":"string","format":"decimal","description":"X-FEE-AMOUNT: The amount debited from your account balance for the domain name registration."},"x-fee-application":{"type":"string","format":"decimal","description":"X-FEE-APPLICATION: The non-refundable amount debited from your account balance for the domain name registration."},"x-fee-currency":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."},"x-gtld-owner-trustee-active":{"type":"string","description":"X-GTLD-OWNER-TRUSTEE-ACTIVE"},"x-gtld-owner-trustee-service-start":{"type":"string","format":"date","description":"X-GTLD-OWNER-TRUSTEE-SERVICE-START"},"x-ownerchange-autoapprove":{"type":"string","description":"X-OWNERCHANGE-AUTOAPPROVE"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"TradeDomain"}},"/domain/{domain}/transfer":{"get":{"operationId":"statusDomainTransfer","summary":"XRRP command StatusDomainTransfer (statusDomainTransfer)","description":"The StatusDomainTransfer command informs you about the current status of a transfer. You can check if the transfer was successfully initiated or who received the eMail to confirm a transfer.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"Domain name you want to know the transfer status of.","schema":{"type":"string","description":"Domain name you want to know the transfer status of."}},{"name":"trigger","in":"query","description":"Fetch ICANN transfer details by trigger code.","schema":{"type":"string","nullable":true,"description":"Fetch ICANN transfer details by trigger code."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"execute_date":{"type":"string","format":"date-time","nullable":true,"description":"Execute date"},"registrar":{"type":"string","nullable":true,"description":"Registrar"},"registration_expiration_date":{"type":"string","format":"date-time","nullable":true,"description":"Registration expiration date"},"request_date":{"type":"string","format":"date-time","description":"Request date"},"requesting_registrar":{"type":"string","description":"Requesting registrar"},"template_de":{"type":"array","description":"Template de","items":{"type":"string","description":"Template de"}},"template_en":{"type":"array","description":"Template en","items":{"type":"string","description":"Template en"}},"transfer_log":{"type":"array","description":"Log entry","items":{"type":"string","description":"Log entry"}},"transfer_status":{"type":"string","nullable":true,"description":"Status"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusDomainTransfer"},"post":{"operationId":"transferDomain","summary":"XRRP command TransferDomain (transferDomain)","description":"This command allows you to request, approve, deny or cancel a domain transfer. Simply enter the command and the respective domain name. Please note that in order to initiate a transfer for most domains you need the respective authorization code (auth).\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"description":"Domain: Domain name to be transferred","schema":{"type":"string","description":"Domain: Domain name to be transferred"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accept-trade":{"type":"string","enum":["0","1"],"description":"Accept trade"},"action":{"type":"string","enum":["REQUEST","APPROVE","DENY","CANCEL","USERTRANSFER","PUSH","TRADE","QUERY"],"description":"Action: Action to perform for the domain transfer"},"admincontact":{"type":"array","description":"Admin contact","items":{"type":"string","nullable":true,"description":"Admin contact"}},"admincontact0":{"type":"string","description":"Admin contact"},"auth":{"type":"string","nullable":true,"description":"Authorization code"},"billingcontact":{"type":"array","description":"Billing contact","items":{"type":"string","nullable":true,"description":"Billing contact"}},"billingcontact0":{"type":"string","nullable":true,"description":"Billing contact"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"dnssec":{"type":"array","description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e","items":{"type":"string","nullable":true,"description":"KEYDATA: Syntax: \u003cflags\u003e \u003cprotocol\u003e \u003calgorithm\u003e \u003cpubkey\u003e"}},"domainauth":{"type":"string"},"emaillanguage":{"type":"string","enum":["en_US","de_DE","pl_PL","sv_SE","es_ES","it_IT","fr_FR","nl_NL"]},"emailsender":{"type":"string"},"emailsubject":{"type":"string"},"emailtac":{"type":"string"},"emailurl":{"type":"string"},"force":{"type":"string","enum":["0","1"]},"forcerequest":{"type":"string","enum":["0","1"]},"nameserver":{"type":"array","description":"Nameserver","items":{"type":"string","nullable":true,"description":"Nameserver"}},"ownercontact0":{"type":"string","nullable":true,"description":"Owner contact"},"period":{"type":"string","nullable":true,"enum":["1","3M"],"description":"Period: Renewal after transfer"},"requestentity":{"type":"string"},"target":{"type":"string","nullable":true,"description":"Target"},"techcontact":{"type":"array","description":"Tech contact","items":{"type":"string","nullable":true,"description":"Tech contact"}},"techcontact0":{"type":"string","description":"Tech contact"},"token":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."},"transferlock":{"type":"string","enum":["0","1"]},"x-accept-premiumprice":{"type":"string","nullable":true,"enum":["0","1"]},"x-accept-quarantine":{"type":"string","nullable":true,"enum":["0","1"],"description":"Transfer from quarantine: Transfer the domain from registry quarantine"},"x-allocation-token":{"type":"string","nullable":true,"description":"Allocation Token: Allocation Token provided by the registry"},"x-at-requestauthcode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Request Authcode: Request an temporary authcode for .at domains. nic.at sends a token code to the e-mail address of the domain holder. This token is valid for 21 days and is only valid for this specific registrar."},"x-ax-business-registration":{"type":"string","nullable":true,"description":"Business Registration Number: Business Registration Number for non-private registrations"},"x-ax-personal-id":{"type":"string","nullable":true,"description":"Personal ID: Personal ID, mandatory for individuals"},"x-be-requestauthcode":{"type":"string","nullable":true,"enum":["1","0"],"description":"Request Authcode: Request an authcode for .be domains. Setting this to 1 will not initiate the transfer"},"x-bg-applicationdate":{"type":"string","nullable":true,"description":"Date of the application for domain name registration"},"x-bg-applicationno":{"type":"string","nullable":true,"description":"Number of the application for domain name registration"},"x-bg-comregid":{"type":"string","nullable":true,"description":"VAT ID or tax no. of Legal entity"},"x-bg-idcard":{"type":"string","nullable":true,"description":"ID Card Number of the representative person"},"x-ca-legal-type":{"type":"string","enum":["ABO","ASS","CCO","CCT","EDU","GOV","HOP","INB","LAM","LGR","MAJ","OMK","PLT","PRT","RES","TDM","TRD","TRS"],"description":"Registrant legal types"},"x-ca-trademark":{"type":"string","nullable":true,"enum":["0","1"],"description":"Is a registered trademark: Describes if the domain is a registered trademark or not."},"x-cn-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .CN trustee TAC: Determines, if the local presence service is to be used to modify this domain"},"x-cn-owner-id-number":{"type":"string","nullable":true,"description":"Owner ID Number: ID number"},"x-cn-owner-id-type":{"type":"string","nullable":true,"enum":["SFZ","HZ","GAJMTX","TWJMTX","WJLSFZ","GAJZZ","TWJZZ","JGZ","QT","ORG","YYZZ","TYDM","BDDM","JDDWFW","SYDWFR","WGCZJG","SHTTFR","ZJCS","MBFQY","JJHFR","LSZY","WGZHWH","WLCZJG","SFJD","JWJG","SHFWJG","MBXXBX","YLJGZY","GZJGZY","BJWSXX","QTTYDM"],"description":"Owner identity type: Identity type of the ID card"},"x-cn-owner-type":{"type":"string","nullable":true,"enum":["I","E"],"description":"Owner type: Identity type owner"},"x-company-reg-id":{"type":"string","nullable":true,"description":"Company registration ID"},"x-company-vat-id":{"type":"string","nullable":true,"description":"Company V.A.T. ID"},"x-de-abuse-contact":{"type":"string","nullable":true,"description":"Abuse Contact: URI Contact for abuse contact that will be shown on DENIC whois"},"x-de-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1","2"],"description":"Accept .DE trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-de-general-request":{"type":"string","nullable":true,"description":"General Request: URI Contact for general requests that will be shown on DENIC whois"},"x-de-holder-person":{"type":"string","nullable":true,"enum":["0","1"],"description":"Ownercontact Person: Sets the contact type for the ownercontact of the .de domain to person."},"x-de-nsentry":{"type":"array","description":"Nsentry: Enables the use of nsentrys instead of nameservers for .de domains","items":{"type":"string","nullable":true,"description":"Nsentry: Enables the use of nsentrys instead of nameservers for .de domains"}},"x-dk-accept-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":".DK acknowledgement: Accept .DK additional terms and conditions"},"x-do-idcard":{"type":"string","nullable":true,"description":"ID card"},"x-eu-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .EU trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-eu-registrant-citizenship":{"type":"string","nullable":true,"enum":["at","be","bg","cz","cy","de","dk","es","ee","fi","fr","gr","hr","hu","ie","is","it","li","lt","lu","lv","mt","nl","no","pl","pt","ro","se","sk","si",""],"description":"Registrant Citizenship: Citizenship of the owner"},"x-fee-amount":{"type":"array","description":"Amount of the fee extension.","items":{"type":"string","format":"decimal","nullable":true,"description":"Amount of the fee extension."}},"x-fee-application":{"type":"string","format":"decimal","nullable":true,"description":"None refundable amount of the fee extension."},"x-fee-currency":{"type":"string","nullable":true,"description":"Currency of the fee extension. Default is the own account currency."},"x-fi-company-reg-id":{"type":"string","nullable":true,"description":"Business ID or Reg. Number: Local business Entity (registered at the Finnish Trade Register or a corporation within the Finnish republic) ID-Code Business ID or Reg.Number"},"x-fi-non-violation-confirmation":{"type":"string","nullable":true,"enum":["0","1"],"description":"Non violation confirmation: Please confirm, that the domain name is not a registered name or trademark that belongs to another party or based on such a name or mark"},"x-fi-personal-id":{"type":"string","nullable":true,"description":"Personal Identity Number: Finnish Personal Identity Number"},"x-fi-requestauthcode":{"type":"string","nullable":true,"description":"Request Authcode: Request Authcode for Trade"},"x-fi-transfer-key":{"type":"string","nullable":true,"description":"Transfer key: The transferkey"},"x-fr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .FR trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-fr-announce":{"type":"string","nullable":true,"description":"Number of page announce JO: Will contain the date of\npublication in the official gazette (the announce attribute shows\nthe number of the announcement, the page attribute shows the\npage number of this announcement)."},"x-fr-birthcity":{"type":"string","nullable":true,"description":"Birthcity: Contains the contact's place of birth."},"x-fr-birthdate":{"type":"string","nullable":true,"description":"Birthdate: Contains the contact's date of birth."},"x-fr-birthpc":{"type":"string","nullable":true,"description":"Birthplace postcode: Contains the postcode of the place of birth (or at least the department code)."},"x-fr-birthplace":{"type":"string","nullable":true,"description":"Birthplace country code: Contains the country code of the contact's place of birth."},"x-fr-date-association":{"type":"string","nullable":true,"description":"Date of publication: Will contain the date of publication in the official gazette (the 'announce' attribute shows the number of the announcement."},"x-fr-date-publication-jo":{"type":"string","nullable":true,"description":"Publication page number: The page attribute shows the page number of this announcement."},"x-fr-duns":{"type":"string","nullable":true,"description":"DUNS number: Short for Data Universal Numbering System; refers to a new identifier that can be sent for an Eligibility Verification at European level. Format has to follow X-XXX-XXXX (Only numbers are allowed)."},"x-fr-local":{"type":"string","nullable":true,"description":"Local identifier: A local identifier specific to a country of the European Economic Area."},"x-fr-numero-de-page-announce-jo":{"type":"string","nullable":true,"description":"Announcement page number: The page attribute shows the page number of this announcement."},"x-fr-restrict-pub":{"type":"string","nullable":true,"enum":["0","1"],"description":"Restrict publication: Restrict publication"},"x-fr-siren-or-siret":{"type":"string","nullable":true,"description":"SIREN code: Contain the SIREN code."},"x-fr-trademark":{"type":"string","nullable":true,"description":"Trademark number: Contain a trademark number."},"x-fr-vatid":{"type":"string","nullable":true,"description":"VAT number: Contain the VAT number."},"x-fr-waldec":{"type":"string","nullable":true,"description":"Waldec linked to an association: Indicates the identifier Waldec linked to an association. If this identifier is provided, this is sufficient to identify an association."},"x-hk-bundle-domain-name":{"type":"string","nullable":true,"description":"Bundle domain name: Bundle domain name."},"x-hr-comregid":{"type":"string","nullable":true,"description":"VAT ID / tax no.: VAT ID / tax no., mandatory for companies"},"x-hr-idcard":{"type":"string","nullable":true,"description":"Passport no.: Passport no., mandatory for individuals"},"x-id-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .ID trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-in-nexus-connection-type":{"type":"string","nullable":true,"enum":["ENTITY","COMM","MKTG","CONTENT","EDU","CULTURE","OTHER"],"description":"Nexus connection to India: The Nexus connection of the registrant to India as required by NIXI for .IN registrations."},"x-in-nexus-declaration":{"type":"string","nullable":true,"enum":["0","1"],"description":"Nexus declaration attestation: Attestation that the registrant has a valid Nexus connection to India as required by NIXI for .IN registrations."},"x-it-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .IT trustee TAC: Determines, if the Key-Systems local presence service is to be used to register this domain"},"x-it-consentforpublishing":{"type":"string","nullable":true,"enum":["0","1"],"description":"ConsentForPublishing: Boolean value to allow the publication of contacts personal data. Values allowed: 1 to allow, 0 to deny."},"x-it-entity-type":{"type":"string","nullable":true,"enum":["1","2","3","4","5","6","7"],"description":"Entity Type: Numeric value to identify registrant typology"},"x-it-pin":{"type":"string","nullable":true,"description":"Registrants taxcode: If the requester is an Italian natural person it contains his/her Codice Fiscale. For foreigners it can contain a\ndocument number. For associations without VAT number and tax code it must\nbe equal to \"n.a.\". In all the other cases it must be equal to VAT number (in the 11\nnumbers format for Italian Nationality) or the\nnumeric Codice Fiscale."},"x-it-sect3-liability":{"type":"string","enum":["0","1"],"description":"Accept Sect. 3 of registrar contract: This value is needed to indicate the acceptance of Section 3 in the .IT registrar contract."},"x-it-sect5-personal-data-for-registration":{"type":"string","enum":["0","1"],"description":"Accept Sect. 5 of registrar contract: This value is needed to indicate the acceptance of Section 5 in the .IT registrar contract."},"x-it-sect6-personal-data-for-diffusion":{"type":"string","enum":["0","1"],"description":"Accept Sect. 6 of registrar contract: This value is needed to indicate the acceptance of Section 6 in the .IT registrar contract."},"x-it-sect7-explicit-acceptance":{"type":"string","enum":["0","1"],"description":"Accept Sect. 7 of registrar contract: This value is needed to indicate the acceptance of Section 7 in the .IT registrar contract."},"x-kr-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":".KR Trustee TAC"},"x-kr-ctfy-no":{"type":"string","nullable":true,"description":"Certification number: Registrant certification number"},"x-kr-ctfy-type":{"type":"string","nullable":true,"enum":["BUSINESS","BUSINESSIND","CORP","UNIQUE","SCHOOL","ETC"],"description":"Certificate type: Certificate type for Korean domains"},"x-lt-company-number":{"type":"string","nullable":true,"description":"Company number: Company number"},"x-lu-transfer-trade":{"type":"string","nullable":true,"enum":["0","1"],"description":".LU - Transfer Trade: Specify that this transfer should be executed as a transfer trade. This requires the additional specification of an owner, admin and tech contact and at least two nameservers."},"x-mo-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .MO trustee TAC: Determines if the local presence service is to be used to modify this domain"},"x-mt-nic-handle":{"type":"string","description":"Nic - Handle"},"x-mt-nic-password":{"type":"string","nullable":true,"description":"Nic password"},"x-mt-nic-username":{"type":"string","nullable":true,"description":"Nic username"},"x-my-admin-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Admin date of birth: Natural person date of birth"},"x-my-admin-identificationnumber":{"type":"string","nullable":true,"description":"Admin identification number: Natural person identification number"},"x-my-admin-organization-registration-number":{"type":"string","nullable":true,"description":"Admin Organization registration number: Admin organization registration number"},"x-my-admin-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Admin Organization type: Admin organization type"},"x-my-billing-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Billing date of birth: Natural person date of birth"},"x-my-billing-identificationnumber":{"type":"string","nullable":true,"description":"Billing identification number: Natural person identification number"},"x-my-billing-organization-registration-number":{"type":"string","nullable":true,"description":"Billing Organization registration number: Billing organization registration number"},"x-my-billing-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Billing Organization type: Billing organization type"},"x-my-owner-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Owner date of birth: Natural person date of birth"},"x-my-owner-identificationnumber":{"type":"string","nullable":true,"description":"Owner identification number: Natural person identification number"},"x-my-owner-organization-registration-number":{"type":"string","nullable":true,"description":"Owner Organization registration number: Owner organization registration number"},"x-my-owner-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Owner Organization type: Owner organization type"},"x-my-tech-dateofbirth":{"type":"string","format":"date","nullable":true,"description":"Tech date of birth: Natural person date of birth"},"x-my-tech-identificationnumber":{"type":"string","nullable":true,"description":"Tech identification number: Natural person identification number"},"x-my-tech-organization-registration-number":{"type":"string","nullable":true,"description":"Tech Organization registration number: Tech organization registration number"},"x-my-tech-organization-type":{"type":"string","nullable":true,"enum":["OTA000005","OTA000003","OTA000025","OTA000006","OTA000012","OTA000032"],"description":"Tech Organization type: Tech organization type"},"x-ne-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .NE trustee TAC: Determines if the local presence service is to be used to modify this domain"},"x-no-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .NO trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-nu-iis-idno":{"type":"string","nullable":true,"description":"Id Number: Identification Number"},"x-nu-iis-vatno":{"type":"string","nullable":true,"description":"VAT Number: Identification Number"},"x-personal-id":{"type":"string","nullable":true,"description":"Personal identification"},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code"},"x-ru-birthdate":{"type":"string","nullable":true,"description":"Customer-s birth date: Customer-s birth date in the format DD.MM.YYYY (figures)."},"x-ru-code":{"type":"string","nullable":true,"description":"TIN taxpayers identification: TIN (taxpayers identification number) of the Customers organization. This field must contain a ten digit number (the last figure is a control figure) Required for organizations incorporated in the Russian Federation."},"x-ru-firstname":{"type":"string","nullable":true,"description":"Firstname in Russian: Customers first name in Russian. To be filled with Russian and Latin letters, no dots. Maximum length is 64 characters."},"x-ru-kpp":{"type":"string","nullable":true,"description":"Reason code: The reason code  for the Customers organization registering. This field must contain a nine digit number. Required for organizations incorporated in the Russian Federation."},"x-ru-lastname":{"type":"string","nullable":true,"description":"Lastname in Russian: Customers last name in Russian. To be filled with Russian and Latin letters, no dots. Maximum length is 64 characters."},"x-ru-middlename":{"type":"string","nullable":true,"description":"Middlename in Russian: Customers middle name in Russian. To be filled with Russian and Latin letters, no dots. Maximum length is 64 characters."},"x-ru-organization":{"type":"string","nullable":true,"description":"Organisation in Russian: Customers organization name in Russian. This field can contain Russian and Latin letters, figures, punctuation marks and spaces. Minimal length is two words, maximum length is 256 characters."},"x-ru-passportdata":{"type":"string","nullable":true,"description":"Customer-s passport data: This field is filled in Russian and can contain Russian and Latin letters, figures, punctuation marks and spaces. Minimal length is two words, maximum length is 256 characters: Document number, Issued by, Issued Date"},"x-scheduledexecutiondate":{"type":"string","nullable":true,"description":"Scheduled execution date: Extension scheduled execution date (FORMAT: YYYY-MM-DD HH:MM:SS)"},"x-scheduledexecutiondays-offset":{"type":"integer","format":"int32","nullable":true,"description":"Scheduled execution days offset: Extension  scheduled execution days offset (1-180) prior to registration expiration date"},"x-sg-accept-trustee-tac":{"type":"string","enum":["0","1"],"description":".SG trustee TAC: Determines, if the Key-Systems local presence service is active for this domain"},"x-sg-admin-singpassid":{"type":"string","nullable":true,"description":"Singpass ID of individual admin: The contact identity card (SingPass ID) for an individual local presence in Singapore (Format: S1234567D)"},"x-sg-rcbid":{"type":"string","nullable":true,"description":"Singapore RCBID: For Singapore citizens and permanent residents, please provide NRIC or Passport No. For Singapore companies, please provide RCBID as it appears in RCB Certificate. For Singapore societies, please provide RCBID as it appears in ROS Certificate."},"x-sk-accept-trustee-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept .SK trustee TAC: Determines, if the local presence service is to be used to register this domain"},"x-sk-contact-ident-number":{"type":"string","nullable":true,"description":"Company number: Company-Ident-Number for Companies. Not required for Persons"},"x-sk-contact-legal-form":{"type":"string","nullable":true,"enum":["CORP","PERS"],"description":"Legal form: PERS for private persons or CORP for Companies"},"x-swiss-owner-type":{"type":"string","nullable":true,"enum":["P","O"],"description":"Owner type: Identity type owner"},"x-swiss-uid":{"type":"string","nullable":true,"description":"UID / UPI: Enterprise ID of the Owners Organization"},"x-tr-citid":{"type":"string","nullable":true,"description":"Citizen ID: If registrant is a private person (can register name-surname.com.tr)"},"x-tr-comregid":{"type":"string","nullable":true,"description":"Company registration number: Company registration number"},"x-tr-nichandle":{"type":"string","nullable":true,"description":"NIC handle of Admin-C: NIC handle of Admin-C"},"x-tr-password":{"type":"string","nullable":true,"description":"Password for Admin-C: Password for Admin-C"},"x-tr-taxnumber":{"type":"string","nullable":true,"description":"Tax number: Tax number"},"x-tr-taxoffice":{"type":"string","nullable":true,"description":"Tax office: Tax office"},"x-tr-tmid":{"type":"string","nullable":true,"description":"Trademark number: Trademark number"},"x-ua-tm-date":{"type":"string","format":"date","nullable":true,"description":"Trademark date: \u003cNULL\u003e"},"x-ua-tm-number":{"type":"string","nullable":true,"description":"Trademark Number"},"x-unitedtld-regulatory-data":{"type":"string","nullable":true,"description":"UnitedTLD Regulatory Body Information: Extension containing information abou the regulatory body"},"x-whois-privacy":{"type":"string","nullable":true,"enum":["0","1"],"description":"Whois Privacy: Enable WhoisProxy after the transfer to prevent disclosure of the contact data in whois."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string","description":"Auth code"},"document_generator_uri":{"type":"string","description":"Document generator uri"},"document_upload_target":{"type":"string","description":"Document upload target"},"document_upload_type":{"type":"string","description":"Document upload type"},"domain":{"type":"string","description":"Domain"},"execute_date":{"type":"string","format":"date-time","description":"Execute date"},"external_transfer":{"type":"integer","format":"int32","description":"External transfer"},"faquri":{"type":"string","description":"Faquri"},"info":{"type":"string"},"job_id":{"type":"string"},"promotions":{"type":"string"},"proposed_finished_date":{"type":"string","format":"date-time","description":"Proposed finished date"},"registrar":{"type":"string","nullable":true,"description":"Registrar"},"registration_expiration_date":{"type":"string","format":"date-time","nullable":true,"description":"Registration expiration date"},"renewal_period":{"type":"string"},"request_date":{"type":"string","format":"date-time","description":"Request date"},"requesting_registrar":{"type":"string","description":"Requesting registrar"},"roid":{"type":"string"},"scheduledcommand":{"type":"string","description":"Scheduledcommand"},"scheduledcommandid":{"type":"integer","format":"int32","description":"Scheduledcommandid"},"status":{"type":"string","description":"Status"},"transfer_log":{"type":"array","description":"Transfer log","items":{"type":"string","description":"Transfer log"}},"transfer_status":{"type":"string"},"transfermode":{"type":"string","description":"Transfermode"},"transferstatus":{"type":"string","description":"Transfer status: The new transfer status of the domain"},"x-cr-date-of-birth":{"type":"string","nullable":true,"description":"Date of birth: Date of birth"},"x-dk-tac-url":{"type":"string","nullable":true,"description":".DK Terms and Conditions URL: .DK Terms and Conditions URL"},"x-document-status":{"type":"string","description":"X-document-status"},"x-fee-amount":{"type":"string","format":"decimal","description":"X-FEE-AMOUNT: The amount debited from your account balance for the domain name registration."},"x-fee-application":{"type":"string","format":"decimal","description":"X-FEE-APPLICATION: The non-refundable amount debited from your account balance for the domain name registration."},"x-fee-currency":{"type":"string","description":"X-FEE-CURRENCY: The currency of the X-FEE-AMOUNT and X-FEE-APPLICATION values."},"x-scheduledexecutiondate":{"type":"string","format":"date-time","description":"X-scheduledexecutiondate"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"TransferDomain"}},"/domain/{domain}/transfer/availability":{"get":{"operationId":"checkDomainTransfer","summary":"XRRP command CheckDomainTransfer (checkDomainTransfer)","description":"The CheckDomainTransfer command allows you to review the details which are necessary to perform a successful transfer of a gTLD CNOBIN (i.e. eMail addresses, current registrar, domain status, ...).\nNote: Only possible for .COM, .NET, .JOBS, .ORG, .BIZ, .INFO, .NAME and .MOBI - domain names\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"schema":{"type":"string"}},{"name":"auth","in":"query","schema":{"type":"string","nullable":true}},{"name":"action","in":"query","schema":{"type":"string","enum":["REQUEST","APPROVE","DENY","CANCEL","USERTRANSFER"]}},{"name":"emaillanguage","in":"query","schema":{"type":"string","enum":["en_US","de_DE","fr_FR"]}},{"name":"emailsender","in":"query","schema":{"type":"string"}},{"name":"emailsubject","in":"query","schema":{"type":"string"}},{"name":"emailtac","in":"query","schema":{"type":"string"}},{"name":"emailurl","in":"query","schema":{"type":"string"}},{"name":"requestentity","in":"query","schema":{"type":"string"}},{"name":"emailrecipient","in":"query","schema":{"type":"string","enum":["OWNER","ADMIN","BOTH"]}},{"name":"x-idn-language","in":"query","description":"IDN Language: IDN encoding used for the domainname","schema":{"type":"string","nullable":true,"description":"IDN Language: IDN encoding used for the domainname"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"admin_contact_email":{"type":"string"},"admin_contact_language":{"type":"string"},"admin_contact_name":{"type":"string"},"admincontactemail":{"type":"string","description":"Administrative contact email: The email - address of the administrative contact"},"admincontactlanguage":{"type":"string","description":"Administrative contact language: The language of the administrative contact"},"admincontactname":{"type":"string","description":"Administrative contact name: The name of the administrative contact"},"age_in_days":{"type":"string"},"ageindays":{"type":"integer","format":"int32","description":"Age in days: The domain age in days"},"created_date":{"type":"string","format":"date-time"},"createddate":{"type":"string","format":"date-time","description":"Created date: The date, when the domain was created"},"owner_contact_email":{"type":"string"},"owner_contact_language":{"type":"string"},"owner_contact_name":{"type":"string"},"registrar":{"type":"string","description":"Registrar: The current registrar of the domain"},"transfer_lock":{"type":"string"},"transferlock":{"type":"string","enum":["0","1"],"description":"Transfer lock: The status of the transfer lock of the domain"},"transferstatus":{"type":"string","description":"Transfer status: The current transfer status of the domain"},"whois_server":{"type":"string"},"whoisserver":{"type":"string","description":"Whois server: The whois server to be queried for details of the domain"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckDomainTransfer"}},"/domain/{domain}/transfer/{trigger}/activate":{"post":{"operationId":"activateTransfer","summary":"XRRP command ActivateTransfer (activateTransfer)","description":"This command applies only to the gTLDs CNOBIN if you have an own transfer confirmation page for ICANN transfers.\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string"}},{"name":"trigger","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["REQUEST","DENY"]},"auth":{"type":"string","nullable":true},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ActivateTransfer"}},"/domain/{domain}/transfermode":{"put":{"operationId":"setDomainTransferMode","summary":"XRRP command SetDomainTransferMode (setDomainTransferMode)","description":"\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"token":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."},"transfermode":{"type":"string","enum":["DEFAULT","AUTOAPPROVE","AUTODENY"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"SetDomainTransferMode"}},"/domain/{domain}/trusteelog":{"get":{"operationId":"queryTrusteeLogList","summary":"XRRP command QueryTrusteeLogList (queryTrusteeLogList)","description":"\n","tags":["domain"],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"maxdate","in":"query","schema":{"type":"string","format":"date","nullable":true}},{"name":"mindate","in":"query","schema":{"type":"string","format":"date","nullable":true}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: The domain name."}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"log_date":{"type":"array","description":"Log date: Date of the trustee log action.","items":{"type":"string","format":"date","description":"Log date: Date of the trustee log action."}},"log_type":{"type":"array","description":"Log Type: The type of the trustee log action.","items":{"type":"string","description":"Log Type: The type of the trustee log action."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryTrusteeLogList"}},"/domain/{domain}/unsync":{"get":{"operationId":"statusUnsyncRegistryContact_2","summary":"XRRP command StatusUnsyncRegistryContact (statusUnsyncRegistryContact_2)","description":"\n","tags":["contact"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"Domain name for the contact sync check.","schema":{"type":"string","nullable":true,"description":"Domain name for the contact sync check."}},{"name":"contact","in":"query","description":"Contact for the sync check.","schema":{"type":"string","nullable":true,"description":"Contact for the sync check."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"contact":{"type":"array","description":"Contact: The contact where the information is not in sync with the registry.","items":{"type":"string","description":"Contact: The contact where the information is not in sync with the registry."}},"contacttype":{"type":"array","description":"Contact Type: The contact type of the contact for the domain name.","items":{"type":"string","description":"Contact Type: The contact type of the contact for the domain name."}},"domain":{"type":"array","description":"Domain: The domain name where the contact information is not in sync with the registry.","items":{"type":"string","description":"Domain: The domain name where the contact information is not in sync with the registry."}},"errorcode":{"type":"array","description":"Error Code: Error code of the failed contact update at the registry if available.","items":{"type":"integer","format":"int32","nullable":true,"description":"Error Code: Error code of the failed contact update at the registry if available."}},"errordescription":{"type":"array","description":"Error Description: Error description of the failed contact update at the registry if available.","items":{"type":"string","description":"Error Description: Error description of the failed contact update at the registry if available."}},"zone":{"type":"array","description":"Zone: The zone of the domain.","items":{"type":"string","description":"Zone: The zone of the domain."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusUnsyncRegistryContact"}},"/domain/{domain}/zone":{"get":{"operationId":"getZone","summary":"XRRP command GetZone (getZone)","description":"This command returns the zone of a specific domain name\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"Domain you want to know the zone for","schema":{"type":"string","description":"Domain you want to know the zone for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: Domain queried"},"zone":{"type":"string","description":"Zone: Zone of the queried domain"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"GetZone"}},"/domain/{type}/activeservice":{"get":{"operationId":"queryActiveServiceList","summary":"XRRP command QueryActiveServiceList (queryActiveServiceList)","description":"Search for services that are currently active with their renewaldate.\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"type","in":"path","required":true,"description":"Serivce Type: The type of service that sould be listed.","schema":{"type":"string","enum":["WHOIS-PROXY","DOMAIN-PIN-LOCK","FEEDBACK-SELFSERVICE","NET-REGISTRY-LOCK","COM-REGISTRY-LOCK","CC-REGISTRY-LOCK","NAME-REGISTRY-LOCK","TV-REGISTRY-LOCK","ANYCAST1","DNSZONE"],"description":"Serivce Type: The type of service that sould be listed."}},{"name":"object","in":"query","description":"Object: Searchpattern for objects in the list.","schema":{"type":"string","nullable":true,"description":"Object: Searchpattern for objects in the list."}},{"name":"includesub","in":"query","description":"Include subresellers: Includes all objects from subreseller acccounts in the list except for TYPES: dnszone, anycast1","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Include subresellers: Includes all objects from subreseller acccounts in the list except for TYPES: dnszone, anycast1"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["OBJECT","RENEWALDATE"],"description":"Sort the result by this column"}},{"name":"domaintag","in":"query","description":"Domain Tag: Show only domain objects that are associated with this domain tag.","schema":{"type":"array","description":"Domain Tag: Show only domain objects that are associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain Tag: Show only domain objects that are associated with this domain tag."}}},{"name":"zonetag","in":"query","description":"Zone Tag: Show only domain objects that are associated with this zone tag.","schema":{"type":"array","description":"Zone Tag: Show only domain objects that are associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone Tag: Show only domain objects that are associated with this zone tag."}}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","nullable":true,"description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","nullable":true,"description":"Limit: Show only this many items in the response"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"object":{"type":"array","description":"Object: The object name.","items":{"type":"string","description":"Object: The object name."}},"period":{"type":"array","description":"Period: Period for the service renewal.","items":{"type":"integer","format":"int32","description":"Period: Period for the service renewal."}},"periodtype":{"type":"array","description":"Periodtype: Periodtype for the service renewal period.","items":{"type":"string","description":"Periodtype: Periodtype for the service renewal period."}},"registrar":{"type":"array","description":"Registrar: The registrar where the object is located on. Only shown when parameter includesub is used.","items":{"type":"string","description":"Registrar: The registrar where the object is located on. Only shown when parameter includesub is used."}},"renewaldate":{"type":"array","description":"Renewal date: Renewal date of the service.","items":{"type":"string","format":"date","description":"Renewal date: Renewal date of the service."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryActiveServiceList"}},"/domain/{type}/suggestion":{"get":{"operationId":"getNameSuggestion","summary":"XRRP command GetNameSuggestion (getNameSuggestion)","description":"\n","tags":["domain"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"type","in":"path","required":true,"description":"Algorithm that will be used to generate alternative names.","schema":{"type":"string","nullable":true,"enum":["SUGGEST","PREFIX","SUFFIX","SPINWORD","PERSONALNAME","SEGMENT","SUPPORTEDTLDS"],"description":"Algorithm that will be used to generate alternative names."}},{"name":"name","in":"query","description":"Base names to generate alternative names for.","schema":{"type":"array","description":"Base names to generate alternative names for.","items":{"type":"string","nullable":true,"description":"Base names to generate alternative names for."}}},{"name":"language","in":"query","description":"Language of the name.","schema":{"type":"string","nullable":true,"enum":["ENG","SPA","ITA","JPN","TUR","CHI","GER","POR","FRE","KOR"],"description":"Language of the name."}},{"name":"tld","in":"query","description":"List of TLDs to generate alternatives for.","schema":{"type":"array","description":"List of TLDs to generate alternatives for.","items":{"type":"string","nullable":true,"description":"List of TLDs to generate alternatives for."}}},{"name":"use-numbers","in":"query","description":"Alternatives may contain digits.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Alternatives may contain digits."}},{"name":"use-idns","in":"query","description":"Alternatives may contain idn characters.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Alternatives may contain idn characters."}},{"name":"use-dashes","in":"query","description":"Alternatives may contain dashes.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Alternatives may contain dashes."}},{"name":"filter-content","in":"query","description":"Filter sensitive names for alternatives.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Filter sensitive names for alternatives."}},{"name":"show-unavailable","in":"query","description":"List unavailable domain names in the result.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"List unavailable domain names in the result."}},{"name":"max-length","in":"query","description":"Maximum name length of the generated alternatives (3-63).","schema":{"type":"integer","format":"int32","nullable":true,"description":"Maximum name length of the generated alternatives (3-63)."}},{"name":"max-results","in":"query","description":"Maximum number of alternative results (1-99).","schema":{"type":"integer","format":"int32","nullable":true,"description":"Maximum number of alternative results (1-99)."}},{"name":"ipaddress","in":"query","description":"Ip address that should be used to calculate the best alternative suggestions.","schema":{"type":"string","nullable":true,"description":"Ip address that should be used to calculate the best alternative suggestions."}},{"name":"showsuggestiontype","in":"query","description":"Return information on the algorithem that was used to generate the result for type SUGGEST.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Return information on the algorithem that was used to generate the result for type SUGGEST."}},{"name":"firstname","in":"query","description":"Firstname for the type PERSONALNAME.","schema":{"type":"string","nullable":true,"description":"Firstname for the type PERSONALNAME."}},{"name":"middlename","in":"query","description":"Middlename for the type PERSONALNAME.","schema":{"type":"string","nullable":true,"description":"Middlename for the type PERSONALNAME."}},{"name":"lastname","in":"query","description":"Lastname for the type PERSONALNAME.","schema":{"type":"string","nullable":true,"description":"Lastname for the type PERSONALNAME."}},{"name":"position","in":"query","description":"Position index of the name to be spinned for type SPINWORD.","schema":{"type":"integer","format":"int32","nullable":true,"description":"Position index of the name to be spinned for type SPINWORD."}},{"name":"spin-firstname","in":"query","description":"Allow to spin the firstname for type PERSONALNAME.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Allow to spin the firstname for type PERSONALNAME."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"availability":{"type":"array","description":"Availability: Availability of the alternative name","items":{"type":"string","description":"Availability: Availability of the alternative name"}},"name":{"type":"array","description":"Name: Alternative Name","items":{"type":"string","description":"Name: Alternative Name"}},"prefix":{"type":"array","description":"Prefix: Suitable prefixes for the given name.","items":{"type":"string","description":"Prefix: Suitable prefixes for the given name."}},"segmentedname":{"type":"array","description":"Segmented name: Segmented names extracted from the given name.","items":{"type":"string","description":"Segmented name: Segmented names extracted from the given name."}},"suffix":{"type":"array","description":"Suffix: Suitable suffixes for the given name.","items":{"type":"string","description":"Suffix: Suitable suffixes for the given name."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"GetNameSuggestion"}},"/domainblocking":{"get":{"operationId":"queryDomainBlockingList","summary":"XRRP command QueryDomainBlockingList (queryDomainBlockingList)","description":"\n","tags":["domainblocking"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"by domainblock (ROID)","schema":{"type":"string","nullable":true,"enum":["DOMAINBLOCK","LABEL","TYPE"],"description":"by domainblock (ROID)"}},{"name":"history","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"servicetag","in":"query","description":"Service Tag: Show only services that are associated with this service tag.","schema":{"type":"array","description":"Service Tag: Show only services that are associated with this service tag.","items":{"type":"string","nullable":true,"description":"Service Tag: Show only services that are associated with this service tag."}}},{"name":"renewalmode","in":"query","description":"Show only domainblockings with this renewalmode","schema":{"type":"string","nullable":true,"description":"Show only domainblockings with this renewalmode"}},{"name":"status","in":"query","description":"Show only domainblockings with this status","schema":{"type":"string","nullable":true,"description":"Show only domainblockings with this status"}},{"name":"type","in":"query","description":"Show only domainblockings with this type","schema":{"type":"string","nullable":true,"description":"Show only domainblockings with this type"}},{"name":"label","in":"query","description":"Show only domainblockings with this label","schema":{"type":"string","nullable":true,"description":"Show only domainblockings with this label"}},{"name":"ownercontact","in":"query","description":"Show only domainblockings with this ownercontact","schema":{"type":"string","nullable":true,"description":"Show only domainblockings with this ownercontact"}},{"name":"wide","in":"query","description":"Show a detailed list or a grouped list version","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show a detailed list or a grouped list version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"auth_code":{"type":"string","nullable":true},"created_by":{"type":"string"},"created_date":{"type":"string","format":"date-time"},"domainblock":{"type":"string"},"label":{"type":"string"},"ownercontact":{"type":"string"},"paid_until":{"type":"string","format":"date-time"},"registrar":{"type":"string"},"registrar_transfer_date":{"type":"string","format":"date-time"},"registration_expiration_date":{"type":"string","format":"date-time"},"registryaccount":{"type":"string"},"renewaldate":{"type":"string","format":"date-time"},"renewalmode":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"updated_by":{"type":"string"},"updated_date":{"type":"string","format":"date-time"}}}},"property":{"type":"object","properties":{"column":{"type":"string"},"count":{"type":"integer","format":"int32"},"first":{"type":"integer","format":"int32"},"last":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDomainBlockingList"},"post":{"operationId":"addDomainBlocking","summary":"XRRP command AddDomainBlocking (addDomainBlocking)","description":"\n","tags":["domainblocking"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addservicetag":{"type":"array","description":"Service Tag: The service tags that will be associated with this service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be associated with this service."}},"auth":{"type":"string","nullable":true,"description":"Auth: Domain Blocking auth code"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"label":{"type":"string","nullable":true,"description":"Label: Label name to be blocked"},"ownercontact0":{"type":"string","description":"Owner contact: Owner contact"},"period":{"type":"string","enum":["1","2","3"],"description":"Period: How many years you want to apply for this Domain Blocking"},"servicetag":{"type":"array","description":"Service Tag: The service tags that will be associated with this service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be associated with this service."}},"smdfile":{"type":"array","description":"SMDFILE: TMCH SMD file","items":{"type":"string","nullable":true,"description":"SMDFILE: TMCH SMD file"}},"type":{"type":"string","description":"Blocking type i.e. ADULTBLOCK, ADULTBLOCKPLUS, GLOBALBLOCK, GLOBALBLOCKPLUS, DPMLBRIDGE, DPMLBRIDGEPLUS, NAMEBLOCK, NAMEBLOCKPLUS"},"x-domain-blocking-ipr-id":{"type":"string","nullable":true,"description":"IPR ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string","description":"Authentication code: The authcode for this block, if supported by registry"},"created_by":{"type":"string","description":"Created by: Who created the block in our system (EXTERNAL if it created by a transfer-in)"},"created_date":{"type":"string","format":"date-time","description":"Created date: When the block was created at the registry if data available, otherwise: in our system"},"domainblock":{"type":"string","description":"DOMAINBLOCK: Roid of the domain block"},"label":{"type":"string","description":"Label: Name of the label"},"ownercontact":{"type":"string","description":"Ownercontact: Current ownercontact of this block"},"registrar":{"type":"string","description":"Registrar: Name of the account"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Expiration date: The block will expire in the registry on this date"},"renewal_date":{"type":"string","format":"date-time","description":"renewal date: The block will be renewed at this date"},"status":{"type":"string","description":"Status: Name of the status"},"type":{"type":"string","description":"Blocking type: Type of the domain block"},"updated_by":{"type":"string","description":"Updated by: Who was the last one updating the block"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When the block was last updated, if never it's the same like the created date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddDomainBlocking"}},"/domainblocking/-/iprid":{"get":{"operationId":"checkDomainBlockingIPRID","summary":"XRRP command CheckDomainBlockingIPRID (checkDomainBlockingIPRID)","description":"\n","tags":["domainblocking"],"parameters":[{"name":"label","in":"query","schema":{"type":"string","nullable":true}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"type","in":"query","description":"Blocking type i.e. ADULTBLOCK, ADULTBLOCKPLUS, GLOBALBLOCK, GLOBALBLOCKPLUS, DPMLBRIDGE, DPMLBRIDGEPLUS","schema":{"type":"string","nullable":true,"description":"Blocking type i.e. ADULTBLOCK, ADULTBLOCKPLUS, GLOBALBLOCK, GLOBALBLOCKPLUS, DPMLBRIDGE, DPMLBRIDGEPLUS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"label#":{"type":"string","description":"Label: Name of the label"},"x-domain-blocking-ipr-id#":{"type":"string","description":"X-DOMAIN-BLOCKING-IPR-ID: IPRID of the domain block"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckDomainBlockingIPRID"}},"/domainblocking/-/transfer":{"get":{"operationId":"queryDomainBlockingTransferList","summary":"XRRP command QueryDomainBlockingTransferList (queryDomainBlockingTransferList)","description":"\n","tags":["domainblocking"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"by domainblock (ROID)","schema":{"type":"string","nullable":true,"enum":["DOMAINBLOCK","LABEL"],"description":"by domainblock (ROID)"}},{"name":"status","in":"query","description":"Show only domainblocking transfers with this status","schema":{"type":"string","nullable":true,"description":"Show only domainblocking transfers with this status"}},{"name":"label","in":"query","description":"Show only domainblockings with this label","schema":{"type":"string","nullable":true,"description":"Show only domainblockings with this label"}},{"name":"type","in":"query","description":"Filter by domainblocking type (e.g. GLOBALBLOCK, ADULTBLOCK)","schema":{"type":"string","nullable":true,"description":"Filter by domainblocking type (e.g. GLOBALBLOCK, ADULTBLOCK)"}},{"name":"transfertype","in":"query","description":"Filter transfers by direction (INBOUND or OUTBOUND)","schema":{"type":"string","nullable":true,"enum":["INBOUND","OUTBOUND"],"description":"Filter transfers by direction (INBOUND or OUTBOUND)"}},{"name":"wide","in":"query","description":"Show a detailed list or a grouped list version","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show a detailed list or a grouped list version"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth_code":{"type":"string"},"column":{"type":"string"},"count":{"type":"string"},"domainblock":{"type":"string"},"first":{"type":"integer","format":"int32"},"label":{"type":"string"},"last":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"registrar":{"type":"string"},"requestdate":{"type":"string","format":"date","description":"Transfer request date"},"requested_by":{"type":"string","description":"Transfer requested by"},"requested_date":{"type":"string","format":"date"},"status":{"type":"string"},"total":{"type":"integer","format":"int32"},"transfer_date":{"type":"string","format":"date"},"transferdate":{"type":"string","format":"date","description":"Transfer completion date"},"transferstatus":{"type":"string","description":"Transfer status"},"transfertype":{"type":"string","description":"Transfer direction: INBOUND or OUTBOUND"},"type":{"type":"string","description":"Domainblocking type (GLOBALBLOCK, ADULTBLOCK, etc.)"},"updated_by":{"type":"string"},"updated_date":{"type":"string","format":"date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryDomainBlockingTransferList"}},"/domainblocking/{domainblock}":{"delete":{"operationId":"deleteDomainBlocking","summary":"XRRP command DeleteDomainBlocking (deleteDomainBlocking)","description":"The DeleteDomainBlocking command allows you to delete a domainblock.\n","tags":["domainblocking"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"type","in":"query","description":"Blocking type i.e. ADULTBLOCK, ADULTBLOCKPLUS, GLOBALBLOCK, GLOBALBLOCKPLUS, DPMLBRIDGE, DPMLBRIDGEPLUS, NAMEBLOCK, NAMEBLOCKPLUS","schema":{"type":"string","nullable":true,"description":"Blocking type i.e. ADULTBLOCK, ADULTBLOCKPLUS, GLOBALBLOCK, GLOBALBLOCKPLUS, DPMLBRIDGE, DPMLBRIDGEPLUS, NAMEBLOCK, NAMEBLOCKPLUS"}},{"name":"domainblock","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteDomainBlocking"},"get":{"operationId":"statusDomainBlocking","summary":"XRRP command StatusDomainBlocking (statusDomainBlocking)","description":"\n","tags":["domainblocking"],"parameters":[{"name":"type","in":"query","schema":{"type":"string","nullable":true}},{"name":"domainblock","in":"path","required":true,"schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string","nullable":true,"description":"Authentication code: The authcode for this block, if supported by registry"},"autocaughtcount":{"type":"integer","format":"int32","description":"Auto caught count"},"blockedcount":{"type":"integer","format":"int32","description":"Blocked count"},"brand_protection_calculator_uri":{"type":"string","description":"Brand protection calculator uri"},"created_by":{"type":"string","description":"Created by: Who created the block in our system (EXTERNAL if it created by a transfer-in)"},"created_date":{"type":"string","format":"date-time","description":"Created date: When the block was created at the registry if data available, otherwise: in our system"},"domainblock":{"type":"string","description":"Domainblock: Roid of the domain block"},"domainblock_status":{"type":"string","description":"Domainblock status"},"expectedblockedcount":{"type":"integer","format":"int32","description":"Expected blocked count"},"label":{"type":"string","description":"Label: Name of the label"},"label_variant_generator_uri":{"type":"string","description":"Label variant generator URI: Label variant generator URI, fill in your label to see the variants"},"labelcount":{"type":"integer","format":"int32","description":"Label count"},"mark":{"type":"string","description":"Mark"},"nonblockedcount":{"type":"integer","format":"int32","description":"Non-blocked count"},"ownercontact":{"type":"string","description":"Ownercontact: Current ownercontact of this block"},"paid_until_date":{"type":"string","format":"date-time","description":"Paiduntil date: The block was paid until this date"},"registrar":{"type":"string","description":"Registrar: Name of the account"},"registrar_transfer_date":{"type":"string","format":"date-time","description":"Registrar transfer date: The block was transferred at this date"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Expiration date: The block will expire at the registry on this date"},"renewal_date":{"type":"string","format":"date-time","description":"renewal date: The block will be renewed at this date"},"renewalmode":{"type":"string","description":"Renewal mode: The block will be renewed repsectively this mode"},"status":{"type":"string","description":"Status: Name of the status"},"tld_blocks":{"type":"string","description":"Tld blocks: These TLDs get blocked by your domainblock"},"type":{"type":"string","description":"Type: Type of the domain block"},"updated_by":{"type":"string","description":"Updated by: Who was the last one updating the block"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When the block was last updated, if never it's the same like the created date"},"x-domain-blocking-ipr-id":{"type":"string","description":"Domain blocking IPR ID"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusDomainBlocking"},"patch":{"operationId":"modifyDomainBlocking","summary":"XRRP command ModifyDomainBlocking (modifyDomainBlocking)","description":"\n","tags":["domainblocking"],"parameters":[{"name":"domainblock","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addownercontact0":{"type":"string","nullable":true},"addservicetag":{"type":"array","description":"Service Tag: The service tags that will be added to the service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be added to the service."}},"auth":{"type":"string","nullable":true,"description":"Auth: domain auth code"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"delownercontact0":{"type":"string","nullable":true},"delservicetag":{"type":"array","description":"Service Tag: The service tags that will be deleted from the service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be deleted from the service."}},"ownercontact0":{"type":"string","nullable":true,"description":"Owner contact: Owner contact"},"renewalmode":{"type":"string","nullable":true,"enum":["DEFAULT","AUTORENEW","AUTOEXPIRE"],"description":"Renewalmode: The domains mode for renewals"},"servicetag":{"type":"array","description":"Service Tag: The service tags that will be associated with this service.","items":{"type":"string","nullable":true,"description":"Service Tag: The service tags that will be associated with this service."}},"type":{"type":"string","nullable":true}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string","description":"Auth: Auth of the domain block"},"domainblock":{"type":"string","description":"Domainblock: Roid of the domain block"},"type":{"type":"string","description":"Type: Type of the domain block"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyDomainBlocking"}},"/domainblocking/{domainblock}/renew":{"patch":{"operationId":"renewDomainBlocking","summary":"XRRP command RenewDomainBlocking (renewDomainBlocking)","description":"\n","tags":["domainblocking"],"parameters":[{"name":"domainblock","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"expirationdate":{"type":"integer","format":"int32","description":"Expiration Date (YYYY): The current expiration date"},"period":{"type":"string","enum":["1","2","3"],"description":"Period: How many years you want to apply for this Domain Blocking"},"type":{"type":"string","nullable":true}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"domainblock":{"type":"string","description":"Domainblock: Roid of the domain block"},"label":{"type":"string","description":"Label: Name of the label"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Expiration date: The block will expire at the registry on this date"},"status":{"type":"string","description":"Status: Name of the status"},"type":{"type":"string","description":"Type: Type of the domain block"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RenewDomainBlocking"}},"/domainblocking/{domainblock}/transfer":{"post":{"operationId":"transferDomainBlocking","summary":"XRRP command TransferDomainBlocking (transferDomainBlocking)","description":"\n","tags":["domainblocking"],"parameters":[{"name":"domainblock","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["REQUEST","APPROVE","DENY","CANCEL","QUERY","USERTRANSFER"],"description":"Action: Action to perform for the domain transfer"},"auth":{"type":"string","nullable":true,"description":"Auth: Domainblock auth code"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"label":{"type":"string","nullable":true,"description":"Label: Label name to be requested"},"ownercontact0":{"type":"string","description":"Owner contact: Owner contact"},"type":{"type":"string","nullable":true,"description":"Blocking type i.e. ADULTBLOCK, ADULTBLOCKPLUS, GLOBALBLOCK, GLOBALBLOCKPLUS, DPMLBRIDGE, DPMLBRIDGEPLUS, NAMEBLOCK, NAMEBLOCKPLUS"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"domainblock":{"type":"string","description":"Domainblock: Roid of the domain block"},"label":{"type":"string","description":"Label: Name of the label"},"loosing_registrar":{"type":"string","description":"Loosing registrar: Who is the loosing registrar"},"requested_by":{"type":"string","description":"Requested by: Who was the requester of the transfer"},"requested_date":{"type":"string","format":"date-time","description":"Requested date: When the transfer block was requested"},"transfer_date":{"type":"string","format":"date-time","description":"Transfer date: When the block was transferred"},"transfer_status":{"type":"string","description":"Transfer status"},"updated_by":{"type":"string","description":"Updated by: Who was the last one updating the block"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When the block was last updated, if never it's the same like the created date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"TransferDomainBlocking"}},"/domian/{domain}/ownerchange":{"get":{"operationId":"statusOwnerchange","summary":"XRRP command StatusOwnerchange (statusOwnerchange)","description":"\n","parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"path","required":true,"description":"DOMAIN: Name of the relevant domain.","schema":{"type":"string","description":"DOMAIN: Name of the relevant domain."}},{"name":"contact","in":"query","description":"CONTACT: ID of the relevant contact.","schema":{"type":"string","description":"CONTACT: ID of the relevant contact."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"domain":{"type":"string","nullable":true,"description":"Domain: ACE encoded version of the domainname"},"gaining_registrant":{"type":"string","description":"Gaining registrant: The gaining registrant contact id"},"losing_registrant":{"type":"string","description":"Loising registrant: The losing registrant contact id"},"reason":{"type":"string","nullable":true,"description":"Reason"},"request_date":{"type":"string","format":"date-time","description":"Request date: The request created date"},"request_expiration_date":{"type":"string","format":"date-time","description":"Request expiration date: The request expiration date"},"status":{"type":"string","description":"Status: The ownerchange status"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusOwnerchange"}},"/event":{"get":{"operationId":"queryEventList","summary":"XRRP command QueryEventList (queryEventList)","description":"Query existing and not yet deleted events in your account. For possible classes and subclasses, please have a look into the table at the beginning of this chapter.\n","tags":["event"],"parameters":[{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["CLASS","SUBCLASS","OBJECTID","DATE","EVENT","EVENTDATE"],"description":"Sort the result by this column"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"class","in":"query","description":"Return only events of this class (wildcards allowed)","schema":{"type":"string","description":"Return only events of this class (wildcards allowed)"}},{"name":"subclass","in":"query","description":"Return only events of this subclass (wildcards allowed)","schema":{"type":"string","description":"Return only events of this subclass (wildcards allowed)"}},{"name":"mindate","in":"query","description":"Search events younger than this date","schema":{"type":"string","format":"date-time","description":"Search events younger than this date"}},{"name":"history","in":"query","description":"Show deleted events","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show deleted events"}},{"name":"wide","in":"query","description":"Return more or less details","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Return more or less details"}},{"name":"maxdate","in":"query","description":"Search events older than this date","schema":{"type":"string","format":"date-time","description":"Search events older than this date"}},{"name":"includesub","in":"query","description":"Include subresellers: Includes all events from subreseller acccounts in the list.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Include subresellers: Includes all events from subreseller acccounts in the list."}},{"name":"objectid","in":"query","description":"Search events with this object id","schema":{"type":"string","description":"Search events with this object id"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"event":{"type":"integer","format":"int32","description":"Event ID: ID of the event"},"event_date":{"type":"string","format":"date-time","description":"Event date: Date the event occured"},"eventclass":{"type":"string","description":"Event class: Class of the event"},"eventsubclass":{"type":"string","description":"Event subclass: Subclass of the event"},"object_id":{"type":"string","description":"Object id: Object (i.e. domain name) involved in the event"},"registrar":{"type":"string","description":"Registrar: The registrar for the event. Only shown when parameter includesub is used."},"status":{"type":"string","description":"Status"}}}},"property":{"type":"object","properties":{"column":{"type":"array","description":"List columns","items":{"type":"string","description":"List columns"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of events shown"},"events_count":{"type":"integer","format":"int32","description":"Events count: How many events are shown"},"events_total":{"type":"integer","format":"int32","description":"Events total: Number of existing events"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of events"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryEventList"}},"/event/{event}":{"delete":{"operationId":"deleteEvent","summary":"XRRP command DeleteEvent (deleteEvent)","description":"\n","tags":["event"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"event","in":"path","required":true,"description":"ID of the event to be deleted","schema":{"type":"integer","format":"int32","description":"ID of the event to be deleted"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteEvent"},"get":{"operationId":"statusEvent","summary":"XRRP command StatusEvent (statusEvent)","description":"Show the content of an event by executing StatusEvent with the event - ID. For possible values inside the event, please have a look into the table at the beginning of this chapter.\n","tags":["event"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"event","in":"path","required":true,"description":"The ID of the event to be queried","schema":{"type":"integer","format":"int32","description":"The ID of the event to be queried"}},{"name":"history","in":"query","description":"Show deleted event","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show deleted event"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"class":{"type":"string","description":"Class: Class of this event"},"data":{"type":"array","description":"Data: Payload of this event","items":{"type":"string","description":"Data: Payload of this event"}},"date":{"type":"string","format":"date-time","description":"Date: Date the event was issued"},"info":{"type":"string","nullable":true,"description":"Info: Detailed information about this event"},"object_id":{"type":"string","nullable":true,"description":"Object id: The object this event is about"},"subclass":{"type":"string","description":"Subclass: Subclass of this event"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusEvent"}},"/hosting/cpanel/{type}":{"delete":{"operationId":"deleteHosting","summary":"XRRP command DeleteHosting (deleteHosting)","description":"Add a new webspace.\n","tags":["hosting"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"class","in":"query","required":true,"description":"Product class: Product class","schema":{"type":"string","enum":["CPANEL"],"description":"Product class: Product class"}},{"name":"type","in":"path","required":true,"description":"Hosting type: Type of hosting to delete","schema":{"type":"string","enum":["USERACCOUNT","ADDONDOMAIN","DOMAINALIAS","SUBDOMAIN","EMAIL","EMAILFORWARD","EMAILDOMAINFORWARD","FTPUSER","MYSQLDATABASE","MYSQLDATABASEUSER","MYSQLDATABASEUSERPRIVILEGES","PACKAGE","FEATURELIST","CATCHALLADDRESS"],"description":"Hosting type: Type of hosting to delete"}},{"name":"object","in":"query","description":"Object: Can be a domain, email, ftpuser, database, ...","schema":{"type":"string","nullable":true,"description":"Object: Can be a domain, email, ftpuser, database, ..."}},{"name":"account","in":"query","description":"Account ID: Account ID","schema":{"type":"string","nullable":true,"description":"Account ID: Account ID"}},{"name":"databasename","in":"query","description":"DATABASENAME: Databasename","schema":{"type":"string","nullable":true,"description":"DATABASENAME: Databasename"}},{"name":"databaseuser","in":"query","description":"DATABASEUSER: Databaseuser","schema":{"type":"string","nullable":true,"description":"DATABASEUSER: Databaseuser"}},{"name":"reason","in":"query","description":"Reason: Reason for deletion","schema":{"type":"string","nullable":true,"description":"Reason: Reason for deletion"}},{"name":"option","in":"query","description":"OPTION: Option for catchall email: fwd, fail, blackhole","schema":{"type":"string","nullable":true,"description":"OPTION: Option for catchall email: fwd, fail, blackhole"}},{"name":"target","in":"query","description":"Target: In case of type = EMAILFORWARD, EMAILDOMAINFORWARD or ADDONDOMAIN target","schema":{"type":"string","nullable":true,"description":"Target: In case of type = EMAILFORWARD, EMAILDOMAINFORWARD or ADDONDOMAIN target"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"job_id":{"type":"integer","format":"int64","description":"Job ID: Job ID of the delete hosting job"},"restoreable_until":{"type":"string","format":"date-time","description":"Restorable until date: Timeframe until the account is restorable"},"status":{"type":"string","description":"Status: Status"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Updated date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteHosting"},"get":{"operationId":"queryHostingList","summary":"XRRP command QueryHostingList (queryHostingList)","description":"Add a new webspace.\n","tags":["hosting"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"class","in":"query","required":true,"description":"Product class: Product class","schema":{"type":"string","enum":["CPANEL"],"description":"Product class: Product class"}},{"name":"type","in":"path","required":true,"description":"Hosting type: Type of hosting","schema":{"type":"string","enum":["USERACCOUNT","PACKAGE","FEATURELIST","SHOWFAIRUSEPOLICYGRACEPERIOD","SHOWFAIRUSEPOLICYSUSPENSION"],"description":"Hosting type: Type of hosting"}},{"name":"status","in":"query","description":"Hosting status: Status of hosting","schema":{"type":"string","nullable":true,"enum":["ACTIVE","PENDINGDELETE","SUSPENDED"],"description":"Hosting status: Status of hosting"}},{"name":"object","in":"query","description":"Object: Can be a domain, email, ftpuser, database, ...","schema":{"type":"string","nullable":true,"description":"Object: Can be a domain, email, ftpuser, database, ..."}},{"name":"name","in":"query","description":"Name: Filter by name (*) asterisk is allowed","schema":{"type":"string","nullable":true,"description":"Name: Filter by name (*) asterisk is allowed"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Limit the output of results by this item","schema":{"type":"integer","format":"int32","description":"Limit: Limit the output of results by this item"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["STATUS","NAME","RENEWALMODE","PACKAGE","REGISTRATIONEXPIRATIONDATE"],"description":"Sort the result by this column"}},{"name":"filter","in":"query","description":"Filter result list by useraccounts, package name or domain names","schema":{"type":"string","nullable":true,"enum":["USERACCOUNT","PACKAGE","PRIMARYDOMAIN"],"description":"Filter result list by useraccounts, package name or domain names"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryHostingList"},"patch":{"operationId":"modifyHosting","summary":"XRRP command ModifyHosting (modifyHosting)","description":"Add a new webspace.\n","tags":["hosting"],"parameters":[{"name":"type","in":"path","required":true,"description":"Hosting type: Type of hosting to modify","schema":{"type":"string","enum":["USERACCOUNT","EMAIL","MYSQLDATABASEUSERPRIVILEGES","PASSWORDRESETFTPUSER","PASSWORDRESETACCOUNT","PASSWORDRESETMYSQLDATABASEUSER","SUBDOMAIN","ADDONDOMAIN","DOMAINALIAS","FTPUSER","CHANGEPRIMARYDOMAIN","USERACCOUNTLANGUAGE","PHPVERSION"],"description":"Hosting type: Type of hosting to modify"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"string","nullable":true,"description":"Account ID: Account ID"},"action":{"type":"string","nullable":true,"enum":["SUSPENDSENDEMAIL","SUSPENDLOGINEMAIL","SUSPENDRECEIVEEMAIL","UNSUSPENDSENDEMAIL","UNSUSPENDLOGINEMAIL","UNSUSPENDRECEIVEEMAIL","SUSPEND","UNSUSPEND","ADDREDIRECT","REMOVEREDIRECT","EMAILQUOTA"],"description":"Action: Action"},"class":{"type":"string","enum":["CPANEL"],"description":"Product class: Product class"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"databasename":{"type":"string","nullable":true,"description":"DATABASENAME: Databasename"},"databaseuser":{"type":"string","nullable":true,"description":"DATABASEUSER: Databaseuser"},"directory":{"type":"string","nullable":true,"description":"Directory: Directory in case of type = subdomain"},"name":{"type":"string","nullable":true,"description":"Name: Set RRP account name (tagging only)"},"object":{"type":"string","nullable":true,"description":"Object: Can be a domain, email, ftpuser, database"},"package":{"type":"string","nullable":true,"description":"Package name: Package name"},"password":{"type":"string","nullable":true,"description":"Password: Password: Strength Configuration - at least 5 characters long, lowercase/uppercase alpha chars, symbols, numbers non alpha chars"},"period":{"type":"integer","format":"int32","nullable":true,"description":"Period: Period 1 - 12  (DEFAULT: 1)"},"periodtype":{"type":"string","nullable":true,"enum":["MONTH","YEAR"],"description":"Periodtype: Periodtype: month or year (DEFAULT: MONTH)"},"quota":{"type":"integer","format":"int32","nullable":true,"description":"Email quota: Size in Megabytes"},"reason":{"type":"string","nullable":true,"description":"Reason: Reason for suspension"},"renewalmode":{"type":"string","enum":["AUTODELETE","AUTORENEW","DEFAULT"],"description":"Renewal Mode"},"target":{"type":"string","nullable":true,"description":"Target: In case of type = EMAILFORWARD, EMAILDOMAINFORWARD or ADDONDOMAIN etc target (incl. redirect)"},"useraccountlanguage":{"type":"string","nullable":true,"description":"Locale: Modify language (en, de, fr, ...)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"invoiceuseraccount":{"type":"integer","format":"int32","description":"Charge useraccount: Charge useraccount"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyHosting"},"post":{"operationId":"addHosting","summary":"XRRP command AddHosting (addHosting)","description":"Add a new webspace.\n","tags":["hosting"],"parameters":[{"name":"type","in":"path","required":true,"description":"Hosting type: Type of hosting to add","schema":{"type":"string","enum":["USERACCOUNT","ADDONDOMAIN","DOMAINALIAS","SUBDOMAIN","EMAIL","EMAILFORWARD","EMAILDOMAINFORWARD","FTPUSER","MYSQLDATABASE","MYSQLDATABASEUSER","MYSQLDATABASEUSERPRIVILEGES","PACKAGE","FEATURELIST","USERACCOUNTMIGRATION","CATCHALLADDRESS"],"description":"Hosting type: Type of hosting to add"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"string","nullable":true,"description":"Account ID: Account ID"},"class":{"type":"string","enum":["CPANEL"],"description":"Product class: Product class"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"databasename":{"type":"string","nullable":true,"description":"DATABASENAME: Databasename"},"databaseuser":{"type":"string","nullable":true,"description":"DATABASEUSER: Databaseuser"},"directory":{"type":"string","nullable":true,"description":"Directory: Directory in case of type = addondomain"},"featureaddondomains":{"type":"string","nullable":true,"enum":["1","0"],"description":"Addon Domains: (DEFAULT: 0) Addon domains allow you to control multiple domains from a single account. An addon domain links a new domain name to a directory in your account, and then stores its files in that directory."},"featureanalog":{"type":"string","nullable":true,"enum":["1","0"],"description":"Analog Stats: (DEFAULT: 0) The Analog Stats interface allows you to access data from the Analog traffic statistics software. Analog compiles traffic statistics for your domain, and organizes the data by month so that it is easy for you to manage and interpret. The software also presents the data for each month in graphs to show additional categories."},"featureautoresponders":{"type":"string","nullable":true,"enum":["1","0"],"description":"Autoresponders: (DEFAULT: 0) This feature allows you to configure automatic email response messages. This is useful, for example, when the recipient is unavailable."},"featureautossl":{"type":"string","nullable":true,"enum":["1","0"],"description":"AutoSSL: (DEFAULT: 0) The AutoSSL feature provides free SSL certificates for your users domains powered by Comodo"},"featureawstats":{"type":"string","nullable":true,"enum":["1","0"],"description":"Awstats: (DEFAULT: 0) The Awstats interface displays traffic statistics from the Advanced Web Statistics (AWStats) software, which compiles information about how users access your website."},"featurebackup":{"type":"string","nullable":true,"enum":["1","0"],"description":"Backup: (DEFAULT: 0) The Backup interface allows you to download and store your files, databases, forwarders and filters in a backup file."},"featurebandwidth":{"type":"string","nullable":true,"enum":["1","0"],"description":"Bandwidth Stats: (DEFAULT: 0) The Bandwidth interface displays bandwidth usage information in several sets of graphs. Each graph contains information about bandwidth usage over a specific period of time."},"featureblockers":{"type":"string","nullable":true,"enum":["1","0"],"description":"Email filter manager: (DEFAULT: 0) Filter the email for each email account in your domain."},"featurecaldavcarddav":{"type":"string","nullable":true,"enum":["1","0"],"description":"Calendars and Contacts: (DEFAULT: 0) Calendars and Contacts"},"featurecgi":{"type":"string","nullable":true,"enum":["1","0"],"description":"CGI: (DEFAULT: 0) Enable cgi module"},"featurechangemx":{"type":"string","nullable":true,"enum":["1","0"],"description":"Change MX / Email routing: (DEFAULT: 0) Email routing"},"featureclamavconnectorscan":{"type":"string","nullable":true,"enum":["1","0"],"description":"Virus Scanner: (DEFAULT: 0) The ClamAV Virus Scanner interface scans your cPanel account's services for malicious software. If the ClamAV Virus Scanner identifies a potential security threat, the system prompts you to perform the appropriate action."},"featurecron":{"type":"string","nullable":true,"enum":["1","0"],"description":"Cron Jobs: (DEFAULT: 0) Cron jobs are scheduled tasks that the system runs at predefined times or intervals."},"featurecsvimport":{"type":"string","nullable":true,"enum":["1","0"],"description":"Address Importer: (DEFAULT: 0) This interface allows you to use two types of files to create multiple email addresses or forwarders for your account simultaneously."},"featuredefaultaddress":{"type":"string","nullable":true,"enum":["1","0"],"description":"Default Address: (DEFAULT: 0) This interface allows you to set up a default address (catch-all address) that receives any mail for an invalid email address for the domain."},"featuredirselector":{"type":"string","nullable":true,"enum":["1","0"],"description":"Directory Selection Popup: (DEFAULT: 0) Directory Selection Popup"},"featurediskusageviewer":{"type":"string","nullable":true,"enum":["1","0"],"description":"Disk Usage Viewer: (DEFAULT: 0) This interface displays information about how you use your account's disk space, and all of your home directory's subdirectories."},"featureemailarchive":{"type":"string","nullable":true,"enum":["1","0"],"description":"Email Archiving: (DEFAULT: 0) This interface allows you to save incoming, outgoing, and mailing list messages for a specified amount of time. The system stores the messages in the mail directory in the user's home directory."},"featureemailauth":{"type":"string","nullable":true,"enum":["1","0"],"description":"Email Deliverability (Authentication): (DEFAULT: 0) Use this interface to identify problems with your mail-related DNS records for one or more of your domains. The system uses these records to verify that other servers can trust it as a sender."},"featureemaildiskusage":{"type":"string","nullable":true,"enum":["1","0"],"description":"Email Disk Usage: (DEFAULT: 0) This interface allows you to view all of your mailboxes and remove old or large messages."},"featureemaildomainfwd":{"type":"string","nullable":true,"enum":["1","0"],"description":"Email Domain Forwarding: (DEFAULT: 0) This interface allows you configure an email address to forward copies of incoming emails to another address."},"featureemailtrace":{"type":"string","nullable":true,"enum":["1","0"],"description":"Email Trace: (DEFAULT: 0) This interface displays reports about email message delivery attempts from your account. You can also use this feature to trace a message's delivery route, which can help you to identify message delivery issues."},"featureenduserlve":{"type":"string","nullable":true,"enum":["1","0"],"description":"LVE end user usage statistics: (DEFAULT: 0) LVE end user usage statistics"},"featureerrlog":{"type":"string","nullable":true,"enum":["1","0"],"description":"Error Log: (DEFAULT: 0) The interface displays up to 300 of the most recent entries in Apache's error logs, in reverse chronological order."},"featureerrpages":{"type":"string","nullable":true,"enum":["1","0"],"description":"Error Pages: (DEFAULT: 0) Error pages inform visitors about problems when they attempt to access your site. Each problem has its own status code (for example, 404) and error page."},"featurefilemanager":{"type":"string","nullable":true,"enum":["1","0"],"description":"File Manager: (DEFAULT: 0) cPanel organizes all the files on your account into folders. Use the File Manager interface to manage and edit your files."},"featurefilerestoration":{"type":"string","nullable":true,"enum":["1","0"],"description":"File and Directory Restoration: (DEFAULT: 0) The File and Directory Restoration interface allows you to restore items from local backup sources."},"featureforwarders":{"type":"string","nullable":true,"enum":["1","0"],"description":"Forwarder Manager: (DEFAULT: 0) This interface allows you configure an email address to forward copies of incoming emails to another address. This is useful if, for example, you want to use one email address to check emails addressed to multiple accounts."},"featureftpaccts":{"type":"string","nullable":true,"enum":["1","0"],"description":"FTP Account Manager: (DEFAULT: 0) You can use this interface to create and manage your website's File Transfer Protocol (FTP) accounts. FTP allows you to manage your website's files."},"featurehandlers":{"type":"string","nullable":true,"enum":["1","0"],"description":"Apache Handlers: (DEFAULT: 0) Apache handlers control how your site\\’s Apache web server software manages certain file types and file extensions. Apache can handle CGI scripts and server-parsed files. The file extensions for these files include .cgi, .pl, .plx, .ppl, .perl, and .shtml. You can configure Apache to use an existing handler to handle a new file type. To do this, manually add the handler and extension in this interface."},"featurehotlink":{"type":"string","nullable":true,"enum":["1","0"],"description":"Hotlink Protection: (DEFAULT: 0) A hotlink occurs when someone embeds content from your site in another site and uses your bandwidth to serve the files. You can use this interface to prevent this issue."},"featureindexmanager":{"type":"string","nullable":true,"enum":["1","0"],"description":"Index Manager: (DEFAULT: 0) Index Manager to define how your web site handles directory listings."},"featurejetbackupcronbackups":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: Cron Job Backups: (DEFAULT: 0) Cron Job Backups: On this page, you can view a list of cron job backups."},"featurejetbackupdbbackups":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: Database Backups: (DEFAULT: 0) Database Backups: On this page, you can view a list of database backups."},"featurejetbackupdnsbackups":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: DNS Zone Backups: (DEFAULT: 0) DNS Backups: On this page, you can view a list of DNS backups."},"featurejetbackupemailbackups":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: Email Backups: (DEFAULT: 0) Email Backups: On this page, you can view a list of email backups."},"featurejetbackupfilesbackups":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: File Backups: (DEFAULT: 0) File Backups: On this page, you can view backups and access the backup file manager."},"featurejetbackupfullbackups":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: Full Account Backups: (DEFAULT: 0) Full Account Backups: On this page, you can view a list of full backup account."},"featurejetbackupgdpr":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: GDPR Compliance: (DEFAULT: 0) At the first time you enter GDPR setting (when your provider enabled GDPR), You will have to approve the following: User Agreement, Privacy Policy and Backup Destination Information."},"featurejetbackupqueue":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: Queue: (DEFAULT: 0) On this page you can view the items in the queue."},"featurejetbackupsettings":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: Settings: (DEFAULT: 0) On this page, you can enter your email and JetBackup will send a notification when the action you have selected is completed."},"featurejetbackupsingle":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: Single: (DEFAULT: 0) Backup file manager: On this page, you can download and restore specific files."},"featurejetbackupsnapshots":{"type":"string","nullable":true,"enum":["1","0"],"description":"JetBackup :: Snapshots: (DEFAULT: 0) On this page, you can create a snapshot for the account and view all available snapshots for the account."},"featurelastvisits":{"type":"string","nullable":true,"enum":["1","0"],"description":"Latest Visitors: (DEFAULT: 0) This interface displays detailed information about the 1,000 most recent visits to your website. This information helps you to learn about your audience and monitor frequent visitors so that you can adjust your website content to fit their needs. It also helps you locate and fix errors, such as missing pages or broken links."},"featurelist":{"type":"string","nullable":true,"description":"Featurelist: Featurelist name (no underscore _ allowed)"},"featurelists":{"type":"string","nullable":true,"enum":["1","0"],"description":"Mailing Lists: (DEFAULT: 0) Mailing lists allow you to use a single address to send mail to multiple email addresses."},"featurelvephpsel":{"type":"string","nullable":true,"enum":["1","0"],"description":"LVE PHP selector: (DEFAULT: 0) CloudLinux PHP Selector"},"featuremime":{"type":"string","nullable":true,"enum":["1","0"],"description":"MIME Types: (DEFAULT: 0) MIME types relay information to the browser about how to handle file extensions. MIME types can allow visitors browsers to handle new technologies as they become available. To add new MIME types to your web server, define the name, directory, and file extension that correspond to the MIME type."},"featuremodulesperl":{"type":"string","nullable":true,"enum":["1","0"],"description":"Perl modules: (DEFAULT: 0) Perl modules are software components in the Perl language. This interface allows you to search for and install Perl modules from the CPAN repository to your website."},"featuremodulesphppear":{"type":"string","nullable":true,"enum":["1","0"],"description":"PHP PEAR packages: (DEFAULT: 0) PHP PEAR packages are software components that are written in the PHP language. The PHP PEAR Packages interface allows you to search for and add PEAR packages to your website, or view all of your website's available PHP packages."},"featuremysql":{"type":"string","nullable":true,"enum":["1","0"],"description":"Enables MySQL: (DEFAULT: 0) Enables MySQL"},"featurenettools":{"type":"string","nullable":true,"enum":["1","0"],"description":"Nettools: (DEFAULT: 0) To help diagnose common issues"},"featureoptimizews":{"type":"string","nullable":true,"enum":["1","0"],"description":"Optimize Website: (DEFAULT: 0) Enable compression for website"},"featureparkeddomains":{"type":"string","nullable":true,"enum":["1","0"],"description":"Park domains: (DEFAULT: 0) Enable park domains"},"featurepassword":{"type":"string","nullable":true,"enum":["1","0"],"description":"Password and Security: (DEFAULT: 0) Allows you to update your account's password"},"featurepgp":{"type":"string","nullable":true,"enum":["1","0"],"description":"PGP/GPG: (DEFAULT: 0) Enables PGP and GPG encryption"},"featurephpconfig":{"type":"string","nullable":true,"enum":["1","0"],"description":"PHP Configuration: (DEFAULT: 0) See PHP Configuration"},"featurephpmyadmin":{"type":"string","nullable":true,"enum":["1","0"],"description":"PhpMyAdmin: (DEFAULT: 0) Enables phpMyAdmin"},"featurepopaccts":{"type":"string","nullable":true,"enum":["1","0"],"description":"Email: (DEFAULT: 0) Enable Email accounts"},"featurerawlog":{"type":"string","nullable":true,"enum":["1","0"],"description":"Raw Access Logs: (DEFAULT: 0) Raw access logs are text files that contain information about your website's visitors and the content on your website that they have accessed. This feature allows you to download a zipped version of your access log."},"featureredirects":{"type":"string","nullable":true,"enum":["1","0"],"description":"Redirects: (DEFAULT: 0) The Redirects interface allows you to send all of the visitors of a domain or particular page to a different URL."},"featureresourceplugin":{"type":"string","nullable":true,"enum":["1","0"],"description":"LVE resource plugin: (DEFAULT: 0) Activate LVE resource usage plugin."},"featurervsitebuilder":{"type":"string","nullable":true,"enum":["1","0"],"description":"RV website builder: (DEFAULT: 0) Enable RV website builder"},"featuresetlang":{"type":"string","nullable":true,"enum":["1","0"],"description":"Change Language: (DEFAULT: 0) To change your cPanel interface's language"},"featuresitepublisher":{"type":"string","nullable":true,"enum":["1","0"],"description":"Site Publisher: (DEFAULT: 0) This interface enables you to quickly create a simple website, even if you have never created a website before. When you use this interface, you will select an appropriate template for your website, and then enter the website content that the template requests."},"featuresoftaculous":{"type":"string","nullable":true,"enum":["1","0"],"description":"Softaculous installer: (DEFAULT: 0) Softaculous Apps Installer"},"featurespamassassin":{"type":"string","nullable":true,"enum":["1","0"],"description":"Apache SpamAssassin: (DEFAULT: 0) This interface allows you to configure Apache SpamAssassin for your account. Apache SpamAssassin is an email utility that examines incoming email and tests for spam characteristics. It uses Bayesian spam filtering and network tests to screen incoming email. This results in an overall score that Apache SpamAssassin uses to determine whether it should discard a message."},"featurespambox":{"type":"string","nullable":true,"enum":["1","0"],"description":"Spambox: (DEFAULT: 0) Enable Email Spambox"},"featuresslinstall":{"type":"string","nullable":true,"enum":["1","0"],"description":"SSL Host Installer: (DEFAULT: 0) Enables SSL certificate installation."},"featuresslmanager":{"type":"string","nullable":true,"enum":["1","0"],"description":"SSL Manager: (DEFAULT: 0) Enables SSL Manager."},"featurestatselect":{"type":"string","nullable":true,"enum":["1","0"],"description":"Statistics selector: (DEFAULT: 0) Statistics selector"},"featurestyle":{"type":"string","nullable":true,"enum":["1","0"],"description":"Change Style: (DEFAULT: 0) Use this interface to choose a style in order to customize the cPanel interface's appearance."},"featuresubdomains":{"type":"string","nullable":true,"enum":["1","0"],"description":"Subdomains: (DEFAULT: 0) This interface allows you to create and manage subdomains for your cPanel account. A subdomain is a subsection of your website that sometimes exists as a subdirectory of your public_html (document root) directory or your account's home directory. Subdomains use a prefix in conjunction with the domain name."},"featuresubdomainstats":{"type":"string","nullable":true,"enum":["1","0"],"description":"Subdomain Stats: (DEFAULT: 0) Enables statistics for subdomains"},"featurethemeswitch":{"type":"string","nullable":true,"enum":["1","0"],"description":"Theme Switching: (DEFAULT: 0) Theme menu in the General Information section of cPanel's Home interface."},"featuretlswizard":{"type":"string","nullable":true,"enum":["1","0"],"description":"SSL/TLS Wizard: (DEFAULT: 0) The SSL/TLS Wizard interface allows you to easily purchase and install SSL certificates for domains on your account."},"featuretraceaddy":{"type":"string","nullable":true,"enum":["1","0"],"description":"Track DNS: (DEFAULT: 0) This interface contains tools to help you retrieve network information."},"featuretwofactorauth":{"type":"string","nullable":true,"enum":["1","0"],"description":"Two-Factor Authentication (Google Authenticator): (DEFAULT: 0) Two-factor authentication (2FA) is an improved security measure that requires two forms of identification: your password and a generated security code. With 2FA enabled, an application on your smartphone supplies a code that you must enter with your password to log in. Without your smartphone, you cannot log in."},"featureupdatecontact":{"type":"string","nullable":true,"enum":["1","0"],"description":"Contact Information: (DEFAULT: 0) Use this interface to store contact information for your cPanel account, and to set your contact preferences."},"featureupdatenotificationprefs":{"type":"string","nullable":true,"enum":["1","0"],"description":"Update Notification Preferences: (DEFAULT: 0) Enables notification preference options in the Contact Information interface"},"featurevideotut":{"type":"string","nullable":true,"enum":["1","0"],"description":"Video tutorial: (DEFAULT: 0) Video tutorial"},"featurewebalizer":{"type":"string","nullable":true,"enum":["1","0"],"description":"Webalizer: (DEFAULT: 0) The Webalizer interface displays traffic statistics from the Webalizer statistics program."},"featurewebdisk":{"type":"string","nullable":true,"enum":["1","0"],"description":"Web Disk: (DEFAULT: 0) Use the Web Disk interface to manage your Web Disk accounts."},"featurewebmail":{"type":"string","nullable":true,"enum":["1","0"],"description":"Webmail: (DEFAULT: 0) Use this interface to add, manage, and delete email accounts."},"featurewebprotect":{"type":"string","nullable":true,"enum":["1","0"],"description":"Webprotect: (DEFAULT: 0) WebProtect application."},"featurewordpresstoolkit":{"type":"string","nullable":true,"enum":["1","0"],"description":"Plugin: Wordpress Toolkit: (DEFAULT: 0) Wordpress Toolkit is a feature-rich management interface that allows anyone to install, configure, and manage WordPress websites."},"featurewordpresstoolkitdeluxe":{"type":"string","nullable":true,"enum":["1","0"],"description":"Plugin: Wordpress Toolkit Deluxe: (DEFAULT: 0) Wordpress Toolkit Deluxe with tools such as Cloning and Smart Updates, is now included as part of cPanel."},"name":{"type":"string","nullable":true,"description":"Name: Set RRP account name (tagging only)"},"object":{"type":"string","nullable":true,"description":"Object: Can be a domain, email, ftpuser, database"},"option":{"type":"string","nullable":true,"description":"OPTION: Option for catchall email: fwd, fail, blackhole"},"package":{"type":"string","nullable":true,"description":"Package: Package name"},"packagebandwidthlimit":{"type":"integer","format":"int32","nullable":true,"description":"Monthly Bandwidth (MB): The amount of information that the account can transfer each month, measured in Megabytes (MB)."},"packagecgi":{"type":"string","nullable":true,"enum":["1","0"],"description":"CGI Access: Allows the account to execute CGI scripts."},"packageextensions":{"type":"string","nullable":true,"description":"Package Extension: Available cPanel extensions (if both extensions used it must be separated by comma: softinstcount,lve)."},"packagelanguage":{"type":"string","nullable":true,"description":"Locale: Select default language (en, de, ...)"},"packagelveentryprocesses":{"type":"integer","format":"int32","nullable":true,"description":"LVE package extension entry processes: Must be a positive number, maximum number of entry processes (concurrent connections) for an useraccount."},"packagelveio":{"type":"integer","format":"int32","nullable":true,"description":"LVE package extension input/output usage speed: Must be a positive number, measured in Kb/s. Maximum I/O usage speed for an useraccount."},"packagelveiops":{"type":"integer","format":"int32","nullable":true,"description":"LVE package extension input/output operations per second: Must be a positive number, maximum IOPS (input/output operations per second) usage for an useraccount."},"packagelvephysicalmemory":{"type":"integer","format":"int32","nullable":true,"description":"LVE package extension physical memory: Must be a positive number, maximum physical memory usage an useraccount."},"packagemaxaddon":{"type":"integer","format":"int32","nullable":true,"description":"Max Addon Domains: The maximum number of addon domains for the account"},"packagemaxemailacctquota":{"type":"integer","format":"int32","nullable":true,"description":"Max Quota per Email Address (MB): The maximum size that the account can define when it creates an email account, in Megabytes (MB). This value defaults to Unlimited."},"packagemaxftp":{"type":"integer","format":"int32","nullable":true,"description":"Max FTP Accounts: The maximum number of FTP accounts for the cPanel account."},"packagemaxlists":{"type":"integer","format":"int32","nullable":true,"description":"Max Email Lists: The maximum number of Mailman mailing lists for the account."},"packagemaxpark":{"type":"integer","format":"int32","nullable":true,"description":"Max Parked Domains: The maximum number of parked domains (aliases) for the account."},"packagemaxpop":{"type":"integer","format":"int32","nullable":true,"description":"Max Email Accounts: The maximum number of email accounts for the cPanel account"},"packagemaxsoftinst":{"type":"integer","format":"int32","nullable":true,"description":"Max Softaculous installations: The maximum number of Softaculous installations."},"packagemaxsql":{"type":"integer","format":"int32","nullable":true,"description":"Max Databases: The maximum number of each available type of SQL database"},"packagemaxsub":{"type":"integer","format":"int32","nullable":true,"description":"Max Sub Domains: The maximum number of subdomains for the account."},"password":{"type":"string","nullable":true,"description":"Password: Password: Strength Configuration - at least 5 characters long, lowercase/uppercase alpha chars, symbols, numbers non alpha chars"},"period":{"type":"integer","format":"int32","nullable":true,"description":"Period: Period 1 - 12  (DEFAULT: 1)"},"periodtype":{"type":"string","nullable":true,"enum":["MONTH"],"description":"Periodtype: Periodtype: month (DEFAULT: MONTH)"},"quota":{"type":"integer","format":"int32","nullable":true,"description":"Package quota: Size in Megabytes"},"registrationexpirationdate":{"type":"string","format":"date","description":"Registration expiration date: Date the useraccount will expire"},"renewalmode":{"type":"string","enum":["AUTODELETE","AUTORENEW","DEFAULT"],"description":"Renewal Mode"},"target":{"type":"string","nullable":true,"description":"Target: In case of type = EMAILFORWARD, EMAILDOMAINFORWARD or ADDONDOMAIN target"},"whmaccount":{"type":"string","nullable":true,"enum":["1","0"],"description":"WHM Account: Create WHM reseller account if server type available for the reseller"},"x-hosting-location":{"type":"string","nullable":true,"description":"Hosting location: Hosting location (LON (LONDON), MEL (Melbourne), SG (Singapore), BUC (Bucharest), FLA (Florida), LAX (Los Angeles)"},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code: Promotion - parameter used to get the promotion - pricing (if available)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"account":{"type":"string","description":"Account ID: Account ID"},"class":{"type":"string","description":"Class: Class"},"created_by":{"type":"string","description":"Created by: Created by"},"created_date":{"type":"string","format":"date","description":"Created date: Created date"},"quota":{"type":"string","description":"Quota: Quota"},"quota_unit":{"type":"string","description":"Quota unit: Quota unit"},"quota_value":{"type":"string","description":"Quota value: Quota value"},"registration_expiration_date":{"type":"string","format":"date","description":"Registration expiration date: Registration expiration date"},"renewal_date":{"type":"string","format":"date","description":"Renewal date: Renewal date"},"renewalmode":{"type":"string","description":"Renewalmode: Renewalmode"},"status":{"type":"string","description":"Status: Status"},"updated_by":{"type":"string","description":"Updated by: Updated by"},"updated_date":{"type":"string","format":"date","description":"Updated date: Updated date"},"x-hosting-location":{"type":"string","description":"HOSTING-LOCATION: X-HOSTING-LOCATION"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddHosting"}},"/hosting/cpanel/{type}/-/availability":{"get":{"operationId":"checkHosting","summary":"XRRP command CheckHosting (checkHosting)","description":"Add a new webspace.\n","tags":["hosting"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"class","in":"query","required":true,"description":"Product class: Product class","schema":{"type":"string","enum":["CPANEL"],"description":"Product class: Product class"}},{"name":"type","in":"path","required":true,"description":"Hosting type","schema":{"type":"string","enum":["X-HOSTING-LOCATION","PACKAGE","FEATURELIST","PASSWORDSTRENGTH"],"description":"Hosting type"}},{"name":"object","in":"query","required":true,"description":"Object: Can be a hosting location, packagename, featurelistname","schema":{"type":"string","description":"Object: Can be a hosting location, packagename, featurelistname"}},{"name":"x-hosting-location","in":"query","description":"Hosting location: Hosting location (LON (LONDON), MEL (Melbourne), SG (Singapore), BUC (Bucharest), FLA (Florida), LAX (Los Angeles)","schema":{"type":"string","nullable":true,"description":"Hosting location: Hosting location (LON (LONDON), MEL (Melbourne), SG (Singapore), BUC (Bucharest), FLA (Florida), LAX (Los Angeles)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"package":{"type":"string","nullable":true,"description":"Package: Available package"},"region":{"type":"string","nullable":true,"description":"Region: Available region"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckHosting"}},"/hosting/cpanel/{type}/{object}":{"get":{"operationId":"statusHosting","summary":"XRRP command StatusHosting (statusHosting)","description":"Add a new webspace.\n","tags":["hosting"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"class","in":"query","required":true,"description":"Product class: Product class","schema":{"type":"string","enum":["CPANEL"],"description":"Product class: Product class"}},{"name":"type","in":"path","required":true,"description":"Hosting type: Type of hosting to get information","schema":{"type":"string","enum":["USERACCOUNT","DOMAINS","EMAIL","EMAILFORWARD","EMAILDOMAINFORWARD","FTPUSER","MYSQLDATABASE","MYSQLDATABASEUSER","MYSQLDATABASEUSERPRIVILEGES","BANDWIDTH","CPANELLOGIN","WEBMAILLOGIN","PACKAGE","FEATURELIST","QUOTA","PHPVERSION","RESOURCEUSAGE","FTP","SUBDOMAIN","CATCHALLADDRESS"],"description":"Hosting type: Type of hosting to get information"}},{"name":"object","in":"path","required":true,"description":"Object: Can be a domain, email, ftpuser, database","schema":{"type":"string","nullable":true,"description":"Object: Can be a domain, email, ftpuser, database"}},{"name":"account","in":"query","description":"Account ID: Account ID","schema":{"type":"string","nullable":true,"description":"Account ID: Account ID"}},{"name":"databasename","in":"query","description":"DATABASENAME: Databasename","schema":{"type":"string","nullable":true,"description":"DATABASENAME: Databasename"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"account":{"type":"string","description":"Account ID: Account ID"},"class":{"type":"string","description":"Class: Class"},"created_by":{"type":"string","description":"Created by: Created by"},"created_date":{"type":"string","format":"date-time","description":"Created date: Created date"},"quota":{"type":"string","description":"Quota: Quota"},"quota_unit":{"type":"string","description":"Quota unit: Quota unit"},"quota_value":{"type":"string","description":"Quota value: Quota value"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date: Registration expiration date"},"renewal_date":{"type":"string","format":"date-time","description":"Renewal date: Renewal date"},"renewalmode":{"type":"string","description":"Renewalmode: Renewalmode"},"status":{"type":"string","description":"Status: Status"},"updated_by":{"type":"string","description":"Updated by: Updated by"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Updated date"},"x-hosting-location":{"type":"string","description":"HOSTING-LOCATION: X-HOSTING-LOCATION"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusHosting"}},"/hosting/{account}/renew":{"post":{"operationId":"renewHosting","summary":"XRRP command RenewHosting (renewHosting)","description":"Add a new webspace.\n","tags":["hosting"],"parameters":[{"name":"account","in":"path","required":true,"description":"Account ID: Account ID","schema":{"type":"string","nullable":true,"description":"Account ID: Account ID"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"class":{"type":"string","enum":["CPANEL"],"description":"Product class: Product class"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"period":{"type":"integer","format":"int32","nullable":true,"description":"Period: Period 1 - 12  (DEFAULT: 1)"},"periodtype":{"type":"string","nullable":true,"enum":["MONTH"],"description":"Periodtype: Periodtype: month (DEFAULT: MONTH)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date: Registration expiration date"},"renewal_date":{"type":"string","format":"date-time","description":"Renewal date: Renewal date"},"renewalmode":{"type":"string","description":"Renewalmode: Renewalmode"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Updated date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RenewHosting"}},"/hosting/{type}/{account}/restore":{"patch":{"operationId":"restoreHosting","summary":"XRRP command RestoreHosting (restoreHosting)","description":"Add a new webspace.\n","tags":["hosting"],"parameters":[{"name":"type","in":"path","required":true,"description":"Hosting type: Type of hosting to restore","schema":{"type":"string","enum":["USERACCOUNT"],"description":"Hosting type: Type of hosting to restore"}},{"name":"account","in":"path","required":true,"description":"Account ID: Account ID","schema":{"type":"string","description":"Account ID: Account ID"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"class":{"type":"string","enum":["CPANEL"],"description":"Product class: Product class"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date: Registration expiration date"},"renewal_date":{"type":"string","format":"date-time","description":"Renewal date: Renewal date"},"renewalmode":{"type":"string","description":"Renewalmode: Renewalmode"},"status":{"type":"string","description":"Status: Status"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Updated date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RestoreHosting"}},"/idntag":{"get":{"operationId":"queryIDNTagList","summary":"XRRP command QueryIDNTagList (queryIDNTagList)","description":"Search for premium domain pricings\n","parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"zone","in":"query","description":"Search for premium domain prices for the given zone","schema":{"type":"string","nullable":true,"description":"Search for premium domain prices for the given zone"}},{"name":"domain","in":"query","description":"Search for premium domain prices for the given domain name","schema":{"type":"string","nullable":true,"description":"Search for premium domain prices for the given domain name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"description":{"type":"array","description":"Description: Detailed description of the language tag","items":{"type":"string","description":"Description: Detailed description of the language tag"}},"idn_language_tag":{"type":"array","description":"IDN Language Tag: IDN Language Tag or Script","items":{"type":"string","description":"IDN Language Tag: IDN Language Tag or Script"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryIDNTagList"}},"/job":{"get":{"operationId":"queryJobList","summary":"XRRP command QueryJobList (queryJobList)","description":"\n","tags":["job"],"parameters":[{"name":"commandname","in":"query","schema":{"type":"string","nullable":true}},{"name":"statuscode","in":"query","schema":{"type":"integer","format":"int32","nullable":true}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of jobs shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of jobs"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryJobList"}},"/job/{jobid}":{"delete":{"operationId":"deleteJob","summary":"XRRP command DeleteJob (deleteJob)","description":"\n","tags":["job"],"parameters":[{"name":"jobid","in":"path","required":true,"schema":{"type":"integer","format":"int64","nullable":true}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteJob"},"get":{"operationId":"statusJob","summary":"XRRP command StatusJob (statusJob)","description":"\n","tags":["job"],"parameters":[{"name":"jobid","in":"path","required":true,"schema":{"type":"integer","format":"int64","nullable":true}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"cltrid":{"type":"string","description":"Cltrid"},"command":{"type":"string"},"created_date":{"type":"string","format":"date-time"},"execute_date":{"type":"string","format":"date-time"},"job_id":{"type":"integer","format":"int64"},"log_index":{"type":"string"},"object_class":{"type":"string"},"object_id":{"type":"string"},"operation_type":{"type":"string"},"registrar":{"type":"string"},"roid":{"type":"string"},"runtime":{"type":"string","format":"decimal","description":"Runtime"},"statuscode":{"type":"integer","format":"int32"},"statusdescription":{"type":"string"},"svtrid":{"type":"string","description":"Svtrid"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusJob"}},"/monitoring":{"get":{"operationId":"queryMonitoringList","summary":"XRRP command QueryMonitoringList (queryMonitoringList)","description":"\n","parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"class","in":"query","required":true,"description":"Type of monitoring class to query","schema":{"type":"string","enum":["next_maintenance","running_maintenance","finished_maintenance"],"description":"Type of monitoring class to query"}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"days","in":"query","description":"Show the maintenances of the next or last X days","schema":{"type":"integer","format":"int32","nullable":true,"description":"Show the maintenances of the next or last X days"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"end_date":{"type":"string","format":"date-time","description":"Maintenance end date"},"mreg_name":{"type":"string","description":"Mreg name"},"opmode":{"type":"string","description":"Opmode"},"reason":{"type":"string"},"service_id":{"type":"string"},"service_name":{"type":"string"},"service_type":{"type":"string"},"start_date":{"type":"string","format":"date-time","description":"Maintenance start date"},"zones":{"type":"string","description":"A comma separated list of affected zones"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of monitorings shown"},"total":{"type":"integer","format":"int32","description":"Total: Total number of monitorings"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryMonitoringList"}},"/nameserver":{"get":{"operationId":"queryNameserverList","summary":"XRRP command QueryNameserverList (queryNameserverList)","description":"\n","tags":["nameserver"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"nameserver","in":"query","description":"Show only nameservers matching this pattern (wildcards allowed)","schema":{"type":"string","description":"Show only nameservers matching this pattern (wildcards allowed)"}},{"name":"parentdomain","in":"query","description":"Show only nameservers belonging to this domain","schema":{"type":"string","description":"Show only nameservers belonging to this domain"}},{"name":"wide","in":"query","description":"Show more or less details","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"column":{"type":"array","description":"List columns","items":{"type":"string","description":"List columns"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of nameservers shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"ipaddresses":{"type":"array","description":"IPs: IPAddresses of the nameserver","items":{"type":"string","description":"IPs: IPAddresses of the nameserver"}},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"nameserver":{"type":"array","description":"Nameserver: Hostname of the nameserver","items":{"type":"string","description":"Nameserver: Hostname of the nameserver"}},"status":{"type":"string","description":"Status"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing nameservers"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryNameserverList"},"post":{"operationId":"addNameserver","summary":"XRRP command AddNameserver (addNameserver)","description":"This command may be used to add a new nameserver (e.g. for GLUE - records).\nNote: The parent domain must be registered with Key-Systems and you can only add new nameservers and not nameservers which already exist.\n","tags":["nameserver"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"ipaddress":{"type":"array","description":"IP address","items":{"type":"string","nullable":true,"description":"IP address"}},"nameserver":{"type":"string","description":"Nameserver: The hostname of the new nameserver"},"status":{"type":"array","description":"Status","items":{"type":"string","nullable":true,"description":"Status"}},"token":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddNameserver"}},"/nameserver/-/availability":{"get":{"operationId":"checkNameservers","summary":"XRRP command CheckNameservers (checkNameservers)","description":"\n","tags":["nameserver"],"parameters":[{"name":"nameserver","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"nameservercheck":{"type":"array","description":"Check response","items":{"type":"string","description":"Check response"}},"nameserverchecktime":{"type":"array","description":"Check time","items":{"type":"string","description":"Check time"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckNameservers"}},"/nameserver/{nameserver}":{"delete":{"operationId":"deleteNameserver","summary":"XRRP command DeleteNameserver (deleteNameserver)","description":"The DeleteNameserver command allows you to delete same servers which were created through this system.\n","tags":["nameserver"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"nameserver","in":"path","required":true,"description":"Nameserver to be deleted","schema":{"type":"string","description":"Nameserver to be deleted"}},{"name":"force","in":"query","description":"Renames the name server in the background and enables the deletion of the parent domain.","schema":{"type":"string","enum":["0","1"],"description":"Renames the name server in the background and enables the deletion of the parent domain."}},{"name":"token","in":"query","description":"Token: The one time authorization token for protected domain names.","schema":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteNameserver"},"get":{"operationId":"statusNameserver","summary":"XRRP command StatusNameserver (statusNameserver)","description":"\n","tags":["nameserver"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"nameserver","in":"path","required":true,"description":"Nameserver to fetch the details for","schema":{"type":"string","description":"Nameserver to fetch the details for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"created_by":{"type":"string","description":"Created by: Account the nameserver was created in"},"created_date":{"type":"string","format":"date-time","description":"Created date: Date, when the nameserver was created"},"ipaddress":{"type":"array","description":"IP address: IP - address(es) of the nameserver","items":{"type":"string","description":"IP address: IP - address(es) of the nameserver"}},"nameserver":{"type":"string","description":"Nameserver: Hostname of the nameserver"},"registrar":{"type":"string"},"registrar_transfer_date":{"type":"string","format":"date","description":"Registrar transfer date"},"roid":{"type":"string","description":"Roid"},"status":{"type":"array","description":"Nameserver status","items":{"type":"string","description":"Nameserver status"}},"updated_by":{"type":"string","description":"Updated by: Account, who did the last update for the nameserver"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Date, when the nameserver was last updated"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusNameserver"},"patch":{"operationId":"modifyNameserver","summary":"XRRP command ModifyNameserver (modifyNameserver)","description":"This command allows you to modify existing nameservers, e.g. change the IP - addresses associated with it.\nNote: You can only modify those nameservers which were created through this system.\n","tags":["nameserver"],"parameters":[{"name":"nameserver","in":"path","required":true,"description":"Nameserver: Nameserver to be changed","schema":{"type":"string","description":"Nameserver: Nameserver to be changed"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addipaddress":{"type":"array","items":{"type":"string"}},"addstatus":{"type":"array","items":{"type":"string","nullable":true}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"delipaddress":{"type":"array","items":{"type":"string"}},"delstatus":{"type":"array","items":{"type":"string","nullable":true}},"ipaddress":{"type":"array","description":"IP address","items":{"type":"string","nullable":true,"description":"IP address"}},"newnameserver":{"type":"string"},"status":{"type":"array","description":"Status","items":{"type":"string","nullable":true,"description":"Status"}},"token":{"type":"string","nullable":true,"description":"Token: The one time authorization token for protected domain names."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyNameserver"}},"/nameserver/{nameserver}/availability":{"get":{"operationId":"checkNameserver","summary":"XRRP command CheckNameserver (checkNameserver)","description":"\n","tags":["nameserver"],"parameters":[{"name":"nameserver","in":"path","required":true,"schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"ipaddress":{"type":"array","description":"IP address: If the nameserver is not available, the given IP address(es) are assigned","items":{"type":"string","description":"IP address: If the nameserver is not available, the given IP address(es) are assigned"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckNameserver"}},"/notification/{type}/{object}":{"put":{"operationId":"resendNotification","summary":"XRRP command ResendNotification (resendNotification)","description":"\n","parameters":[{"name":"type","in":"path","required":true,"description":"Type of notification to resend","schema":{"type":"string","enum":["domaintransfer","certificate","trademark","claimsnotice","contactverification","ownerchange"],"description":"Type of notification to resend"}},{"name":"object","in":"path","required":true,"description":"Object Name: Domain or Certificate ID or Trademark or Email address","schema":{"type":"string","description":"Object Name: Domain or Certificate ID or Trademark or Email address"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"reason":{"type":"string","nullable":true,"description":"Reason: Reason message for resending the notification"},"recipient":{"type":"string","nullable":true,"enum":["owner","admin","gaining","losing","both"],"description":"Recipient: Who should receive the notify again"},"sub":{"type":"string","nullable":true,"description":"Certificate: The ID of the certificate sub where the notification should be send again"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"admin":{"type":"string","description":"Admin: FOA mail Admin"},"owner":{"type":"string","description":"Owner: FOA mail Owner"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ResendNotification"}},"/objectlog":{"get":{"operationId":"queryObjectLogList","summary":"XRRP command QueryObjectLogList (queryObjectLogList)","description":"\n","parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"objectid","in":"query","schema":{"type":"string"}},{"name":"objectclass","in":"query","schema":{"type":"string"}},{"name":"mindate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"maxdate","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"commandname","in":"query","schema":{"type":"string"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"zone","in":"query","schema":{"type":"string"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["LOG","LOGDATE","COMMANDNAME","OBJECTCLASS"],"description":"Sort the result by this column"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"log":{"type":"integer","format":"int32","description":"ID: ID of the log - entry"},"log_date":{"type":"string","format":"date-time","description":"Date: Date, when this request was made"},"object_class":{"type":"string","description":"Object class: Class of the object for which the request was made"},"object_id":{"type":"string","description":"Object ID: Identifier of the object for which this request was made"},"operation_status":{"type":"string","enum":["REQUEST"],"description":"Operation status"},"operation_type":{"type":"string","description":"Operation type: Type of operation made in this request"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of log entries shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of log entries"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryObjectLogList"}},"/objectlog/{log}":{"get":{"operationId":"statusObjectLog","summary":"XRRP command StatusObjectLog (statusObjectLog)","description":"\n","parameters":[{"name":"log","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"cltrid":{"type":"string","description":"Cltrid"},"id_class":{"type":"string"},"log_date":{"type":"string","format":"date-time"},"object_class":{"type":"string"},"operation_info":{"type":"string"},"operation_type":{"type":"string"},"svtrid":{"type":"string","description":"Svtrid"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusObjectLog"}},"/payment/card":{"post":{"operationId":"addPaymentCard","summary":"XRRP command AddPaymentCard (addPaymentCard)","description":"\n","tags":["payment"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accept-tac":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept the terms and agreements of the creditcard payment"},"action":{"type":"string","nullable":true,"enum":["SAVE","DELETE","CHARGE"],"description":"parameter to save or delete stored cc details, or to charge regularly"},"amount":{"type":"string","format":"decimal","description":"Amount: Amount in decimal that will be used to top up the account balance"},"auto":{"type":"string","nullable":true,"enum":["0","1"],"description":"Use stored card: Flag to trigger an automated payment for the stored payment token."},"bi-acceptheader":{"type":"string","nullable":true,"description":"Browser Information Accept Header"},"bi-colordepth":{"type":"integer","format":"int32","nullable":true,"description":"Browser Information Color Depth"},"bi-javaenabled":{"type":"string","nullable":true,"enum":["0","1"],"description":"Browser Information Java Enabled"},"bi-language":{"type":"string","nullable":true,"description":"Browser Information Language"},"bi-screenheight":{"type":"integer","format":"int32","nullable":true,"description":"Browser Information Screen Height"},"bi-screenwidth":{"type":"integer","format":"int32","nullable":true,"description":"Browser Information Screen Width"},"bi-timezoneoffset":{"type":"integer","format":"int32","nullable":true,"description":"Browser Information Time Zone Offset"},"bi-useragent":{"type":"string","nullable":true,"description":"Browser Information User Agent"},"billingaddress-building":{"type":"string","nullable":true,"description":"Billing Address Building: Billing Address House Number or Building Name"},"billingaddress-city":{"type":"string","nullable":true,"description":"Billing Address City: Billing Address City"},"billingaddress-country":{"type":"string","nullable":true,"description":"Billing Address Country: Billing Address Country"},"billingaddress-street":{"type":"string","nullable":true,"description":"Billing Address Street: Billing Address Street"},"billingaddress-zip":{"type":"string","nullable":true,"description":"Billing Address ZIP: Billing Address ZIP Code"},"cardbrand":{"type":"string","nullable":true,"description":"Credit Card Brand: Credit Card Brand e.g. VISA, MASTERCARD, AMEX."},"cardexpiration":{"type":"integer","format":"int32","nullable":true,"description":"Expiration date: Expirationdate of the creditcard (YYMM)"},"cardholder":{"type":"string","nullable":true,"description":"Card Holder: Card holder of the creditcard"},"cardholder-phone":{"type":"string","nullable":true,"description":"Card Holder Phone: Card holder phone number"},"cardholderemail":{"type":"string","nullable":true,"description":"Card Holder Email: Card holder email address of the creditcard"},"cardpan":{"type":"string","nullable":true,"description":"Masked Credit Card PAN: Masked Credit Card PAN to view in storage data."},"cardtoken":{"type":"string","nullable":true,"description":"Card Token: The authenticated token to process the credit card payment."},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"currency":{"type":"string","nullable":true,"description":"Currency: Currency of the amount that will be charged"},"deliveryaddress-city":{"type":"string","nullable":true,"description":"Delivery Address City: Delivery Address City"},"deliveryaddress-country":{"type":"string","nullable":true,"description":"Delivery Address Country: Delivery Address Country"},"deliveryaddress-street":{"type":"string","nullable":true,"description":"Delivery Address Street: Delivery Address Street"},"nonce":{"type":"string","nullable":true,"description":"Nonce: The one time nonce required to authenticate the cardtoken on saving a creditcard."},"shopper-ip":{"type":"string","nullable":true,"description":"IP address of the shopper"},"total":{"type":"string","format":"decimal","nullable":true,"description":"Total: Total amount that will be charged for the credit card holder"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"action_type":{"type":"string","description":"Action type for status ACTIONREQUIRED."},"action_url":{"type":"string","description":"Action URL for status ACTIONREQUIRED."},"amount":{"type":"string","description":"Amount of the payment"},"amount_charged":{"type":"string","description":"Amount accounted in the payment currency"},"currency":{"type":"string","description":"Currency of the payment"},"currency_charged":{"type":"string","description":"Currency that was used for the payment"},"email":{"type":"string","description":"Email status"},"error":{"type":"string","description":"Error description from the payment provider in case of error."},"error_code":{"type":"string","description":"Error code from the payment provider in case of error."},"file":{"type":"string","description":"Receipt file link"},"message":{"type":"string","description":"Contains additional information in case of validation errors."},"paymentid":{"type":"string","description":"Unique PaymentID of the payment from the payment provider."},"rate":{"type":"string","description":"Exchange rate between currency and payment currency"},"receipt":{"type":"string","description":"Receipt status"},"record":{"type":"string","description":"Unique RecordID of the payment from the SHS API."},"status":{"type":"string","description":"Status of the payment."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddPaymentCard"}},"/price":{"delete":{"operationId":"deletePrice","summary":"XRRP command DeletePrice (deletePrice)","description":"Deletes individual subreseller prices or pricescale prices of a specific zone or service.\n","tags":["subreseller"],"parameters":[{"name":"period","in":"query","description":"The period of the price that should be deleted. If not entered all period prices will be deleted.","schema":{"type":"array","description":"The period of the price that should be deleted. If not entered all period prices will be deleted.","items":{"type":"integer","format":"int32","nullable":true,"description":"The period of the price that should be deleted. If not entered all period prices will be deleted."}}},{"name":"periodtype","in":"query","description":"The periodtype of the price that should be deleted. Default is \"YEAR\".","schema":{"type":"array","description":"The periodtype of the price that should be deleted. Default is \"YEAR\".","items":{"type":"string","nullable":true,"description":"The periodtype of the price that should be deleted. Default is \"YEAR\"."}}},{"name":"pricescale","in":"query","description":"The pricescale where a price should be deleted.","schema":{"type":"string","nullable":true,"description":"The pricescale where a price should be deleted."}},{"name":"service","in":"query","description":"The service zone where a price should be deleted.","schema":{"type":"array","description":"The service zone where a price should be deleted.","items":{"type":"string","nullable":true,"description":"The service zone where a price should be deleted."}}},{"name":"type","in":"query","description":"The type of the service zone where a price should be deleted.","schema":{"type":"array","description":"The type of the service zone where a price should be deleted.","items":{"type":"string","nullable":true,"description":"The type of the service zone where a price should be deleted."}}},{"name":"date","in":"query","description":"the date when the price should be deleted. if not entered it will be deleted directly. Can also be used to delete a pending price change!","schema":{"type":"array","description":"the date when the price should be deleted. if not entered it will be deleted directly. Can also be used to delete a pending price change!","items":{"type":"string","nullable":true,"description":"the date when the price should be deleted. if not entered it will be deleted directly. Can also be used to delete a pending price change!"}}},{"name":"status","in":"query","description":"Deletes an active or pending price entry. Default is ACTIVE.","schema":{"type":"string","nullable":true,"enum":["ACTIVE","PENDING"],"description":"Deletes an active or pending price entry. Default is ACTIVE."}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"registrar","in":"query","description":"The registrar where a individual price should be deleted.","schema":{"type":"string","nullable":true,"description":"The registrar where a individual price should be deleted."}},{"name":"zone","in":"query","description":"The tld zone where a price should be deleted.","schema":{"type":"array","description":"The tld zone where a price should be deleted.","items":{"type":"string","nullable":true,"description":"The tld zone where a price should be deleted."}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"description":{"type":"array","description":"Description of a failed deletion","items":{"type":"string","description":"Description of a failed deletion"}},"period":{"type":"array","description":"Period of the zone or service that was deleted","items":{"type":"string","description":"Period of the zone or service that was deleted"}},"periodtype":{"type":"array","description":"Periodtype of the zone or service that was deleted","items":{"type":"string","description":"Periodtype of the zone or service that was deleted"}},"pricescale":{"type":"string","description":"Pricescale name"},"service":{"type":"array","description":"Service that was deleted","items":{"type":"string","description":"Service that was deleted"}},"status":{"type":"array","description":"Status: DeletePrice can fail if e.g. there is no individual price for this subuser and this zone.","items":{"type":"string","enum":["deleted successfully","delete failed"],"description":"Status: DeletePrice can fail if e.g. there is no individual price for this subuser and this zone."}},"type":{"type":"array","description":"Type of service that was deleted","items":{"type":"string","description":"Type of service that was deleted"}},"zone":{"type":"array","description":"Zone","items":{"type":"string","description":"Zone"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeletePrice"},"patch":{"operationId":"modifyPrice","summary":"XRRP command ModifyPrice (modifyPrice)","description":"The ModifyPrice command offers three different functionalities:\nChange / submit prices in an existing pricescale\nChange / submit individual prices of a reseller\nChange / submit price changes for invidiual prices or pricescales for a zone or service\nAssign pricescale to reseller\n","tags":["subreseller"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"annual":{"type":"array","description":"The main price charged for most actions, multiplied by period.","items":{"type":"string","format":"decimal","nullable":true,"description":"The main price charged for most actions, multiplied by period."}},"application":{"type":"array","description":"nonrefundable setupfee charged on creations","items":{"type":"string","format":"decimal","nullable":true,"description":"nonrefundable setupfee charged on creations"}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"comment":{"type":"array","description":"Comment for the price modification","items":{"type":"string","nullable":true,"description":"Comment for the price modification"}},"currency":{"type":"array","description":"The currency of the prices","items":{"type":"string","nullable":true,"description":"The currency of the prices"}},"date":{"type":"array","description":"the activationdate when the new price will be available. if not entered it will be activated directly.","items":{"type":"string","nullable":true,"description":"the activationdate when the new price will be available. if not entered it will be activated directly."}},"description":{"type":"string","nullable":true,"description":"The description of the pricescale"},"operator":{"type":"string","nullable":true,"description":"Changelog user who made the changes to the prices."},"period":{"type":"array","description":"The period of the price that should be added.Only available for services.","items":{"type":"string","nullable":true,"description":"The period of the price that should be added.Only available for services."}},"periodtype":{"type":"array","description":"The periodtype of the price that should be modified.","items":{"type":"string","nullable":true,"description":"The periodtype of the price that should be modified."}},"pricescale":{"type":"string","nullable":true,"description":"Name of the pricescale to modify"},"registrar":{"type":"string","nullable":true,"description":"Name of the registrar"},"remark":{"type":"array","description":"A remark for this price entry. Only visible to the maintainer of the price.","items":{"type":"string","nullable":true,"description":"A remark for this price entry. Only visible to the maintainer of the price."}},"restore":{"type":"array","description":"The restore fee","items":{"type":"string","format":"decimal","nullable":true,"description":"The restore fee"}},"service":{"type":"array","description":"The service name where the price will be modified","items":{"type":"string","nullable":true,"description":"The service name where the price will be modified"}},"setup":{"type":"array","description":"setupfee charged on creations","items":{"type":"string","format":"decimal","nullable":true,"description":"setupfee charged on creations"}},"trade":{"type":"array","description":"The trade fee","items":{"type":"string","format":"decimal","nullable":true,"description":"The trade fee"}},"transfer":{"type":"array","description":"The transfer fee","items":{"type":"string","format":"decimal","nullable":true,"description":"The transfer fee"}},"type":{"type":"array","description":"The class of the service where the price will be modified","items":{"type":"string","nullable":true,"description":"The class of the service where the price will be modified"}},"zone":{"type":"array","description":"The tld zone where the price will be modified","items":{"type":"string","nullable":true,"description":"The tld zone where the price will be modified"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"description":{"type":"array","description":"Description of a failed modification","items":{"type":"string","description":"Description of a failed modification"}},"period":{"type":"array","description":"Period of the zone or service that was modified","items":{"type":"string","description":"Period of the zone or service that was modified"}},"periodtype":{"type":"array","description":"Periodtype of the zone or service that was modified","items":{"type":"string","description":"Periodtype of the zone or service that was modified"}},"pricescale":{"type":"array","description":"Pricescale name","items":{"type":"string","description":"Pricescale name"}},"registrar":{"type":"array","description":"Registrar name","items":{"type":"string","description":"Registrar name"}},"service":{"type":"array","description":"Service that was modified","items":{"type":"string","description":"Service that was modified"}},"status":{"type":"array","description":"Status of the modification","items":{"type":"string","description":"Status of the modification"}},"type":{"type":"array","description":"Type of service that was modified","items":{"type":"string","description":"Type of service that was modified"}},"zone":{"type":"array","description":"Zone that was modified","items":{"type":"string","description":"Zone that was modified"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyPrice"}},"/price/-/history":{"get":{"operationId":"queryPriceHistoryList","summary":"XRRP command QueryPriceHistoryList (queryPriceHistoryList)","description":"\n","tags":["price"],"parameters":[{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"maxdate","in":"query","description":"All changes before the given date","schema":{"type":"string","format":"date","nullable":true,"description":"All changes before the given date"}},{"name":"mindate","in":"query","description":"All changes after the given date","schema":{"type":"string","format":"date","nullable":true,"description":"All changes after the given date"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["CHANGEDATE"],"description":"Sort the result by this column"}},{"name":"period","in":"query","description":"The period of the prices that should be shown. default is 1.","schema":{"type":"integer","format":"int32","nullable":true,"description":"The period of the prices that should be shown. default is 1."}},{"name":"periodtype","in":"query","description":"The periodtype of the prices that should be shown. default is YEAR.","schema":{"type":"string","nullable":true,"description":"The periodtype of the prices that should be shown. default is YEAR."}},{"name":"pricescale","in":"query","description":"The prices of the pricescale that will be selected","schema":{"type":"string","nullable":true,"description":"The prices of the pricescale that will be selected"}},{"name":"registrar","in":"query","description":"The individual prices of the registrar that will be selected","schema":{"type":"string","nullable":true,"description":"The individual prices of the registrar that will be selected"}},{"name":"service","in":"query","description":"The service that will be selected","schema":{"type":"string","nullable":true,"description":"The service that will be selected"}},{"name":"status","in":"query","description":"Shows only active or pending price changes. Default is both.","schema":{"type":"string","nullable":true,"enum":["ACTIVE","PENDING"],"description":"Shows only active or pending price changes. Default is both."}},{"name":"type","in":"query","description":"The tpye of service that will be selected","schema":{"type":"string","nullable":true,"description":"The tpye of service that will be selected"}},{"name":"individual","in":"query","description":"The own individual prices will be selected. Otherwise the own pricesale prices will be selected.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"The own individual prices will be selected. Otherwise the own pricesale prices will be selected."}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"zone","in":"query","description":"The zone that will be selected","schema":{"type":"string","nullable":true,"description":"The zone that will be selected"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"annual":{"type":"string","format":"decimal","description":"Annual fee: Annual fee charged for this zone"},"application":{"type":"string","format":"decimal","description":"Application fee: Application fee charged for this zone (if available)"},"changedate":{"type":"string","format":"date-time","description":"Changedate: The date of the modification"},"comment":{"type":"string","description":"Comment: The comment for the modification"},"currency":{"type":"string","description":"Currency: The currency, this zone will be accounted in"},"operator":{"type":"string","description":"Operator: The user who made the modification"},"period":{"type":"string","description":"Period"},"periodtype":{"type":"string","description":"Period type: Is the period monthly or yearly"},"pricescale":{"type":"string","description":"Pricescale: The pricescale for this dataset"},"registrar":{"type":"string","description":"Registrar: The registrar for this dataset"},"restore":{"type":"string","format":"decimal","description":"Restore fee: Restore fee charged for this zone (if available)"},"service":{"type":"string","description":"Service: The zone for this dataset"},"setup":{"type":"string","format":"decimal","description":"Setup fee: Setup fee ccharged for this zone"},"status":{"type":"string","description":"Status: The status of the modification"},"trade":{"type":"string","format":"decimal","description":"Trade fee: Trade fee charged for this zone (if available)"},"transfer":{"type":"string","format":"decimal","description":"Transfer fee: Transfer fee charged for this zone"},"type":{"type":"string","description":"Type: The zone for this dataset"},"zone":{"type":"string","description":"Zone: The zone for this dataset"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of accountings shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing accountings"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryPriceHistoryList"}},"/price/-/promotion":{"get":{"operationId":"queryAvailablePromotionList","summary":"XRRP command QueryAvailablePromotionList (queryAvailablePromotionList)","description":"This commands shows all promotions that are currently available for your account and your original standard price.\n","tags":["price"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"type","in":"query","description":"Defines if either currently running, upcoming or finished promotions will he shown in the list. Default is RUNNING.","schema":{"type":"string","nullable":true,"enum":["RUNNING","UPCOMING","FINISHED"],"description":"Defines if either currently running, upcoming or finished promotions will he shown in the list. Default is RUNNING."}},{"name":"date","in":"query","description":"Set a date to list all active promotions for this date. Only available for FINISHED type.","schema":{"type":"string","format":"date","nullable":true,"description":"Set a date to list all active promotions for this date. Only available for FINISHED type."}},{"name":"zone","in":"query","description":"Pattern match for zone","schema":{"type":"string","nullable":true,"description":"Pattern match for zone"}},{"name":"promotion","in":"query","description":"Pattern match for promotion name","schema":{"type":"string","nullable":true,"description":"Pattern match for promotion name"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["ZONE","PROMOTION","STARTDATE","ENDDATE"],"description":"Sort the result by this column"}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"application":{"type":"string","format":"decimal","description":"Application: The application promotion price"},"available":{"type":"integer","format":"int32","description":"Counter: How often the promotion can be used until it is no more available. No value means unlimited."},"currency":{"type":"string","description":"Currency: The currency of the promotion prices"},"enddate":{"type":"string","format":"date-time","description":"Enddate: The enddate of the promotion"},"maxperiod":{"type":"integer","format":"int32","description":"Maxperiod: The maxperiod needed to use the promotion"},"minperiod":{"type":"integer","format":"int32","description":"Minperiod: The minperiod needed to use the promotion"},"objectpattern":{"type":"string","description":"Objectpattern: The objectpattern that has to match with the object to use the promotion"},"periodtype":{"type":"string","description":"Periodtype: The periodtype of the promotion"},"promotion":{"type":"string","description":"Promotion: The unique promotion name"},"promotype":{"type":"string","description":"Promotype: The type of the promotion"},"service":{"type":"string","description":"Service: The service for the promotion"},"setup":{"type":"string","format":"decimal","description":"Setup: The setup promotion price"},"startdate":{"type":"string","format":"date-time","description":"Startdate: The startdate of the promotion"},"transfer":{"type":"string","format":"decimal","description":"Transfer: The transfer promotion price"},"type":{"type":"string","description":"Type: The type of service for the promotion"},"unit":{"type":"string","format":"decimal","description":"Unit: The unit promotion price"},"used":{"type":"integer","format":"int32","description":"Used: How often the promotion was used by you"},"zone":{"type":"string","description":"Zone: The zone for the promotion"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of promotions shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"promoactions":{"type":"string","description":"Promoactions: The actions eligible for this promotion"},"promocode":{"type":"string","description":"Promocode: The promocode required to use the promotion"},"restore":{"type":"string","format":"decimal","description":"Restore: The restore promotion price"},"standard_application":{"type":"string","format":"decimal","description":"Standard Application: The standard application price for the product."},"standard_currency":{"type":"string","description":"Standard Currency: The standard currency for the product."},"standard_restore":{"type":"string","format":"decimal","description":"Standard Restore: The standard restore price for the product."},"standard_setup":{"type":"string","format":"decimal","description":"Standard Setup: The standard setup price for the product."},"standard_trade":{"type":"string","format":"decimal","description":"Standard Trade: The standard trade price for the product."},"standard_transfer":{"type":"string","format":"decimal","description":"Standard Transfer: The standard transfer price for the product."},"standard_unit":{"type":"string","format":"decimal","description":"Standard Unit: The standard unit price for the product."},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing promotions"},"trade":{"type":"string","format":"decimal","description":"Trade: The trade promotion price"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAvailablePromotionList"}},"/price/-/service":{"get":{"operationId":"servicePrice","summary":"XRRP command ServicePrice (servicePrice)","description":"The ServicePrice command can be used to get the amount that will be charged for a service for a specific action.\n","tags":["price"],"parameters":[{"name":"period","in":"query","description":"The period that will be calculated. Default is 1.","schema":{"type":"string","nullable":true,"description":"The period that will be calculated. Default is 1."}},{"name":"periodtype","in":"query","description":"The periodtype that will be used for calculation. Default is YEAR.","schema":{"type":"string","nullable":true,"description":"The periodtype that will be used for calculation. Default is YEAR."}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"action","in":"query","description":"The action that should be calculated","schema":{"type":"string","nullable":true,"enum":["ADD","RENEW","TRANSFER"],"description":"The action that should be calculated"}},{"name":"service","in":"query","description":"The service that should be calculated","schema":{"type":"string","nullable":true,"description":"The service that should be calculated"}},{"name":"type","in":"query","description":"The service class","schema":{"type":"string","nullable":true,"description":"The service class"}},{"name":"domain","in":"query","description":"The domainname for applications with premium domain names.","schema":{"type":"string","nullable":true,"description":"The domainname for applications with premium domain names."}},{"name":"x-promotion-code","in":"query","description":"Promotion code to be used for calculating the price","schema":{"type":"string","nullable":true,"description":"Promotion code to be used for calculating the price"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"action":{"type":"string","description":"Type: The type which is calculated. Add, renew, transfer, trade or restore (if available)."},"annual":{"type":"string","format":"decimal","description":"Annual fee: period fee to be paid for this servicetype"},"application":{"type":"string","format":"decimal","nullable":true,"description":"Application fee: Non refundable setupfee for this servicetype"},"currency":{"type":"string","description":"Currency: Currency of the prices for this servicetype"},"exchangerate":{"type":"number","format":"float","nullable":true,"description":"Exchange rate: Exchange rate used to calculate the service price"},"nonrefundable":{"type":"string","format":"decimal","description":"NONREFUNDABLE: The nonrefundable part of the price for this accounting"},"period":{"type":"integer","format":"int32","description":"Period: The period amount calculated for the price"},"periodtype":{"type":"string","description":"Periodtype: The periodtype of the priceperiod used to get the pricing"},"price":{"type":"string","format":"decimal","description":"Price: The amount that will be charged for this servicetype from your account."},"priceperiod":{"type":"string","description":"Priceperiod: The period for the periodtype used to get the pricing"},"promotion":{"type":"array","description":"Promotion: Promotion used to calculate the price","items":{"type":"string","description":"Promotion: Promotion used to calculate the price"}},"restore":{"type":"string","format":"decimal","nullable":true,"description":"Restore fee: Fee charged for restores  (if available)"},"service":{"type":"string","description":"Service: The service for the pricing"},"setup":{"type":"string","format":"decimal","nullable":true,"description":"Setup fee: Refundabel setup fee to be paid for this servicetype"},"trade":{"type":"string","format":"decimal","nullable":true,"description":"Trade fee: Trade fee for this servicetype (if available)"},"transfer":{"type":"string","format":"decimal","description":"Transfer fee: Transfer fee for this servicetype  (if available)"},"type":{"type":"string","description":"Type: Type of the service"},"vat":{"type":"string","format":"decimal","description":"VAT: The vat that will be charged for this servicetype from your account."},"vatnonrefundable":{"type":"string","format":"decimal","description":"VATNONREFUNDABLE: The nonrefundable part of the vat for this accounting"},"vatpercent":{"type":"number","format":"float","nullable":true,"description":"VAT: VAT % that will be charged"},"zonecurrency":{"type":"string","description":"Zone currency: Price currency of the servicetype"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ServicePrice"}},"/price/-/zone":{"get":{"operationId":"queryZonePriceList","summary":"XRRP command QueryZonePriceList (queryZonePriceList)","description":"The QueryZonePricesList command views all individual registrar prices and pricescale prices for a specific zone or service or all individual prices of a registrar or all pricescale prices for a specific pricescale.\n","tags":["subreseller"],"parameters":[{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["REGISTRAR","PRICESCALE","ZONE","SERVICE","TYPE","PERIOD","PERIODTYPE","SETUP","ANNUAL","TRANSFER","TRADE","RESTORE","APPLICATION","CURRENCY"],"description":"Sort the result by this column"}},{"name":"service","in":"query","description":"Services: Shows all pricescale and individual registrar prices for this services","schema":{"type":"array","description":"Services: Shows all pricescale and individual registrar prices for this services","items":{"type":"string","nullable":true,"description":"Services: Shows all pricescale and individual registrar prices for this services"}}},{"name":"type","in":"query","description":"Types: Shows all pricescale and individual registrar prices for this service types","schema":{"type":"array","description":"Types: Shows all pricescale and individual registrar prices for this service types","items":{"type":"string","nullable":true,"description":"Types: Shows all pricescale and individual registrar prices for this service types"}}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"zone","in":"query","description":"Zones: Shows all pricescale and individual registrar prices for this zones","schema":{"type":"array","description":"Zones: Shows all pricescale and individual registrar prices for this zones","items":{"type":"string","nullable":true,"description":"Zones: Shows all pricescale and individual registrar prices for this zones"}}},{"name":"registrar","in":"query","description":"Registrars: Show only the individual prices for this registrars","schema":{"type":"array","description":"Registrars: Show only the individual prices for this registrars","items":{"type":"string","nullable":true,"description":"Registrars: Show only the individual prices for this registrars"}}},{"name":"pricescale","in":"query","description":"Pricescales: Show only the prices for this pricescales","schema":{"type":"array","description":"Pricescales: Show only the prices for this pricescales","items":{"type":"string","nullable":true,"description":"Pricescales: Show only the prices for this pricescales"}}},{"name":"period","in":"query","description":"Period: The period of the prices that should be shown.","schema":{"type":"integer","format":"int32","nullable":true,"description":"Period: The period of the prices that should be shown."}},{"name":"periodtype","in":"query","description":"Period Type: The periodtype of the prices that should be shown.","schema":{"type":"string","nullable":true,"description":"Period Type: The periodtype of the prices that should be shown."}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"annual":{"type":"string","format":"decimal","description":"Annual fee: Annual fee charged for this zone"},"application":{"type":"string","format":"decimal","description":"Application fee: Application fee charged for this zone (if available)"},"currency":{"type":"string","description":"Currency: The currency, this zone will be accounted in"},"period":{"type":"string","description":"Period"},"periodtype":{"type":"string","description":"Period type: Is the period monthly or yearly"},"pricescale":{"type":"string","description":"Pricescale: The pricescale for this dataset"},"registrar":{"type":"string","description":"Registrar: The registrar for this dataset"},"remark":{"type":"string","description":"Remark: A remark regarding this price entry. Only visible to the maintainer of the price."},"restore":{"type":"string","format":"decimal","description":"Restore fee: Restore fee charged for this zone (if available)"},"service":{"type":"string","description":"Service: The zone for this dataset"},"setup":{"type":"string","format":"decimal","description":"Setup fee: Setup fee ccharged for this zone"},"trade":{"type":"string","format":"decimal","description":"Trade fee: Trade fee charged for this zone (if available)"},"transfer":{"type":"string","format":"decimal","description":"Transfer fee: Transfer fee charged for this zone"},"type":{"type":"string","description":"Type: The zone for this dataset"},"zone":{"type":"string","description":"Zone: The zone for this dataset"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of accountings shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing accountings"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryZonePriceList"}},"/pricescale":{"get":{"operationId":"queryPriceScaleList","summary":"XRRP command QueryPriceScaleList (queryPriceScaleList)","description":"Returns all pricescales which are owned and created by the querying user.\n","tags":["price"],"parameters":[{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["PRICESCALE"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description: Description of the pricescale"},"pricescale":{"type":"string","description":"Pricescale: Name of the pricescale"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of pricescales shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing pricescales"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryPriceScaleList"},"post":{"operationId":"addPriceScale","summary":"XRRP command AddPriceScale (addPriceScale)","description":"Adds a new pricescale.\n","tags":["price"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"annual":{"type":"array","description":"The main price charged for most actions, multiplied by period.","items":{"type":"string","format":"decimal","nullable":true,"description":"The main price charged for most actions, multiplied by period."}},"application":{"type":"array","description":"nonrefundable setupfee charged on creations","items":{"type":"string","format":"decimal","nullable":true,"description":"nonrefundable setupfee charged on creations"}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"copy":{"type":"string","nullable":true,"description":"The pricescale that should be used as a copy template. OWN and ALL are keywords that can be used at all times."},"currency":{"type":"array","description":"The currency of the prices","items":{"type":"string","nullable":true,"description":"The currency of the prices"}},"date":{"type":"array","description":"the activationdate when the new price will be available. if not entered it will be activated directly.","items":{"type":"string","nullable":true,"description":"the activationdate when the new price will be available. if not entered it will be activated directly."}},"description":{"type":"string","description":"The description of the pricescale"},"operation":{"type":"string","nullable":true,"enum":["*","+"],"description":"The operation that should be applied to the copy template."},"operator":{"type":"string","nullable":true,"description":"The username that will be logged in the price history"},"period":{"type":"array","description":"The period of the price that should be added.Only available for services.","items":{"type":"string","nullable":true,"description":"The period of the price that should be added.Only available for services."}},"periodtype":{"type":"array","description":"The periodtype of the price that should be added.","items":{"type":"string","nullable":true,"description":"The periodtype of the price that should be added."}},"pricescale":{"type":"string","description":"The name of the pricescale. All numeric and alphanumeric chars can be used."},"restore":{"type":"array","description":"The restore fee","items":{"type":"string","format":"decimal","nullable":true,"description":"The restore fee"}},"service":{"type":"array","description":"The service name where the price will be modified","items":{"type":"string","nullable":true,"description":"The service name where the price will be modified"}},"setup":{"type":"array","description":"setupfee charged on creations","items":{"type":"string","format":"decimal","nullable":true,"description":"setupfee charged on creations"}},"trade":{"type":"array","description":"The trade fee","items":{"type":"string","format":"decimal","nullable":true,"description":"The trade fee"}},"transfer":{"type":"array","description":"The transfer fee","items":{"type":"string","format":"decimal","nullable":true,"description":"The transfer fee"}},"type":{"type":"array","description":"The class of the service where the price will be modified","items":{"type":"string","nullable":true,"description":"The class of the service where the price will be modified"}},"value":{"type":"string","format":"decimal","nullable":true,"description":"The value that will be added or multiplied if you use the operator and copy template."},"zone":{"type":"array","description":"The tld zone where the price will be modified","items":{"type":"string","nullable":true,"description":"The tld zone where the price will be modified"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"description":{"type":"array","description":"Description of a failed modification","items":{"type":"string","description":"Description of a failed modification"}},"period":{"type":"array","description":"Period of the zone or service that was modified","items":{"type":"string","description":"Period of the zone or service that was modified"}},"periodtype":{"type":"array","description":"Periodtype of the zone or service that was modified","items":{"type":"string","description":"Periodtype of the zone or service that was modified"}},"pricescale":{"type":"string","description":"Pricescale name"},"service":{"type":"array","description":"Service that was modified","items":{"type":"string","description":"Service that was modified"}},"status":{"type":"array","description":"Status of the modification","items":{"type":"string","description":"Status of the modification"}},"type":{"type":"array","description":"Type of service that was modified","items":{"type":"string","description":"Type of service that was modified"}},"zone":{"type":"array","description":"Zone that was modified","items":{"type":"string","description":"Zone that was modified"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddPriceScale"}},"/pricescale/{pricescale}":{"delete":{"operationId":"deletePriceScale","summary":"XRRP command DeletePriceScale (deletePriceScale)","description":"Deletes a pricescale which is not used by any subreseller.\n","tags":["subreseller"],"parameters":[{"name":"operator","in":"query","description":"the username that will be logged in the price history.","schema":{"type":"string","nullable":true,"description":"the username that will be logged in the price history."}},{"name":"pricescale","in":"path","required":true,"description":"the pricescale that will be deleted.","schema":{"type":"string","description":"the pricescale that will be deleted."}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeletePriceScale"},"get":{"operationId":"statusPriceScale","summary":"XRRP command StatusPriceScale (statusPriceScale)","description":"Returns all prices of a pricescale.\n","tags":["subreseller"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"pricescale","in":"path","required":true,"description":"The pricescale you want to see the prices. OWN and ALL are keywords that can be used.","schema":{"type":"string","description":"The pricescale you want to see the prices. OWN and ALL are keywords that can be used."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"annual":{"type":"array","description":"Annual fee: The annual fee to be paid for this zone","items":{"type":"string","format":"decimal","description":"Annual fee: The annual fee to be paid for this zone"}},"application":{"type":"array","description":"Application fee: The application fee for this zone (if available)","items":{"type":"string","format":"decimal","description":"Application fee: The application fee for this zone (if available)"}},"currency":{"type":"array","description":"Currency: The currency of this zone","items":{"type":"string","description":"Currency: The currency of this zone"}},"description":{"type":"string","description":"Description: Description of the pricescale"},"period":{"type":"array","description":"Period: The period of this dataset","items":{"type":"string","description":"Period: The period of this dataset"}},"periodtype":{"type":"array","description":"Periodtype: The periodtype of this dataset","items":{"type":"string","description":"Periodtype: The periodtype of this dataset"}},"pricescale":{"type":"string","description":"Pricescale: Name of the pricescale"},"restore":{"type":"array","description":"Restore fee: The restore fee for this zone (if available)","items":{"type":"string","format":"decimal","description":"Restore fee: The restore fee for this zone (if available)"}},"service":{"type":"array","description":"Service: The service of this dataset","items":{"type":"string","description":"Service: The service of this dataset"}},"setup":{"type":"array","description":"Setup fee: The setup - fee for this zone","items":{"type":"string","format":"decimal","description":"Setup fee: The setup - fee for this zone"}},"trade":{"type":"array","description":"Trade fee: The trade fee for this zone","items":{"type":"string","format":"decimal","description":"Trade fee: The trade fee for this zone"}},"transfer":{"type":"array","description":"Transfer fee: The transfer fee for this zone","items":{"type":"string","format":"decimal","description":"Transfer fee: The transfer fee for this zone"}},"type":{"type":"array","description":"Type: The type of the service of this dataset","items":{"type":"string","description":"Type: The type of the service of this dataset"}},"zone":{"type":"array","description":"Zone: The zone of this dataset","items":{"type":"string","description":"Zone: The zone of this dataset"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusPriceScale"}},"/property":{"get":{"operationId":"queryPropertyList","summary":"XRRP command QueryPropertyList (queryPropertyList)","description":"List all properties of a certain class or in total\n","tags":["property"],"parameters":[{"name":"class","in":"query","required":true,"schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"class":{"type":"array","items":{"type":"string"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of properties shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of properties"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryPropertyList"},"post":{"operationId":"setProperty","summary":"XRRP command SetProperty (setProperty)","description":"Modify existing class of properties\n","tags":["property"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"alipay-disabled":{"type":"string","nullable":true,"enum":["0","1"],"description":"System status: The alipay payment option will be disabled for this reseller."},"alipay-processingfee":{"type":"string","format":"decimal","nullable":true,"description":"Processing fee: The processing fee percentage that will be applied to the charged amount for this reseller."},"appayment-accountcurrency":{"type":"string","nullable":true,"description":"Account currency: The currency of the account that is connected to the Alipay payment system."},"appayment-active":{"type":"string","nullable":true,"enum":["1","0"],"description":"System status: Enables the Alipay payment system for the subresellers of a registrar"},"appayment-apikey":{"type":"string","nullable":true,"description":"API Key: API key for the unsername of the Alipay account"},"appayment-apiuserid":{"type":"string","nullable":true,"description":"API User ID: User ID of the Alipay account"},"appayment-ftp":{"type":"string","nullable":true,"description":"FTP server: The FTP server where the Alipay payment receipt will be uploaded."},"appayment-ftppwd":{"type":"string","nullable":true,"description":"FTP password: The password to connect to the FTP server."},"appayment-ftpuser":{"type":"string","nullable":true,"description":"FTP username: The username to connect to the FTP server."},"appayment-mail-bcc":{"type":"string","nullable":true,"description":"Email BCC: Blindcopies of the payment confirmation email will be sent to this adress."},"appayment-mail-from":{"type":"string","nullable":true,"description":"Email sender: The sender adress of the payment confirmation emails that get sent to the subresellers charging their Alipay account."},"appayment-mail-template":{"type":"string","nullable":true,"description":"Email template: The name of the email template that the payment confirmation emails to the subresellers are based on."},"appayment-maxamount":{"type":"string","format":"decimal","nullable":true,"description":"Maximum amount: The maximum amount subreseller have to use to charge their account."},"appayment-minamount":{"type":"string","format":"decimal","nullable":true,"description":"Minimum amount: The minimum amount subreseller have to use to charge their account."},"appayment-processingfee":{"type":"string","format":"decimal","nullable":true,"description":"Processing fee: The processing fee percentage that will be applied to the charged amount."},"appayment-receipt-template":{"type":"string","nullable":true,"description":"Receipt template: The name of the template for the receipts of subreseller Alipay transactions."},"appayment-registryaccount":{"type":"string","nullable":true,"description":"Registryaccount: The registryaccount that will be used to send the commands to."},"appayment-returnurl":{"type":"string","nullable":true,"description":"Return URL: URL where the system will be forward to, after a leaving alipay website."},"appayment-sellername":{"type":"string","nullable":true,"description":"Sellername: Alipay account sellername that will be shown to customers as a reference on alipay payment site."},"ccpayment-accepted-currencies":{"type":"array","description":"Accepted currencies: List of currencies available for the registrars as currency for charging their account.","items":{"type":"string","nullable":true,"description":"Accepted currencies: List of currencies available for the registrars as currency for charging their account."}},"ccpayment-accountcurrency":{"type":"string","nullable":true,"description":"Account currency: The currency of the bank account that is connected to the cc payment system."},"ccpayment-active":{"type":"string","nullable":true,"enum":["1","0"],"description":"System status: Enables the cc payment system for the subresellers of a registrar."},"ccpayment-ccexpire-template":{"type":"string","nullable":true,"description":"Expiration template: The name of the email template that will be sent to subresellers if the credit card expires"},"ccpayment-ccfailed-template":{"type":"string","nullable":true,"description":"Failed charge template: The name of the email template that will be sent to subresellers for failed automated credit card charges"},"ccpayment-clientkey":{"type":"string","nullable":true,"description":"Client Key: The clientkey used in the Control Panel java script libraries  to connect with the payment provider merchant account."},"ccpayment-ftpupload":{"type":"string","nullable":true,"enum":["1","0"],"description":"FTP upload: Enable to upload the reciepts also to the ftp server of the registryaccount."},"ccpayment-mail-bcc":{"type":"string","nullable":true,"description":"Email BCC: Blindcopies of the payment confirmation email will be sent to this adress."},"ccpayment-mail-from":{"type":"string","nullable":true,"description":"Email sender: The sender adress of the payment confirmation emails that get sent to the subresellers charging their credit card."},"ccpayment-mail-template":{"type":"string","nullable":true,"description":"Email template: The name of the email template that the payment confirmation emails to the subresellers are based on."},"ccpayment-maxamount":{"type":"string","format":"decimal","nullable":true,"description":"Maximum amount: The maximum amount subreseller have to use to charge their account."},"ccpayment-merchant-id":{"type":"string","nullable":true,"description":"Merchant ID: The merchant account id to identify the correct account at the payment provider."},"ccpayment-minamount":{"type":"string","format":"decimal","nullable":true,"description":"Minimum amount: The minimum amount subreseller have to use to charge their account."},"ccpayment-processingfee":{"type":"string","format":"decimal","nullable":true,"description":"Processing fee: The processing fee percentage that will be applied to the charged amount."},"ccpayment-receipt-template":{"type":"string","nullable":true,"description":"Receipt template: The name of the template for the receipts of subreseller creditcard transactions."},"claimsnotification-email-claims-url":{"type":"string","nullable":true,"description":"URL to activation website: Replacement for email template: Replaces the URL to the actication service."},"claimsnotification-email-deactivated":{"type":"string","nullable":true,"enum":["0","1"],"description":"Email service status: No mails regarding claimsnotices will be sent to registrants, if set to 1."},"claimsnotification-email-freetext":{"type":"string","nullable":true,"description":"Email freetext: Freetext to replace the RRP default text element in the notification."},"claimsnotification-email-language":{"type":"string","nullable":true,"enum":["EN"],"description":"Template language: In which language should the standard email template be send. Possible values/languages: EN (=english)"},"claimsnotification-email-sender":{"type":"string","nullable":true,"description":"Email sender address: The email sender (FROM). Please add following hostname to your SPF records (if present): _spf.mailrelay.rrpproxy.net."},"claimsnotification-email-signature":{"type":"array","description":"Email signature: The email signature","items":{"type":"string","nullable":true,"description":"Email signature: The email signature"}},"class":{"type":"string","nullable":true},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"contactverification-email-freetext":{"type":"string","nullable":true,"description":"Email freetext: Freetext to insert into RRP default text element before the signature"},"contactverification-email-language":{"type":"string","nullable":true,"enum":["en","de","nl","fr","it"],"description":"Template language: Language used in contact verification emails."},"contactverification-email-sender":{"type":"string","nullable":true,"description":"Email Sender Address: Email address used for ICANN contact verification emails (Default: noreply@emailverification.info). Please add following hostname to your SPF records (if present): _spf.mailrelay.rrpproxy.net."},"contactverification-email-signature":{"type":"array","description":"Email signature: Your email signature","items":{"type":"string","nullable":true,"description":"Email signature: Your email signature"}},"contactverification-email-verification-url":{"type":"string","nullable":true,"description":"Email Verification URL: If you want to replace the default whitelabel website for contact verification you may enter the URL to your alternative here. Please be aware, that the email template adds the string '?trigger=TRIGGERCODE' to the URL automatically, so the GET variable name for the triggercode is predefined."},"contactverification-interrupt-nameserver":{"type":"array","description":"DNS interruption nameserver: The nameserver which will respond a website with registrant verification instructions from the registrar.","items":{"type":"string","nullable":true,"description":"DNS interruption nameserver: The nameserver which will respond a website with registrant verification instructions from the registrar."}},"creditcard-ccemail":{"type":"string","nullable":true,"description":"Notification email: The email adress that will be used to send notifications regarding the stored creditcard information."},"creditcard-chargeamount":{"type":"string","format":"decimal","nullable":true,"description":"Charge amount: The amount that will be charged to the account if the current account value reaches the threshold."},"creditcard-disabled":{"type":"string","nullable":true,"enum":["0","1"],"description":"System status: The credit card payment option will be disabled for this reseller."},"creditcard-ecczv":{"type":"string","nullable":true,"enum":["1","0"],"description":"Automatic credit card debit: The invoiceamount will be automatically charged from the creditcard if activated."},"creditcard-processingfee":{"type":"string","format":"decimal","nullable":true,"description":"Processing fee: The processing fee percentage that will be applied to the charged amount for this reseller."},"creditcard-threshold":{"type":"string","format":"decimal","nullable":true,"description":"Threshold: The threshold value that will be used to determine if an automated chargeup of the account has to be done."},"dns-masteripaddress":{"type":"array","description":"Sets the master IP address for DNS transfers.","items":{"type":"string","nullable":true,"description":"Sets the master IP address for DNS transfers."}},"domaindefaults-admincontact":{"type":"string","nullable":true,"description":"Admin contact: The default admin contact for domain wizard"},"domaindefaults-billingcontact":{"type":"string","nullable":true,"description":"Billing contact: The default billing contact for domain wizard"},"domaindefaults-ownercontact":{"type":"string","nullable":true,"description":"Owner contact: The default owner contact for domain wizard"},"domaindefaults-techcontact":{"type":"string","nullable":true,"description":"Tech contact: The default tech contact for domain wizard"},"gdpr-contact-disclose-legitimated":{"type":"string","nullable":true,"enum":["0","1"],"description":"Contact Disclose Legitimated: Deactivated by Default. Can be set to 1 if we allow the registrar and his subresellers to manage contact disclosure using our API."},"gdpr-contact-disclosure-email-body":{"type":"array","description":"Contact Disclosure Email Body: Email Body Text for the contact disclosure email. Supports also HTML.","items":{"type":"string","nullable":true,"description":"Contact Disclosure Email Body: Email Body Text for the contact disclosure email. Supports also HTML."}},"gdpr-contact-disclosure-email-body-language":{"type":"string","nullable":true,"description":"Contact Disclosure Email Body Language: Language of the Email Body. Information only."},"gdpr-contact-disclosure-email-mime-type":{"type":"string","nullable":true,"enum":["TEXT/PLAIN","TEXT/HTML","MULTIPART/ALTERNATIVE"],"description":"Contact Disclosure Email MIME Type: Email MIME Type for either plain text, html or both as a multipart alternative. Boundary name that must be used in multipart is alternativeBoundary."},"gdpr-contact-disclosure-email-template-language":{"type":"string","nullable":true,"description":"Contact Disclosure Email Template Language: Language of the template name for the contact disclosure email."},"gdpr-contact-disclosure-email-template-name":{"type":"string","nullable":true,"description":"Contact Disclosure Email Template Name: Template name for the contact disclosure email."},"gdpr-contact-disclosure-email-template-registrar":{"type":"string","nullable":true,"description":"Contact Disclosure Email Template Registrar: Registrar of the template name for the contact disclosure email."},"gdpr-contact-disclosure-email-template-reply-to":{"type":"string","nullable":true,"description":"Contact Disclosure Email Reply-To: Sender adress for the contact disclosure email."},"gdpr-contact-disclosure-email-template-sender":{"type":"string","nullable":true,"description":"Contact Disclosure Email Sender: Sender adress for the contact disclosure email."},"gdpr-contact-disclosure-email-template-subject":{"type":"string","nullable":true,"description":"Contact Disclosure Email Subject: Subject for the contact disclosure email."},"gdpr-contact-disclosure-faq":{"type":"string","nullable":true,"description":"Contact Disclosure FAQ: An knowledge base link that will be included in the email to list TLD specific contact disclosure details."},"gdpr-contact-disclosure-policies":{"type":"string","nullable":true,"description":"Contact Disclosure Policies URL: An link to the policies that should be included in the contact disclosure email."},"gdpr-contact-disclosure-url":{"type":"string","nullable":true,"description":"Contact Disclosure URL: The url where the contact will be forwarded to, to update his disclosure settings."},"gdpr-contact-form-url":{"type":"string","nullable":true,"description":"Contact Form URL: The URL of the form where an interessted person can contact a domain contact. A whitelabeled URL can be used here to brand the default page http://domain-contact.org. Note that the webform hast to support two parmaters DOMAIN and CONTACTTYPE to work properly."},"general-account-manager":{"type":"string","nullable":true,"description":"Key Account Manager: Prefix for all page titles (default is 'Interface')."},"general-allow-direct-statusdomain":{"type":"string","nullable":true,"enum":["0","1"],"description":"Direct StatusDomain: If set to yes, the reseller will be passed directly to Registry for Statusdomain (not in Domains Table). Otherwise our default data will be shown."},"general-default-clienttransferprohibited":{"type":"string","nullable":true,"enum":["0","1"],"description":"General default Client Transfer Prohibited: If set, all new domains registered or transferred in will have the clientTransferProhibited lock set. Domains that had the clientTransferProhibited status removed via a domain modification will have the status set again automatically after 30 days. Default is set."},"general-disable-registrycontactvalidation":{"type":"string","nullable":true,"enum":["0","1"],"description":"Disable registry contact validation: If set to yes, registry contact validation (identifier/VAT format checks) is skipped for domains routed through registryaccounts where this registrar is account_owner."},"general-domainutilisation":{"type":"string","nullable":true,"enum":["0","1"],"description":"Domain utilisation: Allow Key-Systems to take over domains flagged for expiration or deletion in their own portfolio as soon as the domains enter their respective deletion phase."},"general-explicit-unlock":{"type":"string","nullable":true,"enum":["0","1"],"description":"Explicit unlock objects: Explicit object unlock required. If switched on the respective object needs to be modified with one single unlock parameter. It is not possible to use this unlock parameter together with other parameters in one modify command. This affects for example the ClientUpdateProhibited setting of a domain."},"general-internal-transfer-renew":{"type":"string","nullable":true,"enum":["","REGISTRY","NORENEW"],"description":"Internal transfer renew: Internal transfer renew policy. \"Default\" renews COM, NET, ORG, BIZ, INFO, NAME domains upon internal transfer. \"Registry\" renews domains according to registry transfer policy. \"Norenew\" never renews a domain upon internal transfer. This setting only applies for incoming transfers."},"general-nameserver-deletion-event":{"type":"string","nullable":true,"enum":["0","1"],"description":"Nameserver deletion event: Enable event notification when a nameserver is deleted. Deactivated by default for registrars."},"general-reseller-on-registry-whois":{"type":"string","nullable":true,"enum":["0","1"],"description":"Reseller on Registry WHOIS: If set to yes, the resller name will be passed to the registrys that show the registrar name in WHOIS. Otherwise our default data will be shown."},"general-show-benefit-recipient":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show benefit recipient: Show benefit recipient (ownercontact) on invoices."},"general-show-domain-rgp":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show domains in RGP: Show Registry Grace Period status of domains, according to RFC 3915. If switched on the API response of a StatusDomain command will also show the Registry Grace Period status of a domain. The response of a StatusDomain command will differ for domains which have recently been deleted, i.e. they will be shown, including their Registry Grace Period status."},"general-strict-contact-validation-mode":{"type":"string","nullable":true,"enum":["MANUAL","AUTO"],"description":"Contact validation mode: If set to AUTO, the system will automatically initiate the contact validation, if neccessary."},"general-tax-free-region":{"type":"string","nullable":true,"enum":["0","1"],"description":"Tax free region: Removes VAT from registrar even though his country would be eliglible for VAT."},"general-wdrp-emailsender":{"type":"string","nullable":true,"description":"WDRP Email Sender: Email address that is used as customers \"from\" in WDRP emails. In case this value is not defined the email address \"donotreply@whoisreminder.info\" is used."},"icannerrp-autorenew-on-expirationdate":{"type":"string","enum":["0","1"],"description":"Renew gTLD domains on expiration date: This flag will renew all gtlds one day before expirationdate instead during RGP phase. In this case the 3rd email notification well not be send anymore."},"icannerrp-email-after-expiration-freetext":{"type":"string","nullable":true,"description":"Freetext for 3rd ERRP mail: Freetext to replace the renewal/deletion RRP default text element in the notification 3"},"icannerrp-email-before-expiration-freetext":{"type":"string","nullable":true,"description":"Freetext for 1st and 2nd ERRP mail: Freetext to replace the renewal/deletion RRP default text element in the notification 1 and 2"},"icannerrp-email-language":{"type":"string","nullable":true,"enum":["en","de","fr","no","it","nl"],"description":"Template language: In which language should the standard Email template be send."},"icannerrp-email-sender":{"type":"string","nullable":true,"description":"Email sender address: The Email sender (DEFAULT: noreply@expirationwarning.net). Please add following hostname to your SPF records (if present): _spf.mailrelay.rrpproxy.net."},"icannerrp-email-signature":{"type":"array","description":"Email signature: The Email signature","items":{"type":"string","nullable":true,"description":"Email signature: The Email signature"}},"icannerrp-email-tac-url":{"type":"string","nullable":true,"description":"URL to your Terms and Conditions: Replacement for Email template: terms and conditions URL, if not set there will be no default URL"},"icannerrp-interrupt-advertisement":{"type":"string","nullable":true,"enum":["0","1"],"description":"Enable advertisement: Show advertisements during DNS interruption. Notice: This is not applied to own nameserver sets defined by ICANNERRP-INTERRUPT-NAMESERVER#. Advertisements will be shown starting from the 2016-03-31, if not configured otherwise."},"icannerrp-interrupt-nameserver":{"type":"array","description":"DNS interruption nameserver: The nameserver which will respond a website with renewal/restore instructions from the registrar within AutoRenew Grace Period.","items":{"type":"string","nullable":true,"description":"DNS interruption nameserver: The nameserver which will respond a website with renewal/restore instructions from the registrar within AutoRenew Grace Period."}},"icanntransfer-emaillanguage":{"type":"string","nullable":true,"enum":["EN","DE","ES","FR","IT"],"description":"FOA email language: Language used for FOA email."},"icanntransfer-emailrecipient":{"type":"string","nullable":true,"enum":["OWNER","ADMIN","BOTH"],"description":"FOA email recipient: FOA email recipient"},"icanntransfer-emailsender":{"type":"string","nullable":true,"description":"Email sender address: Email address used for ICANN transfer confirmation emails. Defaults to \"icann-transfers@key-systems.net\". Please add following hostname to your SPF records (if present): _spf.mailrelay.rrpproxy.net."},"icanntransfer-emailsubject":{"type":"string","nullable":true,"description":"Email subject: Subject of the ICANN transfer confirmation emails. Defaults to \"Transfer Request: {ACTION} {DOMAIN} [{TRIGGER}]\""},"icanntransfer-emailtac":{"type":"string","nullable":true,"description":"URL to Terms and Conditions. Defaults to https://www.centralnicreseller.com/en/terms-conditions: Link to the Terms and Conditions"},"icanntransfer-emailurl":{"type":"string","nullable":true,"description":"URL to Confirmation Page: URL where customers can confirm ICANN transfer emails. Defaults to \"https://icann-transfers.key-systems.net/?domain={DOMAIN}\u0026action={ACTION}\u0026trigger={TRIGGER}\""},"icanntransfer-ownerchange-confirmationlink":{"type":"string","nullable":true,"description":"E-Mail confirmation link: Sets the confirmation link which is displayed in the ICANN-Ownerchange email"},"icanntransfer-ownerchange-emailsender":{"type":"string","nullable":true,"description":"E-Mail sender address: Sets the FROM address of the ICANN-Ownerchange email"},"icanntransfer-ownerchange-emailsubject":{"type":"string","nullable":true,"description":"E-Mail subject: Sets the SUBJECT of the ICANN-Ownerchange email"},"icanntransfer-ownerchange-footer":{"type":"array","description":"E-Mail footer: Sets the footer which is displayed in the ICANN-Ownerchange email","items":{"type":"string","nullable":true,"description":"E-Mail footer: Sets the footer which is displayed in the ICANN-Ownerchange email"}},"icanntransfer-ownerchange-freetext":{"type":"array","description":"E-Mail free text: Sets the freetext which is displayed in the ICANN-Ownerchange email","items":{"type":"string","nullable":true,"description":"E-Mail free text: Sets the freetext which is displayed in the ICANN-Ownerchange email"}},"icanntransfer-ownerchange-infopagelink":{"type":"string","nullable":true,"description":"E-Mail info page link: Sets the info page link which is displayed in the ICANN-Ownerchange email"},"icanntransfer-ownerchange-mode":{"type":"string","nullable":true,"enum":["FOA","DESIGNATED_AGENT"],"description":"ICANN-Ownerchange mode: ICANN-Ownerchange procedure in general"},"icanntransfer-ownerchange-remove-transferlock":{"type":"string","nullable":true,"enum":["0","1"],"description":"Remove transferlock: Allow the registrant to remove the transferlock"},"icanntransfer-ownerchange-transferlock-override":{"type":"string","nullable":true,"enum":["0","1"],"description":"Transferlock registrant opt-out: Registrant can opt-out the transfer lock"},"icanntransfer-ownerchange-triggerda":{"type":"string","nullable":true,"enum":["0","1"],"description":"Trigger designated agent: Enable ICANN-Ownerchange TRIGGERDA (trigger designated agent) parameter in ModifyDomain/ModifyContact"},"icanntransfer-ownerchange-triggerda-legitimated":{"type":"string","nullable":true,"enum":["0","1"],"description":"Ownerchange trigger designated agent Legitimated: Allow registrar to enable triggerDA"},"icanntransfer-requestentity":{"type":"string","nullable":true,"description":"Request entity: Requesting registrar name. Defaults to \"Key-Systems GmbH\""},"ipwhitelist-active":{"type":"string","nullable":true,"enum":["0","1"],"description":"Active: Activates the IP Whitelist feature for the API. Web interface is not affected by IP Whitelist."},"ipwhitelist-ip":{"type":"array","description":"IP address: IPv4 addresses that are allowed to access the API. Single IPv4 addresses or ranges from 24-30 are allowed.","items":{"type":"string","nullable":true,"description":"IP address: IPv4 addresses that are allowed to access the API. Single IPv4 addresses or ranges from 24-30 are allowed."}},"ipwhitelist-webinterface-active":{"type":"string","nullable":true,"enum":["0","1"],"description":"Control Panel Active: Activates the IP Whitelist feature for the CP."},"ipwhitelist-webinterface-ip":{"type":"array","description":"Control Panel IP address: IPv4 addresses that are allowed to access the CP. Single IPv4 addresses or ranges from 24-30 are allowed.","items":{"type":"string","nullable":true,"description":"Control Panel IP address: IPv4 addresses that are allowed to access the CP. Single IPv4 addresses or ranges from 24-30 are allowed."}},"paidservices-account-fee-enabled":{"type":"string","nullable":true,"enum":["0","1"],"description":"Account Fee: CNR account service fee."},"paidservices-account-fee-renewalmode":{"type":"string","nullable":true,"enum":["MONTH","YEAR"],"description":"Account Fee Renewalmode: The renewal interval for the CNR account service fee."},"paidservices-add-grace-deletions":{"type":"string","nullable":true,"enum":["0","1"],"description":"Add Grace Period Service: Service fee to enable the refunds of domain registration fees for domains deleted within add grace period."},"parking-namedrivepassword":{"type":"string","nullable":true,"description":"API key of namedrive account."},"parking-namedriveusername":{"type":"string","nullable":true,"description":"User ID of namedrive account."},"parking-parkingcrewpassword":{"type":"string","nullable":true,"description":"ParkingCrew API key: API key of ParkingCrew account."},"parking-parkingcrewusername":{"type":"string","nullable":true,"description":"ParkingCrew username: User ID of ParkingCrew account."},"parking-trafficclubpassword":{"type":"string","nullable":true,"description":"Traffic.Club API key: API key of Traffic.Club account."},"parking-trafficclubusername":{"type":"string","nullable":true,"description":"Traffic.Club User MID: User ID of Traffic.Club account."},"paypal-disabled":{"type":"string","nullable":true,"enum":["0","1"],"description":"System status: The paypal payment option will be disabled for this reseller."},"paypal-processingfee":{"type":"string","format":"decimal","nullable":true,"description":"Processing fee: The processing fee percentage that will be applied to the charged amount for this reseller."},"pppayment-accountcurrency":{"type":"string","nullable":true,"description":"Account currency: The currency of the account that is connected to the paypal payment system."},"pppayment-active":{"type":"string","nullable":true,"enum":["1","0"],"description":"System status: Enables the paypal payment system for the subresellers of a registrar"},"pppayment-clientkey":{"type":"string","nullable":true,"description":"Client Key: The clientkey used in the Control Panel java script libraries to connect with the payment provider merchant account."},"pppayment-ftp":{"type":"string","nullable":true,"description":"FTP server: The FTP server where the paypal payment receipt will be uploaded."},"pppayment-ftppwd":{"type":"string","nullable":true,"description":"FTP password: The password to connect to the FTP server."},"pppayment-ftpuser":{"type":"string","nullable":true,"description":"FTP username: The username to connect to the FTP server."},"pppayment-mail-bcc":{"type":"string","nullable":true,"description":"Email BCC: Blindcopies of the payment confirmation email will be sent to this adress."},"pppayment-mail-from":{"type":"string","nullable":true,"description":"Email sender: The sender adress of the payment confirmation emails that get sent to the subresellers charging their paypal account."},"pppayment-mail-template":{"type":"string","nullable":true,"description":"Email template: The name of the email template that the payment confirmation emails to the subresellers are based on."},"pppayment-maxamount":{"type":"string","format":"decimal","nullable":true,"description":"Maximum amount: The maximum amount subreseller have to use to charge their account."},"pppayment-merchant-id":{"type":"string","nullable":true,"description":"Merchant ID: The merchant id that will be used to send the commands to the SHS API."},"pppayment-minamount":{"type":"string","format":"decimal","nullable":true,"description":"Minimum amount: The minimum amount subreseller have to use to charge their account."},"pppayment-processingfee":{"type":"string","format":"decimal","nullable":true,"description":"Processing fee: The processing fee percentage that will be applied to the charged amount."},"pppayment-receipt-template":{"type":"string","nullable":true,"description":"Receipt template: The name of the template for the receipts of subreseller paypal transactions."},"premiumdomain-active":{"type":"string","nullable":true,"enum":["0","1"],"description":"Premium handling: Activates premium domains using the FEE extensions"},"premiumdomain-allow-simplemode":{"type":"string","nullable":true,"enum":["0","1"],"description":"Allow simplemode: Allows simple mode for premium domain handing with X-ACCEPT-PREMIUMPRICE=1"},"premiumdomainsystem-active":{"type":"string","nullable":true,"enum":["0","1"],"description":"Active: Activates premium domain settings and handling for this registrars subresellers"},"premiumdomainsystem-formula-currency":{"type":"string","nullable":true,"description":"Formula currency: The currency of the formula values"},"premiumdomainsystem-formula-percentage0":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above 0"},"premiumdomainsystem-formula-percentage1":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above value1"},"premiumdomainsystem-formula-percentage2":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above value2"},"premiumdomainsystem-formula-percentage3":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above value3"},"premiumdomainsystem-formula-percentage4":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above value4"},"premiumdomainsystem-formula-percentage5":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above value5"},"premiumdomainsystem-formula-percentage6":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above value6"},"premiumdomainsystem-formula-percentage7":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above value7"},"premiumdomainsystem-formula-percentage8":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above value8"},"premiumdomainsystem-formula-percentage9":{"type":"integer","format":"int32","nullable":true,"description":"Percentage1: The percentage increase applied to prices above value9"},"premiumdomainsystem-formula-value1":{"type":"integer","format":"int32","nullable":true,"description":"Value1: Applies percentage1 to all prices above this value"},"premiumdomainsystem-formula-value2":{"type":"integer","format":"int32","nullable":true,"description":"Value1: Applies percentage2 to all prices above this value"},"premiumdomainsystem-formula-value3":{"type":"integer","format":"int32","nullable":true,"description":"Value1: Applies percentage3 to all prices above this value"},"premiumdomainsystem-formula-value4":{"type":"integer","format":"int32","nullable":true,"description":"Value1: Applies percentage4 to all prices above this value"},"premiumdomainsystem-formula-value5":{"type":"integer","format":"int32","nullable":true,"description":"Value1: Applies percentage5 to all prices above this value"},"premiumdomainsystem-formula-value6":{"type":"integer","format":"int32","nullable":true,"description":"Value1: Applies percentage6 to all prices above this value"},"premiumdomainsystem-formula-value7":{"type":"integer","format":"int32","nullable":true,"description":"Value1: Applies percentage7 to all prices above this value"},"premiumdomainsystem-formula-value8":{"type":"integer","format":"int32","nullable":true,"description":"Value1: Applies percentage8 to all prices above this value"},"premiumdomainsystem-formula-value9":{"type":"integer","format":"int32","nullable":true,"description":"Value1: Applies percentage9 to all prices above this value"},"restricted":{"type":"array","items":{"type":"string","nullable":true}},"sepa-accountholder":{"type":"string","nullable":true,"description":"Bank account holder: Name of the bank account holder"},"sepa-bic":{"type":"string","nullable":true,"description":"BIC: BIC (Business Identifier Code) of the bank acount e.g. SALADE55XXX"},"sepa-enabled":{"type":"string","nullable":true,"enum":["0","1"],"description":"System status: Enable SEPA bankdebit for this registrar"},"sepa-iban":{"type":"string","nullable":true,"description":"IBAN: IBAN (International Bank Account Number) of the bank account e.g. DE21700519950000007229"},"sepa-mtype":{"type":"string","nullable":true,"enum":["B2B","CORE"],"description":"Mandate type: Whois output for field registrar whois server"},"sepa-noemail":{"type":"string","nullable":true,"enum":["0","1"],"description":"Send email: Prevents the sending of the SEPA contract by email."},"sepa-resend-contract":{"type":"string","nullable":true,"enum":["0","1"],"description":"Recreates and resends the PDF contract"},"sepa-signdate":{"type":"string","format":"date","nullable":true,"description":"Signdate: Date when the mandate was signed by the registrar"},"sepapayment-accountcurrency":{"type":"string","nullable":true,"description":"Account Currency: The currency of the SEPA bank account connected with the GID."},"sepapayment-active":{"type":"string","nullable":true,"enum":["0","1"],"description":"System status: Activates SEPA bankdebit for this registrars subresellers"},"sepapayment-address":{"type":"string","nullable":true,"description":"Address: The address that will be used for the contract wording"},"sepapayment-allowed-iban-countrys":{"type":"string","nullable":true,"description":"Allowed IBAN countrys: A comma seperated list of all allowed IBAN countrys that may be used by registrars. If empty all countrys are allowed!"},"sepapayment-bic":{"type":"string","nullable":true,"description":"BIC: The BIC of the SEPA bank account connected with the GID."},"sepapayment-contract-template":{"type":"string","nullable":true,"description":"Contract template: The name of the contract template that will be used to create the SEPA contract"},"sepapayment-defaultstatus":{"type":"string","nullable":true,"description":"Default Invoice status: The default status that will be used for every created new invoice. Default is PAID."},"sepapayment-ftp":{"type":"string","nullable":true,"description":"FTP server: The FTP server where the sepa contract will be uploaded."},"sepapayment-ftppwd":{"type":"string","nullable":true,"description":"FTP password: The password to connect to the FTP server."},"sepapayment-ftpuser":{"type":"string","nullable":true,"description":"FTP username: The username to connect to the FTP server."},"sepapayment-gid":{"type":"string","nullable":true,"description":"GID: The creditor id. (from german: Glaeubiger ID)."},"sepapayment-iban":{"type":"string","nullable":true,"description":"IBAN: The IBAN of the SEPA bank account connected with the GID."},"sepapayment-mail-activation-template":{"type":"string","nullable":true,"description":"Email activation template: The name of the email template that will be used to send out on SEPA activation."},"sepapayment-mail-from":{"type":"string","nullable":true,"description":"Email sender: The email sender adress of the SEPA contract"},"sepapayment-mail-template":{"type":"string","nullable":true,"description":"Email template: The name of the email template that will be used to send out the SEPA contract"},"sepapayment-mid-prefix":{"type":"string","nullable":true,"description":"MID prefix: A prefix that will be put on front of each generated mandate ID"},"sepapayment-organization":{"type":"string","nullable":true,"description":"Organization: The organizationname that will be used for the contract wording"},"sepapayment-reference":{"type":"string","nullable":true,"description":"Reference Syntax: The reference syntax that will be used to create the references for the SEPA payments."},"subreseller-additional-tax-countries":{"type":"string","nullable":true,"description":"Additional Tax Countries: A comma seperated list of additional countries outside the EU that should also be validated using the EU-VAT-VALUES setting in ALLOWEDVAT. "},"subreseller-allowedvat":{"type":"string","nullable":true,"description":"Allowed VAT: A comma seperated list of allowed VAT values that can be used on subreseller creation. "},"subreseller-charge-whitelabel-url":{"type":"string","nullable":true,"enum":["0","1"],"description":"Charge Whitelabel URL: When activated, the yearly service for a whitelabel URL is charged."},"subreseller-credit":{"type":"string","format":"decimal","nullable":true,"description":"Credit: The default credit for new created subresellers."},"subreseller-currency":{"type":"string","nullable":true,"description":"Currency: The default currency for new created subresellers."},"subreseller-emergencycredit":{"type":"string","format":"decimal","nullable":true,"description":"Emergency Credit: The default emergency renewal credit for new created subresellers."},"subreseller-freeaccounts":{"type":"integer","format":"int32","nullable":true,"description":"Free accounts: The number of accounts a subreseller can add without beeing charged the subreseller account fee."},"subreseller-language":{"type":"string","nullable":true,"description":"Language: The default language for new created subresellers."},"subreseller-maxaccounts":{"type":"integer","format":"int32","nullable":true,"description":"Maximum accounts: The maximum number of accounts a reseller can add. Value 0 is unlimited."},"subreseller-maxlayers":{"type":"integer","format":"int32","nullable":true,"description":"Maximum layers: The maximum number of layers a reseller can use to add subresellers. Value 0 disables the subreseller system for that reseller."},"subreseller-payment-instructions":{"type":"string","nullable":true,"description":"Payment instructions: Payment instructions for sub-resellers on how to pay their parent."},"subreseller-payment-link":{"type":"string","nullable":true,"description":"Payment link: URL for the payment link that sub-resellers should use to pay their parent."},"subreseller-pricescale":{"type":"string","nullable":true,"description":"Pricescale: The default pricescales for new created subresellers."},"subreseller-support-instructions":{"type":"string","nullable":true,"description":"Support instructions: Support instructions for sub-resellers on how to contact their parent for support."},"subreseller-support-link":{"type":"string","nullable":true,"description":"Support link: URL for the support link that sub-resellers should use to contact their parent for support."},"subreseller-vat":{"type":"string","format":"decimal","nullable":true,"description":"VAT: The default VAT for new created subresellers."},"type":{"type":"string","nullable":true,"enum":["OWN","DEFAULT","RESTRICT"],"description":"Name of property type."},"whois-registrar-abuse-contact-email":{"type":"string","description":"REGISTRAR ABUSE EMAIL: Whois output for field registrar abuse contact email"},"whois-registrar-abuse-contact-phone":{"type":"string","description":"REGISTRAR ABUSE PHONE: Whois output for field registrar abuse contact phone"},"whois-registrar-abuse-contact-url":{"type":"string","nullable":true,"description":"REGISTRAR ABUSE URL: Whois output for field registrar abuse contact url"},"whois-registrar-ianaid":{"type":"integer","format":"int32","description":"REGISTRAR IANAID: Whois output for field registrar iana id"},"whois-registrar-name":{"type":"string","description":"REGISTRAR NAME: Whois output for field registrar"},"whois-registrar-rdap-server":{"type":"string","description":"REGISTRAR RDAP SERVER: RDAP output for field registrar RDAP server"},"whois-registrar-rdap-tac-url":{"type":"string","description":"REGISTRAR RDAP Terms And Conditions URL: RDAP output for field registrar terms and conditions URL"},"whois-registrar-whois-server":{"type":"string","description":"REGISTRAR WHOIS SERVER: Whois output for field registrar whois server"},"wicustom-color0":{"type":"string","nullable":true,"description":"Slogan color: Color for slogan. Color name or hexadecimal value allowed (e.g. '0000FF' or 'blue')."},"wicustom-color1":{"type":"string","nullable":true,"description":"Custom color 1: Color for the header of the login box and links. Color name or hexadecimal value allowed (e.g. '0000FF' or 'blue')."},"wicustom-color2":{"type":"string","nullable":true,"description":"Custom color 2: Color name or hexadecimal value allowed (e.g. '0000FF' or 'blue')."},"wicustom-headerbackground":{"type":"string","nullable":true,"description":"Header Background: Header background graphic file."},"wicustom-headerlogo":{"type":"string","nullable":true,"description":"Header Logo: Header logo graphic file."},"wicustom-imprinturl":{"type":"string","nullable":true,"description":"Imprint URL: The imprint URL of the subreseller system."},"wicustom-language":{"type":"array","description":"Available language: Languages that are available to subresellers. LANGUAGE0 will be set as default.","items":{"type":"string","nullable":true,"description":"Available language: Languages that are available to subresellers. LANGUAGE0 will be set as default."}},"wicustom-link":{"type":"array","description":"Custom links","items":{"type":"string","nullable":true,"description":"Custom links"}},"wicustom-linkheader":{"type":"string","nullable":true,"description":"Name of menu entry for links"},"wicustom-slogan":{"type":"string","nullable":true,"description":"Slogan: Possible, pure text addition to the logo appearing in the page header. The color of the slogan can be set separately."},"wicustom-title":{"type":"string","nullable":true,"description":"Title of website: Prefix for all page titles (default is 'Interface')."},"wicustom-welcomeheadline":{"type":"string","nullable":true,"description":"Headline: Headline of the welcome box. A short notice is recommended, e.g. 'Welcome to -yourname- interface'."},"wicustom-welcometext":{"type":"array","description":"Welcome Text: The welcome text.","items":{"type":"string","nullable":true,"description":"Welcome Text: The welcome text."}},"wisettings-renewaldays":{"type":"integer","format":"int32","nullable":true,"description":"Name of menu entry for links"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"contract":{"type":"string","description":"Contract status"},"email":{"type":"string","description":"Email status"},"file":{"type":"string","description":"Contract file link"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"SetProperty"}},"/property/{class}":{"get":{"operationId":"getProperty","summary":"XRRP command GetProperty (getProperty)","description":"Show class of properties\n","tags":["property"],"parameters":[{"name":"class","in":"path","required":true,"schema":{"type":"string","nullable":true}},{"name":"merge","in":"query","description":"Merge paramerters","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Merge paramerters"}},{"name":"type","in":"query","description":"Name of property type.","schema":{"type":"string","nullable":true,"enum":["OWN","DEFAULT","RESTRICT","PARENT_DEFAULT","PARENT_RESTRICT","ALL","MERGE"],"description":"Name of property type."}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"agpsettings_add-grace-offset-default":{"type":"array","items":{"type":"string"}},"agpsettings_add-grace-offset-restricted":{"type":"array","items":{"type":"string"}},"agpsettings_add-grace-percentage-default":{"type":"array","items":{"type":"string"}},"agpsettings_add-grace-percentage-restricted":{"type":"array","items":{"type":"string"}},"alipay_disabled":{"type":"array","items":{"type":"integer","format":"int32"}},"alipay_maxamount":{"type":"array","items":{"type":"string","format":"decimal"}},"alipay_minamount":{"type":"array","items":{"type":"string","format":"decimal"}},"alipay_processingfee":{"type":"array","items":{"type":"string","format":"decimal"}},"alipay_range-currency":{"type":"array","items":{"type":"string"}},"appayment_accountcurrency":{"type":"array","items":{"type":"string"}},"appayment_active":{"type":"array","items":{"type":"integer","format":"int32"}},"appayment_apikey":{"type":"array","items":{"type":"string"}},"appayment_apiuserid":{"type":"array","items":{"type":"string"}},"appayment_ftp":{"type":"array","items":{"type":"string"}},"appayment_ftpuser":{"type":"array","items":{"type":"string"}},"appayment_mail-bcc":{"type":"array","items":{"type":"string"}},"appayment_mail-from":{"type":"array","items":{"type":"string"}},"appayment_mail-template":{"type":"array","items":{"type":"string"}},"appayment_maxamount":{"type":"array","items":{"type":"string","format":"decimal"}},"appayment_minamount":{"type":"array","items":{"type":"string","format":"decimal"}},"appayment_processingfee":{"type":"array","items":{"type":"string","format":"decimal"}},"appayment_receipt-template":{"type":"array","items":{"type":"string"}},"appayment_registryaccount":{"type":"array","items":{"type":"string"}},"appayment_returnurl":{"type":"array","items":{"type":"string"}},"appayment_sellername":{"type":"array","items":{"type":"string"}},"ccpayment_accepted-currencies":{"type":"array","items":{"type":"string"}},"ccpayment_accountcurrency":{"type":"array","items":{"type":"string"}},"ccpayment_active":{"type":"array","items":{"type":"integer","format":"int32"}},"ccpayment_ccexpire-template":{"type":"array","items":{"type":"string"}},"ccpayment_ccfailed-template":{"type":"array","items":{"type":"string"}},"ccpayment_clientkey":{"type":"array","items":{"type":"string"}},"ccpayment_ftpupload":{"type":"array","items":{"type":"integer","format":"int32"}},"ccpayment_mail-bcc":{"type":"array","items":{"type":"string"}},"ccpayment_mail-from":{"type":"array","items":{"type":"string"}},"ccpayment_mail-template":{"type":"array","items":{"type":"string"}},"ccpayment_maxamount":{"type":"array","items":{"type":"string","format":"decimal"}},"ccpayment_merchant-id":{"type":"array","items":{"type":"string"}},"ccpayment_minamount":{"type":"array","items":{"type":"string","format":"decimal"}},"ccpayment_processingfee":{"type":"array","items":{"type":"string"}},"ccpayment_receipt-template":{"type":"array","items":{"type":"string"}},"claimsnotification_email-claimsurl":{"type":"array","items":{"type":"string"}},"claimsnotification_email-deactivated":{"type":"array","items":{"type":"string"}},"claimsnotification_email-freetext":{"type":"array","items":{"type":"string"}},"claimsnotification_email-language":{"type":"array","items":{"type":"string"}},"claimsnotification_email-sender":{"type":"array","items":{"type":"string"}},"claimsnotification_email-signature0":{"type":"array","items":{"type":"string"}},"claimsnotification_email-signature1":{"type":"array","items":{"type":"string"}},"claimsnotification_email-signature2":{"type":"array","items":{"type":"string"}},"contactverification_email-freetext":{"type":"array","items":{"type":"string"}},"contactverification_email-language":{"type":"array","items":{"type":"string"}},"contactverification_email-sender":{"type":"array","items":{"type":"string"}},"contactverification_email-signature0":{"type":"array","items":{"type":"string"}},"contactverification_email-signature1":{"type":"array","items":{"type":"string"}},"contactverification_email-signature2":{"type":"array","items":{"type":"string"}},"contactverification_email-verification-url":{"type":"array","items":{"type":"string"}},"creditcard_accepted-currencies":{"type":"array","items":{"type":"string"}},"creditcard_cardexpiration":{"type":"array","items":{"type":"integer","format":"int32"}},"creditcard_cardholder":{"type":"array","items":{"type":"string"}},"creditcard_cardnumber":{"type":"array","items":{"type":"string"}},"creditcard_ccemail":{"type":"array","items":{"type":"string"}},"creditcard_chargeamount":{"type":"array","items":{"type":"string","format":"decimal"}},"creditcard_clientkey":{"type":"array","items":{"type":"string"}},"creditcard_disabled":{"type":"array","items":{"type":"integer","format":"int32"}},"creditcard_ecczv":{"type":"array","items":{"type":"integer","format":"int32"}},"creditcard_maxamount":{"type":"array","items":{"type":"string","format":"decimal"}},"creditcard_minamount":{"type":"array","items":{"type":"string","format":"decimal"}},"creditcard_processingfee":{"type":"array","items":{"type":"string","format":"decimal"}},"creditcard_threshold":{"type":"array","items":{"type":"string","format":"decimal"}},"dns-masteripaddress0":{"type":"array","items":{"type":"string"}},"dns-masteripaddress1":{"type":"array","items":{"type":"string"}},"dns-masteripaddress2":{"type":"array","items":{"type":"string"}},"dns-masteripaddress3":{"type":"array","items":{"type":"string"}},"dns-masteripaddress4":{"type":"array","items":{"type":"string"}},"dns-masteripaddress5":{"type":"array","items":{"type":"string"}},"gdpr_contact-disclose-legitimated":{"type":"integer","format":"int32"},"gdpr_contact-disclosure-email-body":{"type":"array","items":{"type":"string"}},"gdpr_contact-disclosure-email-body-language":{"type":"string"},"gdpr_contact-disclosure-email-mime-type":{"type":"string","nullable":true,"enum":["TEXT/PLAIN","TEXT/HTML","MULTIPART/ALTERNATIVE"],"description":"Email MIME Type for either plain text, html or both as a multipart alternative. Boundary name that must be used in multipart is alternativeBoundary."},"gdpr_contact-disclosure-email-template-language":{"type":"string"},"gdpr_contact-disclosure-email-template-name":{"type":"string"},"gdpr_contact-disclosure-email-template-registrar":{"type":"string"},"gdpr_contact-disclosure-email-template-reply-to":{"type":"string"},"gdpr_contact-disclosure-email-template-sender":{"type":"string"},"gdpr_contact-disclosure-email-template-subject":{"type":"string"},"gdpr_contact-disclosure-faq":{"type":"string"},"gdpr_contact-disclosure-policies":{"type":"string"},"gdpr_contact-disclosure-url":{"type":"string"},"gdpr_contact-form-url":{"type":"string"},"general_account-manager":{"type":"string"},"general_allow-direct-statusdomain":{"type":"integer","format":"int32"},"general_default-clienttransferprohibited":{"type":"integer","format":"int32"},"general_disable-registrycontactvalidation":{"type":"integer","format":"int32"},"general_domainutilisation":{"type":"integer","format":"int32"},"general_explicit-unlock":{"type":"integer","format":"int32"},"general_internal-transfer-renew":{"type":"string"},"general_monitor-api-limit":{"type":"integer","format":"int32"},"general_nameserver-deletion-event":{"type":"integer","format":"int32"},"general_reseller-on-registry-whois":{"type":"integer","format":"int32"},"general_show-benefit-recipient":{"type":"integer","format":"int32"},"general_show-domain-rgp":{"type":"integer","format":"int32"},"general_strict-contact-validation-mode":{"type":"string"},"general_tax-free-region":{"type":"integer","format":"int32"},"general_wdrp-emailsender":{"type":"string"},"generaltest-allowed":{"type":"array","items":{"type":"string"}},"generaltest-allowed-default":{"type":"array","items":{"type":"string"}},"generaltest-allowed-restricted":{"type":"array","items":{"type":"string"}},"generaltest-bamdam":{"type":"array","items":{"type":"string"}},"generaltest-bamdam-default":{"type":"array","items":{"type":"string"}},"generaltest-bamdam-restricted":{"type":"array","items":{"type":"string"}},"icannerrp_after-expiration-freetext":{"type":"array","items":{"type":"string"}},"icannerrp_autorenew-on-expirationdate":{"type":"array","items":{"type":"integer","format":"int32"}},"icannerrp_before-expiration-freetext":{"type":"array","items":{"type":"string"}},"icannerrp_email-language":{"type":"array","items":{"type":"string"}},"icannerrp_email-sender":{"type":"array","items":{"type":"string"}},"icannerrp_email-signature0":{"type":"array","items":{"type":"string"}},"icannerrp_email-signature1":{"type":"array","items":{"type":"string"}},"icannerrp_email-signature2":{"type":"array","items":{"type":"string"}},"icannerrp_email-tac-url":{"type":"array","items":{"type":"string"}},"icannerrp_ignore-registrar":{"type":"array","items":{"type":"string"}},"icannerrp_ignore-registrarregistryaccount":{"type":"array","items":{"type":"string"}},"icannerrp_interrupt-advertisement":{"type":"array","items":{"type":"string"}},"icannerrp_interrupt-nameserver0":{"type":"array","items":{"type":"string"}},"icannerrp_interrupt-nameserver1":{"type":"array","items":{"type":"string"}},"icannerrp_interrupt-nameserver2":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-confirmationlink":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-emailsender":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-emailsubject":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-enable":{"type":"array","items":{"type":"integer","format":"int32"}},"icanntransfer-ownerchange-footer0":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-footer1":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-footer2":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-freetext0":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-freetext1":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-freetext2":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-infopagelink":{"type":"array","items":{"type":"string"}},"icanntransfer-ownerchange-mode":{"type":"array","items":{"type":"integer","format":"int32"}},"icanntransfer-ownerchange-ram-disable":{"type":"array","items":{"type":"integer","format":"int32"}},"icanntransfer-ownerchange-remove-transferlock":{"type":"array","items":{"type":"integer","format":"int32"}},"icanntransfer-ownerchange-transferlock-override":{"type":"array","items":{"type":"integer","format":"int32"}},"icanntransfer-ownerchange-triggerda":{"type":"array","items":{"type":"integer","format":"int32"}},"ipwhitelist_active":{"type":"integer","format":"int32"},"ipwhitelist_ip":{"type":"array","items":{"type":"string"}},"ipwhitelist_webinterface-active":{"type":"integer","format":"int32"},"ipwhitelist_webinterface-ip":{"type":"array","items":{"type":"string"}},"paidservices_account-fee-enabled":{"type":"string","nullable":true,"enum":["0","1"],"description":"CNR account service fee."},"paidservices_account-fee-next-duedate":{"type":"string","format":"date-time","description":"The next due date when the CNR account service fee will be charged."},"paidservices_account-fee-price":{"type":"string","format":"decimal","description":"The amount that will be charged for the CNR account service fee."},"paidservices_account-fee-price-currency":{"type":"string","description":"The currency of the amount that will be charged for the CNR account service fee."},"paidservices_account-fee-renewalmode":{"type":"string","nullable":true,"enum":["MONTH","YEAR"],"description":"The renewal interval for the CNR account service fee."},"paidservices_add-grace-deletions":{"type":"string","nullable":true,"enum":["0","1"],"description":"Service fee to enable the refunds of domain registration fees for domains deleted within add grace  period."},"paidservices_add-grace-deletions-already-paid":{"type":"string","enum":["0","1"],"description":"Indicates if the service fee has been paid the past. Another activation will be free of charge."},"paypal_clientkey":{"type":"array","items":{"type":"string"}},"paypal_disabled":{"type":"array","items":{"type":"integer","format":"int32"}},"paypal_maxamount":{"type":"array","items":{"type":"string","format":"decimal"}},"paypal_minamount":{"type":"array","items":{"type":"string","format":"decimal"}},"paypal_processingfee":{"type":"array","items":{"type":"string","format":"decimal"}},"paypal_range-currency":{"type":"array","items":{"type":"string"}},"pppayment_accountcurrency":{"type":"array","items":{"type":"string"}},"pppayment_active":{"type":"array","items":{"type":"integer","format":"int32"}},"pppayment_clientkey":{"type":"array","items":{"type":"string"}},"pppayment_ftp":{"type":"array","items":{"type":"string"}},"pppayment_ftpuser":{"type":"array","items":{"type":"string"}},"pppayment_mail-bcc":{"type":"array","items":{"type":"string"}},"pppayment_mail-from":{"type":"array","items":{"type":"string"}},"pppayment_mail-template":{"type":"array","items":{"type":"string"}},"pppayment_maxamount":{"type":"array","items":{"type":"string","format":"decimal"}},"pppayment_merchant-id":{"type":"array","items":{"type":"string"}},"pppayment_minamount":{"type":"array","items":{"type":"string","format":"decimal"}},"pppayment_processingfee":{"type":"array","items":{"type":"string","format":"decimal"}},"pppayment_receipt-template":{"type":"array","items":{"type":"string"}},"premiumdomain_active":{"type":"array","description":"Active: Activates premium domains using the FEE extensions","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"Active: Activates premium domains using the FEE extensions"}},"premiumdomain_allow-simplemode":{"type":"array","description":"Allow simplemode: Allows simple mode for premium domain handing with X-ACCEPT-PREMIUMPRICE=1","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"Allow simplemode: Allows simple mode for premium domain handing with X-ACCEPT-PREMIUMPRICE=1"}},"premiumdomainsystem_active":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-currency":{"type":"array","items":{"type":"string"}},"premiumdomainsystem_formula-percentage0":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-percentage1":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-percentage2":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-percentage3":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-percentage4":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-percentage5":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-percentage6":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-percentage7":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-percentage8":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-percentage9":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-updateddate":{"type":"array","items":{"type":"string","format":"date-time"}},"premiumdomainsystem_formula-value0":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-value1":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-value2":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-value3":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-value4":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-value5":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-value6":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-value7":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-value8":{"type":"array","items":{"type":"integer","format":"int32"}},"premiumdomainsystem_formula-value9":{"type":"array","items":{"type":"integer","format":"int32"}},"restricted":{"type":"array","items":{"type":"string"}},"sepa_accountholder":{"type":"array","description":"Bank account holder: Name of the bank account holder","items":{"type":"string","description":"Bank account holder: Name of the bank account holder"}},"sepa_active":{"type":"array","description":"Active: Indicates if this registrar uses SEPA bankdebit.","items":{"type":"string","enum":["0","1"],"description":"Active: Indicates if this registrar uses SEPA bankdebit."}},"sepa_bic":{"type":"array","description":"BIC: BIC (Business Identifier Code) of the bank account.","items":{"type":"string","description":"BIC: BIC (Business Identifier Code) of the bank account."}},"sepa_contract-file":{"type":"array","description":"Contract file","items":{"type":"string","description":"Contract file"}},"sepa_enabled":{"type":"array","description":"Enabled: Indicates if this registrar may use SEPA bankdebit.","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"Enabled: Indicates if this registrar may use SEPA bankdebit."}},"sepa_iban":{"type":"array","description":"IBAN: IBAN (International Bank Account Number) of the bank account.","items":{"type":"string","description":"IBAN: IBAN (International Bank Account Number) of the bank account."}},"sepa_lastuse":{"type":"array","description":"Date of last use: Date when the mandate was used the last time.","items":{"type":"string","format":"date","description":"Date of last use: Date when the mandate was used the last time."}},"sepa_mid":{"type":"array","description":"Mandate ID: Mandate ID of the account.","items":{"type":"string","description":"Mandate ID: Mandate ID of the account."}},"sepa_mtype":{"type":"array","description":"Mandate type: Whois output for field registrar whois server","items":{"type":"string","nullable":true,"enum":["B2B","CORE"],"description":"Mandate type: Whois output for field registrar whois server"}},"sepa_signdate":{"type":"array","description":"Signdate: Date when the mandate was signed by the registrar.","items":{"type":"string","format":"date","description":"Signdate: Date when the mandate was signed by the registrar."}},"sepapayment_accountcurrency":{"type":"array","items":{"type":"string"}},"sepapayment_active":{"type":"array","items":{"type":"integer","format":"int32"}},"sepapayment_address":{"type":"array","items":{"type":"string"}},"sepapayment_allowed-iban-countrys":{"type":"array","items":{"type":"string"}},"sepapayment_bic":{"type":"array","items":{"type":"string"}},"sepapayment_contract-template":{"type":"array","items":{"type":"string"}},"sepapayment_defaultstatus":{"type":"array","items":{"type":"string"}},"sepapayment_ftp":{"type":"array","items":{"type":"string"}},"sepapayment_ftppwd":{"type":"array","items":{"type":"string"}},"sepapayment_ftpuser":{"type":"array","items":{"type":"string"}},"sepapayment_gid":{"type":"array","items":{"type":"string"}},"sepapayment_iban":{"type":"array","items":{"type":"string"}},"sepapayment_mail-activation-template":{"type":"array","items":{"type":"string"}},"sepapayment_mail-from":{"type":"array","items":{"type":"string"}},"sepapayment_mail-template":{"type":"array","items":{"type":"string"}},"sepapayment_mid-prefix":{"type":"array","items":{"type":"string"}},"sepapayment_organization":{"type":"array","items":{"type":"string"}},"sepapayment_reference":{"type":"array","items":{"type":"string"}},"subreseller_additional-tax-countries":{"type":"string"},"subreseller_allowedvat":{"type":"string"},"subreseller_available-maxaccounts":{"type":"integer","format":"int32"},"subreseller_available-maxlayers":{"type":"integer","format":"int32"},"subreseller_charge-whitelabel-url":{"type":"integer","format":"int32"},"subreseller_credit":{"type":"string","format":"decimal"},"subreseller_currency":{"type":"string"},"subreseller_emergencycredit":{"type":"string","format":"decimal"},"subreseller_freeaccounts":{"type":"integer","format":"int32"},"subreseller_invoicerun":{"type":"string"},"subreseller_language":{"type":"string"},"subreseller_maxaccounts":{"type":"integer","format":"int32"},"subreseller_maxlayers":{"type":"integer","format":"int32"},"subreseller_own-freeaccounts":{"type":"integer","format":"int32"},"subreseller_payment-instructions":{"type":"string"},"subreseller_payment-link":{"type":"string"},"subreseller_pricescale":{"type":"string"},"subreseller_renewalmode":{"type":"string"},"subreseller_support-instructions":{"type":"string"},"subreseller_support-link":{"type":"string"},"subreseller_total-subaccounts":{"type":"integer","format":"int32"},"subreseller_vat":{"type":"string","format":"decimal"},"whois_registrar-abuse-contact-email":{"type":"array","items":{"type":"string"}},"whois_registrar-abuse-contact-phone":{"type":"array","items":{"type":"string"}},"whois_registrar-abuse-contact-url":{"type":"array","items":{"type":"string"}},"whois_registrar-ianaid":{"type":"array","items":{"type":"integer","format":"int32"}},"whois_registrar-name":{"type":"array","items":{"type":"string"}},"whois_registrar-rdap-server":{"type":"array","items":{"type":"string"}},"whois_registrar-rdap-tac-url":{"type":"array","items":{"type":"string"}},"whois_registrar-whois-server":{"type":"array","items":{"type":"string"}},"wicustom_color0":{"type":"string"},"wicustom_color1":{"type":"string"},"wicustom_color2":{"type":"string"},"wicustom_headerbackground":{"type":"string"},"wicustom_headerlogo":{"type":"string"},"wicustom_imprinturl":{"type":"string"},"wicustom_language":{"type":"array","items":{"type":"string"}},"wicustom_link":{"type":"array","items":{"type":"string"}},"wicustom_linkheader":{"type":"string"},"wicustom_slogan":{"type":"string"},"wicustom_title":{"type":"string"},"wicustom_welcomeheadline":{"type":"string"},"wicustom_welcometext":{"type":"array","items":{"type":"string"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"GetProperty"}},"/provider":{"get":{"operationId":"queryACMEaccountList","summary":"XRRP command QueryACMEaccountList (queryACMEaccountList)","description":"\n","tags":["acmeaccount"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"provider","in":"query","description":"Filter the result by this string","schema":{"type":"string","nullable":true,"description":"Filter the result by this string"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["ACMEACCOUNT","REGISTRATION_EXPIRATION_DATE","PRODUCT","PROVIDER","STATUS","RENEWAL_DATE"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"includesub","in":"query","description":"Include subresellers: Includes all accountings for all subreseller acccounts in the list.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Include subresellers: Includes all accountings for all subreseller acccounts in the list."}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"acmeaccount":{"type":"array","description":"ACME account ID","items":{"type":"string","description":"ACME account ID"}},"acmeaccount_kid":{"type":"array","description":"Key identifier for the external account","items":{"type":"string","description":"Key identifier for the external account"}},"acmeserverurl":{"type":"array","description":"ACME server directory URL","items":{"type":"string","description":"ACME server directory URL"}},"column":{"type":"array","description":"Column names returned in the result set","items":{"type":"string","description":"Column names returned in the result set"}},"count":{"type":"integer","format":"int32","description":"Number of results returned"},"created_by":{"type":"array","description":"Registrar who created the account","items":{"type":"string","description":"Registrar who created the account"}},"created_date":{"type":"array","description":"Creation date","items":{"type":"string","format":"date","description":"Creation date"}},"first":{"type":"integer","format":"int32","description":"Index of the first result returned"},"last":{"type":"integer","format":"int32","description":"Index of the last result returned"},"limit":{"type":"integer","format":"int32","description":"Maximum number of results per page"},"paid_until":{"type":"array","description":"Date until the subscription is paid","items":{"type":"string","format":"date","description":"Date until the subscription is paid"}},"product":{"type":"array","description":"ACME product","items":{"type":"string","description":"ACME product"}},"provider":{"type":"array","description":"Certificate provider","items":{"type":"string","description":"Certificate provider"}},"registrar":{"type":"array","description":"Owning registrar; only returned with WIDE and INCLUDESUB","items":{"type":"string","description":"Owning registrar; only returned with WIDE and INCLUDESUB"}},"registration_expiration_date":{"type":"array","description":"Subscription expiration date","items":{"type":"string","format":"date","description":"Subscription expiration date"}},"renewal_date":{"type":"array","description":"Date on which automatic renewal will be attempted","items":{"type":"string","format":"date","description":"Date on which automatic renewal will be attempted"}},"renewalmode":{"type":"array","description":"Renewal mode","items":{"type":"string","description":"Renewal mode"}},"status":{"type":"array","description":"Account status","items":{"type":"string","description":"Account status"}},"total":{"type":"integer","format":"int32","description":"Total number of matching results"},"updated_by":{"type":"array","description":"Last user to update the account","items":{"type":"string","description":"Last user to update the account"}},"updated_date":{"type":"array","description":"Date of the last update","items":{"type":"string","format":"date","description":"Date of the last update"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryACMEaccountList"}},"/registrar":{"get":{"operationId":"queryRegistrarList","summary":"XRRP command QueryRegistrarList (queryRegistrarList)","description":"Returns all subresellers of the registrar.\n","tags":["registrar"],"parameters":[{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["REGISTRAR","PARENT","TREE","CREDIT","ACCOUNT","TEMPCREDIT","THRESHOLD","EMAIL","PRICESCALE","STATUS","CURRENCY","COUNTRY","URGENTEMAIL","CREATEDDATE","UPDATEDDATE"],"description":"Sort the result by this column"}},{"name":"tempcredit","in":"query","description":"Shows all subresellers with a temporary credit.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows all subresellers with a temporary credit."}},{"name":"showtree","in":"query","description":"Shows the entire registrartree of the executing user","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows the entire registrartree of the executing user"}},{"name":"status","in":"query","description":"Shows only subresellers with the defined status","schema":{"type":"string","nullable":true,"enum":["ACTIVE","INACTIVE","DISABLED","PENDING","UNVERIFIED","EMAILVERIFICATION"],"description":"Shows only subresellers with the defined status"}},{"name":"registrar","in":"query","description":"Shows only subresellers with the defined status","schema":{"type":"string","description":"Shows only subresellers with the defined status"}},{"name":"registrarindex","in":"query","description":"Shows the name of the registrar whit the given index.","schema":{"type":"integer","format":"int32","description":"Shows the name of the registrar whit the given index."}},{"name":"wide","in":"query","description":"Shows additional data for each subreseller.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows additional data for each subreseller."}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","format":"decimal","description":"Account: Current account deposit"},"country":{"type":"string","nullable":true,"description":"Country: The country of the registrar."},"created_date":{"type":"string","format":"date-time","description":"Created date: When the registrar was created in our system"},"credit":{"type":"string","format":"decimal","description":"Credit: Credit of the registrar account"},"currency":{"type":"string","description":"Currency: Currency of the registrar account"},"email":{"type":"string","nullable":true,"description":"Email: Email of the registrar"},"price_scale":{"type":"string"},"registrar":{"type":"string","description":"Registrar: Subreseller registrar name"},"status":{"type":"string","description":"Status: Status of the registrar account"},"subaccounts":{"type":"integer","format":"int32","description":"Subreseller Count: The amount of subreseller accounts under this subreseller, if multiple layers exist."},"tempcredit":{"type":"string","format":"decimal","description":"Registrar: Temporary credit set for the registrar"},"threshold":{"type":"string","format":"decimal","description":"Threshold: Currently available Threshold."},"total_certificates":{"type":"integer","format":"int32","description":"Total certificates: Total amount of certificates of the registrar"},"total_domains":{"type":"integer","format":"int32","description":"Total domains: Total amount of domains of the registrar"},"transfers_incoming":{"type":"integer","format":"int32","description":"Transfers incoming: Total amount of incoming transfers"},"transfers_outgoing":{"type":"integer","format":"int32","description":"Transfers outgoing: Total amount of outgoing transfers"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When the registrar was last updated"},"urgent_email":{"type":"string","nullable":true,"description":"Urgent Email: The urgent email of the registrar."}}}},"property":{"type":"object","properties":{"account_manager":{"type":"array","description":"Account Manager: The account manager of the registrar.","items":{"type":"string","nullable":true,"description":"Account Manager: The account manager of the registrar."}},"count":{"type":"integer","format":"int32","description":"Count: Total number of pricescales shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"parent":{"type":"array","description":"Registrar: Subreseller parent name","items":{"type":"string","description":"Registrar: Subreseller parent name"}},"pricescale":{"type":"array","description":"Pricescale: Pricescale of the registrar","items":{"type":"string","description":"Pricescale: Pricescale of the registrar"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing pricescales"},"tree":{"type":"array","description":"Registrar tree: Subreseller tree path","items":{"type":"string","nullable":true,"description":"Registrar tree: Subreseller tree path"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryRegistrarList"},"post":{"operationId":"addRegistrar","summary":"XRRP command AddRegistrar (addRegistrar)","description":"\n","tags":["registrar"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"admincity":{"type":"string","nullable":true,"description":"City"},"admincountry":{"type":"string","nullable":true,"description":"Country"},"adminemail":{"type":"string","nullable":true,"description":"Email"},"adminfax":{"type":"string","nullable":true,"description":"Fax: Fax of the admin contact (+12.34567890)"},"adminfirstname":{"type":"string","nullable":true,"description":"First name"},"adminlastname":{"type":"string","nullable":true,"description":"Last name"},"adminmiddlename":{"type":"string","nullable":true,"description":"Middle name"},"adminorganization":{"type":"string","nullable":true,"description":"Organization"},"adminphone":{"type":"string","nullable":true,"description":"Phone: Phone of the admin contact (+12.34567890)"},"adminstate":{"type":"string","nullable":true,"description":"State"},"adminstreet0":{"type":"string","nullable":true,"description":"Street"},"adminstreet1":{"type":"string","nullable":true,"description":"Street"},"adminstreet2":{"type":"string","nullable":true,"description":"Street"},"admintitle":{"type":"string","nullable":true,"description":"Title"},"adminzip":{"type":"string","nullable":true,"description":"Zip"},"billingcity":{"type":"string","nullable":true,"description":"City"},"billingcountry":{"type":"string","nullable":true,"description":"Country"},"billingemail":{"type":"string","nullable":true,"description":"Email"},"billingfax":{"type":"string","nullable":true,"description":"Fax: Fax of the billing contact (+12.34567890)"},"billingfirstname":{"type":"string","nullable":true,"description":"First name"},"billinglastname":{"type":"string","nullable":true,"description":"Last name"},"billingmiddlename":{"type":"string","nullable":true,"description":"Middle name"},"billingorganization":{"type":"string","nullable":true,"description":"Organization"},"billingphone":{"type":"string","nullable":true,"description":"Phone: Phone of the billing contact (+12.34567890)"},"billingstate":{"type":"string","nullable":true,"description":"State"},"billingstreet0":{"type":"string","nullable":true,"description":"Street"},"billingstreet1":{"type":"string","nullable":true,"description":"Street"},"billingstreet2":{"type":"string","nullable":true,"description":"Street"},"billingtitle":{"type":"string","nullable":true,"description":"Title"},"billingzip":{"type":"string","nullable":true,"description":"Zip"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"comments":{"type":"array","description":"Comment: Any number of comments as e.g. information about the registrar","items":{"type":"string","nullable":true,"description":"Comment: Any number of comments as e.g. information about the registrar"}},"country":{"type":"string","description":"Country: 2-letter ISO Code"},"credit":{"type":"string","format":"decimal","nullable":true,"description":"Credit: Initial credit"},"currency":{"type":"string","nullable":true,"enum":["EUR","USD","AUD","BGN","BRL","CAD","CHF","CNY","CZK","DKK","EEK","GBP","HKD","HRK","HUF","IDR","INR","JPY","KRW","LTL","LVL","MXN","MYR","NOK","NZD","PHP","PLN","RON","RUB","SEK","SGD","THB","TRY","ZAR","AED","QAR"],"description":"Currency: Accounting currency used for your account."},"email":{"type":"string","nullable":true,"description":"Email: All automatic events from the system will be sent to this emailaddress. We recommend you to enter the same\nemailaddress that you use yourself, but you can also set up special addresses for the events of your subresellers. Your\nsubresellers are not supposed to get the event messages directly but you should filter the events and forward them\nto your subresellers."},"emergencycredit":{"type":"string","format":"decimal","nullable":true,"description":"Emergency credit: This credit is used for renewals only"},"ftppassword":{"type":"string","nullable":true,"description":"FTP - password: Password for the FTP - account"},"invoicerun":{"type":"string","nullable":true,"description":"Invoicerun: The invoicerun that should be used for the invoice system."},"language":{"type":"string","nullable":true,"enum":["EN","DE","ES","FR","IT"],"description":"Language: Language the user wants to use"},"lowbalancewarning":{"type":"string","format":"decimal","nullable":true,"description":"Low-balance warning: If the account balance falls below this value, a warningmail is send. Enter 0 to disable this feature."},"nlemail":{"type":"string","nullable":true,"description":"NL - Email: Comma-separated list of newsletter - recipients. We will send our newsletter to the given addresses in your\naccount data. Subresellers do not get this newsletter, you are free to use the newsletter fields in their data for the\nsame purpose."},"nllanguage":{"type":"string","nullable":true,"description":"NL - Language: Comma-separated list of languages. If you submit one language, you will receive the newsletter to all addresses in this\nlanguage. If the number of languages separated by commas is the same as in the list of addresses, each address will\nreceive the newsletter in the specific language."},"ownercity":{"type":"string","nullable":true,"description":"City"},"ownercountry":{"type":"string","nullable":true,"description":"Country"},"owneremail":{"type":"string","nullable":true,"description":"Email"},"ownerfax":{"type":"string","nullable":true,"description":"Fax: Fax of the owner contact (+12.34567890)"},"ownerfirstname":{"type":"string","nullable":true,"description":"First name"},"ownerlastname":{"type":"string","nullable":true,"description":"Last name"},"ownermiddlename":{"type":"string","nullable":true,"description":"Middle name"},"ownerorganization":{"type":"string","nullable":true,"description":"Organization"},"ownerphone":{"type":"string","nullable":true,"description":"Phone: Phone of the owner contact (+12.34567890)"},"ownerstate":{"type":"string","nullable":true,"description":"State"},"ownerstreet0":{"type":"string","nullable":true,"description":"Street"},"ownerstreet1":{"type":"string","nullable":true,"description":"Street"},"ownerstreet2":{"type":"string","nullable":true,"description":"Street"},"ownertitle":{"type":"string","nullable":true,"description":"Title"},"ownerzip":{"type":"string","nullable":true,"description":"ZIP"},"passphrase":{"type":"string","nullable":true,"description":"Passphrase: This passphrase should be given to the support if they ask you, to verify that you are authorized to act in your name"},"password":{"type":"string","description":"Password: Password used for API - access or the webinterface"},"pricescale":{"type":"string","nullable":true,"description":"Pricescale: Prices of this pricescale will apply to all actions of the reseller"},"registrar":{"type":"string","description":"Registrar: Name of the new user account"},"renewalmode":{"type":"string","enum":["AUTORENEW","AUTODELETE","AUTOEXPIRE"],"description":"Renewalmode: Products with no fixed renewalmode will be using the renewalmode given here"},"techcity":{"type":"string","nullable":true,"description":"City"},"techcountry":{"type":"string","nullable":true,"description":"Country"},"techemail":{"type":"string","nullable":true,"description":"Email"},"techfax":{"type":"string","nullable":true,"description":"Fax: Fax of the tech contact (+12.34567890)"},"techfirstname":{"type":"string","nullable":true,"description":"First name"},"techlastname":{"type":"string","nullable":true,"description":"Last name"},"techmiddlename":{"type":"string","nullable":true,"description":"Middle name"},"techorganization":{"type":"string","nullable":true,"description":"Organization"},"techphone":{"type":"string","nullable":true,"description":"Phone: Phone of the tech contact (+12.34567890)"},"techstate":{"type":"string","nullable":true,"description":"State"},"techstreet0":{"type":"string","nullable":true,"description":"Street"},"techstreet1":{"type":"string","nullable":true,"description":"Street"},"techstreet2":{"type":"string","nullable":true,"description":"Street"},"techtitle":{"type":"string","nullable":true,"description":"Title"},"techzip":{"type":"string","nullable":true,"description":"Zip"},"transfermode":{"type":"string","enum":["DEFAULT","AUTOAPPROVE","AUTODENY"],"description":"Transfermode: Policy that applies to outgoing transfer requests (if supported by the registry). The default for this is to apply the policy in use by the registry operator."},"urgentemail":{"type":"string","description":"Urgent email: This mail will be used for urgent messages like abuses. Messages to this address should be answered fast"},"url":{"type":"string","nullable":true,"description":"URL: URL used for registration servicers"},"vat":{"type":"string","format":"decimal","nullable":true,"description":"V.A.T.: The vatpercentage used on reseller accountings"},"vatid":{"type":"string","nullable":true,"description":"V.A.T. ID: The VATID assigned to you or your company."},"whois-banner":{"type":"array","description":"Banner: This text will be shown in the whois","items":{"type":"string","nullable":true,"description":"Banner: This text will be shown in the whois"}},"whois-rsp":{"type":"string","nullable":true,"description":"RSP: This text will be shown in the whois as responsible registrar"},"zone":{"type":"array","description":"Zones: List of active TLDs","items":{"type":"string","nullable":true,"description":"Zones: List of active TLDs"}},"zones":{"type":"string","nullable":true,"description":"Zones: Comma-separated list of all of the users active TLDs"},"zonetag":{"type":"array","description":"Zone Tag: Activate all zones within a specific zone tag for this registrar.","items":{"type":"string","nullable":true,"description":"Zone Tag: Activate all zones within a specific zone tag for this registrar."}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"registrar":{"type":"array","description":"Registrar: Subreseller registrar name","items":{"type":"string","description":"Registrar: Subreseller registrar name"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddRegistrar"}},"/registrar/-/bydomain/{domain}":{"get":{"operationId":"queryRegistrarByDomain","summary":"XRRP command QueryRegistrarByDomain (queryRegistrarByDomain)","description":"\n","tags":["registrar"],"parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"domain":{"type":"string","description":"Domain: Domain name"},"registrar":{"type":"string","description":"Registrar: Registrar name"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryRegistrarByDomain"}},"/registrar/-/comment":{"post":{"operationId":"addRegistrarComment","summary":"XRRP command AddRegistrarComment (addRegistrarComment)","description":"\n","tags":["registrar"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"comment":{"type":"string","description":"The comment that will be added for the registrar"},"operator":{"type":"string","nullable":true,"description":"the username for the registrar comment"},"registrar":{"type":"string","description":"The registrar for the new comment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddRegistrarComment"}},"/registrar/-/comments":{"get":{"operationId":"queryRegistrarComments","summary":"XRRP command QueryRegistrarComments (queryRegistrarComments)","description":"\n","tags":["subreseller"],"parameters":[{"name":"maxdate","in":"query","schema":{"type":"string","format":"date","nullable":true}},{"name":"mindate","in":"query","schema":{"type":"string","format":"date","nullable":true}},{"name":"registrar","in":"query","schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["CREATEDDATE"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryRegistrarComments"}},"/registrar/-/emailaddress":{"get":{"operationId":"queryRegistrarEmailaddressList","summary":"XRRP command QueryRegistrarEmailaddressList (queryRegistrarEmailaddressList)","description":"Description comes here...\n","tags":["registrar"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"language","in":"query","description":"Language: Filter by Language","schema":{"type":"string","description":"Language: Filter by Language"}},{"name":"class","in":"query","description":"Filter by Class","schema":{"type":"string","description":"Filter by Class"}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is column1.","schema":{"type":"string","nullable":true,"enum":["COLUMN1","COLUMN2"],"description":"Order the results for the corresponding column. Default is column1."}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"class":{"type":"array","description":"Class: Class","items":{"type":"string","description":"Class: Class"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"email":{"type":"array","description":"E-Mail: E-Mail address","items":{"type":"string","description":"E-Mail: E-Mail address"}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"language":{"type":"array","description":"Language: Language","items":{"type":"string","description":"Language: Language"}},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"name":{"type":"array","description":"Name: Name of Recipient","items":{"type":"string","description":"Name: Name of Recipient"}},"status":{"type":"array","description":"Status: Status","items":{"type":"string","description":"Status: Status"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryRegistrarEmailaddressList"},"post":{"operationId":"addRegistrarEmailaddress","summary":"XRRP command AddRegistrarEmailaddress (addRegistrarEmailaddress)","tags":["registrar"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"class":{"type":"array","description":"Class: CLASS into the E-Mail address will be added","items":{"type":"string","nullable":true,"enum":["MAINTENANCE","NEWSLETTER","ABUSE","INVOICE","SUPPORT"],"description":"Class: CLASS into the E-Mail address will be added"}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"email":{"type":"string","description":"Email address: The E-Mail Address"},"language":{"type":"string","nullable":true,"description":"Language: Defined Language for E-Mail Address"},"name":{"type":"string","nullable":true,"description":"Name: Name of Recipient"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddRegistrarEmailaddress"}},"/registrar/-/emailaddress/{email}":{"delete":{"operationId":"deleteRegistrarEmailaddress","summary":"XRRP command DeleteRegistrarEmailaddress (deleteRegistrarEmailaddress)","description":"\n","tags":["registrar"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"email","in":"path","required":true,"description":"Email address: The E-Mail Address","schema":{"type":"string","description":"Email address: The E-Mail Address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteRegistrarEmailaddress"},"get":{"operationId":"statusRegistrarEmailaddress","summary":"XRRP command StatusRegistrarEmailaddress (statusRegistrarEmailaddress)","description":"\n","tags":["registrar"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"email","in":"path","required":true,"description":"Email address: The E-Mail Address","schema":{"type":"string","description":"Email address: The E-Mail Address"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"class":{"type":"string","description":"Class: E-Mail Class"},"email":{"type":"string","description":"Status: The E-Mail address"},"language":{"type":"string","description":"Status: Language of the E-Mail"},"status":{"type":"string","enum":["ACTIVE","DISABLED","PROCESSING","BLOCKED"],"description":"Status: Status of the E-Mail"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusRegistrarEmailaddress"},"patch":{"operationId":"modifyRegistrarEmailaddress","summary":"XRRP command ModifyRegistrarEmailaddress (modifyRegistrarEmailaddress)","description":"\n","tags":["registrar"],"parameters":[{"name":"email","in":"path","required":true,"description":"Email address: The E-Mail Address","schema":{"type":"string","description":"Email address: The E-Mail Address"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"class":{"type":"array","description":"Class: CLASS into the E-Mail address will be added","items":{"type":"string","nullable":true,"enum":["MAINTENANCE","NEWSLETTER","ABUSE","INVOICE"],"description":"Class: CLASS into the E-Mail address will be added"}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"language":{"type":"string","nullable":true,"description":"Language: Defined Language for E-Mail Address"},"name":{"type":"string","nullable":true,"description":"Name: Name of Recipient"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyRegistrarEmailaddress"}},"/registrar/-/statistic":{"get":{"operationId":"queryRegistrarStatisticList","summary":"XRRP command QueryRegistrarStatisticList (queryRegistrarStatisticList)","description":"This command queries a statistic - cache in the system. This allows you to get a quick glance how many objects you have in which zone.\nThe cache is regenerated every 4 hours.\n","tags":["registrar"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"type","in":"query","description":"Type: Show only statistics of the area matching this parameter","schema":{"type":"string","nullable":true,"enum":["domain","contact","nameserver","transfer","application","gtld-preorder","certificate","certificate2"],"description":"Type: Show only statistics of the area matching this parameter"}},{"name":"wide","in":"query","description":"Wide: Show more or less details","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Wide: Show more or less details"}},{"name":"zone","in":"query","description":"Zone: You may limit the search to this, a wildcard * or the special value \"_all_\" may be used","schema":{"type":"string","nullable":true,"description":"Zone: You may limit the search to this, a wildcard * or the special value \"_all_\" may be used"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is ZONE.","schema":{"type":"string","nullable":true,"enum":["TYPE","ZONE","AMOUNT","UPDATED_DATE"],"description":"Order the results for the corresponding column. Default is ZONE."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"amount":{"type":"array","description":"How many objects of the type the registrar manages","items":{"type":"integer","format":"int32","description":"How many objects of the type the registrar manages"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of statistics shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of statistics available"},"type":{"type":"array","description":"Indicates the type for this cached entry: domain, contact, nameserver, transfer, application, gTLD - preorder or certificates (API 1 and 2)","items":{"type":"string","description":"Indicates the type for this cached entry: domain, contact, nameserver, transfer, application, gTLD - preorder or certificates (API 1 and 2)"}},"updated_date":{"type":"array","description":"Updated date: The time, when this cache - entry was last updated","items":{"type":"string","format":"date-time","description":"Updated date: The time, when this cache - entry was last updated"}},"zone":{"type":"array","description":"The zone of the cached entry, _all_ for a sum of all entries of one type","items":{"type":"string","description":"The zone of the cached entry, _all_ for a sum of all entries of one type"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryRegistrarStatisticList"}},"/registrar/-/subscription":{"post":{"operationId":"addSubscriptionRequest","summary":"XRRP command AddSubscriptionRequest (addSubscriptionRequest)","description":"\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"acceptnda":{"type":"string","enum":["1","0"],"description":"Accept non-disclosure agreements: Accept non-disclosure agreements."},"acceptra":{"type":"string","enum":["1","0"],"description":"Accept registrar agreement: Accept registrar agreement."},"accepttac":{"type":"string","enum":["1","0"],"description":"Accept terms and conditions: Accept terms and conditions."},"city":{"type":"string","description":"City: City of the contact persons adress."},"classification":{"type":"string","description":"Request classification: Request classification"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"comment":{"type":"string","nullable":true,"description":"Additional comment: Space for additional comments"},"contactby":{"type":"string","nullable":true,"enum":["email","phone"],"description":"Preferred method of contact: Preferred method of contact"},"country":{"type":"string","description":"Country: 2 letter ISO country code of the contact persons adress."},"currentprovider":{"type":"string","nullable":true,"description":"Current provider: The registrar currently managing your domains."},"email":{"type":"string","nullable":true,"description":"Email address: Your email address"},"emailrepeated":{"type":"string","nullable":true,"description":"Email address repeated: Email address repeated"},"expectedvolume":{"type":"integer","format":"int32","description":"Expected volume: The number of domains which can be expected to be under our management  within the next 12 months."},"fax":{"type":"string","nullable":true,"description":"Fax number: Fax number"},"language":{"type":"string","enum":["de","en"],"description":"Preferred contact language: Preferred language to contact you"},"loginname":{"type":"string","nullable":true,"description":"Desired login name: The final login name may differ from your choice due to blacklisting or already taken names."},"name":{"type":"string","description":"Contact person: Full name of primary contact person"},"organization":{"type":"string","nullable":true,"description":"Organization: Organization"},"parent":{"type":"string","nullable":true,"description":"Parent user"},"phone":{"type":"string","nullable":true,"description":"Phone number: Phone number"},"referral":{"type":"string","nullable":true,"description":"Where did you hear from us: How did you hear about us"},"servicesinterested":{"type":"string","nullable":true,"description":"Services interested: Services you are interested in"},"state":{"type":"string","nullable":true,"description":"State: State of the contact persons adress."},"street":{"type":"string","description":"Street: Street of the contact persons adress."},"url":{"type":"string","nullable":true,"description":"Primary website: Your primary website"},"zip":{"type":"string","description":"ZIP: ZIP / postal code of the contact persons adress."},"zonesinterested":{"type":"string","nullable":true,"description":"TLDs you are interested in: TLDs you are interested in"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"email":{"type":"string"},"status":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddSubscriptionRequest"}},"/registrar/{registrar}":{"get":{"operationId":"statusRegistrar","summary":"XRRP command StatusRegistrar (statusRegistrar)","description":"\n","tags":["registrar"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"registrar","in":"path","required":true,"description":"Registrar: Name of the new user account","schema":{"type":"string","description":"Registrar: Name of the new user account"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"admin_city":{"type":"string","nullable":true,"description":"City: City of the administrative contact"},"admin_contact":{"type":"string"},"admin_country":{"type":"string","nullable":true,"description":"Country: Country of the administrative contact"},"admin_email":{"type":"string","nullable":true,"description":"Email: Email - address of the administative contact"},"admin_fax":{"type":"string","nullable":true,"description":"Fax: FAX - number of the administrative contact"},"admin_firstname":{"type":"string","nullable":true,"description":"Firstname: First name of the administrative contact"},"admin_lastname":{"type":"string","nullable":true,"description":"Lastname: Last name of the administrative contact"},"admin_middlename":{"type":"string","nullable":true,"description":"Middlename: Middle name of the administrative contact"},"admin_organization":{"type":"string","nullable":true,"description":"Organization: Organization of the administrative contact"},"admin_phone":{"type":"string","nullable":true,"description":"Phone: Telephone number of the administrative contact"},"admin_state":{"type":"string","nullable":true,"description":"State: State of the administrative contact"},"admin_street":{"type":"array","description":"Street: Street of the administrative contact","items":{"type":"string","nullable":true,"description":"Street: Street of the administrative contact"}},"admin_title":{"type":"string","nullable":true,"description":"Title: Title of the administrative contact"},"admin_zip":{"type":"string","nullable":true,"description":"Zip: Zip of the administrative contact"},"billing_city":{"type":"string","nullable":true,"description":"City: City of the billing contact"},"billing_contact":{"type":"string"},"billing_country":{"type":"string","nullable":true,"description":"Country: Country of the billing contact"},"billing_email":{"type":"string","nullable":true,"description":"Email: Email - address of the billing contact"},"billing_fax":{"type":"string","nullable":true,"description":"Fax: FAX - number of the billing contact"},"billing_firstname":{"type":"string","nullable":true,"description":"Firstname: First name of the billing contact"},"billing_lastname":{"type":"string","nullable":true,"description":"Lastname: Last name of the billing contact"},"billing_middlename":{"type":"string","nullable":true,"description":"Middlename: Middle name of the billing contact"},"billing_organization":{"type":"string","nullable":true,"description":"Organization: Organization of the billing contact"},"billing_phone":{"type":"string","nullable":true,"description":"Phone: Telephone number of the billing contact"},"billing_state":{"type":"string","nullable":true,"description":"State: State of the billing contact"},"billing_street":{"type":"array","description":"Street: Street of the billing contact","items":{"type":"string","nullable":true,"description":"Street: Street of the billing contact"}},"billing_title":{"type":"string","nullable":true,"description":"Title: Title of the billing contact"},"billing_zip":{"type":"string","nullable":true,"description":"Zip: Zip of the billing contact"},"comment":{"type":"string"},"comments":{"type":"array","description":"Comment: Any number of comments as e.g. information about the registrar","items":{"type":"string","description":"Comment: Any number of comments as e.g. information about the registrar"}},"country":{"type":"string","description":"Country: 2-letter ISO country code"},"created_date":{"type":"string","format":"date-time","description":"Created date: When the registrar was created"},"credit":{"type":"string","format":"decimal","description":"Credit: Current credit"},"currency":{"type":"string","description":"Currency: The currency in which the account will be billed"},"currency_change_date":{"type":"string","format":"date","description":"Currency Change Date: The date when the currency change will be executed."},"currency_change_status":{"type":"string","description":"Currency Change Status: The status of a currently pending account currency change."},"currency_change_to_currency":{"type":"string","description":"New Account Currency: The account currency to be changed to."},"current":{"type":"string"},"email":{"type":"string","description":"Email: All automatic events from RRPProxy will be sent to this emailaddress."},"emergencycredit":{"type":"string","format":"decimal","description":"Emergency credit: The credit useable for renewals"},"ftppassword":{"type":"string"},"invoicerun":{"type":"string","description":"Invoicerun: The rrpproxy invoicerun used for this registrar."},"language":{"type":"string","enum":["en_US","de_DE"],"description":"Language: Language the user wants to use"},"lowbalance_warning":{"type":"string","format":"decimal","description":"Low-balance warning: If the account goes lower than this value, a warningmail will be send"},"nlemail":{"type":"string","description":"NL - Email: Comma-separated list of newsletter - recipients."},"nllanguage":{"type":"string","description":"NL - Language: Comma-separated list of languages. If you submit one language, you will receive the newsletter to all addresses in this\nlanguage. If the number of languages separated by commas is the same as in the list of addresses, each address will\nreceive the newsletter in the specific language."},"owner_city":{"type":"string","nullable":true,"description":"City: City of the owner contact"},"owner_contact":{"type":"string"},"owner_country":{"type":"string","nullable":true,"description":"Country: Country of the owner contact"},"owner_email":{"type":"string","nullable":true,"description":"Email: Email - address of the owner contact"},"owner_fax":{"type":"string","nullable":true,"description":"Fax: FAX - number of the owner contact"},"owner_firstname":{"type":"string","nullable":true,"description":"Firstname: First name of the owner contact"},"owner_lastname":{"type":"string","nullable":true,"description":"Lastname: Last name of the owner contact"},"owner_middlename":{"type":"string","nullable":true,"description":"Middlename: Middle name of the owner contact"},"owner_organization":{"type":"string","nullable":true,"description":"Organization: Organization name of the owner contact"},"owner_phone":{"type":"string","nullable":true,"description":"Phone: Telephone - number of the owner contact"},"owner_state":{"type":"string","nullable":true,"description":"State: State of the owner contact"},"owner_street":{"type":"array","description":"Street: Street of the owner contact","items":{"type":"string","nullable":true,"description":"Street: Street of the owner contact"}},"owner_title":{"type":"string","nullable":true,"description":"Title: Title of the owner contact"},"owner_zip":{"type":"string","nullable":true,"description":"Zip: Zip of the owner contact"},"parent":{"type":"string","description":"Parent: Name of the parent reseller"},"pricescale":{"type":"string","description":"Pricescale: Pricescale assigned to the account"},"ram_active":{"type":"string","description":"Active Registry Account Management: A flag that shows if there are current active registry account management systems active."},"registrar":{"type":"string","description":"Registrar: Name of the account"},"renewalmode":{"type":"string","enum":["AUTORENEW","AUTODELETE","AUTOEXPIRE"],"description":"Renewal mode: Products with no fixed renewalmode will be using the renewalmode given here"},"sepa_accountholder":{"type":"string","description":"Account holder: Holder of the bank - account"},"sepa_active":{"type":"string","enum":["0","1"],"description":"SEPA direct debit: SEPA direct debit authorization"},"sepa_bic":{"type":"string","description":"BIC: BIC of the SEPA direct debit mandate"},"sepa_iban":{"type":"string","description":"IBAN: IBAN of the SEPA direct debit mandate"},"sepa_mid":{"type":"string","description":"MID: Mandate id for SEPA direct debit payment"},"status":{"type":"string"},"tech_city":{"type":"string","nullable":true,"description":"City: City of the technical contact"},"tech_contact":{"type":"string"},"tech_country":{"type":"string","nullable":true,"description":"Country: Country of the technical contact"},"tech_email":{"type":"string","nullable":true,"description":"Email: Email - address of the technical contact"},"tech_fax":{"type":"string","nullable":true,"description":"Fax: FAX - number of the technical contact"},"tech_firstname":{"type":"string","nullable":true,"description":"Firstname: First name of the technical contact"},"tech_lastname":{"type":"string","nullable":true,"description":"Lastname: Last name of the technical contact"},"tech_middlename":{"type":"string","nullable":true,"description":"Middlename: Middle name of the technical contact"},"tech_organization":{"type":"string","nullable":true,"description":"Organization: Organization of the technical contact"},"tech_phone":{"type":"string","nullable":true,"description":"Phone: Telephone number of the technical contact"},"tech_state":{"type":"string","nullable":true,"description":"State: State of the technical contact"},"tech_street":{"type":"array","description":"Street: Street of the technical contact","items":{"type":"string","nullable":true,"description":"Street: Street of the technical contact"}},"tech_title":{"type":"string","nullable":true,"description":"Title: Title of the technical contact"},"tech_zip":{"type":"string","nullable":true,"description":"Zip: Zip of the technical contact"},"tempcredit":{"type":"string","format":"decimal","description":"Temporary credit: Indicates, if a temporary credit is currently being used"},"transfer_emailsender":{"type":"string","nullable":true,"description":"Transfer emailsender"},"transfer_emailsubject":{"type":"string","nullable":true,"description":"Transfer emailsubject"},"transfer_emailtac":{"type":"string","nullable":true,"description":"Transfer emailtac"},"transfer_emailurl":{"type":"string","nullable":true,"description":"Transfer emailurl"},"transfermode":{"type":"string","enum":["DEFAULT","AUTOAPPROVE","AUTODENY"],"description":"Transfer mode: Policy that applies to outgoing transfer requests"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When was the last modification to the accunt - data being made"},"urgentemail":{"type":"string","description":"Urgent email: This mail will be used for urgent messages like abuses. Messages to this address should be answered fast"},"url":{"type":"string","description":"URL: URL used for registration servicers"},"vat":{"type":"string","format":"decimal","description":"V.A.T.: The value added tax which will be charged"},"vat_id":{"type":"string","description":"V.A.T. ID: The VATID assigned to you or your company."},"whois":{"type":"string","description":"Whois"},"whois-banner":{"type":"array","description":"Banner: This text will be shown in the whois as banner","items":{"type":"string","description":"Banner: This text will be shown in the whois as banner"}},"whois-rsp":{"type":"string","description":"RSP: This text will be shown in the whois as responsible registrar"},"zone":{"type":"array","description":"Zones: List of active TLDs","items":{"type":"string","description":"Zones: List of active TLDs"}},"zones":{"type":"string","nullable":true,"description":"Zones: Comma-separated list of all of the users active TLDs"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusRegistrar"},"patch":{"operationId":"modifyRegistrar","summary":"XRRP command ModifyRegistrar (modifyRegistrar)","description":"\n","tags":["registrar"],"parameters":[{"name":"registrar","in":"path","required":true,"description":"Registrar: Name of the new user account","schema":{"type":"string","description":"Registrar: Name of the new user account"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addzone":{"type":"array","items":{"type":"string","nullable":true}},"addzonetag":{"type":"array","description":"Zone Tag: Activate all zones within a specific zone tag for this registrar.","items":{"type":"string","nullable":true,"description":"Zone Tag: Activate all zones within a specific zone tag for this registrar."}},"admincity":{"type":"string","nullable":true,"description":"City"},"admincountry":{"type":"string","nullable":true,"description":"Country"},"adminemail":{"type":"string","nullable":true,"description":"Email"},"adminfax":{"type":"string","nullable":true,"description":"Fax: Fax of the admin contact (+12.34567890)"},"adminfirstname":{"type":"string","nullable":true,"description":"First name"},"adminlastname":{"type":"string","nullable":true,"description":"Last name"},"adminmiddlename":{"type":"string","nullable":true,"description":"Middle name"},"adminorganization":{"type":"string","nullable":true,"description":"Organization"},"adminphone":{"type":"string","nullable":true,"description":"Phone: Phone of the admin contact (+12.34567890)"},"adminstate":{"type":"string","nullable":true,"description":"State"},"adminstreet":{"type":"array","description":"Street","items":{"type":"string","nullable":true,"description":"Street"}},"admintitle":{"type":"string","nullable":true,"description":"Title"},"adminzip":{"type":"string","nullable":true,"description":"Zip"},"billingcity":{"type":"string","nullable":true,"description":"City"},"billingcountry":{"type":"string","nullable":true,"description":"Country"},"billingemail":{"type":"string","nullable":true,"description":"Email"},"billingfax":{"type":"string","nullable":true,"description":"Fax: Fax of the billing contact (+12.34567890)"},"billingfirstname":{"type":"string","nullable":true,"description":"First name"},"billinglastname":{"type":"string","nullable":true,"description":"Last name"},"billingmiddlename":{"type":"string","nullable":true,"description":"Middle name"},"billingorganization":{"type":"string","nullable":true,"description":"Organization"},"billingphone":{"type":"string","nullable":true,"description":"Phone: Phone of the billing contact (+12.34567890)"},"billingstate":{"type":"string","nullable":true,"description":"State"},"billingstreet":{"type":"array","description":"Street","items":{"type":"string","nullable":true,"description":"Street"}},"billingtitle":{"type":"string","nullable":true,"description":"Title"},"billingzip":{"type":"string","nullable":true,"description":"Zip"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"comments":{"type":"array","description":"Comment: Any number of comments as e.g. information about the registrar","items":{"type":"string","nullable":true,"description":"Comment: Any number of comments as e.g. information about the registrar"}},"country":{"type":"string","nullable":true,"description":"Country: 2-letter ISO Code"},"credit":{"type":"string","format":"decimal","nullable":true,"description":"Credit: Initial credit"},"delzone":{"type":"array","items":{"type":"string","nullable":true}},"delzonetag":{"type":"array","description":"Zone Tag: Disable all zones within a specific zone tag for this registrar.","items":{"type":"string","nullable":true,"description":"Zone Tag: Disable all zones within a specific zone tag for this registrar."}},"email":{"type":"string","nullable":true,"description":"Email: All automatic events from this system will be sent to this emailaddress. We recommend you to enter the same\nemailaddress that you use yourself, but you can also set up special addresses for the events of your subresellers. Your\nsubresellers are not supposed to get the event messages directly but you should filter the events and forward them\nto your subresellers."},"emergencycredit":{"type":"string","format":"decimal","nullable":true,"description":"Emergency credit: This credit is used for renewals only"},"ftppassword":{"type":"string","nullable":true,"description":"FTP password: FTP Password for registrar ftp connection"},"language":{"type":"string","nullable":true,"enum":["EN","DE","ES","FR","IT"],"description":"Language: Language used for automated emails, forms, invoices and more."},"lowbalancewarning":{"type":"string","format":"decimal","nullable":true,"description":"Low-balance warning: If the account balance falls below this value, a warningmail is send. Warnings are send to your \"urgent\" email address. Enter 0 to disable this feature."},"nlemail":{"type":"string","nullable":true,"description":"NL - Email: Comma-separated list of newsletter - recipients. We will send our newsletter to the given addresses in your\naccount data. Subresellers do not get this newsletter, you are free to use the newsletter fields in their data for the\nsame purpose."},"nllanguage":{"type":"string","nullable":true,"description":"NL - Language: Comma-separated list of languages. If you submit one language, you will receive the newsletter to all addresses in this\nlanguage. If the number of languages separated by commas is the same as in the list of addresses, each address will\nreceive the newsletter in the specific language."},"otepassword":{"type":"string","nullable":true,"description":"OT\u0026E password: Changes the OTE password of the registrar. Only works in LIVE system."},"ownercity":{"type":"string","nullable":true,"description":"City"},"ownercountry":{"type":"string","nullable":true,"description":"Country"},"owneremail":{"type":"string","nullable":true,"description":"Email"},"ownerfax":{"type":"string","nullable":true,"description":"Fax: Fax of the owner contact (+12.34567890)"},"ownerfirstname":{"type":"string","nullable":true,"description":"First name"},"ownerlastname":{"type":"string","nullable":true,"description":"Last name"},"ownermiddlename":{"type":"string","nullable":true,"description":"Middle name"},"ownerorganization":{"type":"string","nullable":true,"description":"Organization"},"ownerphone":{"type":"string","nullable":true,"description":"Phone: Phone of the owner contact (+12.34567890)"},"ownerstate":{"type":"string","nullable":true,"description":"State"},"ownerstreet":{"type":"array","description":"Street","items":{"type":"string","nullable":true,"description":"Street"}},"ownertitle":{"type":"string","nullable":true,"description":"Title"},"ownerzip":{"type":"string","nullable":true,"description":"Zip"},"passphrase":{"type":"string","nullable":true,"description":"Passphrase: This passphrase should be given to the support if they ask you, to verify that you are authorized to act in your name"},"password":{"type":"string","nullable":true,"description":"Password: Password used for API - access or the webinterface"},"pricescale":{"type":"string","description":"Pricescale: Prices of this pricescale will apply to all actions of the reseller"},"renewalmode":{"type":"string","enum":["AUTORENEW","AUTODELETE","AUTOEXPIRE"],"description":"Renewalmode: Global setting for all domain names and other services which have their renewal policy set to „DEFAULT“. Setting an individual mode for each single domain or service is also possible."},"status":{"type":"string","nullable":true,"enum":["ACTIVE","INACTIVE","DISABLED"],"description":"Status: Determines if a registrar is active or inactive."},"techcity":{"type":"string","nullable":true,"description":"City"},"techcountry":{"type":"string","nullable":true,"description":"Country"},"techemail":{"type":"string","nullable":true,"description":"Email"},"techfax":{"type":"string","nullable":true,"description":"Fax: Fax of the tech contact (+12.34567890)"},"techfirstname":{"type":"string","nullable":true,"description":"First name"},"techlastname":{"type":"string","nullable":true,"description":"Last name"},"techmiddlename":{"type":"string","nullable":true,"description":"Middle name"},"techorganization":{"type":"string","nullable":true,"description":"Organization"},"techphone":{"type":"string","nullable":true,"description":"Phone: Phone of the tech contact (+12.34567890)"},"techstate":{"type":"string","nullable":true,"description":"State"},"techstreet":{"type":"array","description":"Street","items":{"type":"string","nullable":true,"description":"Street"}},"techtitle":{"type":"string","nullable":true,"description":"Title"},"techzip":{"type":"string","nullable":true,"description":"Zip"},"tempcredit":{"type":"string","format":"decimal","nullable":true,"description":"Temporary credit: A temporary credit that can be set and removed by the managing reseller"},"transfermode":{"type":"string","enum":["DEFAULT","AUTOAPPROVE","AUTODENY"],"description":"Transfermode: Policy that applies to outgoing transfer requests (if supported by the registry). The default for this is to apply the policy in use by the registry operator."},"urgentemail":{"type":"string","nullable":true,"description":"Urgent email: This mail will be used for urgent messages like abuses. Messages to this address should be answered fast"},"url":{"type":"string","nullable":true,"description":"URL: URL used for registration servicers"},"vat":{"type":"string","format":"decimal","nullable":true,"description":"V.A.T."},"vatid":{"type":"string","nullable":true,"description":"V.A.T. ID: The VATID assigned to you or your company."},"whois-banner":{"type":"array","description":"Banner: This text will be shown in the whois","items":{"type":"string","nullable":true,"description":"Banner: This text will be shown in the whois"}},"whois-rsp":{"type":"string","nullable":true,"description":"RSP: This text will be shown in the whois as responsible registrar"},"zone":{"type":"array","description":"Zones: List of active TLDs","items":{"type":"string","nullable":true,"description":"Zones: List of active TLDs"}},"zones":{"type":"string","nullable":true,"description":"Zones: Comma-separated list of all of the users active TLDs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyRegistrar"}},"/registrar/{registrar}/availability":{"get":{"operationId":"checkRegistrar","summary":"XRRP command CheckRegistrar (checkRegistrar)","description":"This command checks if the desired registrar name is available and can be created in the system.\n","tags":["registrar"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"registrar","in":"path","required":true,"description":"Registrar name to be checked for availability","schema":{"type":"string","description":"Registrar name to be checked for availability"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CheckRegistrar"}},"/registrar/{registrar}/comment":{"get":{"operationId":"queryRegistrarCommentList","summary":"XRRP command QueryRegistrarCommentList (queryRegistrarCommentList)","description":"\n","tags":["registrar"],"parameters":[{"name":"maxdate","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"mindate","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"registrar","in":"path","required":true,"schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["CREATEDDATE"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","description":"Show more or less details in the results","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less details in the results"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"comment":{"type":"string","description":"Comment: The comment data"},"created_date":{"type":"string","format":"date-time"},"user":{"type":"string","description":"User: The user who created or triggered the comment"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of pricescales shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"maxdate":{"type":"string","format":"date","nullable":true,"description":"Maxdate: Maximum date to select the registrar comments"},"mindate":{"type":"string","format":"date","nullable":true,"description":"Mindate: Minimum date to select the registrar comments"},"registrar":{"type":"string","description":"Registrar: Registrar regarding the comments"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing pricescales"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryRegistrarCommentList"}},"/registrar/{registrar}/currency":{"patch":{"operationId":"modifyRegistrarCurrency","summary":"XRRP command ModifyRegistrarCurrency (modifyRegistrarCurrency)","description":"\n","tags":["registrar"],"parameters":[{"name":"registrar","in":"path","required":true,"description":"Registrar: Name of the registrar for the currency change.","schema":{"type":"string","nullable":true,"description":"Registrar: Name of the registrar for the currency change."}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cancelchange":{"type":"string","nullable":true,"enum":["1","0"],"description":"Cancel pending currency change: If you want to cancel a currently pending currency change, you can use this paramter to do so."},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"currency":{"type":"string","nullable":true,"description":"Currency: The currency to which the account will be changed to."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"changedate":{"type":"string","format":"date","nullable":true,"description":"Changedate: Indicates the changedate when the currency will be changed if status is PENDING."},"status":{"type":"string","description":"Status: Name status of the currency change. It can be PENDING, SUCCESS or DELETED."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyRegistrarCurrency"}},"/registryaccount":{"get":{"operationId":"queryRegistryAccountList","summary":"XRRP command QueryRegistryAccountList (queryRegistryAccountList)","description":"\n","tags":["registryaccount"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"registryaccount","in":"query","description":"Pattern match for registryaccount","schema":{"type":"string","nullable":true,"description":"Pattern match for registryaccount"}},{"name":"status","in":"query","description":"Pattern match for status","schema":{"type":"string","nullable":true,"description":"Pattern match for status"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["REGISTRYACCOUNT","CREATED_DATE"],"description":"Sort the result by this column"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"wide","in":"query","description":"Show a detailed list","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show a detailed list"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of ACL entries shown"},"created_date":{"type":"array","items":{"type":"string","format":"date-time"}},"domain_count":{"type":"array","items":{"type":"integer","format":"int32","nullable":true}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"iana_id":{"type":"array","items":{"type":"string","nullable":true}},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"registryaccount":{"type":"array","items":{"type":"string"}},"status":{"type":"array","items":{"type":"string"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of ACLs"},"zones":{"type":"array","items":{"type":"string","nullable":true}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryRegistryAccountList"}},"/registryaccount/{registryaccount}":{"get":{"operationId":"statusRegistryAccount","summary":"XRRP command StatusRegistryAccount (statusRegistryAccount)","description":"\n","tags":["registryaccount"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"registryaccount","in":"path","required":true,"description":"The Registry Account Name","schema":{"type":"string","description":"The Registry Account Name"}},{"name":"token","in":"query","description":"PinLock Token to show the passwords","schema":{"type":"string","description":"PinLock Token to show the passwords"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"api_password":{"type":"array","items":{"type":"string"}},"api_password_change_days":{"type":"array","items":{"type":"integer","format":"int32"}},"api_password_expiry_date":{"type":"array","items":{"type":"string","format":"date-time"}},"api_password_last_change_date":{"type":"array","items":{"type":"string","format":"date-time"}},"api_username":{"type":"array","items":{"type":"string"}},"balance_credit":{"type":"string","format":"decimal","nullable":true,"description":"Balance credit"},"balance_currency":{"type":"string","nullable":true,"description":"Balance currency"},"balance_current":{"type":"string","format":"decimal","nullable":true,"description":"Balance current"},"created_date":{"type":"array","items":{"type":"string","format":"date-time"}},"domain_count":{"type":"array","items":{"type":"integer","format":"int32"}},"ftp_password":{"type":"array","items":{"type":"string"}},"ftp_username":{"type":"array","items":{"type":"string"}},"iana_id":{"type":"array","items":{"type":"string"}},"organization":{"type":"array","items":{"type":"string"}},"registryaccount":{"type":"string"},"status":{"type":"array","items":{"type":"string"}},"zones":{"type":"array","items":{"type":"string"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusRegistryAccount"}},"/scheduledcommand":{"get":{"operationId":"queryScheduledCommandList","summary":"XRRP command QueryScheduledCommandList (queryScheduledCommandList)","description":"\n","tags":["scheduledcommand"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"List ordering","schema":{"type":"string","nullable":true,"enum":["DOMAIN","COMMAND","STATUS","X-SCHEDULEDEXECUTIONDATE"],"description":"List ordering"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"column":{"type":"string"},"count":{"type":"string"},"created_by":{"type":"string"},"created_date":{"type":"string","format":"date"},"domain":{"type":"string"},"external_transfer":{"type":"string"},"first":{"type":"integer","format":"int32"},"last":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"registrar":{"type":"string"},"scheduledcommand":{"type":"string"},"scheduledcommandid":{"type":"integer","format":"int32"},"status":{"type":"string"},"total":{"type":"integer","format":"int32"},"updated_by":{"type":"string"},"updated_date":{"type":"string","format":"date"},"x-scheduledexecutiondate":{"type":"string","format":"date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryScheduledCommandList"},"post":{"operationId":"addScheduledCommand","summary":"XRRP command AddScheduledCommand (addScheduledCommand)","description":"\n","tags":["scheduledcommand"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"type":"string","nullable":true,"description":"Authentication code: The authorization code for the domain (not supported by all registries)"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"domain":{"type":"string","description":"Domain: Domain name"},"force":{"type":"string","enum":["0","1"]},"ownercontact0":{"type":"string","nullable":true,"description":"Owner contact"},"scheduledcommand":{"type":"string","enum":["TRANSFERDOMAIN"],"description":"Scheduled command: Command which should be executed."},"scheduledprecheck":{"type":"string","nullable":true,"enum":["0","1"],"description":"Pre check Scheduled command: Pre check scheduled command (for example AUTH check)"},"x-be-requestauthcode":{"type":"string","nullable":true,"enum":["1","0"],"description":"Request Authcode: Request an authcode for .be domains."},"x-fi-requestauthcode":{"type":"string","nullable":true,"enum":["1","0"],"description":"Request Authcode: Request an authcode for .fi domains"},"x-scheduledexecutiondate":{"type":"string","nullable":true,"description":"Scheduled execution date: Extension scheduled execution date (FORMAT: YYYY-MM-DD HH:MM:SS)"},"x-scheduledexecutiondays-offset":{"type":"integer","format":"int32","nullable":true,"description":"Scheduled execution days offset: Extension  scheduled execution days offset (1-180) prior to registration expiration date"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddScheduledCommand"}},"/scheduledcommand/-/history":{"get":{"operationId":"queryScheduledCommandHistoryList","summary":"XRRP command QueryScheduledCommandHistoryList (queryScheduledCommandHistoryList)","description":"\n","tags":["scheduledcommand"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"List ordering","schema":{"type":"string","nullable":true,"enum":["DOMAIN","COMMAND","STATUS","X-SCHEDULEDEXECUTIONDATE"],"description":"List ordering"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryScheduledCommandHistoryList"}},"/scheduledcommand/{scheduledcommandid}":{"delete":{"operationId":"deleteScheduledCommand","summary":"XRRP command DeleteScheduledCommand (deleteScheduledCommand)","description":"\n","tags":["scheduledcommand"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","required":true,"description":"Domain: Domain name","schema":{"type":"string","nullable":true,"description":"Domain: Domain name"}},{"name":"scheduledcommandid","in":"path","required":true,"description":"Scheduled command id: Scheduled command id","schema":{"type":"string","nullable":true,"description":"Scheduled command id: Scheduled command id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteScheduledCommand"},"get":{"operationId":"statusScheduledCommand","summary":"XRRP command StatusScheduledCommand (statusScheduledCommand)","description":"\n","tags":["scheduledcommand"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"domain","in":"query","required":true,"description":"Domain: Domain name","schema":{"type":"string","nullable":true,"description":"Domain: Domain name"}},{"name":"scheduledcommandid","in":"path","required":true,"description":"Scheduled command id: Scheduled command id","schema":{"type":"string","nullable":true,"description":"Scheduled command id: Scheduled command id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusScheduledCommand"},"patch":{"operationId":"modifyScheduledCommand","summary":"XRRP command ModifyScheduledCommand (modifyScheduledCommand)","description":"\n","tags":["scheduledcommand"],"parameters":[{"name":"scheduledcommandid","in":"path","required":true,"description":"Scheduled command id: Scheduled command id","schema":{"type":"string","nullable":true,"description":"Scheduled command id: Scheduled command id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"auth":{"type":"string","nullable":true,"description":"Authentication code: The authorization code for the domain (not supported by all registries)"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"domain":{"type":"string","nullable":true,"description":"Domain: Domain name"},"force":{"type":"string","enum":["0","1"]},"ownercontact0":{"type":"string","nullable":true,"description":"Owner contact"},"x-scheduledexecutiondate":{"type":"string","nullable":true,"description":"Scheduled execution date: Extension scheduled execution date (FORMAT: YYYY-MM-DD HH:MM:SS)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyScheduledCommand"}},"/service":{"get":{"operationId":"queryServiceList","summary":"XRRP command QueryServiceList (queryServiceList)","description":"Shows a price overview over all available services\n","parameters":[{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"service","in":"query","description":"Shows only the prices of the given service.","schema":{"type":"string","nullable":true,"description":"Shows only the prices of the given service."}},{"name":"type","in":"query","description":"Shows only the prices of the given type.","schema":{"type":"string","nullable":true,"description":"Shows only the prices of the given type."}},{"name":"individual","in":"query","description":"Shows only individual prices if set to 0. Default 1.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows only individual prices if set to 0. Default 1."}},{"name":"inactive","in":"query","description":"Shows inactive prices too if set to 0. Default 1.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows inactive prices too if set to 0. Default 1."}},{"name":"registrar","in":"query","description":"Shows the prices of the given subreseller.","schema":{"type":"string","nullable":true,"description":"Shows the prices of the given subreseller."}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"active":{"type":"string","enum":["1","0"],"description":"Service active: Is this service activated"},"annual":{"type":"string","format":"decimal","nullable":true,"description":"Annual fee: The annual costs of this service"},"application":{"type":"string","format":"decimal","nullable":true,"description":"Application fee: The application fee for this service"},"currency":{"type":"string","description":"Currency: The currency in which this service will be billed"},"dependency":{"type":"string","description":"Dependency: Dependency to other services"},"description":{"type":"string","description":"Description: A small description for this service"},"period":{"type":"integer","format":"int32","description":"Period: The dataset is valid for this period"},"periodtype":{"type":"string","description":"Period type: The type of period, mostly YEAR"},"restore":{"type":"string","format":"decimal","nullable":true,"description":"Restore fee: The restore fee of this service"},"service":{"type":"string","description":"Service name: Name of the service"},"setup":{"type":"string","format":"decimal","nullable":true,"description":"Setup fee: The setup costs of this service"},"trade":{"type":"string","format":"decimal","nullable":true,"description":"Trade fee: The trade fee of this service"},"transfer":{"type":"string","format":"decimal","nullable":true,"description":"Transfer fee: The transfer fee of this service"},"type":{"type":"string","description":"Service type: Type of the service, e.g. SSL123 for the service \"Certificate\""}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryServiceList"}},"/session":{"delete":{"operationId":"stopSession","summary":"XRRP command StopSession (stopSession)","description":"\n","tags":["session"],"parameters":[{"name":"sessionid","in":"query","schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StopSession"},"post":{"operationId":"startSession","summary":"XRRP command StartSession (startSession)","description":"\n","tags":["session"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"lifetime":{"type":"integer","format":"int32","description":"Session lifetime seconds: The session lifetime in seconds. Default is 86400 (24 hours). With a value 0 no session is created."},"login":{"type":"string","description":"Login: The registrar name. If you use an ACL user, the registrar and user must be separated by a colon"},"newpassword":{"type":"string","description":"New Password: Change the registrar or ACL user password"},"password":{"type":"string","description":"Password: The registrar password or if it is an ACL user the user password"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"expiration_date":{"type":"string","format":"date-time","description":"Session Expiration Date: The session expiration date"},"sessionid":{"type":"string","description":"Session ID: The session ID"},"token":{"type":"string","description":"Session Token: The session token"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StartSession"}},"/session/{sessionid}":{"delete":{"operationId":"stopSession_2","summary":"XRRP command StopSession (stopSession_2)","description":"\n","tags":["session"],"parameters":[{"name":"sessionid","in":"path","required":true,"schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StopSession"}},"/set":{"get":{"operationId":"querySetList","summary":"XRRP command QuerySetList (querySetList)","description":"\n","tags":["set"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"set","in":"query","description":"Pattern match for set name","schema":{"type":"string","nullable":true,"description":"Pattern match for set name"}},{"name":"type","in":"query","description":"Pattern match for set type","schema":{"type":"string","nullable":true,"description":"Pattern match for set type"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["SET","TYPE"],"description":"Sort the result by this column"}},{"name":"wide","in":"query","description":"Show a detailed list or a grouped list version","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show a detailed list or a grouped list version"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"set":{"type":"string","description":"Set name: The name of the set."}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count"},"created_by":{"type":"array","description":"Created by: Who created the set.","items":{"type":"string","description":"Created by: Who created the set."}},"created_date":{"type":"array","description":"Created date: When the set was created.","items":{"type":"string","format":"date-time","description":"Created date: When the set was created."}},"first":{"type":"integer","format":"int32","description":"First"},"last":{"type":"integer","format":"int32","description":"Last"},"limit":{"type":"integer","format":"int32","description":"Limit"},"total":{"type":"integer","format":"int32","description":"Total"},"type":{"type":"array","description":"Set type: The type of the set.","items":{"type":"string","description":"Set type: The type of the set."}},"updated_by":{"type":"array","description":"Updated by: Who was the last one updating the set.","items":{"type":"string","description":"Updated by: Who was the last one updating the set."}},"updated_date":{"type":"array","description":"Updated date: When the set was last updated.","items":{"type":"string","format":"date-time","description":"Updated date: When the set was last updated."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QuerySetList"},"patch":{"operationId":"modifySet","summary":"XRRP command ModifySet (modifySet)","description":"\n","tags":["set"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addkey":{"type":"array","description":"Key: Key of the entry to be added / modified","items":{"type":"string","nullable":true,"description":"Key: Key of the entry to be added / modified"}},"addvalue":{"type":"array","description":"Value: Value of the entry to be modified","items":{"type":"string","nullable":true,"description":"Value: Value of the entry to be modified"}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"delkey":{"type":"array","description":"Delete key: Key of the entry to be deleted","items":{"type":"string","nullable":true,"description":"Delete key: Key of the entry to be deleted"}},"newname":{"type":"string","nullable":true,"description":"New set name: New name of the set"},"set":{"type":"string","description":"Set name: Name of the set to be modified"},"type":{"type":"string","nullable":true,"description":"Set type: Type of the set"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifySet"},"post":{"operationId":"addSet","summary":"XRRP command AddSet (addSet)","description":"\n","tags":["set"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"key":{"type":"array","description":"Key: The key to be added to the set","items":{"type":"string","nullable":true,"description":"Key: The key to be added to the set"}},"set":{"type":"string","description":"Set name: The name of this set"},"type":{"type":"string","nullable":true,"description":"Set type: The type of this set"},"value":{"type":"array","description":"Value: The value to be used for the key in this set","items":{"type":"string","nullable":true,"description":"Value: The value to be used for the key in this set"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddSet"}},"/set/{set}":{"delete":{"operationId":"deleteSet","summary":"XRRP command DeleteSet (deleteSet)","description":"\n","tags":["set"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"set","in":"path","required":true,"description":"Set name: Name of the set to be deleted","schema":{"type":"string","description":"Set name: Name of the set to be deleted"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteSet"},"get":{"operationId":"statusSet","summary":"XRRP command StatusSet (statusSet)","description":"\n","tags":["set"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"set","in":"path","required":true,"description":"Set name: Name of the set to be queried","schema":{"type":"string","description":"Set name: Name of the set to be queried"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"created_by":{"type":"string","description":"Created by: Who created the set."},"created_date":{"type":"string","format":"date-time","description":"Created date: When the set was created."},"key":{"type":"array","description":"Key: Name of the parameter to be replaced / inserted into a command","items":{"type":"string","description":"Key: Name of the parameter to be replaced / inserted into a command"}},"set":{"type":"string","description":"Set name: Name of the set"},"type":{"type":"string","description":"Set type: Type of the set"},"updated_by":{"type":"string","description":"Updated by: Who was the last one updating the set."},"updated_date":{"type":"string","format":"date-time","description":"Updated date: When the set was last updated."},"value":{"type":"array","description":"Value: Value of the parameter to be inserted / replaced in a command","items":{"type":"string","description":"Value: Value of the parameter to be inserted / replaced in a command"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusSet"}},"/sms":{"get":{"operationId":"queryMobileAccountList","summary":"XRRP command QueryMobileAccountList (queryMobileAccountList)","description":"Get all informations about your mobile accounts.\n","tags":["sms"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"wide","in":"query","description":"Show more or less verbose output","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show more or less verbose output"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"account":{"type":"array","description":"Account: ID of the account","items":{"type":"string","description":"Account: ID of the account"}},"count":{"type":"integer","format":"int32","description":"Count: Total number of mobile accounts shown"},"created_date":{"type":"array","description":"Created date: Date, when this mobile account was created","items":{"type":"string","format":"date","description":"Created date: Date, when this mobile account was created"}},"currency":{"type":"array","description":"Currency: Currency of this mobile account","items":{"type":"string","description":"Currency: Currency of this mobile account"}},"current":{"type":"array","description":"Current: Current amount available on this mobile account","items":{"type":"string","format":"decimal","description":"Current: Current amount available on this mobile account"}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"password":{"type":"array","description":"Password: Password for this mobile account","items":{"type":"string","description":"Password: Password for this mobile account"}},"status":{"type":"array","description":"Status: Current status of this mobile account","items":{"type":"string","enum":["ACTIVE","SUSPENDED"],"description":"Status: Current status of this mobile account"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of mobile accounts"},"updated_date":{"type":"array","description":"Updated date: date, when this mobile account was last updated","items":{"type":"string","format":"date","description":"Updated date: date, when this mobile account was last updated"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryMobileAccountList"},"post":{"operationId":"createMobileAccount","summary":"XRRP command CreateMobileAccount (createMobileAccount)","description":"Create a new mobile account, the amount on this account is independent from your main account, just the initial charging will be accounted on the main account, not single SMS.\n","tags":["sms"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","format":"int32","description":"Amount to be charged on the mobileaccount from your real account, min 10, max 500"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"accountid":{"type":"string","description":"Accountid: ID of the new mobile account, this may be used to access the dedicated API (parameter \"ACCOUNTID\")"},"amount_charged":{"type":"integer","format":"int32","description":"Amount charged: The amount charged from your account"},"currency":{"type":"string","description":"Currency: Currency of the mobile account"},"currency_charged":{"type":"string","description":"Currency charged: The currency charged from your account"},"current":{"type":"integer","format":"int32","description":"Current: Current amount available on the mobile account"},"password":{"type":"string","description":"Password: The password to be used while accessing the dedicated mobile API (parameter \"PASSWORD\")"},"status":{"type":"string","enum":["ACTIVE"],"description":"Status: Current status of the mobile account"},"vat_charged":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"CreateMobileAccount"}},"/sms/account/{accountid}":{"get":{"operationId":"statusMobileAccount","summary":"XRRP command StatusMobileAccount (statusMobileAccount)","description":"Get details of your mobile account, useful if you forgot the password or need to ensure that enough money is charged on it.\n","tags":["sms"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"accountid","in":"path","required":true,"description":"Account-ID: Unique identifier of the account to be queried","schema":{"type":"string","description":"Account-ID: Unique identifier of the account to be queried"}},{"name":"password","in":"query","description":"Mobile account password to be used","schema":{"type":"string","description":"Mobile account password to be used"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"accountid":{"type":"string","description":"Accountid: ID of the new mobile account, this may be used to access the dedicated API (parameter \"ACCOUNTID\")"},"amount_charged":{"type":"integer","format":"int32","description":"Amount charged: The amount charged from your account"},"created_date":{"type":"string","format":"date-time"},"currency":{"type":"string","description":"Currency: Currency of the mobile account"},"currency_charged":{"type":"string","description":"Currency charged: The currency charged from your account"},"current":{"type":"string","format":"decimal","description":"Current: Current amount available on the mobile account"},"password":{"type":"string","description":"Password: The password to be used while accessing the dedicated mobile API (parameter \"PASSWORD\")"},"settings":{"type":"string"},"status":{"type":"string","description":"Status: Current status of the mobile account"},"updated_date":{"type":"string","format":"date-time"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusMobileAccount"}},"/sms/{accountid}/charge":{"patch":{"operationId":"chargeMobileAccount","summary":"XRRP command ChargeMobileAccount (chargeMobileAccount)","description":"Charge your mobile account, the amount on this account is independent from your main account, just the charging will be accounted on the main account, not single SMS.\n","tags":["sms"],"parameters":[{"name":"accountid","in":"path","required":true,"description":"Account-ID: Unique identifier of the account to be charged","schema":{"type":"string","description":"Account-ID: Unique identifier of the account to be charged"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","format":"int32","description":"Amount: Amount to be charged on the mobileaccount from your real account, min 10, max 500"},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"account_currency":{"type":"string"},"accountid":{"type":"string","description":"Accountid: ID of the mobile account, this may be used to access the dedicated API (parameter \"ACCOUNTID\")"},"amount_charged":{"type":"integer","format":"int32","description":"Amount charged: The amount charged from your account"},"amount_charged_from_account":{"type":"string"},"amount_charged_to_mobileaccount":{"type":"string"},"currency":{"type":"string"},"currency_charged":{"type":"string","description":"Currency charged: The currency charged from your account"},"current":{"type":"integer","format":"int32","description":"Current: Current amount available on the mobile account"},"exchange_rate_account_currency":{"type":"string"},"password":{"type":"string","description":"Password: The password to be used while accessing the dedicated mobile API (parameter \"PASSWORD\")"},"status":{"type":"string","enum":["ACTIVE"],"description":"Status: Current status of the mobile account"},"vat_charged_from_account":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ChargeMobileAccount"}},"/sms/{accountid}/send":{"post":{"operationId":"sendSMS","summary":"XRRP command SendSMS (sendSMS)","description":"Send an SMS with your mobile account, the cost will be charged from the mobile account, not from your real account.\n","tags":["sms"],"parameters":[{"name":"accountid","in":"path","required":true,"description":"Unique identifier of the account to be used","schema":{"type":"string","description":"Unique identifier of the account to be used"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"encoding":{"type":"string","enum":["PLAIN","UNICODE"],"description":"Encoding type of the message, changing this may modify the appearance of your sms"},"mobilenr":{"type":"string","description":"Recipients cellphone number (depreceated)"},"password":{"type":"string","description":"Mobile account password to be used"},"premium":{"type":"string","nullable":true,"enum":["0","1"],"description":"If used the SMS will be sent using our high available premium sms provider. The SMS will also get accounted with the premium SMS price!"},"sourceid":{"type":"string","description":"Senders cellphone number or name"},"text":{"type":"string","description":"Text of the SMS to be send"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"mobilenr":{"type":"array","items":{"type":"string"}},"smsid":{"type":"integer","format":"int32","description":"SMS ID: ID of the SMS just sent (only after a successful sending)"},"status":{"type":"array","items":{"type":"string"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"SendSMS"}},"/sms/{accountid}/sms":{"get":{"operationId":"querySMSList","summary":"XRRP command QuerySMSList (querySMSList)","description":"Query details about SMS sent with the given account. Useful for delivery notifications or accountings.\n","tags":["sms"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"accountid","in":"path","required":true,"description":"Unique identifier of the account to be queried","schema":{"type":"string","description":"Unique identifier of the account to be queried"}},{"name":"recipient","in":"query","description":"Show only sms with this recipient, wildcards allowed (i.e. *1234*)","schema":{"type":"string","nullable":true,"description":"Show only sms with this recipient, wildcards allowed (i.e. *1234*)"}},{"name":"smsid","in":"query","description":"Show only SMS matching with this ID, wildcards allowed (i.e. *1234*)","schema":{"type":"string","nullable":true,"description":"Show only SMS matching with this ID, wildcards allowed (i.e. *1234*)"}},{"name":"maxdate","in":"query","description":"Show only SMS sent before this date","schema":{"type":"string","format":"date","nullable":true,"description":"Show only SMS sent before this date"}},{"name":"mindate","in":"query","description":"Show only SMS sent after this date","schema":{"type":"string","format":"date","nullable":true,"description":"Show only SMS sent after this date"}},{"name":"smsstatus","in":"query","description":"Show only SMS with this status","schema":{"type":"string","nullable":true,"description":"Show only SMS with this status"}},{"name":"wide","in":"query","description":"Show less or more details","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Show less or more details"}},{"name":"password","in":"query","description":"Mobile account password to be used","schema":{"type":"string","description":"Mobile account password to be used"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","description":"Amount"},"currency":{"type":"string","description":"The currency of the amount."},"date":{"type":"string","format":"date-time","description":"Date the SMS was sent"},"recipient":{"type":"string","description":"The recipient of the SMS, last 3 chars anonymized"},"smsid":{"type":"string","description":"Unique ID of this transaction"},"status":{"type":"string","enum":["SEND","DELIVERED","BUFFERED","FAILED","EXPIRED","REJECTED","ERROR","UNKNOWN"],"description":"Status of the SMS, the following states may occur"}}}},"property":{"type":"object","properties":{"account":{"type":"array","description":"The amount that was charged from the mobile account for this SMS.","items":{"type":"string","format":"decimal","description":"The amount that was charged from the mobile account for this SMS."}},"count":{"type":"integer","format":"int32","description":"Count: Total number of SMS shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing SMS"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QuerySMSList"}},"/sms/{smsid}":{"get":{"operationId":"statusSMS","summary":"XRRP command StatusSMS (statusSMS)","description":"\n","tags":["sms"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"smsid","in":"path","required":true,"description":"SMS ID: Unique ID of the SMS","schema":{"type":"string","description":"SMS ID: Unique ID of the SMS"}},{"name":"accountid","in":"query","description":"Unique identifier of the account to be used","schema":{"type":"string","description":"Unique identifier of the account to be used"}},{"name":"password","in":"query","description":"Mobile account password to be used","schema":{"type":"string","description":"Mobile account password to be used"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date the SMS was sent"},"description":{"type":"string","description":"The description of the problem if SMS could not be delivered."},"mobileaccount":{"type":"string","description":"The mobile account that was used to send the sms."},"recipient":{"type":"string","description":"The recipient of the SMS, last 3 chars anonymized"},"smsid":{"type":"string","description":"Unique ID of this mobile transaction"},"status":{"type":"string","enum":["SEND","DELIVERED","BUFFERED","FAILED","EXPIRED","REJECTED","ERROR","UNKNOWN"],"description":"Status of the SMS, the following states may occur"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusSMS"}},"/tag/{type}":{"get":{"operationId":"queryTagList","summary":"XRRP command QueryTagList (queryTagList)","description":"\n","tags":["tag"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"tag","in":"query","description":"Search for tags with this name.","schema":{"type":"string","nullable":true,"description":"Search for tags with this name."}},{"name":"type","in":"path","required":true,"description":"Search for tags with this type.","schema":{"type":"string","nullable":true,"enum":["DOMAIN","ZONE","SERVICE"],"description":"Search for tags with this type."}},{"name":"servicetype","in":"query","required":true,"description":"Service type: The service type","schema":{"type":"string","nullable":true,"description":"Service type: The service type"}},{"name":"showdefaultzonetags","in":"query","description":"Shows all the default zone tags that are available in the system.","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Shows all the default zone tags that are available in the system."}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is name.","schema":{"type":"string","nullable":true,"enum":["TAG","TYPE"],"description":"Order the results for the corresponding column. Default is name."}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of data shown"},"description":{"type":"array","description":"Description: Description of the tag.","items":{"type":"string","nullable":true,"description":"Description: Description of the tag."}},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"objectcount":{"type":"array","description":"Object Count: Count of the associated objects within this tag.","items":{"type":"integer","format":"int32","description":"Object Count: Count of the associated objects within this tag."}},"servicetype":{"type":"array","description":"Service type: Service type of the tag.","items":{"type":"string","nullable":true,"description":"Service type: Service type of the tag."}},"tag":{"type":"array","description":"Name: Name of the tag.","items":{"type":"string","description":"Name: Name of the tag."}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing data"},"type":{"type":"array","description":"Type: Type of the tag.","items":{"type":"string","description":"Type: Type of the tag."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryTagList"},"patch":{"operationId":"modifyTag","summary":"XRRP command ModifyTag (modifyTag)","description":"\n","tags":["tag"],"parameters":[{"name":"type","in":"path","required":true,"description":"Tag type: The type of this tag.","schema":{"type":"string","enum":["DOMAIN","ZONE","SERVICE"],"description":"Tag type: The type of this tag."}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"adddomain":{"type":"array","description":"Domain: The domains that will be added to the domain tag.","items":{"type":"string","nullable":true,"description":"Domain: The domains that will be added to the domain tag."}},"addobject":{"type":"array","description":"Object: The oject that will be added to the service tag.","items":{"type":"string","nullable":true,"description":"Object: The oject that will be added to the service tag."}},"addzone":{"type":"array","description":"Zone: The zones that will be added to the zone tag.","items":{"type":"string","nullable":true,"description":"Zone: The zones that will be added to the zone tag."}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"deldomain":{"type":"array","description":"Domain: The domains that will be deleted from the domain tag.","items":{"type":"string","nullable":true,"description":"Domain: The domains that will be deleted from the domain tag."}},"delobject":{"type":"array","description":"Object: The oject that will be deleted from the service tag.","items":{"type":"string","nullable":true,"description":"Object: The oject that will be deleted from the service tag."}},"delzone":{"type":"array","description":"Zone: The zones that will be deleted from the zone tag.","items":{"type":"string","nullable":true,"description":"Zone: The zones that will be deleted from the zone tag."}},"description":{"type":"string","nullable":true,"description":"Tag description: The description of this tag."},"domain":{"type":"array","description":"Domain: The domains that will be associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain: The domains that will be associated with this domain tag."}},"newtag":{"type":"string","nullable":true,"description":"New tag name: The new name of this tag."},"object":{"type":"array","description":"Object: The oject that will be associated with this service tag.","items":{"type":"string","nullable":true,"description":"Object: The oject that will be associated with this service tag."}},"servicetype":{"type":"string","nullable":true,"description":"Service type: The service type"},"tag":{"type":"string","description":"Tag name: The name of this tag."},"zone":{"type":"array","description":"Zone: The zones that will be set for the zone tag.","items":{"type":"string","nullable":true,"description":"Zone: The zones that will be set for the zone tag."}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyTag"},"post":{"operationId":"addTag","summary":"XRRP command AddTag (addTag)","description":"\n","tags":["tag"],"parameters":[{"name":"type","in":"path","required":true,"description":"Tag type: The type of this tag","schema":{"type":"string","enum":["DOMAIN","ZONE","SERVICE"],"description":"Tag type: The type of this tag"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"copy":{"type":"string","nullable":true,"description":"Copy from: The name of the zone tag that should be copied."},"description":{"type":"string","nullable":true,"description":"Tag description: The description of this tag"},"domain":{"type":"array","description":"Domain: The domains that should be associated with this domain tag.","items":{"type":"string","nullable":true,"description":"Domain: The domains that should be associated with this domain tag."}},"object":{"type":"array","description":"Object: The services that should be associated with this object tag.","items":{"type":"string","nullable":true,"description":"Object: The services that should be associated with this object tag."}},"servicetype":{"type":"string","nullable":true,"description":"Service type: The service type"},"tag":{"type":"string","description":"Tag name: The name of this tag"},"zone":{"type":"array","description":"Zone: The zones that should be associated with this zone tag.","items":{"type":"string","nullable":true,"description":"Zone: The zones that should be associated with this zone tag."}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddTag"}},"/tag/{type}/{tag}":{"delete":{"operationId":"deleteTag","summary":"XRRP command DeleteTag (deleteTag)","description":"\n","tags":["tag"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"tag","in":"path","required":true,"description":"Tag name: The name of this tag","schema":{"type":"string","description":"Tag name: The name of this tag"}},{"name":"type","in":"path","required":true,"description":"Tag type: The type of this tag","schema":{"type":"string","enum":["DOMAIN","ZONE","SERVICE"],"description":"Tag type: The type of this tag"}},{"name":"servicetype","in":"query","required":true,"description":"Service type: The service type","schema":{"type":"string","nullable":true,"description":"Service type: The service type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteTag"},"get":{"operationId":"statusTag","summary":"XRRP command StatusTag (statusTag)","description":"\n","tags":["tag"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"tag","in":"path","required":true,"description":"Tag name: The name of this tag","schema":{"type":"string","description":"Tag name: The name of this tag"}},{"name":"type","in":"path","required":true,"description":"Tag type: The type of this tag","schema":{"type":"string","enum":["DOMAIN","ZONE","SERVICE"],"description":"Tag type: The type of this tag"}},{"name":"servicetype","in":"query","required":true,"description":"Service type: The service type","schema":{"type":"string","nullable":true,"description":"Service type: The service type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"description":{"type":"array","description":"Description: Description of the tag.","items":{"type":"string","nullable":true,"description":"Description: Description of the tag."}},"domain":{"type":"array","description":"Domain: List of domains that are associated with the domain tag.","items":{"type":"string","description":"Domain: List of domains that are associated with the domain tag."}},"service-domainblocking":{"type":"array","description":"Service Domainblocking: List of Domainblocking that are associated with the service tag.","items":{"type":"string","nullable":true,"description":"Service Domainblocking: List of Domainblocking that are associated with the service tag."}},"servicetype":{"type":"array","description":"Service type: List of servicetype that are associated with the service tag.","items":{"type":"string","nullable":true,"description":"Service type: List of servicetype that are associated with the service tag."}},"tag":{"type":"string","description":"Name: Name of the tag."},"type":{"type":"string","description":"Type: Type of the tag."},"zone":{"type":"array","description":"Zone: List of zones that are associated with the zone tag.","items":{"type":"string","description":"Zone: List of zones that are associated with the zone tag."}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusTag"}},"/trademark":{"post":{"operationId":"addTrademark","summary":"XRRP command AddTrademark (addTrademark)","description":"The AddTrademark command allows you to add a trademark validation request. Your trademark data will be validated with our partners.\n","tags":["trademark"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"alabel":{"type":"array","description":"ALabel ##NUM##","items":{"type":"string","nullable":true,"description":"ALabel ##NUM##"}},"auth":{"type":"string","nullable":true,"description":"Authcode: The authorization code for this Trademark. Will be generated automatically if empty."},"claimsnotify":{"type":"array","description":"Claim Notification ##NUM##","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"Claim Notification ##NUM##"}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"courtname":{"type":"string","nullable":true,"description":"Court name: Court name"},"doctype":{"type":"string","enum":["TMLICENSEEDECLARATION","TMASSIGNEEDECLARATION","TMOTHER","DECLARATIONOFPROOFOFUSESAMPLE","PROOFOFUSEOTHER","TMCOPYOFCOURTORDER"],"description":"Document Type: Document type to proof validity of your Trademark."},"entitlement":{"type":"string","enum":["OWNER","ASSIGNEE","LICENSEE"],"description":"Entitlement: The form of entitlement of the Trademark Holder that is submitting the Trademark Record."},"goodsandservices":{"type":"array","description":"GOODSANDSERVICES ##NUM##","items":{"type":"string","nullable":true,"description":"GOODSANDSERVICES ##NUM##"}},"markname":{"type":"string","description":"Trademark name: Name of the trademark."},"marktype":{"type":"string","enum":["REGISTERED_MARK","COURT_VALIDATED_MARK","STATUTE_OR_TREATY"],"description":"Trademark Type: Type of new trademark."},"period":{"type":"string","enum":["1","3","5"],"description":"Period: Period in Years."},"prodate":{"type":"string","format":"date","nullable":true,"description":"Date of protection of the mark: Date of protection of the mark"},"refnumber":{"type":"string","nullable":true,"description":"Reference Number: Reference Number"},"regdate":{"type":"string","format":"date","nullable":true,"description":"Date of protection / registration: Date of protection/registration of the mark"},"regnumber":{"type":"string","nullable":true,"description":"Reference / Registration Number: Reference/Registration Number"},"smdinclusion":{"type":"array","description":"SMD Inclusion ##NUM##","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"SMD Inclusion ##NUM##"}},"sotexecdate":{"type":"string","format":"date","nullable":true,"description":"Date of execution: Date of execution of the statue or treaty"},"sotprotectionruling":{"type":"string","nullable":true,"description":"Protection ruling: Protection ruling iso country code(s), separated by comma."},"sottitle":{"type":"string","nullable":true,"description":"Title of statue or treaty: Title of statue or treaty"},"tmholder":{"type":"string","description":"Trademark Holder Contact ID: Contact handle of the Trademark Holder"},"tmregclass":{"type":"string","nullable":true,"description":"Trademark class: Trademark class(es), separated by comma. See also: http://web2.wipo.int/nicepub/edition-20130101/taxonomy/  or http://en.wikipedia.org/wiki/Nice_(WIPO)"},"tmregcountry":{"type":"string","nullable":true,"description":"Country where trademark is valid: Country where trademark is valid"},"tmregdate":{"type":"string","format":"date","nullable":true,"description":"Trademark registration date: The date of the trademark registration. (YYYY-MM-DD)"},"tmregexpirationdate":{"type":"string","format":"date","nullable":true,"description":"Trademark expiration date: The date when the registered trademark expires. (YYYY-MM-DD)"},"tmregjurisdiction":{"type":"string","nullable":true,"description":"Jurisdiction: The national or regional territory in which the registered trademark is protected."},"tmregnumber":{"type":"string","nullable":true,"description":"Trademark registration number: Trademark registration number as provided by the trademark office."},"ulabel":{"type":"array","description":"ULabel ##NUM##","items":{"type":"string","nullable":true,"description":"ULabel ##NUM##"}},"x-accept-additional-label-cost":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept additional label costs: Determines, TAG for resellers to accept the costs for further labels beyond 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string","description":"Authcode: The authorization code for this Trademark"},"created_date":{"type":"string","format":"date-time","description":"Created date: Date the trademark was registered"},"email":{"type":"string","description":"EMail Address: The unique email address to send trademark documentation to."},"job_id":{"type":"string","description":"Job id: Job id"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date: Date the trademark will expire"},"renewal_date":{"type":"string","format":"date-time","description":"Renewal date: Date when the trademark must be renewed"},"status":{"type":"string","enum":["ACTIVE","PROCESSING","REQUESTED","FAILED","DOCUMENTS_RECEIVED","DEACTIVATED","EXPIRED"],"description":"Status: Shows the current state of the trademark registration"},"trademark":{"type":"string","description":"Trademark ID: The unique ID of your Trademark validation request."},"x-accept-additional-label-cost":{"type":"string","enum":["0","1"],"description":"Accept additional label costs: Determines, TAG for resellers to accept the costs for further labels beyond 10"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddTrademark"}},"/trademark/":{"get":{"operationId":"queryTradeMarkList","summary":"XRRP command QueryTradeMarkList (queryTradeMarkList)","description":"\n","tags":["trademark"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"trademarkname","in":"query","description":"Trademark: Searchpattern for trademark names in the list.","schema":{"type":"string","nullable":true,"description":"Trademark: Searchpattern for trademark names in the list."}},{"name":"trademarktoken","in":"query","description":"Trademark: Searchpattern for trademark token in the list.","schema":{"type":"string","nullable":true,"description":"Trademark: Searchpattern for trademark token in the list."}},{"name":"trademarktype","in":"query","description":"Trademark: Searchpattern for trademark types in the list.","schema":{"type":"string","enum":["REGISTERED_MARK","COURT_VALIDATED_MARK","STATUTE_OR_TREATY"],"description":"Trademark: Searchpattern for trademark types in the list."}},{"name":"trademarkstatus","in":"query","description":"Trademark: Searchpattern for trademark status in the list.","schema":{"type":"string","enum":["REQUESTED","DOCUMENTS_RECEIVED","PROCESSING","FAILED","ACTIVE","INCORRECT","EXPIRED","DEACTIVATED"],"description":"Trademark: Searchpattern for trademark status in the list."}},{"name":"tmchstatus","in":"query","description":"Trademark: Searchpattern for tmch status in the list.","schema":{"type":"string","enum":["INVALID","INCORRECT","EXPIRED","DEACTIVATED","VERIFIED"],"description":"Trademark: Searchpattern for tmch status in the list."}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["TRADEMARKNAME","RENEWALDATE","TRADEMARKTYPE","ENTITLEMENT","TRADEMARKSTATUS"],"description":"Sort the result by this column"}},{"name":"type","in":"query","description":"Select the dataset based on different criterias","schema":{"type":"string","nullable":true,"enum":["DEFAULT","SHOWSUBLAYER"],"description":"Select the dataset based on different criterias"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","nullable":true,"description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","nullable":true,"description":"Limit: Show only this many items in the response"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"entitlement":{"type":"string","description":"Entitlement: Entitlement of the trademark."},"registrar":{"type":"string","description":"Registrar: Registrar."},"registration_expiration_date":{"type":"string","format":"date-time","description":"Registration expiration date: Registration expiration date of the trademark."},"renewal_date":{"type":"string","format":"date-time","description":"Renewal date: Renewal date of the trademark."},"tmch_status":{"type":"string","nullable":true,"description":"TMCH Status: Status of the trademark at TMCH."},"trademark":{"type":"string","description":"Trademark ID: The trademark ID."},"trademark_name":{"type":"string","description":"Trademark name: The trademark name."},"trademark_status":{"type":"string","description":"Status: Status of the trademark."},"trademark_type":{"type":"string","description":"Trademark type: The type of the trademark."}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryTradeMarkList"}},"/trademark/-/availability/":{"get":{"operationId":"getTrademarkLabels","summary":"XRRP command GetTrademarkLabels (getTrademarkLabels)","description":"This command returns the labels of a trademark name\n","tags":["trademark"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"markname","in":"query","required":true,"description":"Trademarkname","schema":{"type":"string","description":"Trademarkname"}},{"name":"marktype","in":"query","required":true,"description":"Trademarktype","schema":{"type":"string","enum":["REGISTERED_MARK","COURT_VALIDATED_MARK","STATUTE_OR_TREATY"],"description":"Trademarktype"}},{"name":"country","in":"query","required":true,"description":"Country code or jurisdiction","schema":{"type":"string","description":"Country code or jurisdiction"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"alabel#":{"type":"array","description":"Ascii label for the trademark name: ALabel ##NUM##","items":{"type":"string","nullable":true,"description":"Ascii label for the trademark name: ALabel ##NUM##"}},"label#":{"type":"array","description":"Label for the trademark name: Label ##NUM##","items":{"type":"string","nullable":true,"description":"Label for the trademark name: Label ##NUM##"}},"markname":{"type":"string","description":"Trademark name: Markname queried"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"GetTrademarkLabels"}},"/trademark/{trademark}":{"delete":{"operationId":"deleteTrademark","summary":"XRRP command DeleteTrademark (deleteTrademark)","description":"This command allows you to delete a Trademark Validation in our System.\n","tags":["trademark"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"trademark","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"payback":{"type":"string","description":"REFUND status: REFUND status"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteTrademark"},"get":{"operationId":"statusTrademark","summary":"XRRP command StatusTrademark (statusTrademark)","description":"This command allows you to query trademark status information from our system.\n","tags":["trademark"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"trademark","in":"path","required":true,"description":"ID of the trademark given by TMCH.","schema":{"type":"string","description":"ID of the trademark given by TMCH."}},{"name":"statustype","in":"query","required":true,"schema":{"type":"string","nullable":true,"enum":["SMD","ENC"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"alabel":{"type":"array","description":"A label: A label","items":{"type":"string","nullable":true,"description":"A label: A label"}},"auth_code":{"type":"string","nullable":true,"description":"Authcode: The authorization code for this Trademark"},"claimsnotify":{"type":"array","description":"Claim Notification: Claim Notification","items":{"type":"integer","format":"int32","nullable":true,"description":"Claim Notification: Claim Notification"}},"courtname":{"type":"string","nullable":true,"description":"Court name: Court name"},"created_by":{"type":"string","description":"Created by: Who created this trademark"},"created_date":{"type":"string","format":"date-time","description":"Created date: created date of the trademark"},"doctype":{"type":"string","enum":["TMLICENSEEDECLARATION","TMASSIGNEEDECLARATION","TMOTHER","DECLARATIONOFPROOFOFUSESAMPLE","PROOFOFUSEOTHER","TMCOPYOFCOURTORDER"],"description":"Document type: Document type to proof validity of your Trademark."},"email":{"type":"string","description":"Email address: The unique email address to send trademark documentation to."},"entitlement":{"type":"string","enum":["OWNER","ASSIGNEE","LICENSEE"],"description":"Entitlement: The form of entitlement of the Trademark Holder that is submitting the Trademark Record."},"faquri":{"type":"string","description":"FAQ URI"},"filedoctype":{"type":"array","description":"Doctype of file: Document type of uploaded file at TMCH","items":{"type":"string","nullable":true,"description":"Doctype of file: Document type of uploaded file at TMCH"}},"fileid":{"type":"array","description":"File id: File id of uploaded file at TMCH","items":{"type":"string","nullable":true,"description":"File id: File id of uploaded file at TMCH"}},"filename":{"type":"array","description":"Filename: Filename of uploaded file at TMCH","items":{"type":"string","nullable":true,"description":"Filename: Filename of uploaded file at TMCH"}},"filestatus":{"type":"array","description":"File status: File status of uploaded file at TMCH","items":{"type":"string","nullable":true,"description":"File status: File status of uploaded file at TMCH"}},"filetype":{"type":"array","description":"Filetype: File extension of uploaded file at TMCH","items":{"type":"string","nullable":true,"description":"Filetype: File extension of uploaded file at TMCH"}},"goodsandservices":{"type":"string","description":"All goods and services: Description of the goods and services associated to the trademark."},"job_id":{"type":"string","description":"Job ID: Job id"},"markname":{"type":"string","description":"Trademark name: Your Trademark name"},"marktype":{"type":"string","enum":["REGISTERED_MARK","COURT_VALIDATED_MARK","STATUTE_OR_TREATY"],"description":"Trademark type: Type of new trademark."},"paid_until":{"type":"string","format":"date-time","description":"Paid until: Paid until date of this trademark"},"period":{"type":"integer","format":"int32","description":"Period"},"prodate":{"type":"string","format":"date-time","description":"Mark protection date: Date of protection of the mark"},"refnumber":{"type":"string","nullable":true,"description":"Reference number: Reference Number"},"registrar":{"type":"string","description":"Registrar: Current registrar"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Expiration date: Current expiration date of this trademark"},"renewal_date":{"type":"string","format":"date-time","description":"Renewal date: Current renewal date of this trademark"},"renewaldate":{"type":"string","format":"date-time","description":"Renewaldate"},"renewalmode":{"type":"string","enum":["AUTORENEW","AUTOEXPIRE"],"description":"Renewalmode: Renewalmode"},"smddecodedsignedmark":{"type":"string","description":"SMD file decoded: SMD file as xml"},"smdencodedsignedmark":{"type":"string","description":"SMD file base64 encoded: SMD file base64 encoded"},"smdfile":{"type":"array","description":"SMD FILE: SMD Filecontent","items":{"type":"string","nullable":true,"description":"SMD FILE: SMD Filecontent"}},"smdfilename":{"type":"string","nullable":true,"description":"SMD FILENAME: SMD Filename"},"smdid":{"type":"string","nullable":true,"description":"SMD ID: SMD ID"},"smdinclusion":{"type":"array","description":"SMD Inclusion: SMD Inclusion","items":{"type":"string","nullable":true,"description":"SMD Inclusion: SMD Inclusion"}},"sotexecdate":{"type":"string","format":"date-time","description":"Execution date: Date of execution of the statue or treaty"},"sotprotectionruling":{"type":"string","description":"SOTprotectionruling: SOT protection ruling"},"sottitle":{"type":"string","nullable":true,"description":"Title: Title of statue or treaty"},"status":{"type":"string","description":"Status: Current status of this trademark"},"tmch_id":{"type":"string","description":"TMCH ID: ID of the trademark given by TMCH."},"tmch_pou_status":{"type":"string","description":"TMCH POU STATUS: Status of POU of the trademark given by TMCH."},"tmch_smd_format":{"type":"string","description":"SMD file: SMD file"},"tmch_status":{"type":"string","description":"Tmch status"},"tmch_validator_comments":{"type":"string","description":"TMCH validator comments: Comments from the validator of TMCH"},"tmholder":{"type":"string","description":"Trademark holder contact handle: Contact Handle of the Trademark Holder"},"tmregclass":{"type":"string","nullable":true,"description":"Trademark class: Trademark class"},"tmregcountry":{"type":"string","nullable":true,"description":"Country where trademark is valid: Country where trademark is valid"},"tmregdate":{"type":"string","format":"date-time","nullable":true,"description":"Trademark register date: The date of the trademark registration. (YYYY-MM-DD)"},"tmregexpirationdate":{"type":"string","format":"date-time","nullable":true,"description":"Trademark register expiration date: The date when the registered trademark expires. (YYYY-MM-DD)"},"tmregjurisdiction":{"type":"string","nullable":true,"description":"Jurisdiction: The national or regional territory in which the registered trademark is protected."},"tmregnumber":{"type":"string","nullable":true,"description":"Trademark register number: Trademark registration number as provided by the trademark office."},"trademark":{"type":"string","description":"Trademark ID: ID of the trademark given by RRPproxy."},"transfer_date":{"type":"string","format":"date-time","description":"Transferred date: Transferred date of the trademark"},"ulabel":{"type":"array","description":"U label: U label","items":{"type":"string","nullable":true,"description":"U label: U label"}},"updated_by":{"type":"string","description":"Updated by: Updated by"},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Date of the last modification of the trademark"},"x-accept-additional-label-cost":{"type":"string","enum":["0","1"],"description":"Accept additional label costs: Determines, TAG for resellers to accept the costs for further labels beyond 10"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusTrademark"},"patch":{"operationId":"modifyTrademark","summary":"XRRP command ModifyTrademark (modifyTrademark)","description":"The ModifyTrademark command allows you to modify a trademark validation request. Your trademark data will be validated with our partners.\n","tags":["trademark"],"parameters":[{"name":"trademark","in":"path","required":true,"description":"Trademark ID: ID of the trademark given by TMCH.","schema":{"type":"string","description":"Trademark ID: ID of the trademark given by TMCH."}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addalabel":{"type":"array","description":"Add ALabel ##NUM##","items":{"type":"string","nullable":true,"description":"Add ALabel ##NUM##"}},"addclaimsnotify":{"type":"array","description":"Add Claim Notification ##NUM##","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"Add Claim Notification ##NUM##"}},"addsmdinclusion":{"type":"array","description":"Add SMD Inclusion ##NUM##","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"Add SMD Inclusion ##NUM##"}},"addulabel":{"type":"array","description":"Add ULabel ##NUM##","items":{"type":"string","nullable":true,"description":"Add ULabel ##NUM##"}},"alabel":{"type":"array","description":"ALabel ##NUM##","items":{"type":"string","nullable":true,"description":"ALabel ##NUM##"}},"auth":{"type":"string","nullable":true,"description":"Authcode: The authorization code for this Trademark. Will be generated automatically if empty."},"claimsnotify":{"type":"array","description":"Claim Notification ##NUM##","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"Claim Notification ##NUM##"}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"courtname":{"type":"string","nullable":true,"description":"Court name: Court name"},"delalabel":{"type":"array","description":"Delete ALabel ##NUM##","items":{"type":"string","nullable":true,"description":"Delete ALabel ##NUM##"}},"delclaimsnotify":{"type":"array","description":"Delete Claim Notification ##NUM##","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"Delete Claim Notification ##NUM##"}},"delsmdinclusion":{"type":"array","description":"Delete SMD Inclusion ##NUM##","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"Delete SMD Inclusion ##NUM##"}},"delulabel":{"type":"array","description":"Delete ULabel ##NUM##","items":{"type":"string","nullable":true,"description":"Delete ULabel ##NUM##"}},"doctype":{"type":"string","nullable":true,"enum":["TMLICENSEEDECLARATION","TMASSIGNEEDECLARATION","TMOTHER","DECLARATIONOFPROOFOFUSESAMPLE","PROOFOFUSEOTHER","TMCOPYOFCOURTORDER"],"description":"Document Type: Document type to proof validity of your Trademark."},"entitlement":{"type":"string","nullable":true,"enum":["OWNER","ASSIGNEE","LICENSEE"],"description":"Entitlement: The form of entitlement of the Trademark Holder that is submitting the Trademark Record."},"goodsandservices":{"type":"array","description":"GOODSANDSERVICES ##NUM##","items":{"type":"string","nullable":true,"description":"GOODSANDSERVICES ##NUM##"}},"markname":{"type":"string","nullable":true,"description":"Trademark name: Name of the trademark."},"prodate":{"type":"string","format":"date","nullable":true,"description":"Date of protection of the mark: Date of protection of the mark"},"refnumber":{"type":"string","nullable":true,"description":"Reference Number: Reference Number"},"regdate":{"type":"string","format":"date","nullable":true,"description":"Date of protection / registration: Date of protection/registration of the mark"},"regnumber":{"type":"string","nullable":true,"description":"Reference / Registration Number: Reference/Registration Number"},"smdinclusion":{"type":"array","description":"SMD Inclusion ##NUM##","items":{"type":"string","nullable":true,"enum":["0","1"],"description":"SMD Inclusion ##NUM##"}},"sotexecdate":{"type":"string","format":"date","nullable":true,"description":"Date of execution: Date of execution of the statue or treaty"},"sotprotectionruling":{"type":"string","nullable":true,"description":"Protection ruling: Protection ruling iso country code(s), separated by comma."},"sottitle":{"type":"string","nullable":true,"description":"Title of statue or treaty: Title of statue or treaty"},"tmholder":{"type":"string","nullable":true,"description":"Trademark Holder Contact ID: Contact handle of the Trademark Holder"},"tmregclass":{"type":"string","nullable":true,"description":"Trademark class: Trademark class(es), separated by comma. See also: http://web2.wipo.int/nicepub/edition-20130101/taxonomy/  or http://en.wikipedia.org/wiki/Nice_(WIPO)"},"tmregcountry":{"type":"string","nullable":true,"description":"Country where trademark is valid: Country where trademark is valid"},"tmregdate":{"type":"string","format":"date","nullable":true,"description":"Trademark registration date: The date of the trademark registration. (YYYY-MM-DD)"},"tmregexpirationdate":{"type":"string","format":"date","nullable":true,"description":"Trademark expiration date: The date when the registered trademark expires. (YYYY-MM-DD)"},"tmregjurisdiction":{"type":"string","nullable":true,"description":"Jurisdiction: The national or regional territory in which the registered trademark is protected."},"tmregnumber":{"type":"string","nullable":true,"description":"Trademark registration number: Trademark registration number as provided by the trademark office."},"ulabel":{"type":"array","description":"ULabel ##NUM##","items":{"type":"string","nullable":true,"description":"ULabel ##NUM##"}},"x-accept-additional-label-cost":{"type":"string","nullable":true,"enum":["0","1"],"description":"Accept additional label costs: Determines, TAG for resellers to accept the costs for further labels beyond 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"alabel#":{"type":"array","description":"Ascii label for the trademark name: ALabel ##NUM##","items":{"type":"string","nullable":true,"description":"Ascii label for the trademark name: ALabel ##NUM##"}},"auth":{"type":"string","description":"Authcode: The authorization code for this Trademark"},"claimsnotify#":{"type":"array","description":"Claimsnotify: Claim Notification ##NUM##","items":{"type":"integer","format":"int32","description":"Claimsnotify: Claim Notification ##NUM##"}},"created_date":{"type":"string","format":"date-time","description":"Created date: Date when the trademark was created"},"email":{"type":"string","description":"EMail Address: The unique email address to send trademark documentation to."},"job_id":{"type":"string","description":"Job id: Job id"},"registration_expiration_date":{"type":"string","format":"date","description":"Registration expiration date: Date when the trademark will expire"},"renewal_date":{"type":"string","format":"date","description":"Renewal date: Date when the trademark must be renewed"},"smdinclusion#":{"type":"array","description":"SMDinclusion: SMD Inclusion ##NUM##","items":{"type":"integer","format":"int32","description":"SMDinclusion: SMD Inclusion ##NUM##"}},"status":{"type":"string","enum":["ACTIVE","PROCESSING","REQUESTED","FAILED","DOCUMENTS_RECEIVED","INCORRECT","DEACTIVATED","EXPIRED"],"description":"Status: Shows the current state of the trademark registration"},"trademark":{"type":"string","description":"Trademark ID: The unique ID of your Trademark validation request."},"updated_date":{"type":"string","format":"date-time","description":"Updated date: Date when the trademark was updated"},"x-accept-additional-label-cost":{"type":"string","enum":["0","1"],"description":"Accept additional label costs: Determines, TAG for resellers to accept the costs for further labels beyond 10"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyTrademark"}},"/trademark/{trademark}/renew":{"patch":{"operationId":"renewTrademark","summary":"XRRP command RenewTrademark (renewTrademark)","description":"When renewing a trademark, the period for renewal (period = 1) and the current expiration year e.g. 2010.\n","tags":["trademark"],"parameters":[{"name":"trademark","in":"path","required":true,"description":"Trademark: Trademark to be renewed","schema":{"type":"string","description":"Trademark: Trademark to be renewed"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"expirationdate":{"type":"integer","format":"int32","description":"Current expiration year: The current expiration year of the trademark"},"period":{"type":"integer","format":"int32","description":"Period: The amount of years, you want to renew"},"x-promotion-code":{"type":"string","nullable":true,"description":"Promotion code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"job_id":{"type":"array","items":{"type":"string"}},"promotions":{"type":"string"},"registration_expiration_date":{"type":"string","format":"date-time","description":"Expiration date: The new expiration date"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"RenewTrademark"}},"/trademark/{trademark}/renewalmode":{"patch":{"operationId":"setTrademarkRenewalMode","summary":"XRRP command SetTrademarkRenewalMode (setTrademarkRenewalMode)","description":"This command allows you to change the renewal mode for an object .\n","tags":["trademark"],"parameters":[{"name":"trademark","in":"path","required":true,"description":"The trademark you want to change the renewalmode for","schema":{"type":"string","description":"The trademark you want to change the renewalmode for"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"renewalmode":{"type":"string","enum":["AUTORENEW","AUTOEXPIRE"],"description":"Renewalmode: The mode for renewals"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"SetTrademarkRenewalMode"}},"/trademark/{trademark}/transfer":{"patch":{"operationId":"transferTrademark","summary":"XRRP command TransferTrademark (transferTrademark)","description":"\n","tags":["trademark"],"parameters":[{"name":"trademark","in":"path","required":true,"description":"RRP Trademark ID","schema":{"type":"string","nullable":true,"description":"RRP Trademark ID"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["INITIATE","EXECUTE"],"description":"Action"},"auth":{"type":"string","nullable":true},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"auth":{"type":"string","description":"Authcode for trademark"},"new_tmch_id":{"type":"string","description":"New TMCH ID for trademark"},"trademark":{"type":"string","description":"RRP Trademark ID"},"trademark_id":{"type":"string","description":"TMCH ID for trademark"},"transfer_date":{"type":"string","description":"Transfer date"},"transfer_status":{"type":"string","description":"Transfer status"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"TransferTrademark"}},"/user":{"get":{"operationId":"queryUserList","summary":"XRRP command QueryUserList (queryUserList)","description":"\n","tags":["user"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"type","in":"query","schema":{"type":"string","nullable":true,"enum":["USER","GROUP"]}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"username":{"type":"string"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of users shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of users"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryUserList"},"post":{"operationId":"addUser","summary":"XRRP command AddUser (addUser)","description":"\n","tags":["user"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"email":{"type":"string","nullable":true},"group":{"type":"array","items":{"type":"string","nullable":true}},"password":{"type":"string","nullable":true},"type":{"type":"string","nullable":true,"enum":["USER","GROUP"]},"username":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddUser"}},"/user/-/acl":{"get":{"operationId":"queryAclList_2","summary":"XRRP command QueryAclList (queryAclList_2)","description":"\n","tags":["user"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"username","in":"query","required":true,"schema":{"type":"string"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string"},"right":{"type":"string"},"rightnames":{"type":"string"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of ACL entries shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"registrar":{"type":"string"},"total":{"type":"integer","format":"int32","description":"Total: Total number of ACLs"},"username":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAclList"}},"/user/-/aclright":{"get":{"operationId":"queryUserRights_2","summary":"XRRP command QueryUserRights (queryUserRights_2)","description":"\n","tags":["user"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"username","in":"query","required":true,"schema":{"type":"string"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"type","in":"query","schema":{"type":"string","nullable":true,"enum":["ALL","USER","GROUP","RESOLVED"]}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string"},"right":{"type":"string"},"rightnames":{"type":"string"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of user rights"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"registrar":{"type":"string"},"total":{"type":"integer","format":"int32","description":"Total: Total number of user rights"},"username":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryUserRights"}},"/user/{username}":{"delete":{"operationId":"deleteUser","summary":"XRRP command DeleteUser (deleteUser)","description":"\n","tags":["user"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteUser"},"get":{"operationId":"statusUser","summary":"XRRP command StatusUser (statusUser)","description":"\n","tags":["user"],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"email":{"type":"string"},"group":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"username":{"type":"string"},"users":{"type":"array","items":{"type":"string"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusUser"},"patch":{"operationId":"modifyUser","summary":"XRRP command ModifyUser (modifyUser)","description":"\n","tags":["user"],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"adduser":{"type":"array","items":{"type":"string","nullable":true}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"deluser":{"type":"array","items":{"type":"string","nullable":true}},"email":{"type":"string","nullable":true},"group":{"type":"array","items":{"type":"string","nullable":true}},"moduser":{"type":"array","items":{"type":"string","nullable":true}},"password":{"type":"string","nullable":true},"user":{"type":"array","items":{"type":"string","nullable":true}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyUser"}},"/user/{username}/acl":{"get":{"operationId":"queryAclList","summary":"XRRP command QueryAclList (queryAclList)","description":"\n","tags":["user"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string"},"right":{"type":"string"},"rightnames":{"type":"string"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of ACL entries shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"registrar":{"type":"string"},"total":{"type":"integer","format":"int32","description":"Total: Total number of ACLs"},"username":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAclList"},"post":{"operationId":"addAcl","summary":"XRRP command AddAcl (addAcl)","description":"\n","tags":["user"],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"acl":{"type":"array","items":{"type":"string","nullable":true}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"},"location":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"AddAcl"}},"/user/{username}/acl/{location}":{"delete":{"operationId":"deleteAcl","summary":"XRRP command DeleteAcl (deleteAcl)","description":"\n","tags":["user"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"location","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"DeleteAcl"},"get":{"operationId":"statusAcl","summary":"XRRP command StatusAcl (statusAcl)","description":"\n","tags":["user"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"location","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"acl":{"type":"string"},"location":{"type":"string"},"rights":{"type":"string"},"username":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusAcl"},"patch":{"operationId":"modifyAcl","summary":"XRRP command ModifyAcl (modifyAcl)","description":"\n","tags":["user"],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"location","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"acl":{"type":"array","items":{"type":"string","nullable":true}},"cltrid":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"ModifyAcl"}},"/user/{username}/aclright":{"get":{"operationId":"queryUserRights","summary":"XRRP command QueryUserRights (queryUserRights)","description":"\n","tags":["user"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"type","in":"query","schema":{"type":"string","nullable":true,"enum":["ALL","USER","GROUP","RESOLVED"]}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string"},"right":{"type":"string"},"rightnames":{"type":"string"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of user rights"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"registrar":{"type":"string"},"total":{"type":"integer","format":"int32","description":"Total: Total number of user rights"},"username":{"type":"string"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryUserRights"}},"/useracltype":{"get":{"operationId":"queryAclTypes","summary":"XRRP command QueryAclTypes (queryAclTypes)","description":"\n","tags":["user"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"type","in":"query","required":true,"schema":{"type":"string","nullable":true,"enum":["ALL","LOCATION","ACL"]}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string"},"right":{"type":"string"},"rightname":{"type":"string"},"type":{"type":"string"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of ACL types shown"},"total":{"type":"integer","format":"int32","description":"Total: Total number of ACL types"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAclTypes"}},"/zone":{"get":{"operationId":"queryZoneList","summary":"XRRP command QueryZoneList (queryZoneList)","description":"The QueryZonelist command enables you to review your prices and for which gTLDs and ccTLDs your MREG-Account has been activated for.\n","tags":["zone"],"parameters":[{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}},{"name":"wide","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"zone","in":"query","description":"Zones: Show only the prices for this list of zones","schema":{"type":"array","description":"Zones: Show only the prices for this list of zones","items":{"type":"string","nullable":true,"description":"Zones: Show only the prices for this list of zones"}}},{"name":"inactive","in":"query","description":"Inactive: Show not yet activated zones (default = 0)","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Inactive: Show not yet activated zones (default = 0)"}},{"name":"individual","in":"query","description":"Individual","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Individual"}},{"name":"registrar","in":"query","description":"Registrar: Show the prices for this reseller","schema":{"type":"string","nullable":true,"description":"Registrar: Show the prices for this reseller"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["ZONE"],"description":"Sort the result by this column"}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"3rds":{"type":"string"},"active":{"type":"string","enum":["1","0"],"description":"Active: Shows if you agreed to the appendis of this zone, if not you will not be able to purchase domains within this zone."},"annual":{"type":"string","format":"decimal","description":"Annual fee: Annual fee charged for this zone"},"application":{"type":"string","format":"decimal","description":"Application fee: Application fee charged for this zone (if available)"},"currency":{"type":"string","description":"Currency: The currency, this zone will be accounted in"},"domain_count":{"type":"integer","format":"int32","description":"Domain count: Amount of domains you already purchased in this zone"},"periodtype":{"type":"string","description":"Period type: Is the period monthly or yearly"},"restore":{"type":"string","format":"decimal","description":"Restore fee: Restore fee charged for this zone (if available)"},"setup":{"type":"string","format":"decimal","description":"Setup fee: Setup fee ccharged for this zone"},"trade":{"type":"string","format":"decimal","description":"Trade fee: Trade fee charged for this zone (if available)"},"transfer":{"type":"string","format":"decimal","description":"Transfer fee: Transfer fee charged for this zone"},"zone":{"type":"string","description":"Zone: The zone for this dataset"}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of contacts shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"minimum_registration_period":{"type":"array","description":"Minimum registration period: The minimum registration/renewal period for this zone","items":{"type":"string","description":"Minimum registration period: The minimum registration/renewal period for this zone"}},"minimum_transfer_period":{"type":"array","description":"Minimum transfer period: The minimum transfer period for this zone","items":{"type":"string","description":"Minimum transfer period: The minimum transfer period for this zone"}},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing contacts"}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryZoneList"}},"/zone/-/agp":{"get":{"operationId":"queryAGPDeletesList","summary":"XRRP command QueryAGPDeletesList (queryAGPDeletesList)","description":"\n","tags":["zone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"zone","in":"query","description":"Searchpattern for the zone.","schema":{"type":"string","nullable":true,"description":"Searchpattern for the zone."}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"wide","in":"query","description":"Grade of details returned","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Grade of details returned"}},{"name":"order","in":"query","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"]}},{"name":"orderby","in":"query","description":"Order the results for the corresponding column. Default is name.","schema":{"type":"string","nullable":true,"enum":["TAG","TYPE"],"description":"Order the results for the corresponding column. Default is name."}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"available_agp_deletes":{"type":"integer","format":"int32","description":"Available AGP Deletes: The number of currently available AGP deletionsin the current month. If negative, it is the amount of registrations that will be recharged at the end of the month."},"current_agp_deletes":{"type":"integer","format":"int32","description":"Current AGP Deletes: Total number of current AGP deletions in that zone in the current month."},"current_domain_registrations":{"type":"integer","format":"int32","description":"Current Domain Registrations: Total number of current domain registrations in that zone in the current month."},"total_agp_deletes":{"type":"integer","format":"int32","description":"Total AGP Deletes: Current maximum number of AGP deletions in that zone in the current month depending on the current registrations."}}}},"property":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"Count: Total number of data shown"},"first":{"type":"integer","format":"int32","description":"First: Pointer to the first shown ID"},"last":{"type":"integer","format":"int32","description":"Last: Pointer to the last shown ID"},"limit":{"type":"integer","format":"int32","description":"Limit: The limit given in the command"},"total":{"type":"integer","format":"int32","description":"Total: Total number of existing data"},"zone":{"type":"string","description":"Zone: The zone for the current AGP details."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryAGPDeletesList"}},"/zone/-/info":{"get":{"operationId":"queryZoneInfoList","summary":"XRRP command QueryZoneInfoList (queryZoneInfoList)","description":"The QueryZoneInfolist command enables you to review zones by category etc.\n","tags":["zone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"category","in":"query","description":"Category: Search pattern for zone category","schema":{"type":"string","nullable":true,"description":"Category: Search pattern for zone category"}},{"name":"ntld","in":"query","description":"nTld: Is a new gtld zone","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"nTld: Is a new gtld zone"}},{"name":"fullfillment","in":"query","description":"Fullfillment: Is a fullfillment zone","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Fullfillment: Is a fullfillment zone"}},{"name":"registrationpossible","in":"query","description":"Registration possible: Is domain registration possible for this zone","schema":{"type":"string","nullable":true,"enum":["0","1"],"description":"Registration possible: Is domain registration possible for this zone"}},{"name":"order","in":"query","description":"The sort direction","schema":{"type":"string","nullable":true,"enum":["ASC","DESC"],"description":"The sort direction"}},{"name":"orderby","in":"query","description":"Sort the result by this column","schema":{"type":"string","nullable":true,"enum":["ZONE",""],"description":"Sort the result by this column"}},{"name":"generatelist","in":"query","schema":{"type":"string","nullable":true,"enum":["0","1"]}},{"name":"sendlistemail","in":"query","description":"Email address where the CSV will be sent to","schema":{"type":"string","nullable":true,"description":"Email address where the CSV will be sent to"}},{"name":"first","in":"query","description":"First: Start the output of results from this item","schema":{"type":"integer","format":"int32","nullable":true,"description":"First: Start the output of results from this item"}},{"name":"limit","in":"query","description":"Limit: Show only this many items in the response","schema":{"type":"integer","format":"int32","nullable":true,"description":"Limit: Show only this many items in the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"zone":{"type":"array","description":"Zone: The zone for this dataset","items":{"type":"string","description":"Zone: The zone for this dataset"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryZoneInfoList"}},"/zone/-/information":{"get":{"operationId":"queryZoneInformationList","summary":"XRRP command QueryZoneInformationList (queryZoneInformationList)","description":"The command \"GetZoneInfo\" queries information about a zone. This includes (but is not limited to): allowed periods, IDN capability, length restrictions.\nNote: The returned fields may vary across the different zones.\n","tags":["zone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"zone","in":"query","description":"Zones: Return information about this zones","schema":{"type":"array","description":"Zones: Return information about this zones","items":{"type":"string","nullable":true,"description":"Zones: Return information about this zones"}}},{"name":"domain","in":"query","description":"Domains: Gets the zone of these domains and returns information about them","schema":{"type":"array","description":"Domains: Gets the zone of these domains and returns information about them","items":{"type":"string","nullable":true,"description":"Domains: Gets the zone of these domains and returns information about them"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"abuse_policy":{"type":"array","description":"Abuse Policy of the Registry.","items":{"type":"string","description":"Abuse Policy of the Registry."}},"abuse_policy_url":{"type":"string","description":"URL to Abuse Policy of the Registry."},"active":{"type":"integer","format":"int32","description":"Active"},"add_grace_period":{"type":"string","description":"AddGrace Period in Days."},"allowed_characters":{"type":"string","description":"Allowed Characters for Domain Registration."},"allowed_characters_ascii_digits":{"type":"integer","format":"int32","description":"Allowed characters ascii digits"},"allowed_characters_ascii_letters":{"type":"integer","format":"int32","description":"Allowed characters ascii letters"},"allowed_characters_hyphen":{"type":"string","description":"Allowed characters hyphen"},"allowed_characters_notes":{"type":"array","description":"Allowed characters notes","items":{"type":"string","description":"Allowed characters notes"}},"allowed_characters_special_characters":{"type":"string","description":"Allowed characters special characters"},"applicant0_company_type":{"type":"string","description":"Applicant0 company type"},"applicant0_country_id":{"type":"string","description":"Applicant0 country id"},"applicant0_icann_region":{"type":"string","description":"Applicant0 icann region"},"applicant0_name":{"type":"string","description":"Applicant0 name"},"applicant0_ntld_type":{"type":"string","description":"Applicant0 ntld type"},"applicant0_registry_name":{"type":"string","description":"Applicant0 registry name"},"applicant0_url":{"type":"string","description":"Applicant0 url"},"applicant10_company_type":{"type":"string","description":"Applicant10 company type"},"applicant10_country_id":{"type":"integer","format":"int32","description":"Applicant10 country id"},"applicant10_icann_region":{"type":"string","description":"Applicant10 icann region"},"applicant10_name":{"type":"string","description":"Applicant10 name"},"applicant10_ntld_type":{"type":"string","description":"Applicant10 ntld type"},"applicant10_registry_name":{"type":"string","description":"Applicant10 registry name"},"applicant10_url":{"type":"string","description":"Applicant10 url"},"applicant11_company_type":{"type":"string","description":"Applicant11 company type"},"applicant11_country_id":{"type":"integer","format":"int32","description":"Applicant11 country id"},"applicant11_icann_region":{"type":"string","description":"Applicant11 icann region"},"applicant11_name":{"type":"string","description":"Applicant11 name"},"applicant11_ntld_type":{"type":"string","description":"Applicant11 ntld type"},"applicant11_registry_name":{"type":"string","description":"Applicant11 registry name"},"applicant11_url":{"type":"string","description":"Applicant11 url"},"applicant1_company_type":{"type":"string","description":"Applicant1 company type"},"applicant1_country_id":{"type":"string","description":"Applicant1 country id"},"applicant1_icann_region":{"type":"string","description":"Applicant1 icann region"},"applicant1_name":{"type":"string","description":"Applicant1 name"},"applicant1_ntld_type":{"type":"string","description":"Applicant1 ntld type"},"applicant1_registry_name":{"type":"string","description":"Applicant1 registry name"},"applicant1_url":{"type":"string","description":"Applicant1 url"},"applicant2_company_type":{"type":"string","description":"Applicant2 company type"},"applicant2_country_id":{"type":"string","description":"Applicant2 country id"},"applicant2_icann_region":{"type":"string","description":"Applicant2 icann region"},"applicant2_name":{"type":"string","description":"Applicant2 name"},"applicant2_ntld_type":{"type":"string","description":"Applicant2 ntld type"},"applicant2_registry_name":{"type":"string","description":"Applicant2 registry name"},"applicant2_url":{"type":"string","description":"Applicant2 url"},"applicant3_company_type":{"type":"string","description":"Applicant3 company type"},"applicant3_country_id":{"type":"integer","format":"int32","description":"Applicant3 country id"},"applicant3_icann_region":{"type":"string","description":"Applicant3 icann region"},"applicant3_name":{"type":"string","description":"Applicant3 name"},"applicant3_ntld_type":{"type":"string","description":"Applicant3 ntld type"},"applicant3_registry_name":{"type":"string","description":"Applicant3 registry name"},"applicant3_url":{"type":"string","description":"Applicant3 url"},"applicant4_company_type":{"type":"string","description":"Applicant4 company type"},"applicant4_country_id":{"type":"integer","format":"int32","description":"Applicant4 country id"},"applicant4_icann_region":{"type":"string","description":"Applicant4 icann region"},"applicant4_name":{"type":"string","description":"Applicant4 name"},"applicant4_ntld_type":{"type":"string","description":"Applicant4 ntld type"},"applicant4_registry_name":{"type":"string","description":"Applicant4 registry name"},"applicant4_url":{"type":"string","description":"Applicant4 url"},"applicant5_company_type":{"type":"string","description":"Applicant5 company type"},"applicant5_country_id":{"type":"integer","format":"int32","description":"Applicant5 country id"},"applicant5_icann_region":{"type":"string","description":"Applicant5 icann region"},"applicant5_name":{"type":"string","description":"Applicant5 name"},"applicant5_ntld_type":{"type":"string","description":"Applicant5 ntld type"},"applicant5_registry_name":{"type":"string","description":"Applicant5 registry name"},"applicant5_url":{"type":"string","description":"Applicant5 url"},"applicant6_company_type":{"type":"string","description":"Applicant6 company type"},"applicant6_country_id":{"type":"integer","format":"int32","description":"Applicant6 country id"},"applicant6_icann_region":{"type":"string","description":"Applicant6 icann region"},"applicant6_name":{"type":"string","description":"Applicant6 name"},"applicant6_ntld_type":{"type":"string","description":"Applicant6 ntld type"},"applicant6_registry_name":{"type":"string","description":"Applicant6 registry name"},"applicant6_url":{"type":"string","description":"Applicant6 url"},"applicant7_company_type":{"type":"string","description":"Applicant7 company type"},"applicant7_country_id":{"type":"integer","format":"int32","description":"Applicant7 country id"},"applicant7_icann_region":{"type":"string","description":"Applicant7 icann region"},"applicant7_name":{"type":"string","description":"Applicant7 name"},"applicant7_ntld_type":{"type":"string","description":"Applicant7 ntld type"},"applicant7_registry_name":{"type":"string","description":"Applicant7 registry name"},"applicant7_url":{"type":"string","description":"Applicant7 url"},"applicant8_company_type":{"type":"string","description":"Applicant8 company type"},"applicant8_country_id":{"type":"integer","format":"int32","description":"Applicant8 country id"},"applicant8_icann_region":{"type":"string","description":"Applicant8 icann region"},"applicant8_name":{"type":"string","description":"Applicant8 name"},"applicant8_ntld_type":{"type":"string","description":"Applicant8 ntld type"},"applicant8_registry_name":{"type":"string","description":"Applicant8 registry name"},"applicant8_url":{"type":"string","description":"Applicant8 url"},"applicant9_company_type":{"type":"string","description":"Applicant9 company type"},"applicant9_country_id":{"type":"integer","format":"int32","description":"Applicant9 country id"},"applicant9_icann_region":{"type":"string","description":"Applicant9 icann region"},"applicant9_name":{"type":"string","description":"Applicant9 name"},"applicant9_ntld_type":{"type":"string","description":"Applicant9 ntld type"},"applicant9_registry_name":{"type":"string","description":"Applicant9 registry name"},"applicant9_url":{"type":"string","description":"Applicant9 url"},"application_phase0_application_procedure":{"type":"array","description":"Application phase0 application procedure","items":{"type":"string","nullable":true,"description":"Application phase0 application procedure"}},"application_phase0_class":{"type":"string","description":"Application phase0 class"},"application_phase0_description":{"type":"array","description":"Application phase0 description","items":{"type":"string","description":"Application phase0 description"}},"application_phase0_end":{"type":"string","description":"Application phase0 end"},"application_phase0_model":{"type":"string","description":"Application phase0 model"},"application_phase0_name":{"type":"string","description":"Application phase0 name"},"application_phase0_periods":{"type":"string","description":"Application phase0 periods"},"application_phase0_start":{"type":"string","description":"Application phase0 start"},"application_phase10_application_procedure":{"type":"array","description":"Application phase10 application procedure","items":{"type":"string","description":"Application phase10 application procedure"}},"application_phase10_end":{"type":"string","description":"Application phase10 end"},"application_phase10_model":{"type":"string","description":"Application phase10 model"},"application_phase10_name":{"type":"string","description":"Application phase10 name"},"application_phase10_start":{"type":"string","description":"Application phase10 start"},"application_phase11_application_procedure":{"type":"array","description":"Application phase11 application procedure","items":{"type":"string","description":"Application phase11 application procedure"}},"application_phase11_end":{"type":"string","description":"Application phase11 end"},"application_phase11_model":{"type":"string","description":"Application phase11 model"},"application_phase11_name":{"type":"string","description":"Application phase11 name"},"application_phase11_start":{"type":"string","description":"Application phase11 start"},"application_phase12_application_procedure":{"type":"array","description":"Application phase12 application procedure","items":{"type":"string","description":"Application phase12 application procedure"}},"application_phase12_end":{"type":"string","description":"Application phase12 end"},"application_phase12_model":{"type":"string","description":"Application phase12 model"},"application_phase12_name":{"type":"string","description":"Application phase12 name"},"application_phase12_start":{"type":"string","description":"Application phase12 start"},"application_phase1_application_procedure":{"type":"array","description":"Application phase1 application procedure","items":{"type":"string","description":"Application phase1 application procedure"}},"application_phase1_class":{"type":"string","description":"Application phase1 class"},"application_phase1_description":{"type":"array","description":"Application phase1 description","items":{"type":"string","description":"Application phase1 description"}},"application_phase1_end":{"type":"string","description":"Application phase1 end"},"application_phase1_model":{"type":"string","description":"Application phase1 model"},"application_phase1_name":{"type":"string","description":"Application phase1 name"},"application_phase1_periods":{"type":"string","description":"Application phase1 periods"},"application_phase1_start":{"type":"string","description":"Application phase1 start"},"application_phase2_application_procedure":{"type":"array","description":"Application phase2 application procedure","items":{"type":"string","description":"Application phase2 application procedure"}},"application_phase2_class":{"type":"string","description":"Application phase2 class"},"application_phase2_description":{"type":"array","description":"Application phase2 description","items":{"type":"string","description":"Application phase2 description"}},"application_phase2_end":{"type":"string","description":"Application phase2 end"},"application_phase2_model":{"type":"string","description":"Application phase2 model"},"application_phase2_name":{"type":"string","description":"Application phase2 name"},"application_phase2_periods":{"type":"string","description":"Application phase2 periods"},"application_phase2_start":{"type":"string","description":"Application phase2 start"},"application_phase3_application_procedure":{"type":"array","description":"Application phase3 application procedure","items":{"type":"string","description":"Application phase3 application procedure"}},"application_phase3_class":{"type":"string","description":"Application phase3 class"},"application_phase3_end":{"type":"string","description":"Application phase3 end"},"application_phase3_model":{"type":"string","description":"Application phase3 model"},"application_phase3_name":{"type":"string","description":"Application phase3 name"},"application_phase3_periods":{"type":"string","description":"Application phase3 periods"},"application_phase3_start":{"type":"string","description":"Application phase3 start"},"application_phase4_application_procedure":{"type":"array","description":"Application phase4 application procedure","items":{"type":"string","description":"Application phase4 application procedure"}},"application_phase4_class":{"type":"string","description":"Application phase4 class"},"application_phase4_end":{"type":"string","description":"Application phase4 end"},"application_phase4_model":{"type":"string","description":"Application phase4 model"},"application_phase4_name":{"type":"string","description":"Application phase4 name"},"application_phase4_periods":{"type":"string","description":"Application phase4 periods"},"application_phase4_start":{"type":"string","description":"Application phase4 start"},"application_phase5_application_procedure":{"type":"array","description":"Application phase5 application procedure","items":{"type":"string","description":"Application phase5 application procedure"}},"application_phase5_end":{"type":"string","description":"Application phase5 end"},"application_phase5_model":{"type":"string","description":"Application phase5 model"},"application_phase5_name":{"type":"string","description":"Application phase5 name"},"application_phase5_periods":{"type":"string","description":"Application phase5 periods"},"application_phase5_start":{"type":"string","description":"Application phase5 start"},"application_phase6_application_procedure":{"type":"array","description":"Application phase6 application procedure","items":{"type":"string","description":"Application phase6 application procedure"}},"application_phase6_end":{"type":"string","description":"Application phase6 end"},"application_phase6_model":{"type":"string","description":"Application phase6 model"},"application_phase6_name":{"type":"string","description":"Application phase6 name"},"application_phase6_periods":{"type":"string","description":"Application phase6 periods"},"application_phase6_start":{"type":"string","description":"Application phase6 start"},"application_phase7_application_procedure":{"type":"array","description":"Application phase7 application procedure","items":{"type":"string","description":"Application phase7 application procedure"}},"application_phase7_end":{"type":"string","description":"Application phase7 end"},"application_phase7_model":{"type":"string","description":"Application phase7 model"},"application_phase7_name":{"type":"string","description":"Application phase7 name"},"application_phase7_periods":{"type":"string","description":"Application phase7 periods"},"application_phase7_start":{"type":"string","description":"Application phase7 start"},"application_phase8_application_procedure":{"type":"array","description":"Application phase8 application procedure","items":{"type":"string","description":"Application phase8 application procedure"}},"application_phase8_end":{"type":"string","description":"Application phase8 end"},"application_phase8_model":{"type":"string","description":"Application phase8 model"},"application_phase8_name":{"type":"string","description":"Application phase8 name"},"application_phase8_periods":{"type":"string","description":"Application phase8 periods"},"application_phase8_start":{"type":"string","description":"Application phase8 start"},"application_phase9_application_procedure":{"type":"array","description":"Application phase9 application procedure","items":{"type":"string","description":"Application phase9 application procedure"}},"application_phase9_end":{"type":"string","description":"Application phase9 end"},"application_phase9_model":{"type":"string","description":"Application phase9 model"},"application_phase9_name":{"type":"string","description":"Application phase9 name"},"application_phase9_start":{"type":"string","description":"Application phase9 start"},"auth_code":{"type":"string","description":"Transfer require Auth code"},"auth_code_maximum_length":{"type":"integer","format":"int32","description":"The maximum auth code length"},"auth_code_minimum_length":{"type":"integer","format":"int32","description":"The minimum auth code length"},"auth_code_required_chars":{"type":"string","description":"Required chars for auth code"},"auth_domain":{"type":"string","nullable":true,"description":"Auth domain"},"authoritative_renewal_confirmation":{"type":"array","description":"Authoritative renewal confirmation","items":{"type":"string","description":"Authoritative renewal confirmation"}},"auto_approved_transfers":{"type":"string","description":"Auto approved transfers"},"auto_renew_grace_period":{"type":"string","description":"Auto renew grace period"},"auto_renew_grace_period_days":{"type":"string","description":"The auto renew grace period days"},"basic_internal_notes":{"type":"string","description":"Basic internal notes"},"best_renewed_before":{"type":"string","description":"Best renewed before"},"country":{"type":"string","description":"Country"},"country_capital":{"type":"string","description":"Country capital"},"country_currency":{"type":"string","description":"Country currency"},"country_html_description":{"type":"string","description":"Country html description"},"country_html_keywords":{"type":"string","description":"Country html keywords"},"country_html_title":{"type":"string","description":"Country html title"},"country_info":{"type":"array","description":"Country info","items":{"type":"string","description":"Country info"}},"country_name":{"type":"string","description":"Country name"},"country_official_language":{"type":"string","description":"Country official language"},"currency":{"type":"string","description":"Currency"},"delete_restore_possible":{"type":"string","description":"Restore after Deletion is possible."},"delete_restore_procedure":{"type":"array","description":"Restore procedure.","items":{"type":"string","description":"Restore procedure."}},"deletion_internal_notes":{"type":"string","description":"Deletion internal notes"},"deletion_possible":{"type":"string","description":"Deletion possible."},"deletion_procedure":{"type":"array","description":"Deletion procedure.","items":{"type":"string","description":"Deletion procedure."}},"deletion_timeframe":{"type":"string","description":"Deletion timeframe."},"difficulty":{"type":"integer","format":"int32","description":"Difficulty"},"direct_accreditation":{"type":"string","description":"Direct accreditation"},"dispute_policy":{"type":"array","description":"Dispute Policy of the Registry.","items":{"type":"string","description":"Dispute Policy of the Registry."}},"dispute_policy_url":{"type":"string","description":"URL to Dispute Policy of the Registry."},"dns_configuration":{"type":"string","description":"DNS configuration: Information about DNS configuration, if applicable."},"document_links":{"type":"array","description":"Links to documents.","items":{"type":"string","description":"Links to documents."}},"domain_bundling":{"type":"string","description":"Domain bundling: TLD is bundled to another TLD (example: NGO/ONG)"},"expiration_date_after_renewals":{"type":"string","description":"Expiration date after renewals"},"expiration_date_after_transfer_renewals":{"type":"string","description":"Expiration date after transfer renewals"},"foa_email":{"type":"string","description":"FOA required"},"general_information":{"type":"array","description":"General information","items":{"type":"string","nullable":true,"description":"General information"}},"general_registration_info":{"type":"array","description":"General registration info","items":{"type":"string","description":"General registration info"}},"handles_updateable":{"type":"string","description":"Supports handle updates."},"has_dispute_policy":{"type":"string","description":"Has dispute policy"},"has_premium_domains":{"type":"string","description":"Premium domain registration possible"},"html_description":{"type":"string","description":"Html description"},"html_keywords":{"type":"string","description":"Html keywords"},"html_title":{"type":"string","description":"Html title"},"idn":{"type":"string","description":"TLD is IDN capable.: TLD is IDN capable."},"idn_allowed_characters":{"type":"string","description":"IDN allowed characters: Allowed characters for IDN domains."},"idn_autodetect_language_tag":{"type":"string","description":"Idn autodetect language tag"},"idn_info":{"type":"array","description":"IDN information: IDN information.","items":{"type":"string","description":"IDN information: IDN information."}},"idn_language_name0":{"type":"string","description":"Idn language name0"},"idn_language_restrictions":{"type":"string","description":"IDN language restrictions: Restrictions for IDN domains."},"idn_language_tags":{"type":"string","description":"Possible IDN tags: List of supported language tags."},"idn_requires_language_tag":{"type":"string","description":"IDN language tag required on registration: Requires language tag for IDN domains."},"idn_requires_language_tag_on_check":{"type":"string","description":"IDN language tag required on check domain: API Command: CheckDomain requires language tag for checking IDN domains."},"idn_script":{"type":"string","description":"Idn script"},"idn_setup_fee":{"type":"string","description":"Idn setup fee"},"idn_translation":{"type":"string","description":"Idn translation"},"idn_transliteration":{"type":"string","description":"Idn transliteration"},"is_fulfillment_tld":{"type":"string","description":"Is fulfillment tld"},"is_generic":{"type":"string","description":"Is generic: Type of the TLD: ccTLD, gTLD, new gTLD."},"is_ntld":{"type":"string","description":"Is ntld"},"is_restore_possible":{"type":"string","description":"Is domain restore possible"},"local_admin":{"type":"string","description":"Local admin"},"local_billing":{"type":"string","description":"Local billing"},"local_owner":{"type":"string","description":"Local owner"},"local_presence":{"type":"string","description":"Local presence"},"local_presence_countries":{"type":"string","description":"Local presence countries"},"local_presence_info":{"type":"array","description":"Local presence info","items":{"type":"string","description":"Local presence info"}},"local_presence_process":{"type":"array","description":"Local presence process","items":{"type":"string","description":"Local presence process"}},"local_tech":{"type":"string","description":"Local tech"},"maximum_domain_length":{"type":"integer","format":"int32","description":"The maximum domain name length"},"maximum_nameserver_ips":{"type":"string","description":"Maximum nameserver ips"},"maximum_nameservers":{"type":"string","description":"Maximum nameservers"},"maximum_term":{"type":"string","description":"Maximum term"},"minimum_domain_length":{"type":"integer","format":"int32","description":"The minimum domain name length"},"minimum_nameserver_ips":{"type":"string","description":"Minimum nameserver ips"},"minimum_nameservers":{"type":"string","description":"Minimum nameservers"},"minimum_term":{"type":"string","description":"Minimum term"},"modify_info":{"type":"array","description":"Information for domain modifications.","items":{"type":"string","description":"Information for domain modifications."}},"nameserver_required":{"type":"string","description":"Nameservers are required"},"ntld_categories":{"type":"string","description":"TLD Categories: Category for this TLD."},"ntld_html_description":{"type":"string","description":"Ntld html description"},"ntld_html_keywords":{"type":"string","description":"Ntld html keywords"},"ntld_html_title":{"type":"string","description":"Ntld html title"},"ntld_registry_urls":{"type":"array","description":"Ntld registry urls","items":{"type":"string","description":"Ntld registry urls"}},"number_of_domains":{"type":"string","description":"Number of domains"},"number_of_domains_allowed_to_register":{"type":"string","description":"Number of domains allowed to register"},"number_of_domains_allowed_to_register_is_limited":{"type":"string","description":"Number of domains allowed to register is limited"},"ownerchange_process":{"type":"string","description":"Ownerchange process"},"parent_tld":{"type":"string","description":"Parent TLD: Parent TLD for this TLD, if applicable."},"pending_delete":{"type":"string","description":"Pending delete"},"pending_delete_days":{"type":"string","description":"Pending delete days"},"pending_deletion_timeframe":{"type":"string","description":"Pending deletion timeframe"},"periods":{"type":"string","description":"Registration Periods."},"preconfigured_dns":{"type":"string","description":"Preconfigured DNS required: Requires pre-configured DNS."},"premium_domain_info":{"type":"array","description":"Premium domain information","items":{"type":"string","description":"Premium domain information"}},"premium_names":{"type":"string","description":"Premium names"},"premium_setup_fee":{"type":"string","description":"Premium setup fee"},"private_reg_allowed":{"type":"string","description":"Private reg allowed"},"prohibited_names":{"type":"array","description":"Prohibited names","items":{"type":"string","description":"Prohibited names"}},"realtime":{"type":"integer","format":"int32","description":"Realtime"},"redemption_period":{"type":"string","description":"Redemption period"},"redemption_period_days":{"type":"string","description":"Redemption period days"},"registration_periods":{"type":"string","description":"Registration periods"},"registration_possible":{"type":"string","description":"Registration possible"},"registration_procedure":{"type":"array","description":"Registration procedure","items":{"type":"string","description":"Registration procedure"}},"registration_requires_business_registration_certificate":{"type":"string","description":"Registration requires business registration certificate"},"registration_requires_business_registration_number":{"type":"string","description":"Registration requires business registration number"},"registration_requires_personal_id_number":{"type":"string","description":"Registration requires personal id number"},"registration_requires_trademark":{"type":"string","description":"Registration requires trademark"},"registration_requires_vat_id":{"type":"string","description":"Registration requires vat id"},"registration_system":{"type":"array","description":"Registration system","items":{"type":"string","description":"Registration system"}},"registration_time":{"type":"string","description":"Registration time"},"registry_account_email":{"type":"string","description":"Registry account email"},"registry_add_grace_period":{"type":"string","description":"Registry add grace period"},"registry_allows_whois_privacy":{"type":"string","description":"Registry allows whois privacy"},"registry_auto_renew_grace_period_days":{"type":"string","description":"Registry auto renew grace period days"},"registry_contact":{"type":"array","description":"Registry contact","items":{"type":"string","description":"Registry contact"}},"registry_deletion_timeframe":{"type":"string","description":"Registry deletion timeframe"},"registry_lock_possible":{"type":"string","description":"Registry lock possible: TLD offer registry lock."},"registry_logo":{"type":"string","description":"Registry logo"},"registry_name":{"type":"string","description":"Registry name"},"registry_offers_local_presence":{"type":"string","description":"Registry offers local presence"},"registry_offers_trustee":{"type":"string","description":"Registry offers trustee"},"registry_redemption_period":{"type":"string","description":"Registry redemption period"},"registry_type":{"type":"string","description":"Registry type"},"registry_url":{"type":"string","description":"Registry url"},"renew_grace_period_info":{"type":"array","description":"Renew grace period info","items":{"type":"string","description":"Renew grace period info"}},"renewal_after_transfer":{"type":"string","description":"Renew after transfer"},"renewal_at_trade":{"type":"string","description":"Renew at trade"},"renewal_at_transfer":{"type":"string","description":"Renewal at transfer"},"renewal_by_autorenew":{"type":"string","description":"Renewal by autorenew"},"renewal_by_bank_transfer":{"type":"string","description":"Renewal by bank transfer"},"renewal_by_credit_card":{"type":"string","description":"Renewal by credit card"},"renewal_by_invoice":{"type":"string","description":"Renewal by invoice"},"renewal_by_manual":{"type":"string","description":"Renewal by manual"},"renewal_by_none":{"type":"string","description":"Renewal by none"},"renewal_by_top_off_account":{"type":"string","description":"Renewal by top off account"},"renewal_internal_notes":{"type":"array","description":"Renewal internal notes","items":{"type":"string","description":"Renewal internal notes"}},"renewal_periods":{"type":"string","description":"Renewal periods"},"renewal_procedure":{"type":"array","description":"Renewal procedure","items":{"type":"string","nullable":true,"description":"Renewal procedure"}},"renewal_term":{"type":"string","description":"Renewal term"},"required_contacts":{"type":"string","description":"Required contacts"},"requires_a_or_cname_record":{"type":"string","description":"Requires A or CNAME record."},"requires_mx_record":{"type":"string","description":"Requires MX record."},"requires_personal_admin_contact":{"type":"string","description":"Requires personal admin contact"},"requires_personal_owner_contact":{"type":"string","description":"Requires personal owner contact"},"requires_personal_tech_contact":{"type":"string","description":"Requires personal tech contact"},"requires_soa_record":{"type":"string","description":"Requires SOA record."},"requires_working_email":{"type":"string","description":"Requires working email address."},"reserved_names":{"type":"array","description":"Reserved names","items":{"type":"string","description":"Reserved names"}},"restore_internal_notes":{"type":"string","description":"Restore internal notes"},"restore_procedure":{"type":"array","description":"Restore procedure","items":{"type":"string","description":"Restore procedure"}},"restrictions":{"type":"array","description":"Restrictions","items":{"type":"string","description":"Restrictions"}},"rrp_proxy_support":{"type":"string","description":"Automation level: Full = Full automisation. Partial = Partial automisation. None = Not supported."},"rrp_supports_delete":{"type":"string","description":"Deletion possible."},"rrp_supports_dnssec":{"type":"string","description":"Rrp supports dnssec"},"rrp_supports_modify":{"type":"string","description":"Modification possible."},"rrp_supports_registration":{"type":"string","description":"Registration possible."},"rrp_supports_renewal":{"type":"string","description":"Explicit Renewal possible."},"rrp_supports_restore":{"type":"string","description":"Restore Possible."},"rrp_supports_trade":{"type":"string","description":"Rrp supports trade"},"rrp_supports_transfer":{"type":"string","description":"Transfer possible."},"rrp_supports_whois_privacy":{"type":"string","description":"TLD allows registrations using WhoIs Privacy."},"supported_contacts":{"type":"string","description":"Supported contacts"},"supported_dnssec_algorithms":{"type":"string","description":"Supported dnssec algorithms"},"supported_dnssec_dsdata_algorithms":{"type":"string","description":"Supported dnssec dsdata algorithms"},"supported_dnssec_dsdata_digest_types":{"type":"string","description":"Supported dnssec dsdata digest types"},"supports_backordering":{"type":"string","description":"Supports backordering"},"supports_client_delete_prohibited":{"type":"string","description":"Support delete lock"},"supports_client_hold":{"type":"string","description":"Support client hold"},"supports_client_renew_prohibited":{"type":"string","description":"Support renew lock"},"supports_client_transfer_prohibited":{"type":"string","description":"Support transfer lock"},"supports_client_update_prohibited":{"type":"string","description":"Support update lock"},"supports_contact_disclosure":{"type":"string","description":"Supports contact disclosure"},"supports_dnssec":{"type":"string","description":"Supports DNSSEC keydata: Supports DNSSEC. KEYDATA is always supported."},"supports_dnssec_dsdata":{"type":"string","description":"Supports DNSSEC dsdata: Supports DSDATA (KEYDATA is always supported)."},"supports_idn":{"type":"string","description":"Supports idn"},"supports_ipv6":{"type":"string","description":"Supports IPv6 Nameserver."},"supports_transfer_approve":{"type":"string","description":"Support transfer approve"},"supports_transfer_cancel":{"type":"string","description":"Support transfer cancel"},"supports_transfer_deny":{"type":"string","description":"Support transfer deny"},"supports_transfer_locks":{"type":"string","description":"Supports transfer locks"},"supports_trustee":{"type":"string","description":"Supports trustee"},"tag":{"type":"array","description":"Category: Categories for this TLD.","items":{"type":"string","description":"Category: Categories for this TLD."}},"terms_and_conditions":{"type":"array","description":"Terms and conditions","items":{"type":"string","description":"Terms and conditions"}},"terms_and_conditions_url":{"type":"string","description":"Terms and conditions URL"},"tld_type":{"type":"string","description":"Tld type"},"tld_zone_propagation_time":{"type":"string","description":"Tld zone propagation time"},"trade_internal_notes":{"type":"string","description":"Trade internal notes"},"trade_procedure":{"type":"array","description":"Trade procedure","items":{"type":"string","description":"Trade procedure"}},"trade_resets_registration_period":{"type":"string","description":"Trade resets registration period"},"trademark_jurisdictions":{"type":"string","description":"Trademark jurisdictions"},"trademark_juristications":{"type":"string","description":"Trademark juristications"},"transfer_default_renew_period":{"type":"string","description":"Transfer renew period"},"transfer_internal_notes":{"type":"string","description":"Transfer internal notes"},"transfer_periods":{"type":"string","description":"Transfer periods"},"transfer_procedure":{"type":"array","description":"Transfer procedure","items":{"type":"string","description":"Transfer procedure"}},"transfer_required_contacts":{"type":"string","description":"Transfer required contacts"},"transfer_resets_registration_period":{"type":"string","description":"Transfer resets registration period"},"transfer_supported_contacts":{"type":"string","description":"Transfer supported contacts"},"transfer_supported_nameservers":{"type":"integer","format":"int32","description":"Transfer supported nameservers"},"transfer_time":{"type":"string","description":"Transfer time"},"translation_progress":{"type":"string","description":"Translation progress"},"trustee_info":{"type":"array","description":"Trustee info","items":{"type":"string","description":"Trustee info"}},"trustee_process":{"type":"array","description":"Trustee process","items":{"type":"string","description":"Trustee process"}},"url_for_idn_information_at_registry":{"type":"string","description":"URL for IDN information at Registry.: URL for IDN information at Registry."},"web_whois_url":{"type":"string","description":"Web whois url"},"whois_rsp":{"type":"string","description":"Whois RSP"},"whois_server":{"type":"string","description":"Whois server"},"whois_update":{"type":"string","description":"Whois update"},"whois_update_realtime":{"type":"string","description":"Whois update realtime"},"whois_update_time":{"type":"string","description":"Whois update time"},"wiki_teaser":{"type":"array","description":"Wiki teaser","items":{"type":"string","description":"Wiki teaser"}},"zone":{"type":"string","description":"Zone"},"zone_check_tool_url":{"type":"string","description":"URL to zone check tool.: URL to zone check tool."},"zone_info":{"type":"array","description":"Information for this TLD.","items":{"type":"string","description":"Information for this TLD."}},"zone_use":{"type":"array","description":"Zone use","items":{"type":"string","description":"Zone use"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"QueryZoneInformationList"}},"/zone/{zone}/agp":{"get":{"operationId":"statusAGPDeletes","summary":"XRRP command StatusAGPDeletes (statusAGPDeletes)","description":"\n","tags":["zone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"zone","in":"path","required":true,"description":"The zone where the current AGP details should be returned.","schema":{"type":"string","nullable":true,"description":"The zone where the current AGP details should be returned."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"available_agp_deletes":{"type":"integer","format":"int32","description":"Available AGP Deletes: The number of currently available AGP deletionsin the current month. If negative, it is the amount of registrations that will be recharged at the end of the month."},"current_agp_deletes":{"type":"integer","format":"int32","description":"Current AGP Deletes: Total number of current AGP deletions in that zone in the current month."},"current_domain_registrations":{"type":"integer","format":"int32","description":"Current Domain Registrations: Total number of current domain registrations in that zone in the current month."},"total_agp_deletes":{"type":"integer","format":"int32","description":"Total AGP Deletes: Current maximum number of AGP deletions in that zone in the current month depending on the current registrations."},"zone":{"type":"string","description":"Zone: The zone for the current AGP details."}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"StatusAGPDeletes"}},"/zone/{zone}/info":{"get":{"operationId":"getZoneInfo","summary":"XRRP command GetZoneInfo (getZoneInfo)","description":"Query information about a zone, this includes (but not limited to): Allowed periods, IDN - capability, length - restrictions\nNote: The returned fields may vary across the different zones\n","tags":["zone"],"parameters":[{"name":"cltrid","in":"query","description":"Unique identifier for this request, must be changed with every request, the default is autogenerated","schema":{"type":"string","nullable":true,"description":"Unique identifier for this request, must be changed with every request, the default is autogenerated"}},{"name":"zone","in":"path","required":true,"description":"Zone: Return information about this zone","schema":{"type":"string","description":"Zone: Return information about this zone"}},{"name":"domain","in":"query","description":"Domain: Get zone of this domain and return information about it","schema":{"type":"string","description":"Domain: Get zone of this domain and return information about it"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SuccessResponse"},{"type":"object","properties":{"property":{"type":"object","properties":{"abuse_policy":{"type":"array","description":"Abuse Policy of the Registry.","items":{"type":"string","description":"Abuse Policy of the Registry."}},"abuse_policy_url":{"type":"string","description":"URL to Abuse Policy of the Registry."},"active":{"type":"integer","format":"int32","description":"Active"},"add_grace_period":{"type":"string","description":"AddGrace Period in Days."},"allowed_characters":{"type":"string","description":"Allowed Characters for Domain Registration."},"allowed_characters_ascii_digits":{"type":"integer","format":"int32","description":"Allowed characters ascii digits"},"allowed_characters_ascii_letters":{"type":"integer","format":"int32","description":"Allowed characters ascii letters"},"allowed_characters_hyphen":{"type":"string","description":"Allowed characters hyphen"},"allowed_characters_notes":{"type":"array","description":"Allowed characters notes","items":{"type":"string","description":"Allowed characters notes"}},"allowed_characters_special_characters":{"type":"string","description":"Allowed characters special characters"},"applicant0_company_type":{"type":"string","description":"Applicant0 company type"},"applicant0_country_id":{"type":"string","description":"Applicant0 country id"},"applicant0_icann_region":{"type":"string","description":"Applicant0 icann region"},"applicant0_name":{"type":"string","description":"Applicant0 name"},"applicant0_ntld_type":{"type":"string","description":"Applicant0 ntld type"},"applicant0_registry_name":{"type":"string","description":"Applicant0 registry name"},"applicant0_url":{"type":"string","description":"Applicant0 url"},"applicant10_company_type":{"type":"string","description":"Applicant10 company type"},"applicant10_country_id":{"type":"integer","format":"int32","description":"Applicant10 country id"},"applicant10_icann_region":{"type":"string","description":"Applicant10 icann region"},"applicant10_name":{"type":"string","description":"Applicant10 name"},"applicant10_ntld_type":{"type":"string","description":"Applicant10 ntld type"},"applicant10_registry_name":{"type":"string","description":"Applicant10 registry name"},"applicant10_url":{"type":"string","description":"Applicant10 url"},"applicant11_company_type":{"type":"string","description":"Applicant11 company type"},"applicant11_country_id":{"type":"integer","format":"int32","description":"Applicant11 country id"},"applicant11_icann_region":{"type":"string","description":"Applicant11 icann region"},"applicant11_name":{"type":"string","description":"Applicant11 name"},"applicant11_ntld_type":{"type":"string","description":"Applicant11 ntld type"},"applicant11_registry_name":{"type":"string","description":"Applicant11 registry name"},"applicant11_url":{"type":"string","description":"Applicant11 url"},"applicant1_company_type":{"type":"string","description":"Applicant1 company type"},"applicant1_country_id":{"type":"string","description":"Applicant1 country id"},"applicant1_icann_region":{"type":"string","description":"Applicant1 icann region"},"applicant1_name":{"type":"string","description":"Applicant1 name"},"applicant1_ntld_type":{"type":"string","description":"Applicant1 ntld type"},"applicant1_registry_name":{"type":"string","description":"Applicant1 registry name"},"applicant1_url":{"type":"string","description":"Applicant1 url"},"applicant2_company_type":{"type":"string","description":"Applicant2 company type"},"applicant2_country_id":{"type":"string","description":"Applicant2 country id"},"applicant2_icann_region":{"type":"string","description":"Applicant2 icann region"},"applicant2_name":{"type":"string","description":"Applicant2 name"},"applicant2_ntld_type":{"type":"string","description":"Applicant2 ntld type"},"applicant2_registry_name":{"type":"string","description":"Applicant2 registry name"},"applicant2_url":{"type":"string","description":"Applicant2 url"},"applicant3_company_type":{"type":"string","description":"Applicant3 company type"},"applicant3_country_id":{"type":"integer","format":"int32","description":"Applicant3 country id"},"applicant3_icann_region":{"type":"string","description":"Applicant3 icann region"},"applicant3_name":{"type":"string","description":"Applicant3 name"},"applicant3_ntld_type":{"type":"string","description":"Applicant3 ntld type"},"applicant3_registry_name":{"type":"string","description":"Applicant3 registry name"},"applicant3_url":{"type":"string","description":"Applicant3 url"},"applicant4_company_type":{"type":"string","description":"Applicant4 company type"},"applicant4_country_id":{"type":"integer","format":"int32","description":"Applicant4 country id"},"applicant4_icann_region":{"type":"string","description":"Applicant4 icann region"},"applicant4_name":{"type":"string","description":"Applicant4 name"},"applicant4_ntld_type":{"type":"string","description":"Applicant4 ntld type"},"applicant4_registry_name":{"type":"string","description":"Applicant4 registry name"},"applicant4_url":{"type":"string","description":"Applicant4 url"},"applicant5_company_type":{"type":"string","description":"Applicant5 company type"},"applicant5_country_id":{"type":"integer","format":"int32","description":"Applicant5 country id"},"applicant5_icann_region":{"type":"string","description":"Applicant5 icann region"},"applicant5_name":{"type":"string","description":"Applicant5 name"},"applicant5_ntld_type":{"type":"string","description":"Applicant5 ntld type"},"applicant5_registry_name":{"type":"string","description":"Applicant5 registry name"},"applicant5_url":{"type":"string","description":"Applicant5 url"},"applicant6_company_type":{"type":"string","description":"Applicant6 company type"},"applicant6_country_id":{"type":"integer","format":"int32","description":"Applicant6 country id"},"applicant6_icann_region":{"type":"string","description":"Applicant6 icann region"},"applicant6_name":{"type":"string","description":"Applicant6 name"},"applicant6_ntld_type":{"type":"string","description":"Applicant6 ntld type"},"applicant6_registry_name":{"type":"string","description":"Applicant6 registry name"},"applicant6_url":{"type":"string","description":"Applicant6 url"},"applicant7_company_type":{"type":"string","description":"Applicant7 company type"},"applicant7_country_id":{"type":"integer","format":"int32","description":"Applicant7 country id"},"applicant7_icann_region":{"type":"string","description":"Applicant7 icann region"},"applicant7_name":{"type":"string","description":"Applicant7 name"},"applicant7_ntld_type":{"type":"string","description":"Applicant7 ntld type"},"applicant7_registry_name":{"type":"string","description":"Applicant7 registry name"},"applicant7_url":{"type":"string","description":"Applicant7 url"},"applicant8_company_type":{"type":"string","description":"Applicant8 company type"},"applicant8_country_id":{"type":"integer","format":"int32","description":"Applicant8 country id"},"applicant8_icann_region":{"type":"string","description":"Applicant8 icann region"},"applicant8_name":{"type":"string","description":"Applicant8 name"},"applicant8_ntld_type":{"type":"string","description":"Applicant8 ntld type"},"applicant8_registry_name":{"type":"string","description":"Applicant8 registry name"},"applicant8_url":{"type":"string","description":"Applicant8 url"},"applicant9_company_type":{"type":"string","description":"Applicant9 company type"},"applicant9_country_id":{"type":"integer","format":"int32","description":"Applicant9 country id"},"applicant9_icann_region":{"type":"string","description":"Applicant9 icann region"},"applicant9_name":{"type":"string","description":"Applicant9 name"},"applicant9_ntld_type":{"type":"string","description":"Applicant9 ntld type"},"applicant9_registry_name":{"type":"string","description":"Applicant9 registry name"},"applicant9_url":{"type":"string","description":"Applicant9 url"},"application_phase0_application_procedure":{"type":"array","description":"Application phase0 application procedure","items":{"type":"string","nullable":true,"description":"Application phase0 application procedure"}},"application_phase0_class":{"type":"string","description":"Application phase0 class"},"application_phase0_description":{"type":"array","description":"Application phase0 description","items":{"type":"string","description":"Application phase0 description"}},"application_phase0_end":{"type":"string","description":"Application phase0 end"},"application_phase0_model":{"type":"string","description":"Application phase0 model"},"application_phase0_name":{"type":"string","description":"Application phase0 name"},"application_phase0_periods":{"type":"string","description":"Application phase0 periods"},"application_phase0_start":{"type":"string","description":"Application phase0 start"},"application_phase10_application_procedure":{"type":"array","description":"Application phase10 application procedure","items":{"type":"string","description":"Application phase10 application procedure"}},"application_phase10_end":{"type":"string","description":"Application phase10 end"},"application_phase10_model":{"type":"string","description":"Application phase10 model"},"application_phase10_name":{"type":"string","description":"Application phase10 name"},"application_phase10_start":{"type":"string","description":"Application phase10 start"},"application_phase11_application_procedure":{"type":"array","description":"Application phase11 application procedure","items":{"type":"string","description":"Application phase11 application procedure"}},"application_phase11_end":{"type":"string","description":"Application phase11 end"},"application_phase11_model":{"type":"string","description":"Application phase11 model"},"application_phase11_name":{"type":"string","description":"Application phase11 name"},"application_phase11_start":{"type":"string","description":"Application phase11 start"},"application_phase12_application_procedure":{"type":"array","description":"Application phase12 application procedure","items":{"type":"string","description":"Application phase12 application procedure"}},"application_phase12_end":{"type":"string","description":"Application phase12 end"},"application_phase12_model":{"type":"string","description":"Application phase12 model"},"application_phase12_name":{"type":"string","description":"Application phase12 name"},"application_phase12_start":{"type":"string","description":"Application phase12 start"},"application_phase1_application_procedure":{"type":"array","description":"Application phase1 application procedure","items":{"type":"string","description":"Application phase1 application procedure"}},"application_phase1_class":{"type":"string","description":"Application phase1 class"},"application_phase1_description":{"type":"array","description":"Application phase1 description","items":{"type":"string","description":"Application phase1 description"}},"application_phase1_end":{"type":"string","description":"Application phase1 end"},"application_phase1_model":{"type":"string","description":"Application phase1 model"},"application_phase1_name":{"type":"string","description":"Application phase1 name"},"application_phase1_periods":{"type":"string","description":"Application phase1 periods"},"application_phase1_start":{"type":"string","description":"Application phase1 start"},"application_phase2_application_procedure":{"type":"array","description":"Application phase2 application procedure","items":{"type":"string","description":"Application phase2 application procedure"}},"application_phase2_class":{"type":"string","description":"Application phase2 class"},"application_phase2_description":{"type":"array","description":"Application phase2 description","items":{"type":"string","description":"Application phase2 description"}},"application_phase2_end":{"type":"string","description":"Application phase2 end"},"application_phase2_model":{"type":"string","description":"Application phase2 model"},"application_phase2_name":{"type":"string","description":"Application phase2 name"},"application_phase2_periods":{"type":"string","description":"Application phase2 periods"},"application_phase2_start":{"type":"string","description":"Application phase2 start"},"application_phase3_application_procedure":{"type":"array","description":"Application phase3 application procedure","items":{"type":"string","description":"Application phase3 application procedure"}},"application_phase3_class":{"type":"string","description":"Application phase3 class"},"application_phase3_end":{"type":"string","description":"Application phase3 end"},"application_phase3_model":{"type":"string","description":"Application phase3 model"},"application_phase3_name":{"type":"string","description":"Application phase3 name"},"application_phase3_periods":{"type":"string","description":"Application phase3 periods"},"application_phase3_start":{"type":"string","description":"Application phase3 start"},"application_phase4_application_procedure":{"type":"array","description":"Application phase4 application procedure","items":{"type":"string","description":"Application phase4 application procedure"}},"application_phase4_class":{"type":"string","description":"Application phase4 class"},"application_phase4_end":{"type":"string","description":"Application phase4 end"},"application_phase4_model":{"type":"string","description":"Application phase4 model"},"application_phase4_name":{"type":"string","description":"Application phase4 name"},"application_phase4_periods":{"type":"string","description":"Application phase4 periods"},"application_phase4_start":{"type":"string","description":"Application phase4 start"},"application_phase5_application_procedure":{"type":"array","description":"Application phase5 application procedure","items":{"type":"string","description":"Application phase5 application procedure"}},"application_phase5_end":{"type":"string","description":"Application phase5 end"},"application_phase5_model":{"type":"string","description":"Application phase5 model"},"application_phase5_name":{"type":"string","description":"Application phase5 name"},"application_phase5_periods":{"type":"string","description":"Application phase5 periods"},"application_phase5_start":{"type":"string","description":"Application phase5 start"},"application_phase6_application_procedure":{"type":"array","description":"Application phase6 application procedure","items":{"type":"string","description":"Application phase6 application procedure"}},"application_phase6_end":{"type":"string","description":"Application phase6 end"},"application_phase6_model":{"type":"string","description":"Application phase6 model"},"application_phase6_name":{"type":"string","description":"Application phase6 name"},"application_phase6_periods":{"type":"string","description":"Application phase6 periods"},"application_phase6_start":{"type":"string","description":"Application phase6 start"},"application_phase7_application_procedure":{"type":"array","description":"Application phase7 application procedure","items":{"type":"string","description":"Application phase7 application procedure"}},"application_phase7_end":{"type":"string","description":"Application phase7 end"},"application_phase7_model":{"type":"string","description":"Application phase7 model"},"application_phase7_name":{"type":"string","description":"Application phase7 name"},"application_phase7_periods":{"type":"string","description":"Application phase7 periods"},"application_phase7_start":{"type":"string","description":"Application phase7 start"},"application_phase8_application_procedure":{"type":"array","description":"Application phase8 application procedure","items":{"type":"string","description":"Application phase8 application procedure"}},"application_phase8_end":{"type":"string","description":"Application phase8 end"},"application_phase8_model":{"type":"string","description":"Application phase8 model"},"application_phase8_name":{"type":"string","description":"Application phase8 name"},"application_phase8_periods":{"type":"string","description":"Application phase8 periods"},"application_phase8_start":{"type":"string","description":"Application phase8 start"},"application_phase9_application_procedure":{"type":"array","description":"Application phase9 application procedure","items":{"type":"string","description":"Application phase9 application procedure"}},"application_phase9_end":{"type":"string","description":"Application phase9 end"},"application_phase9_model":{"type":"string","description":"Application phase9 model"},"application_phase9_name":{"type":"string","description":"Application phase9 name"},"application_phase9_start":{"type":"string","description":"Application phase9 start"},"auth_code":{"type":"string","description":"Transfer require Auth code"},"auth_code_maximum_length":{"type":"integer","format":"int32","description":"The maximum auth code length"},"auth_code_minimum_length":{"type":"integer","format":"int32","description":"The minimum auth code length"},"auth_code_required_chars":{"type":"string","description":"Required chars for auth code"},"auth_domain":{"type":"string","nullable":true,"description":"Auth domain"},"authoritative_renewal_confirmation":{"type":"array","description":"Authoritative renewal confirmation","items":{"type":"string","description":"Authoritative renewal confirmation"}},"auto_approved_transfers":{"type":"string","description":"Auto approved transfers"},"auto_renew_grace_period":{"type":"string","description":"Auto renew grace period"},"auto_renew_grace_period_days":{"type":"string","description":"The auto renew grace period days"},"basic_internal_notes":{"type":"string","description":"Basic internal notes"},"best_renewed_before":{"type":"string","description":"Best renewed before"},"country":{"type":"string","description":"Country"},"country_capital":{"type":"string","description":"Country capital"},"country_currency":{"type":"string","description":"Country currency"},"country_html_description":{"type":"string","description":"Country html description"},"country_html_keywords":{"type":"string","description":"Country html keywords"},"country_html_title":{"type":"string","description":"Country html title"},"country_info":{"type":"array","description":"Country info","items":{"type":"string","description":"Country info"}},"country_name":{"type":"string","description":"Country name"},"country_official_language":{"type":"string","description":"Country official language"},"currency":{"type":"string","description":"Currency"},"delete_restore_possible":{"type":"string","description":"Restore after Deletion is possible."},"delete_restore_procedure":{"type":"array","description":"Restore procedure.","items":{"type":"string","description":"Restore procedure."}},"deletion_internal_notes":{"type":"string","description":"Deletion internal notes"},"deletion_possible":{"type":"string","description":"Deletion possible."},"deletion_procedure":{"type":"array","description":"Deletion procedure.","items":{"type":"string","description":"Deletion procedure."}},"deletion_timeframe":{"type":"string","description":"Deletion timeframe."},"difficulty":{"type":"integer","format":"int32","description":"Difficulty"},"direct_accreditation":{"type":"string","description":"Direct accreditation"},"dispute_policy":{"type":"array","description":"Dispute Policy of the Registry.","items":{"type":"string","description":"Dispute Policy of the Registry."}},"dispute_policy_url":{"type":"string","description":"URL to Dispute Policy of the Registry."},"dns_configuration":{"type":"string","description":"DNS configuration: Information about DNS configuration, if applicable."},"document_links":{"type":"array","description":"Links to documents.","items":{"type":"string","description":"Links to documents."}},"domain_bundling":{"type":"string","description":"Domain bundling: TLD is bundled to another TLD. (Example: NGO/ONG)"},"expiration_date_after_renewals":{"type":"string","description":"Expiration date after renewals"},"expiration_date_after_transfer_renewals":{"type":"string","description":"Expiration date after transfer renewals"},"foa_email":{"type":"string","description":"FOA required"},"general_information":{"type":"array","description":"General information","items":{"type":"string","nullable":true,"description":"General information"}},"general_registration_info":{"type":"array","description":"General registration info","items":{"type":"string","description":"General registration info"}},"handles_updateable":{"type":"string","description":"Supports handle updates."},"has_dispute_policy":{"type":"string","description":"Has dispute policy"},"has_premium_domains":{"type":"string","description":"Premium domain registration possible"},"html_description":{"type":"string","description":"Html description"},"html_keywords":{"type":"string","description":"Html keywords"},"html_title":{"type":"string","description":"Html title"},"idn":{"type":"string","description":"TLD is IDN capable.: TLD is IDN capable."},"idn_allowed_characters":{"type":"string","description":"IDN allowed characters: Allowed characters for IDN domains."},"idn_autodetect_language_tag":{"type":"string","description":"Idn autodetect language tag"},"idn_info":{"type":"array","description":"IDN information: IDN information.","items":{"type":"string","description":"IDN information: IDN information."}},"idn_language_name0":{"type":"string","description":"Idn language name0"},"idn_language_restrictions":{"type":"string","description":"IDN language restrictions: Restrictions for IDN domains."},"idn_language_tags":{"type":"string","description":"Possible IDN tags: List of supported language tags."},"idn_requires_language_tag":{"type":"string","description":"IDN language tag required on registration: Requires language tag for IDN domains."},"idn_requires_language_tag_on_check":{"type":"string","description":"IDN language tag required on check domain: API Command: CheckDomain requires language tag for checking IDN domains."},"idn_script":{"type":"string","description":"Idn script"},"idn_setup_fee":{"type":"string","description":"Idn setup fee"},"idn_translation":{"type":"string","description":"Idn translation"},"idn_transliteration":{"type":"string","description":"Idn transliteration"},"is_fulfillment_tld":{"type":"string","description":"Is fulfillment tld"},"is_generic":{"type":"string","description":"Is generic: Type of the TLD: ccTLD, gTLD, new gTLD."},"is_ntld":{"type":"string","description":"Is ntld"},"is_restore_possible":{"type":"string","description":"Is domain restore possible"},"local_admin":{"type":"string","description":"Local admin"},"local_billing":{"type":"string","description":"Local billing"},"local_owner":{"type":"string","description":"Local owner"},"local_presence":{"type":"string","description":"Local presence"},"local_presence_countries":{"type":"string","description":"Local presence countries"},"local_presence_info":{"type":"array","description":"Local presence info","items":{"type":"string","description":"Local presence info"}},"local_presence_process":{"type":"array","description":"Local presence process","items":{"type":"string","description":"Local presence process"}},"local_tech":{"type":"string","description":"Local tech"},"maximum_domain_length":{"type":"integer","format":"int32","description":"The maximum domain name length"},"maximum_nameserver_ips":{"type":"string","description":"Maximum nameserver ips"},"maximum_nameservers":{"type":"string","description":"Maximum nameservers"},"maximum_term":{"type":"string","description":"Maximum term"},"minimum_domain_length":{"type":"integer","format":"int32","description":"The minimum domain name length"},"minimum_nameserver_ips":{"type":"string","description":"Minimum nameserver ips"},"minimum_nameservers":{"type":"string","description":"Minimum nameservers"},"minimum_term":{"type":"string","description":"Minimum term"},"modify_info":{"type":"array","description":"Information for domain modifications.","items":{"type":"string","description":"Information for domain modifications."}},"nameserver_required":{"type":"string","description":"Nameservers are required"},"ntld_categories":{"type":"string","description":"TLD Categories: Category for this TLD."},"ntld_html_description":{"type":"string","description":"Ntld html description"},"ntld_html_keywords":{"type":"string","description":"Ntld html keywords"},"ntld_html_title":{"type":"string","description":"Ntld html title"},"ntld_registry_urls":{"type":"array","description":"Ntld registry urls","items":{"type":"string","description":"Ntld registry urls"}},"number_of_domains":{"type":"string","description":"Number of domains"},"number_of_domains_allowed_to_register":{"type":"string","description":"Number of domains allowed to register"},"number_of_domains_allowed_to_register_is_limited":{"type":"string","description":"Number of domains allowed to register is limited"},"ownerchange_process":{"type":"string","description":"Ownerchange process"},"parent_tld":{"type":"string","description":"Parent TLD: Parent TLD for this TLD, if applicable."},"pending_delete":{"type":"string","description":"Pending delete"},"pending_delete_days":{"type":"string","description":"Pending delete days"},"pending_deletion_timeframe":{"type":"string","description":"Pending deletion timeframe"},"periods":{"type":"string","description":"Registration Periods."},"preconfigured_dns":{"type":"string","description":"Preconfigured DNS required: Requires pre-configured DNS."},"premium_domain_info":{"type":"array","description":"Premium domain information","items":{"type":"string","description":"Premium domain information"}},"premium_names":{"type":"string","description":"Premium names"},"premium_setup_fee":{"type":"string","description":"Premium setup fee"},"private_reg_allowed":{"type":"string","description":"Private reg allowed"},"prohibited_names":{"type":"array","description":"Prohibited names","items":{"type":"string","description":"Prohibited names"}},"realtime":{"type":"integer","format":"int32","description":"Realtime"},"redemption_period":{"type":"string","description":"Redemption period"},"redemption_period_days":{"type":"string","description":"Redemption period days"},"registration_periods":{"type":"string","description":"Registration periods"},"registration_possible":{"type":"string","description":"Registration possible"},"registration_procedure":{"type":"array","description":"Registration procedure","items":{"type":"string","description":"Registration procedure"}},"registration_requires_business_registration_certificate":{"type":"string","description":"Registration requires business registration certificate"},"registration_requires_business_registration_number":{"type":"string","description":"Registration requires business registration number"},"registration_requires_personal_id_number":{"type":"string","description":"Registration requires personal id number"},"registration_requires_trademark":{"type":"string","description":"Registration requires trademark"},"registration_requires_vat_id":{"type":"string","description":"Registration requires vat id"},"registration_system":{"type":"array","description":"Registration system","items":{"type":"string","description":"Registration system"}},"registration_time":{"type":"string","description":"Registration time"},"registry_account_email":{"type":"string","description":"Registry account email"},"registry_add_grace_period":{"type":"string","description":"Registry add grace period"},"registry_allows_whois_privacy":{"type":"string","description":"Registry allows whois privacy"},"registry_auto_renew_grace_period_days":{"type":"string","description":"Registry auto renew grace period days"},"registry_contact":{"type":"array","description":"Registry contact","items":{"type":"string","description":"Registry contact"}},"registry_deletion_timeframe":{"type":"string","description":"Registry deletion timeframe"},"registry_lock_possible":{"type":"string","description":"Registry lock possible: TLD offer registry lock."},"registry_logo":{"type":"string","description":"Registry logo"},"registry_name":{"type":"string","description":"Registry name"},"registry_offers_local_presence":{"type":"string","description":"Registry offers local presence"},"registry_offers_trustee":{"type":"string","description":"Registry offers trustee"},"registry_redemption_period":{"type":"string","description":"Registry redemption period"},"registry_type":{"type":"string","description":"Registry type"},"registry_url":{"type":"string","description":"Registry url"},"renew_grace_period_info":{"type":"array","description":"Renew grace period info","items":{"type":"string","description":"Renew grace period info"}},"renewal_after_transfer":{"type":"string","description":"Renew after transfer"},"renewal_at_trade":{"type":"string","description":"Renew at trade"},"renewal_at_transfer":{"type":"string","description":"Renewal at transfer"},"renewal_by_autorenew":{"type":"string","description":"Renewal by autorenew"},"renewal_by_bank_transfer":{"type":"string","description":"Renewal by bank transfer"},"renewal_by_credit_card":{"type":"string","description":"Renewal by credit card"},"renewal_by_invoice":{"type":"string","description":"Renewal by invoice"},"renewal_by_manual":{"type":"string","description":"Renewal by manual"},"renewal_by_none":{"type":"string","description":"Renewal by none"},"renewal_by_top_off_account":{"type":"string","description":"Renewal by top off account"},"renewal_internal_notes":{"type":"array","description":"Renewal internal notes","items":{"type":"string","description":"Renewal internal notes"}},"renewal_periods":{"type":"string","description":"Renewal periods"},"renewal_procedure":{"type":"array","description":"Renewal procedure","items":{"type":"string","nullable":true,"description":"Renewal procedure"}},"renewal_term":{"type":"string","description":"Renewal term"},"required_contacts":{"type":"string","description":"Required contacts"},"requires_a_or_cname_record":{"type":"string","description":"Requires A or CNAME record."},"requires_mx_record":{"type":"string","description":"Requires MX record."},"requires_personal_admin_contact":{"type":"string","description":"Requires personal admin contact"},"requires_personal_owner_contact":{"type":"string","description":"Requires personal owner contact"},"requires_personal_tech_contact":{"type":"string","description":"Requires personal tech contact"},"requires_soa_record":{"type":"string","description":"Requires SOA record."},"requires_working_email":{"type":"string","description":"Requires working email address."},"reserved_names":{"type":"array","description":"Reserved names","items":{"type":"string","description":"Reserved names"}},"restore_internal_notes":{"type":"string","description":"Restore internal notes"},"restore_procedure":{"type":"array","description":"Restore procedure","items":{"type":"string","description":"Restore procedure"}},"restrictions":{"type":"array","description":"Restrictions","items":{"type":"string","description":"Restrictions"}},"rrp_proxy_support":{"type":"string","description":"Automation level: Full = Full automisation. Partial = Partial automisation. None = Not supported."},"rrp_supports_delete":{"type":"string","description":"Deletion possible."},"rrp_supports_dnssec":{"type":"string","description":"Rrp supports dnssec"},"rrp_supports_modify":{"type":"string","description":"Modification possible."},"rrp_supports_registration":{"type":"string","description":"Registration possible."},"rrp_supports_renewal":{"type":"string","description":"Explicit Renewal possible."},"rrp_supports_restore":{"type":"string","description":"Restore Possible."},"rrp_supports_trade":{"type":"string","description":"Rrp supports trade"},"rrp_supports_transfer":{"type":"string","description":"Transfer possible."},"rrp_supports_whois_privacy":{"type":"string","description":"TLD allows registrations using WhoIs Privacy."},"supported_contacts":{"type":"string","description":"Supported contacts"},"supported_dnssec_algorithms":{"type":"string","description":"Supported dnssec algorithms"},"supported_dnssec_dsdata_algorithms":{"type":"string","description":"Supported dnssec dsdata algorithms"},"supported_dnssec_dsdata_digest_types":{"type":"string","description":"Supported dnssec dsdata digest types"},"supports_backordering":{"type":"string","description":"Supports backordering"},"supports_client_delete_prohibited":{"type":"string","description":"Support delete lock"},"supports_client_hold":{"type":"string","description":"Support client hold"},"supports_client_renew_prohibited":{"type":"string","description":"Support renew lock"},"supports_client_transfer_prohibited":{"type":"string","description":"Support transfer lock"},"supports_client_update_prohibited":{"type":"string","description":"Support update lock"},"supports_contact_disclosure":{"type":"string","description":"Supports contact disclosure"},"supports_dnssec":{"type":"string","description":"Supports DNSSEC keydata: Supports DNSSEC. KEYDATA is always supported."},"supports_dnssec_dsdata":{"type":"string","description":"Supports DNSSEC dsdata: Supports DSDATA. (KEYDATA is always supported.)"},"supports_idn":{"type":"string","description":"Supports idn"},"supports_ipv6":{"type":"string","description":"Supports IPv6 Nameserver."},"supports_transfer_approve":{"type":"string","description":"Support transfer approve"},"supports_transfer_cancel":{"type":"string","description":"Support transfer cancel"},"supports_transfer_deny":{"type":"string","description":"Support transfer deny"},"supports_transfer_locks":{"type":"string","description":"Supports transfer locks"},"supports_trustee":{"type":"string","description":"Supports trustee"},"tag":{"type":"array","description":"Category: Categories for this TLD.","items":{"type":"string","description":"Category: Categories for this TLD."}},"terms_and_conditions":{"type":"array","description":"Terms and conditions","items":{"type":"string","description":"Terms and conditions"}},"terms_and_conditions_url":{"type":"string","description":"Terms and conditions URL"},"tld_type":{"type":"string","description":"Tld type"},"tld_zone_propagation_time":{"type":"string","description":"Tld zone propagation time"},"trade_internal_notes":{"type":"string","description":"Trade internal notes"},"trade_procedure":{"type":"array","description":"Trade procedure","items":{"type":"string","description":"Trade procedure"}},"trade_resets_registration_period":{"type":"string","description":"Trade resets registration period"},"trademark_jurisdictions":{"type":"string","description":"Trademark jurisdictions"},"trademark_juristications":{"type":"string","description":"Trademark juristications"},"transfer_default_renew_period":{"type":"string","description":"Transfer renew period"},"transfer_internal_notes":{"type":"string","description":"Transfer internal notes"},"transfer_periods":{"type":"string","description":"Transfer periods"},"transfer_procedure":{"type":"array","description":"Transfer procedure","items":{"type":"string","description":"Transfer procedure"}},"transfer_required_contacts":{"type":"string","description":"Transfer required contacts"},"transfer_resets_registration_period":{"type":"string","description":"Transfer resets registration period"},"transfer_supported_contacts":{"type":"string","description":"Transfer supported contacts"},"transfer_supported_nameservers":{"type":"integer","format":"int32","description":"Transfer supported nameservers"},"transfer_time":{"type":"string","description":"Transfer time"},"translation_progress":{"type":"string","description":"Translation progress"},"trustee_info":{"type":"array","description":"Trustee info","items":{"type":"string","description":"Trustee info"}},"trustee_process":{"type":"array","description":"Trustee process","items":{"type":"string","description":"Trustee process"}},"url_for_idn_information_at_registry":{"type":"string","description":"URL for IDN information at Registry.: URL for IDN information at Registry."},"web_whois_url":{"type":"string","description":"Web whois url"},"whois_rsp":{"type":"string","description":"Whois RSP"},"whois_server":{"type":"string","description":"Whois server"},"whois_update":{"type":"string","description":"Whois update"},"whois_update_realtime":{"type":"string","description":"Whois update realtime"},"whois_update_time":{"type":"string","description":"Whois update time"},"wiki_teaser":{"type":"array","description":"Wiki teaser","items":{"type":"string","description":"Wiki teaser"}},"zone":{"type":"string","description":"Zone"},"zone_check_tool_url":{"type":"string","description":"URL to zone check tool.: URL to zone check tool."},"zone_info":{"type":"array","description":"Information for this TLD.","items":{"type":"string","description":"Information for this TLD."}},"zone_use":{"type":"array","description":"Zone use","items":{"type":"string","description":"Zone use"}}}}}}]}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ptf-command":"GetZoneInfo"}}},"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"cltrid":{"type":"string","description":"Client transaction ID"},"code":{"type":"integer","format":"int32","description":"Response code","example":"549"},"description":{"type":"string","description":"Response description","example":"Command failed"},"property":{"type":"object"},"queuetime":{"type":"number","format":"float","description":"Command queuing time","example":0.001},"reason":{"type":"string","description":"Response reason","example":"Invalid parameter"},"runtime":{"type":"number","format":"float","description":"Command running time","example":0.001},"svtrid":{"type":"string","description":"Server transaction ID"}}},"SuccessResponse":{"type":"object","properties":{"cltrid":{"type":"string","description":"Client transaction ID"},"code":{"type":"integer","format":"int32","description":"Response code","example":"200"},"description":{"type":"string","example":"Command completed successfully"},"queuetime":{"type":"number","format":"float","description":"Command queuing time","example":0.001},"reason":{"type":"string","description":"Response reason","example":"Action is pending"},"runtime":{"type":"number","format":"float","description":"Command running time","example":0.001},"svtrid":{"type":"string","description":"Server transaction ID"}}}}},"security":[{"BasicAuth":[]},{"bearerAuth":[]}]}