{ "info": { "_postman_id": "4e213d03-2ed6-4175-9c06-150434e5d01e", "name": "Domains.co.za API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Authentication", "item": [ { "name": "Authentication", "request": { "method": "POST", "header": [], "url": { "raw": "{{URL}}/login?username=The Username to authenticate&password=The Password to authenticate", "host": [ "{{URL}}" ], "path": [ "login" ], "query": [ { "key": "username", "value": "The Username to authenticate", "description": "Required : yes" }, { "key": "password", "value": "The Password to authenticate", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Create 2FA secret", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/user/generateAuthSecret", "host": [ "{{URL}}" ], "path": [ "user", "generateAuthSecret" ] } }, "response": [] }, { "name": "Enable 2FA", "request": { "method": "POST", "header": [], "url": { "raw": "{{URL}}/user/enableAuth?code=Code from your 2 factor authentication APP", "host": [ "{{URL}}" ], "path": [ "user", "enableAuth" ], "query": [ { "key": "code", "value": "Code from your 2 factor authentication APP", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Disable 2FA", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/user/disableAuth", "host": [ "{{URL}}" ], "path": [ "user", "disableAuth" ] } }, "response": [] }, { "name": "Get 2FA status", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/user/authStatus", "host": [ "{{URL}}" ], "path": [ "user", "authStatus" ] } }, "response": [] } ] }, { "name": "Domain", "item": [ { "name": "check", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/check?tld=SLD to check&sld=TLD to check", "host": [ "{{URL}}" ], "path": [ "domain", "check" ], "query": [ { "key": "tld", "value": "SLD to check", "description": "Required : yes" }, { "key": "sld", "value": "TLD to check", "description": "Required : yes" } ] } }, "response": [] }, { "name": "list", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/list?tld=TLD to filter the list on", "host": [ "{{URL}}" ], "path": [ "domain", "list" ], "query": [ { "key": "tld", "value": "TLD to filter the list on", "description": "Required : no" } ] } }, "response": [] }, { "name": "Info", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Create", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain?sld=SLD of the domain in question&tld=TLD of the domain in question&period=The number of years to register the domain&nsTemplate=Nameserver template to use instead of specifying servers manually.&dns=Select managed to use Domains Premium DNS and custom to use details provided in ns1,ns2, ...&ns1=First nameserver to be used by your domain&ns2=Second nameserver to be used by your domain&ns3=Third nameserver to be used by your domain&ns4=Fourth nameserver to be used by your domain&ns5=Fifth nameserver to be used by your domain®istrantTemplate=The registrant contact template to use instead of specifying details manually®istrantName=The registrant contact persons name®istrantEmail=The registrant contact persons email address®istrantCountry=The registrant contact persons country in ISO 3166-1 alpha-2 code®istrantProvince=The registrant contact persons state or province®istrantContactNumber=The registrant contact persons contact number®istrantPostalCode=The registrant contact persons area or postal code®istrantAddress1=The registrant contact persons address line 1®istrantAddress2=The registrant contact persons address line 2®istrantAddress3=The registrant contact persons address line 3®istrantCity=The registrant contact persons city&adminTemplate=The registrant contact template to use instead of specifying details manually&adminName=The admin contact persons name&adminEmail=The admin contact persons email address&adminCountry=The admin contact persons country in ISO 3166-1 alpha-2 code&adminProvince=The admin contact persons state or province&adminContactNumber=The admin contact persons contact number&adminPostalCode=The admin contact persons area or postal code&adminAddress1=The admin contact persons address line 1&adminAddress2=The admin contact persons address line 2&adminAddress3=The admin contact persons address line 3&adminCity=The admin contact persons city&billingTemplate=The billing contact template to use instead of specifying details manually&billingName=The billing contact persons name&billingEmail=The billing contact persons email address&billingCountry=The billing contact persons country in ISO 3166-1 alpha-2 code&billingProvince=The billing contact persons state or province&billingContactNumber=The billing contact persons contact number&billingPostalCode=The billing contact persons area or postal code&billingAddress1=The billing contact persons address line 1&billingAddress2=The billing contact persons address line 2&billingAddress3=The billing contact persons address line 3&billingCity=The billing contact persons city&techTemplate=The tech contact template to use instead of specifying details manually&techName=The tech contact persons name&techEmail=The tech contact persons email address&techCountry=The tech contact persons country in ISO 3166-1 alpha-2 code&techProvince=The tech contact persons state or province&techContactNumber=The tech contact persons contact number&techPostalCode=The tech contact persons area or postal code&techAddress1=The tech contact persons address line 1&techAddress2=The tech contact persons address line 2&techAddress3=The tech contact persons address line 3&techCity=The tech contact persons city", "host": [ "{{URL}}" ], "path": [ "domain" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "period", "value": "The number of years to register the domain", "description": "Required : yes" }, { "key": "nsTemplate", "value": "Nameserver template to use instead of specifying servers manually.", "description": "Required : no" }, { "key": "dns", "value": "Select managed to use Domains Premium DNS and custom to use details provided in ns1,ns2, ...", "description": "Required : no" }, { "key": "ns1", "value": "First nameserver to be used by your domain", "description": "Required : no" }, { "key": "ns2", "value": "Second nameserver to be used by your domain", "description": "Required : no" }, { "key": "ns3", "value": "Third nameserver to be used by your domain", "description": "Required : no" }, { "key": "ns4", "value": "Fourth nameserver to be used by your domain", "description": "Required : no" }, { "key": "ns5", "value": "Fifth nameserver to be used by your domain", "description": "Required : no" }, { "key": "registrantTemplate", "value": "The registrant contact template to use instead of specifying details manually", "description": "Required : no" }, { "key": "registrantName", "value": "The registrant contact persons name", "description": "Required : no" }, { "key": "registrantEmail", "value": "The registrant contact persons email address", "description": "Required : no" }, { "key": "registrantCountry", "value": "The registrant contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : no" }, { "key": "registrantProvince", "value": "The registrant contact persons state or province", "description": "Required : no" }, { "key": "registrantContactNumber", "value": "The registrant contact persons contact number", "description": "Required : no" }, { "key": "registrantPostalCode", "value": "The registrant contact persons area or postal code", "description": "Required : no" }, { "key": "registrantAddress1", "value": "The registrant contact persons address line 1", "description": "Required : no" }, { "key": "registrantAddress2", "value": "The registrant contact persons address line 2", "description": "Required : no" }, { "key": "registrantAddress3", "value": "The registrant contact persons address line 3", "description": "Required : no" }, { "key": "registrantCity", "value": "The registrant contact persons city", "description": "Required : no" }, { "key": "adminTemplate", "value": "The registrant contact template to use instead of specifying details manually", "description": "Required : no" }, { "key": "adminName", "value": "The admin contact persons name", "description": "Required : no" }, { "key": "adminEmail", "value": "The admin contact persons email address", "description": "Required : no" }, { "key": "adminCountry", "value": "The admin contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : no" }, { "key": "adminProvince", "value": "The admin contact persons state or province", "description": "Required : no" }, { "key": "adminContactNumber", "value": "The admin contact persons contact number", "description": "Required : no" }, { "key": "adminPostalCode", "value": "The admin contact persons area or postal code", "description": "Required : no" }, { "key": "adminAddress1", "value": "The admin contact persons address line 1", "description": "Required : no" }, { "key": "adminAddress2", "value": "The admin contact persons address line 2", "description": "Required : no" }, { "key": "adminAddress3", "value": "The admin contact persons address line 3", "description": "Required : no" }, { "key": "adminCity", "value": "The admin contact persons city", "description": "Required : no" }, { "key": "billingTemplate", "value": "The billing contact template to use instead of specifying details manually", "description": "Required : no" }, { "key": "billingName", "value": "The billing contact persons name", "description": "Required : no" }, { "key": "billingEmail", "value": "The billing contact persons email address", "description": "Required : no" }, { "key": "billingCountry", "value": "The billing contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : no" }, { "key": "billingProvince", "value": "The billing contact persons state or province", "description": "Required : no" }, { "key": "billingContactNumber", "value": "The billing contact persons contact number", "description": "Required : no" }, { "key": "billingPostalCode", "value": "The billing contact persons area or postal code", "description": "Required : no" }, { "key": "billingAddress1", "value": "The billing contact persons address line 1", "description": "Required : no" }, { "key": "billingAddress2", "value": "The billing contact persons address line 2", "description": "Required : no" }, { "key": "billingAddress3", "value": "The billing contact persons address line 3", "description": "Required : no" }, { "key": "billingCity", "value": "The billing contact persons city", "description": "Required : no" }, { "key": "techTemplate", "value": "The tech contact template to use instead of specifying details manually", "description": "Required : no" }, { "key": "techName", "value": "The tech contact persons name", "description": "Required : no" }, { "key": "techEmail", "value": "The tech contact persons email address", "description": "Required : no" }, { "key": "techCountry", "value": "The tech contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : no" }, { "key": "techProvince", "value": "The tech contact persons state or province", "description": "Required : no" }, { "key": "techContactNumber", "value": "The tech contact persons contact number", "description": "Required : no" }, { "key": "techPostalCode", "value": "The tech contact persons area or postal code", "description": "Required : no" }, { "key": "techAddress1", "value": "The tech contact persons address line 1", "description": "Required : no" }, { "key": "techAddress2", "value": "The tech contact persons address line 2", "description": "Required : no" }, { "key": "techAddress3", "value": "The tech contact persons address line 3", "description": "Required : no" }, { "key": "techCity", "value": "The tech contact persons city", "description": "Required : no" } ] } }, "response": [] }, { "name": "Delete", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/domain?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Update Contacts", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "PUT", "header": [], "url": { "raw": "{{URL}}/domain?sld=SLD of the domain in question&tld=TLD of the domain in question®istrantTemplate=The registrant contact template to use instead of specifying details manually®istrantName=The registrant contact persons name®istrantEmail=The registrant contact persons email address®istrantCountry=The registrant contact persons country in ISO 3166-1 alpha-2 code®istrantProvince=The registrant contact persons state or province®istrantContactNumber=The registrant contact persons contact number®istrantPostalCode=The registrant contact persons area or postal code®istrantAddress1=The registrant contact persons address line 1:Required : Required : no®istrantAddress2=The registrant contact persons address line 2®istrantAddress3=The registrant contact persons address line 3®istrantCity=The registrant contact persons city&adminTemplate=The admin contact template to use instead of specifying details manually&adminName=The admin contact persons name&adminEmail=The admin contact persons email address&adminCountry=The admin contact persons country in ISO 3166-1 alpha-2 code&adminProvince=The admin contact persons state or province&adminContactNumber=The admin contact persons contact number&adminPostalCode=The admin contact persons area or postal code&adminAddress1=The admin contact persons address line 1&adminAddress2=The admin contact persons address line 2&adminAddress3=The admin contact persons address line 3&adminCity=The admin contact persons city&billingTemplate=The billing contact template to use instead of specifying details manually&billingName=The billing contact persons name&billingEmail=The billing contact persons email address&billingCountry=The billing contact persons country in ISO 3166-1 alpha-2 code&billingProvince=The billing contact persons state or province&billingContactNumber=The billing contact persons contact number&billingPostalCode=The billing contact persons area or postal code&billingAddress1=The billing contact persons address line 1&billingAddress2=The billing contact persons address line 2&billingAddress3=The billing contact persons address line 3&billingCity=The billing contact persons city&techTemplate=The tech contact template to use instead of specifying details manually&techName=The tech contact persons name&techEmail=The tech contact persons email address&techCountry=The tech contact persons country in ISO 3166-1 alpha-2 code&techProvince=The tech contact persons state or province&techContactNumber=The tech contact persons contact number&techPostalCode=The tech contact persons area or postal code&techAddress1=The tech contact persons address line 1&techAddress2=The tech contact persons address line 2&techAddress3=The tech contact persons address line 3&techCity=The tech contact persons city", "host": [ "{{URL}}" ], "path": [ "domain" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "registrantTemplate", "value": "The registrant contact template to use instead of specifying details manually", "description": "Required : no" }, { "key": "registrantName", "value": "The registrant contact persons name", "description": "Required : no" }, { "key": "registrantEmail", "value": "The registrant contact persons email address", "description": "Required : no" }, { "key": "registrantCountry", "value": "The registrant contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : no" }, { "key": "registrantProvince", "value": "The registrant contact persons state or province", "description": "Required : no" }, { "key": "registrantContactNumber", "value": "The registrant contact persons contact number", "description": "Required : no" }, { "key": "registrantPostalCode", "value": "The registrant contact persons area or postal code", "description": "Required : no" }, { "key": "registrantAddress1", "value": "The registrant contact persons address line 1:Required : Required : no", "description": "Required : no" }, { "key": "registrantAddress2", "value": "The registrant contact persons address line 2", "description": "Required : no" }, { "key": "registrantAddress3", "value": "The registrant contact persons address line 3", "description": "Required : no" }, { "key": "registrantCity", "value": "The registrant contact persons city", "description": "Required : no" }, { "key": "adminTemplate", "value": "The admin contact template to use instead of specifying details manually", "description": "Required : no" }, { "key": "adminName", "value": "The admin contact persons name", "description": "Required : no" }, { "key": "adminEmail", "value": "The admin contact persons email address", "description": "Required : no" }, { "key": "adminCountry", "value": "The admin contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : no" }, { "key": "adminProvince", "value": "The admin contact persons state or province", "description": "Required : no" }, { "key": "adminContactNumber", "value": "The admin contact persons contact number", "description": "Required : no" }, { "key": "adminPostalCode", "value": "The admin contact persons area or postal code", "description": "Required : no" }, { "key": "adminAddress1", "value": "The admin contact persons address line 1", "description": "Required : no" }, { "key": "adminAddress2", "value": "The admin contact persons address line 2", "description": "Required : no" }, { "key": "adminAddress3", "value": "The admin contact persons address line 3", "description": "Required : no" }, { "key": "adminCity", "value": "The admin contact persons city", "description": "Required : no" }, { "key": "billingTemplate", "value": "The billing contact template to use instead of specifying details manually", "description": "Required : no" }, { "key": "billingName", "value": "The billing contact persons name", "description": "Required : no" }, { "key": "billingEmail", "value": "The billing contact persons email address", "description": "Required : no" }, { "key": "billingCountry", "value": "The billing contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : no" }, { "key": "billingProvince", "value": "The billing contact persons state or province", "description": "Required : no" }, { "key": "billingContactNumber", "value": "The billing contact persons contact number", "description": "Required : no" }, { "key": "billingPostalCode", "value": "The billing contact persons area or postal code", "description": "Required : no" }, { "key": "billingAddress1", "value": "The billing contact persons address line 1", "description": "Required : no" }, { "key": "billingAddress2", "value": "The billing contact persons address line 2", "description": "Required : no" }, { "key": "billingAddress3", "value": "The billing contact persons address line 3", "description": "Required : no" }, { "key": "billingCity", "value": "The billing contact persons city", "description": "Required : no" }, { "key": "techTemplate", "value": "The tech contact template to use instead of specifying details manually", "description": "Required : no" }, { "key": "techName", "value": "The tech contact persons name", "description": "Required : no" }, { "key": "techEmail", "value": "The tech contact persons email address", "description": "Required : no" }, { "key": "techCountry", "value": "The tech contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : no" }, { "key": "techProvince", "value": "The tech contact persons state or province", "description": "Required : no" }, { "key": "techContactNumber", "value": "The tech contact persons contact number", "description": "Required : no" }, { "key": "techPostalCode", "value": "The tech contact persons area or postal code", "description": "Required : no" }, { "key": "techAddress1", "value": "The tech contact persons address line 1", "description": "Required : no" }, { "key": "techAddress2", "value": "The tech contact persons address line 2", "description": "Required : no" }, { "key": "techAddress3", "value": "The tech contact persons address line 3", "description": "Required : no" }, { "key": "techCity", "value": "The tech contact persons city", "description": "Required : no" } ] } }, "response": [] }, { "name": "Update Nameservers", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/ns?sld=SLD of the domain in question&tld=TLD of the domain in question&nsTemplate=Nameserver template to use instead of specifying servers manually&dns=Defaults to custom. Set to managed to make use of Domains Premium DNS&ns1=First nameserver to be used if dns = 'custom'&ns2=Second nameserver to be used if dns = 'custom'&ns3=Third nameserver to be used if dns = 'custom'&ns4=Fourth nameserver to be used if dns = 'custom'&ns5=Fifth nameserver to be used if dns = 'custom'&dnsSec=Whether or not DNSSec should be used&dnsSecData=Base64 encoded Json string of DNSSec data", "host": [ "{{URL}}" ], "path": [ "domain", "ns" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "nsTemplate", "value": "Nameserver template to use instead of specifying servers manually", "description": "Required : no" }, { "key": "dns", "value": "Defaults to custom. Set to managed to make use of Domains Premium DNS", "description": "Required : no" }, { "key": "ns1", "value": "First nameserver to be used if dns = 'custom'", "description": "Required : no" }, { "key": "ns2", "value": "Second nameserver to be used if dns = 'custom'", "description": "Required : no" }, { "key": "ns3", "value": "Third nameserver to be used if dns = 'custom'", "description": "Required : no" }, { "key": "ns4", "value": "Fourth nameserver to be used if dns = 'custom'", "description": "Required : no" }, { "key": "ns5", "value": "Fifth nameserver to be used if dns = 'custom'", "description": "Required : no" }, { "key": "dnsSec", "value": "Whether or not DNSSec should be used", "description": "Required : no" }, { "key": "dnsSecData", "value": "Base64 encoded Json string of DNSSec data", "description": "Required : no" } ] } }, "response": [] }, { "name": "Autorenew", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/autorenew?sld=SLD of the domain in question&tld=TLD of the domain in question&autorenew=Either true or false", "host": [ "{{URL}}" ], "path": [ "domain", "autorenew" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "autorenew", "value": "Either true or false", "description": "Required : no" } ] } }, "response": [] }, { "name": "Renew", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/renew?sld=SLD of the domain in question&tld=TLD of the domain in question&period=Defaults to 1¬e=Customized note to go with renewal. This will display in billing history", "host": [ "{{URL}}" ], "path": [ "domain", "renew" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "period", "value": "Defaults to 1", "description": "Required : no" }, { "key": "note", "value": "Customized note to go with renewal. This will display in billing history", "description": "Required : no" } ] } }, "response": [] }, { "name": "Lock", "request": { "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/lock?sld=SLD of the domain in question&tld=TLD of the domain in question&action=Can be either lock or unlock", "host": [ "{{URL}}" ], "path": [ "domain", "lock" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "action", "value": "Can be either lock or unlock", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Get lock Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/lock?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "lock" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Suspend", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/suspend?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "suspend" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Unsuspend", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/unsuspend?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "unsuspend" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Send Auth Code / EPP Key", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/sendAuthCode?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "sendAuthCode" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Get Auth Code / EPP Key", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/eppKey?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "eppKey" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Request Transfer", "request": { "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/transfer?sld=SLD of the domain in question&tld=TLD of the domain in question&eppKey=Icann tlds require an eppKey to be sent. ZACR (.za) tlds do not require an eppKey&dnsTemplate=Nameserver template to use instead of specifying servers manually. See more on templates&dns=Select managed to use Domains Premium DNS and custom to use details provided in ns1,ns2, ...&ns1=First nameserver to be used by your domain&ns2=Second nameserver to be used by your domain&ns3=Third nameserver to be used by your domain&ns4=Fourth nameserver to be used by your domain&ns5=Fifth nameserver to be used by your domain®istrantTemplate=The registrant contact template to use instead of specifying details manually®istrantName=The registrant contact persons name®istrantEmail=The registrant contact persons email address®istrantCountry=The registrant contact persons country in ISO 3166-1 alpha-2 code®istrantProvince=The registrant contact persons state or province®istrantContactNumber=The registrant contact persons contact number®istrantPostalCode=The registrant contact persons area or postal code®istrantAddress1=The registrant contact persons address line 1®istrantAddress2=The registrant contact persons address line 2®istrantAddress3=The registrant contact persons address line 3®istrantCity=The registrant contact persons city&adminTemplate=The registrant contact template to use instead of specifying details manually&adminName=The admin contact persons name&adminEmail=The admin contact persons email address&adminCountry=The admin contact persons country in ISO 3166-1 alpha-2 code&adminProvince=The admin contact persons state or province&adminContactNumber=The admin contact persons contact number&adminPostalCode=The admin contact persons area or postal code&adminAddress1=The admin contact persons address line 1&adminAddress2=The admin contact persons address line 2&adminAddress3=The admin contact persons address line 3&adminCity=The admin contact persons city&billingTemplate=The billing contact template to use instead of specifying details manually&billingName=The billing contact persons name&billingEmail=The billing contact persons email address&billingCountry=The billing contact persons country in ISO 3166-1 alpha-2 code&billingProvince=The billing contact persons state or province&billingContactNumber=The billing contact persons contact number&billingPostalCode=The billing contact persons area or postal code&billingAddress1=The billing contact persons address line 1&billingAddress2=The billing contact persons address line 2&billingAddress3=The billing contact persons address line 3&billingCity=The billing contact persons city&techTemplate=The tech contact template to use instead of specifying details manually&techName=The tech contact persons name&techEmail=The tech contact persons email address&techCountry=The tech contact persons country in ISO 3166-1 alpha-2 code&techProvince=The tech contact persons state or province&techContactNumber=The tech contact persons contact number&techPostalCode=The tech contact persons area or postal code&techAddress1=The tech contact persons address line 1&techAddress2=The tech contact persons address line 2&techAddress3=The tech contact persons address line 3&techCity=The tech contact persons city&externalRef=Custom reference for the transfer request", "host": [ "{{URL}}" ], "path": [ "domain", "transfer" ], "query": [ { "key": "sld", "value": "SLD of the domain in question" }, { "key": "tld", "value": "TLD of the domain in question" }, { "key": "eppKey", "value": "Icann tlds require an eppKey to be sent. ZACR (.za) tlds do not require an eppKey" }, { "key": "dnsTemplate", "value": "Nameserver template to use instead of specifying servers manually. See more on templates" }, { "key": "dns", "value": "Select managed to use Domains Premium DNS and custom to use details provided in ns1,ns2, ..." }, { "key": "ns1", "value": "First nameserver to be used by your domain" }, { "key": "ns2", "value": "Second nameserver to be used by your domain" }, { "key": "ns3", "value": "Third nameserver to be used by your domain" }, { "key": "ns4", "value": "Fourth nameserver to be used by your domain" }, { "key": "ns5", "value": "Fifth nameserver to be used by your domain" }, { "key": "registrantTemplate", "value": "The registrant contact template to use instead of specifying details manually" }, { "key": "registrantName", "value": "The registrant contact persons name" }, { "key": "registrantEmail", "value": "The registrant contact persons email address" }, { "key": "registrantCountry", "value": "The registrant contact persons country in ISO 3166-1 alpha-2 code" }, { "key": "registrantProvince", "value": "The registrant contact persons state or province" }, { "key": "registrantContactNumber", "value": "The registrant contact persons contact number" }, { "key": "registrantPostalCode", "value": "The registrant contact persons area or postal code" }, { "key": "registrantAddress1", "value": "The registrant contact persons address line 1" }, { "key": "registrantAddress2", "value": "The registrant contact persons address line 2" }, { "key": "registrantAddress3", "value": "The registrant contact persons address line 3" }, { "key": "registrantCity", "value": "The registrant contact persons city" }, { "key": "adminTemplate", "value": "The registrant contact template to use instead of specifying details manually" }, { "key": "adminName", "value": "The admin contact persons name" }, { "key": "adminEmail", "value": "The admin contact persons email address" }, { "key": "adminCountry", "value": "The admin contact persons country in ISO 3166-1 alpha-2 code" }, { "key": "adminProvince", "value": "The admin contact persons state or province" }, { "key": "adminContactNumber", "value": "The admin contact persons contact number" }, { "key": "adminPostalCode", "value": "The admin contact persons area or postal code" }, { "key": "adminAddress1", "value": "The admin contact persons address line 1" }, { "key": "adminAddress2", "value": "The admin contact persons address line 2" }, { "key": "adminAddress3", "value": "The admin contact persons address line 3" }, { "key": "adminCity", "value": "The admin contact persons city" }, { "key": "billingTemplate", "value": "The billing contact template to use instead of specifying details manually" }, { "key": "billingName", "value": "The billing contact persons name" }, { "key": "billingEmail", "value": "The billing contact persons email address" }, { "key": "billingCountry", "value": "The billing contact persons country in ISO 3166-1 alpha-2 code" }, { "key": "billingProvince", "value": "The billing contact persons state or province" }, { "key": "billingContactNumber", "value": "The billing contact persons contact number" }, { "key": "billingPostalCode", "value": "The billing contact persons area or postal code" }, { "key": "billingAddress1", "value": "The billing contact persons address line 1" }, { "key": "billingAddress2", "value": "The billing contact persons address line 2" }, { "key": "billingAddress3", "value": "The billing contact persons address line 3" }, { "key": "billingCity", "value": "The billing contact persons city" }, { "key": "techTemplate", "value": "The tech contact template to use instead of specifying details manually" }, { "key": "techName", "value": "The tech contact persons name" }, { "key": "techEmail", "value": "The tech contact persons email address" }, { "key": "techCountry", "value": "The tech contact persons country in ISO 3166-1 alpha-2 code" }, { "key": "techProvince", "value": "The tech contact persons state or province" }, { "key": "techContactNumber", "value": "The tech contact persons contact number" }, { "key": "techPostalCode", "value": "The tech contact persons area or postal code" }, { "key": "techAddress1", "value": "The tech contact persons address line 1" }, { "key": "techAddress2", "value": "The tech contact persons address line 2" }, { "key": "techAddress3", "value": "The tech contact persons address line 3" }, { "key": "techCity", "value": "The tech contact persons city" }, { "key": "externalRef", "value": "Custom reference for the transfer request" } ] } }, "response": [] }, { "name": "Get Transfer Status", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/transfer?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "transfer" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Cancel Transfer", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/domain/transfer?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "transfer" ], "query": [ { "key": "sld", "value": "SLD of the domain in question" }, { "key": "tld", "value": "TLD of the domain in question" } ] } }, "response": [] }, { "name": "Resends a transfer FOA", "request": { "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/transfer/resendFoa?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "transfer", "resendFoa" ], "query": [ { "key": "sld", "value": "SLD of the domain in question" }, { "key": "tld", "value": "TLD of the domain in question" } ] } }, "response": [] }, { "name": "Validate Transfer EppKey", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/validateEppKey?sld=SLD of the domain in question&tld=TLD of the domain in question&auth=Auth Code to validate for the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "validateEppKey" ], "query": [ { "key": "sld", "value": "SLD of the domain in question" }, { "key": "tld", "value": "TLD of the domain in question" }, { "key": "auth", "value": "Auth Code to validate for the domain in question" } ] } }, "response": [] }, { "name": "Get Transfer Details", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/transfer/details?transferKey=Unique transfer accept key", "host": [ "{{URL}}" ], "path": [ "domain", "transfer", "details" ], "query": [ { "key": "transferKey", "value": "Unique transfer accept key", "description": "Required : yes\n" } ] } }, "response": [] }, { "name": "Get Transfer In List", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/transfer/transferInList?sortBy=Which field to sort the returned result by. Options are strDomainName, requestDate, strStatus and createdAt&order=Order to sort by. Options are ascending or descending&startPoint=For pagination, the start point for the returned results&limit=For pagination, the amount of entries to return&search=A specific keyword to search for", "host": [ "{{URL}}" ], "path": [ "domain", "transfer", "transferInList" ], "query": [ { "key": "sortBy", "value": "Which field to sort the returned result by. Options are strDomainName, requestDate, strStatus and createdAt", "description": "Required : no" }, { "key": "order", "value": "Order to sort by. Options are ascending or descending", "description": "Required : no" }, { "key": "startPoint", "value": "For pagination, the start point for the returned results", "description": "Required : no" }, { "key": "limit", "value": "For pagination, the amount of entries to return", "description": "Required : no" }, { "key": "search", "value": "A specific keyword to search for", "description": "Required : no" } ] } }, "response": [] }, { "name": "Get Transfer Out List", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/transfer/transferOutList?sortBy=Which field to sort the returned result by. Options are strDomainName, requestDate, strStatus and createdAt&order=Order to sort by. Options are ascending or descending&startPoint=For pagination, the start point for the returned results&limit=For pagination, the amount of entries to return&search=A specific keyword to search for", "host": [ "{{URL}}" ], "path": [ "domain", "transfer", "transferOutList" ], "query": [ { "key": "sortBy", "value": "Which field to sort the returned result by. Options are strDomainName, requestDate, strStatus and createdAt", "description": "Required : no" }, { "key": "order", "value": "Order to sort by. Options are ascending or descending", "description": "Required : no" }, { "key": "startPoint", "value": "For pagination, the start point for the returned results", "description": "Required : no" }, { "key": "limit", "value": "For pagination, the amount of entries to return", "description": "Required : no" }, { "key": "search", "value": "A specific keyword to search for", "description": "Required : no" } ] } }, "response": [] }, { "name": "Respond To Domain Transfer", "request": { "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/transfer/response?sld=SLD of the domain in question&tld=TLD of the domain in question&response=Whether to approve or reject the transfer request&key=The unique transfer key sent to the registrant and registrar", "host": [ "{{URL}}" ], "path": [ "domain", "transfer", "response" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "response", "value": "Whether to approve or reject the transfer request", "description": "Required : yes" }, { "key": "key", "value": "The unique transfer key sent to the registrant and registrar", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Get Glue Records", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/gluerecords?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "gluerecords" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Set Glue Records", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/gluerecords?sld=SLD of the domain in question&tld=TLD of the domain in question&ns1=The FQDN of the first NS record&ns1-ip4=The IPv4 address of the first NS record&ns1-ip6=The IPv6 address of the first NS record&ns2=The FQDN of the second NS record&ns2-ip4=The IPv4 address of the second NS record&ns2-ip6=The IPv6 address of the second NS record&ns3=The FQDN of the third NS record&ns3-ip4=The IPv4 address of the third NS record&ns3-ip6=The IPv6 address of the third NS record&ns4=The FQDN of the fourth NS record&ns4-ip4=The IPv4 address of the third NS record&ns4-ip6=The IPv6 address of the third NS record&ns5=The FQDN of the fourth NS record&ns5-ip4=The IPv4 address of the third NS record&ns5-ip6=The IPv6 address of the third NS record", "host": [ "{{URL}}" ], "path": [ "domain", "gluerecords" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "ns1", "value": "The FQDN of the first NS record", "description": "Required : yes" }, { "key": "ns1-ip4", "value": "The IPv4 address of the first NS record", "description": "Required : no" }, { "key": "ns1-ip6", "value": "The IPv6 address of the first NS record", "description": "Required : no" }, { "key": "ns2", "value": "The FQDN of the second NS record", "description": "Required : yes" }, { "key": "ns2-ip4", "value": "The IPv4 address of the second NS record", "description": "Required : no" }, { "key": "ns2-ip6", "value": "The IPv6 address of the second NS record", "description": "Required : no" }, { "key": "ns3", "value": "The FQDN of the third NS record", "description": "Required : no" }, { "key": "ns3-ip4", "value": "The IPv4 address of the third NS record", "description": "Required : no" }, { "key": "ns3-ip6", "value": "The IPv6 address of the third NS record", "description": "Required : no" }, { "key": "ns4", "value": "The FQDN of the fourth NS record", "description": "Required : no" }, { "key": "ns4-ip4", "value": "The IPv4 address of the third NS record", "description": "Required : no" }, { "key": "ns4-ip6", "value": "The IPv6 address of the third NS record", "description": "Required : no" }, { "key": "ns5", "value": "The FQDN of the fourth NS record", "description": "Required : no" }, { "key": "ns5-ip4", "value": "The IPv4 address of the third NS record", "description": "Required : no" }, { "key": "ns5-ip6", "value": "The IPv6 address of the third NS record", "description": "Required : no" } ] } }, "response": [] }, { "name": "Get Host Records", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/hostrecords?sld=SLD of the domain in question&tld=TLD of the domain in question&host=The host record that you want more information on", "host": [ "{{URL}}" ], "path": [ "domain", "hostrecords" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "host", "value": "The host record that you want more information on", "description": "Required : no" } ] } }, "response": [] }, { "name": "Set Host Records", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/hostrecords?sld=SLD of the domain in question&tld=TLD of the domain in question&host=The FQDN of the NS record&host1-ip4=The first IPv4 address of the host record&host1-ip6=The first IPv6 address of the host record&host2-ip4=The second IPv4 address of the host record&host2-ip6=The second IPv6 address of the host record", "host": [ "{{URL}}" ], "path": [ "domain", "hostrecords" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "host", "value": "The FQDN of the NS record", "description": "Required : yes" }, { "key": "host1-ip4", "value": "The first IPv4 address of the host record", "description": "Required : yes" }, { "key": "host1-ip6", "value": "The first IPv6 address of the host record", "description": "Required : no" }, { "key": "host2-ip4", "value": "The second IPv4 address of the host record", "description": "Required : no" }, { "key": "host2-ip6", "value": "The second IPv6 address of the host record", "description": "Required : no" } ] } }, "response": [] }, { "name": "Delete Host Records", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/domain/hostrecords?sld=SLD of the domain in question&tld=TLD of the domain in question&host=The host record that you want to remove from the domain", "host": [ "{{URL}}" ], "path": [ "domain", "hostrecords" ], "query": [ { "key": "sld", "value": "SLD of the domain in question" }, { "key": "tld", "value": "TLD of the domain in question" }, { "key": "host", "value": "The host record that you want to remove from the domain" } ] } }, "response": [] }, { "name": "Get DNSSec", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/dnssec?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "dnssec" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Set DNSSec", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/dnssec?sld=SLD of the domain in question&tld=TLD of the domain in question&tag=Numeric value which identifies the referenced DNSKEY-record&alg=The algorithm of the referenced DNSKEY-record&digestType=Cryptographic hash algorithm used to create the Digest value&digest=A cryptographic hash value of the referenced DNSKEY-record", "host": [ "{{URL}}" ], "path": [ "domain", "dnssec" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "tag", "value": "Numeric value which identifies the referenced DNSKEY-record", "description": "Required : yes" }, { "key": "alg", "value": "The algorithm of the referenced DNSKEY-record", "description": "Required : yes" }, { "key": "digestType", "value": "Cryptographic hash algorithm used to create the Digest value", "description": "Required : yes" }, { "key": "digest", "value": "A cryptographic hash value of the referenced DNSKEY-record", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Delete DNSSec", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/domain/dnssec?sld=SLD of the domain in question&tld=TLD of the domain in question&tag=Numeric value which identifies the referenced DNSKEY-record&alg=The algorithm of the referenced DNSKEY-record&digestType=Cryptographic hash algorithm used to create the Digest value&digest=A cryptographic hash value of the referenced DNSKEY-record", "host": [ "{{URL}}" ], "path": [ "domain", "dnssec" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "tag", "value": "Numeric value which identifies the referenced DNSKEY-record", "description": "Required : yes" }, { "key": "alg", "value": "The algorithm of the referenced DNSKEY-record", "description": "Required : yes" }, { "key": "digestType", "value": "Cryptographic hash algorithm used to create the Digest value", "description": "Required : yes" }, { "key": "digest", "value": "A cryptographic hash value of the referenced DNSKEY-record", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Tlds", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/tlds", "host": [ "{{URL}}" ], "path": [ "domain", "tlds" ] } }, "response": [] } ] }, { "name": "DNS", "item": [ { "name": "Get DNS Records", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/dns?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "dns" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Set DNS Records", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/dns?sld=SLD of the domain in question&tld=TLD of the domain in question&append=Whether or not to append to the zone or rewrite the zone with supplied information&type1=Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV)&ttl1=Defaults the TTL to 3600&name1=Name of the record. If the domain is not appended to the name, it will be done automatically&content1=The value or destination of the DNS record&prio1=Defaults to 0 (highest priority)&type999=Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV)&ttl999=Defaults the TTL to 3600&name999=Name of the record. If the domain is not appended to the name, it will be done automatically&content999=The value or destination of the DNS record&prio999=Defaults to 0 (highest priority)", "host": [ "{{URL}}" ], "path": [ "domain", "dns" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "append", "value": "Whether or not to append to the zone or rewrite the zone with supplied information", "description": "Required : no" }, { "key": "type1", "value": "Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV)", "description": "Required : no" }, { "key": "ttl1", "value": "Defaults the TTL to 3600", "description": "Required : no" }, { "key": "name1", "value": "Name of the record. If the domain is not appended to the name, it will be done automatically", "description": "Required : no" }, { "key": "content1", "value": "The value or destination of the DNS record", "description": "Required : no" }, { "key": "prio1", "value": "Defaults to 0 (highest priority)", "description": "Required : no" }, { "key": "type999", "value": "Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV)", "description": "Required : no" }, { "key": "ttl999", "value": "Defaults the TTL to 3600", "description": "Required : no" }, { "key": "name999", "value": "Name of the record. If the domain is not appended to the name, it will be done automatically", "description": "Required : no" }, { "key": "content999", "value": "The value or destination of the DNS record", "description": "Required : no" }, { "key": "prio999", "value": "Defaults to 0 (highest priority)", "description": "Required : no" } ] } }, "response": [] }, { "name": "Remove DNS", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/domain/dns?sld=SLD of the domain in question&tld=TLD of the domain in question", "host": [ "{{URL}}" ], "path": [ "domain", "dns" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Add DNS Record", "request": { "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/dns/entry?sld=SLD of the domain in question&tld=TLD of the domain in question&type=Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV)&ttl=Defaults the TTL to 3600&name=Name of the record. If the domain is not appended to the name, it will be done automatically&content=The value or destination of the DNS record&prio=Defaults to 0 (highest priority)", "host": [ "{{URL}}" ], "path": [ "domain", "dns", "entry" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "type", "value": "Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV)", "description": "Required : yes" }, { "key": "ttl", "value": "Defaults the TTL to 3600", "description": "Required : no" }, { "key": "name", "value": "Name of the record. If the domain is not appended to the name, it will be done automatically", "description": "Required : no" }, { "key": "content", "value": "The value or destination of the DNS record", "description": "Required : yes" }, { "key": "prio", "value": "Defaults to 0 (highest priority)", "description": "Required : no" } ] } }, "response": [] }, { "name": "Change DNS Record", "request": { "method": "PUT", "header": [], "url": { "raw": "{{URL}}/domain/dns/entry?sld=SLD of the domain in question&tld=TLD of the domain in question&dnsId=The unique Id linked to the DNS record&type=Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV)&ttl=Defaults the TTL to 3600&name=Name of the record. If the domain is not appended to the name, it will be done automatically&content=The value or destination of the DNS record&prio=Defaults to 0 (highest priority)", "host": [ "{{URL}}" ], "path": [ "domain", "dns", "entry" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "dnsId", "value": "The unique Id linked to the DNS record", "description": "Required : yes" }, { "key": "type", "value": "Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV)", "description": "Required : yes" }, { "key": "ttl", "value": "Defaults the TTL to 3600", "description": "Required : no" }, { "key": "name", "value": "Name of the record. If the domain is not appended to the name, it will be done automatically", "description": "Required : no" }, { "key": "content", "value": "The value or destination of the DNS record", "description": "Required : yes" }, { "key": "prio", "value": "Defaults to 0 (highest priority)", "description": "Required : no" } ] } }, "response": [] }, { "name": "Remove DNS record", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/domain/dns/entry?sld=SLD of the domain in question&tld=TLD of the domain in question&dnsId=The unique Id linked to the DNS record", "host": [ "{{URL}}" ], "path": [ "domain", "dns", "entry" ], "query": [ { "key": "sld", "value": "SLD of the domain in question", "description": "Required : yes" }, { "key": "tld", "value": "TLD of the domain in question", "description": "Required : yes" }, { "key": "dnsId", "value": "The unique Id linked to the DNS record", "description": "Required : yes" } ] } }, "response": [] } ] }, { "name": "Poll", "item": [ { "name": "Get Poll Messages", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/poll?filter=Filter by type of poll. Options are: ns, delete, update, create, poll, transfer, contact, renew, expiry&acked=Filter by messages that are acked or not acked or both. true for acked only, false for not acked only and both for both acked and not acked messages&sortBy=What field to sort the returned result by. Options are pollDomain, pollMessage, pollCode, ackDate and created_at&order=Order to sort by. Options are ascending or descending&startPoint=For pagination, the start point for the returned results&limit=For pagination, the amount of messages to return&domain=A specific domain to filter by", "host": [ "{{URL}}" ], "path": [ "domain", "poll" ], "query": [ { "key": "filter", "value": "Filter by type of poll. Options are: ns, delete, update, create, poll, transfer, contact, renew, expiry", "description": "Required : no" }, { "key": "acked", "value": "Filter by messages that are acked or not acked or both. true for acked only, false for not acked only and both for both acked and not acked messages", "description": "Required : no" }, { "key": "sortBy", "value": "What field to sort the returned result by. Options are pollDomain, pollMessage, pollCode, ackDate and created_at", "description": "Required : no" }, { "key": "order", "value": "Order to sort by. Options are ascending or descending", "description": "Required : no" }, { "key": "startPoint", "value": "For pagination, the start point for the returned results", "description": "Required : no" }, { "key": "limit", "value": "For pagination, the amount of messages to return", "description": "Required : no" }, { "key": "domain", "value": "A specific domain to filter by", "description": "Required : no" } ] } }, "response": [] }, { "name": "Ack Poll Messages", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/domain/poll?pollId=The ID of the poll message you want to acknowledge. This may be an array of IDs or a single string containing one ID", "host": [ "{{URL}}" ], "path": [ "domain", "poll" ], "query": [ { "key": "pollId", "value": "The ID of the poll message you want to acknowledge. This may be an array of IDs or a single string containing one ID", "description": "Required : yes" } ] } }, "response": [] } ] }, { "name": "User", "item": [ { "name": "Get Balance", "request": { "auth": { "type": "bearer" }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/domain/funds", "host": [ "{{URL}}" ], "path": [ "domain", "funds" ] } }, "response": [] }, { "name": "Get User Info", "request": { "auth": { "type": "bearer" }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/reseller", "host": [ "{{URL}}" ], "path": [ "reseller" ] } }, "response": [] }, { "name": "Update User Info", "request": { "auth": { "type": "bearer" }, "method": "PUT", "header": [], "url": { "raw": "{{URL}}/reseller?name=The API users contact persons name&email=The API users contact persons email&company=The API users company name&contactNumber=The API users contact persons contact number&fax=The API users contact persons fax number&address1=The API users contact persons address line 1&address2=The API users contact persons address line 2&address3=The API users contact persons address line 3&city=The API users contact persons city&province=The API users contact persons province&postalCode=The API users contact persons postal code&country=The API users contact persons country&password=If password is sent, your API password will be updated", "host": [ "{{URL}}" ], "path": [ "reseller" ], "query": [ { "key": "name", "value": "The API users contact persons name", "description": "Required : yes" }, { "key": "email", "value": "The API users contact persons email", "description": "Required : yes" }, { "key": "company", "value": "The API users company name", "description": "Required : no" }, { "key": "contactNumber", "value": "The API users contact persons contact number", "description": "Required : yes" }, { "key": "fax", "value": "The API users contact persons fax number", "description": "Required : no" }, { "key": "address1", "value": "The API users contact persons address line 1", "description": "Required : yes" }, { "key": "address2", "value": "The API users contact persons address line 2", "description": "Required : no" }, { "key": "address3", "value": "The API users contact persons address line 3", "description": "Required : no" }, { "key": "city", "value": "The API users contact persons city", "description": "Required : yes" }, { "key": "province", "value": "The API users contact persons province", "description": "Required : yes" }, { "key": "postalCode", "value": "The API users contact persons postal code", "description": "Required : yes" }, { "key": "country", "value": "The API users contact persons country", "description": "Required : yes" }, { "key": "password", "value": "If password is sent, your API password will be updated", "description": "Required : no" } ] } }, "response": [] }, { "name": "Get User Pricing", "request": { "auth": { "type": "bearer" }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/reseller/pricing?format=Sending tld will group the pricing by TLD. This is the new standard of formatting for the function. All previous formats are deprecated.", "host": [ "{{URL}}" ], "path": [ "reseller", "pricing" ], "query": [ { "key": "format", "value": "Sending tld will group the pricing by TLD. This is the new standard of formatting for the function. All previous formats are deprecated.", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Get User Notification Settings", "request": { "auth": { "type": "bearer" }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/reseller/notifications", "host": [ "{{URL}}" ], "path": [ "reseller", "notifications" ] } }, "response": [] }, { "name": "Set User Notification Settings", "request": { "auth": { "type": "bearer" }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/reseller/notifications?contactUpdates=Whether or not to receive a notification for contact updates&nsSuccess=Whether or not to receive a notification for successful nameserver updates&nsFailed=Whether or not to receive a notification for unsuccessful nameserver updates&domainUpdates=Whether or not to receive a notification for domain update&domainRenewals=Whether or not to receive a notification for domain renewals&domainTransfers=Whether or not to receive a notification for domain transfers&domainDeletes=Whether or not to receive a notification for domain deletions&domainCreates=Whether or not to receive a notification for domain creations", "host": [ "{{URL}}" ], "path": [ "reseller", "notifications" ], "query": [ { "key": "contactUpdates", "value": "Whether or not to receive a notification for contact updates", "description": "Required : no" }, { "key": "nsSuccess", "value": "Whether or not to receive a notification for successful nameserver updates", "description": "Required : no" }, { "key": "nsFailed", "value": "Whether or not to receive a notification for unsuccessful nameserver updates", "description": "Required : no" }, { "key": "domainUpdates", "value": "Whether or not to receive a notification for domain update", "description": "Required : no" }, { "key": "domainRenewals", "value": "Whether or not to receive a notification for domain renewals", "description": "Required : no" }, { "key": "domainTransfers", "value": "Whether or not to receive a notification for domain transfers", "description": "Required : no" }, { "key": "domainDeletes", "value": "Whether or not to receive a notification for domain deletions", "description": "Required : no" }, { "key": "domainCreates", "value": "Whether or not to receive a notification for domain creations", "description": "Required : no" } ] } }, "response": [] } ] }, { "name": "Reseller", "item": [ { "name": "Get Reseller Info", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/reseller?username=The username of the reseller in question. If no username is supplied, your registrar information is retrieved", "host": [ "{{URL}}" ], "path": [ "reseller" ], "query": [ { "key": "username", "value": "The username of the reseller in question. If no username is supplied, your registrar information is retrieved", "description": "Required : no\n" } ] } }, "response": [] }, { "name": "Update Reseller Info", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "PUT", "header": [], "url": { "raw": "{{URL}}/reseller?username=The username of the reseller. If no username is supplied, your registrar information are modified&name=The API users contact persons name&email=The API users contact persons email&company=The API users company name&contactNumber=The API users contact persons contact number&fax=The API users contact persons fax number&address1=The API users contact persons address line 1&address2=The API users contact persons address line 2&address3=The API users contact persons address line 3&city=The API users contact persons city&province=The API users contact persons province&postalCode=The API users contact persons postal code&country=The API users contact persons country&password=If password is sent, your API password will be updated", "host": [ "{{URL}}" ], "path": [ "reseller" ], "query": [ { "key": "username", "value": "The username of the reseller. If no username is supplied, your registrar information are modified", "description": "Required : no" }, { "key": "name", "value": "The API users contact persons name", "description": "Required : yes" }, { "key": "email", "value": "The API users contact persons email", "description": "Required : yes" }, { "key": "company", "value": "The API users company name", "description": "Required : no" }, { "key": "contactNumber", "value": "The API users contact persons contact number", "description": "Required : yes" }, { "key": "fax", "value": "The API users contact persons fax number", "description": "Required : no" }, { "key": "address1", "value": "The API users contact persons address line 1", "description": "Required : yes" }, { "key": "address2", "value": "The API users contact persons address line 2", "description": "Required : no" }, { "key": "address3", "value": "The API users contact persons address line 3", "description": "Required : no" }, { "key": "city", "value": "The API users contact persons city", "description": "Required : yes" }, { "key": "province", "value": "The API users contact persons province", "description": "Required : yes" }, { "key": "postalCode", "value": "The API users contact persons postal code", "description": "Required : yes" }, { "key": "country", "value": "The API users contact persons country", "description": "Required : yes" }, { "key": "password", "value": "If password is sent, your API password will be updated", "description": "Required : no" } ] } }, "response": [] }, { "name": "Create Reseller", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/reseller?username=The username of the reseller to be created&password=The password to use for the reseller&name=The API users contact persons name&email=The API users contact persons email&company=The API users company name&contactNumber=The API users contact persons contact number&fax=The API users contact persons fax number&address1=The API users contact persons address line 1&address2=The API users contact persons address line 2&address3=The API users contact persons address line 3&city=The API users contact persons city&province=The API users contact persons province&postalCode=The API users contact persons postal code&country=The API users contact persons country", "host": [ "{{URL}}" ], "path": [ "reseller" ], "query": [ { "key": "username", "value": "The username of the reseller to be created", "description": "Required : yes" }, { "key": "password", "value": "The password to use for the reseller", "description": "Required : yes" }, { "key": "name", "value": "The API users contact persons name", "description": "Required : yes" }, { "key": "email", "value": "The API users contact persons email", "description": "Required : yes" }, { "key": "company", "value": "The API users company name", "description": "Required : no" }, { "key": "contactNumber", "value": "The API users contact persons contact number", "description": "Required : yes" }, { "key": "fax", "value": "The API users contact persons fax number", "description": "Required : no" }, { "key": "address1", "value": "The API users contact persons address line 1", "description": "Required : yes" }, { "key": "address2", "value": "The API users contact persons address line 2", "description": "Required : no" }, { "key": "address3", "value": "The API users contact persons address line 3", "description": "Required : no" }, { "key": "city", "value": "The API users contact persons city", "description": "Required : yes" }, { "key": "province", "value": "The API users contact persons province", "description": "Required : yes" }, { "key": "postalCode", "value": "The API users contact persons postal code", "description": "Required : yes" }, { "key": "country", "value": "The API users contact persons country", "description": "Required : yes" } ] } }, "response": [] }, { "name": "List Resellers", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/reseller/list?sortBy=What field to sort the returned result by. Options are agreementSigned, strCompany, strName, strUsername and intTotalDomains&order=Order to sort by. Options are ascending or descending&startPoint=For pagination, the start point for the returned results&limit=For pagination, the amount of reseller accounts to return&search=A specific keyword to search for", "host": [ "{{URL}}" ], "path": [ "reseller", "list" ], "query": [ { "key": "sortBy", "value": "What field to sort the returned result by. Options are agreementSigned, strCompany, strName, strUsername and intTotalDomains", "description": "Required : no" }, { "key": "order", "value": "Order to sort by. Options are ascending or descending", "description": "Required : no" }, { "key": "startPoint", "value": "For pagination, the start point for the returned results", "description": "Required : no" }, { "key": "limit", "value": "For pagination, the amount of reseller accounts to return", "description": "Required : no" }, { "key": "search", "value": "A specific keyword to search for", "description": "Required : no" } ] } }, "response": [] }, { "name": "Suspend Reseller", "request": { "method": "PUT", "header": [], "url": { "raw": "{{URL}}/reseller/suspendUser?username=The username of the reseller in question", "host": [ "{{URL}}" ], "path": [ "reseller", "suspendUser" ], "query": [ { "key": "username", "value": "The username of the reseller in question", "description": "Required : no" } ] } }, "response": [] }, { "name": "Unsuspend Reseller", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "PUT", "header": [], "url": { "raw": "{{URL}}/reseller/unsuspendUser?username=The username of the reseller in question", "host": [ "{{URL}}" ], "path": [ "reseller", "unsuspendUser" ], "query": [ { "key": "username", "value": "The username of the reseller in question", "description": "Required : no" } ] } }, "response": [] }, { "name": "Add Credits", "request": { "method": "POST", "header": [], "url": { "raw": "{{URL}}/billing/manualTopup?username=The username of the reseller in question&value=The float value of credits to add to the reseller account", "host": [ "{{URL}}" ], "path": [ "billing", "manualTopup" ], "query": [ { "key": "username", "value": "The username of the reseller in question", "description": "Required : no" }, { "key": "value", "value": "The float value of credits to add to the reseller account", "description": "Required : no" } ] } }, "response": [] }, { "name": "Remove Credits", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/billing/removeCredits?username=The username of the reseller in question&value=The float value of credits to remove from the reseller account", "host": [ "{{URL}}" ], "path": [ "billing", "removeCredits" ], "query": [ { "key": "username", "value": "The username of the reseller in question", "description": "Required : no" }, { "key": "value", "value": "The float value of credits to remove from the reseller account", "description": "Required : no" } ] } }, "response": [] }, { "name": "Get Reseller Prices", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/reseller/pricing?format=Sending tld will group the pricing by TLD. This is the new standard of formatting for the function. All previous formats are deprecated.&username=The username of the reseller in question. If no username is supplied, your registrar cost pricing will be retrieved", "host": [ "{{URL}}" ], "path": [ "reseller", "pricing" ], "query": [ { "key": "format", "value": "Sending tld will group the pricing by TLD. This is the new standard of formatting for the function. All previous formats are deprecated.", "description": "Required : yes" }, { "key": "username", "value": "The username of the reseller in question. If no username is supplied, your registrar cost pricing will be retrieved", "description": "Required : no" } ] } }, "response": [] }, { "name": "Set Reseller Prices", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/reseller/pricing?username=The username of the reseller in question&type=Sending tld will group the pricing by TLD. This is the new standard of formatting for the function. All previous formats are deprecated.&tld=The TLD to set the pricing for®istration=The registration price of the TLD in question&renewal=The renewal price of the TLD in question&transfer=The transfer price of the TLD in question&redemption=The redemption price of the TLD in question&premium=The premium price of the TLD in question¤cy=The currency of the pricing. Defaults to ZAR", "host": [ "{{URL}}" ], "path": [ "reseller", "pricing" ], "query": [ { "key": "username", "value": "The username of the reseller in question", "description": "Required : no" }, { "key": "type", "value": "Sending tld will group the pricing by TLD. This is the new standard of formatting for the function. All previous formats are deprecated.", "description": "Required : no" }, { "key": "tld", "value": "The TLD to set the pricing for", "description": "Required : yes" }, { "key": "registration", "value": "The registration price of the TLD in question", "description": "Required : yes" }, { "key": "renewal", "value": "The renewal price of the TLD in question", "description": "Required : yes" }, { "key": "transfer", "value": "The transfer price of the TLD in question", "description": "Required : yes" }, { "key": "redemption", "value": "The redemption price of the TLD in question", "description": "Required : yes" }, { "key": "premium", "value": "The premium price of the TLD in question", "description": "Required : yes" }, { "key": "currency", "value": "The currency of the pricing. Defaults to ZAR", "description": "Required : no" } ] } }, "response": [] }, { "name": "Get Default Pricing", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/reseller/defaultPricing?format=Format the result to be grouped by tld", "host": [ "{{URL}}" ], "path": [ "reseller", "defaultPricing" ], "query": [ { "key": "format", "value": "Format the result to be grouped by tld", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Set Default Pricing", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/reseller/defaultPricing?type=Type of markup to set. Can be either base, markup or percentage. Defaults to base&tld=The TLD to set the pricing for®istration=The registration price of the TLD in question&renewal=The renewal price of the TLD in question&transfer=The transfer price of the TLD in question&redemption=The redemption price of the TLD in question&premium=The premium price of the TLD in question¤cy=The currency of the pricing. Defaults to ZAR", "host": [ "{{URL}}" ], "path": [ "reseller", "defaultPricing" ], "query": [ { "key": "type", "value": "Type of markup to set. Can be either base, markup or percentage. Defaults to base", "description": "Required : yes" }, { "key": "tld", "value": "The TLD to set the pricing for", "description": "Required : yes" }, { "key": "registration", "value": "The registration price of the TLD in question", "description": "Required : yes" }, { "key": "renewal", "value": "The renewal price of the TLD in question", "description": "Required : yes" }, { "key": "transfer", "value": "The transfer price of the TLD in question", "description": "Required : yes" }, { "key": "redemption", "value": "The redemption price of the TLD in question", "description": "Required : yes" }, { "key": "premium", "value": "The premium price of the TLD in question", "description": "Required : yes" }, { "key": "currency", "value": "The currency of the pricing. Defaults to ZAR", "description": "Required : no" } ] } }, "response": [] }, { "name": "Get Notification Settings", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/reseller/notifications?username=The reseller account to fetch the settings for. If blank, registrar user settings are fetched", "host": [ "{{URL}}" ], "path": [ "reseller", "notifications" ], "query": [ { "key": "username", "value": "The reseller account to fetch the settings for. If blank, registrar user settings are fetched", "description": "Required : no" } ] } }, "response": [] }, { "name": "Set Notification Settings", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/reseller/notifications?username=The reseller account to fetch the settings for. If blank, registrar user settings are fetched&contactUpdates=Whether or not to receive a notification for contact updates&nsSuccess=Whether or not to receive a notification for successful nameserver updates&nsFailed=Whether or not to receive a notification for unsuccessful nameserver updates&domainUpdates=Whether or not to receive a notification for domain update&domainRenewals=Whether or not to receive a notification for domain renewals&domainTransfers=Whether or not to receive a notification for domain transfers&domainDeletes=Whether or not to receive a notification for domain deletions&domainCreates=Whether or not to receive a notification for domain creations", "host": [ "{{URL}}" ], "path": [ "reseller", "notifications" ], "query": [ { "key": "username", "value": "The reseller account to fetch the settings for. If blank, registrar user settings are fetched", "description": "Required : no" }, { "key": "contactUpdates", "value": "Whether or not to receive a notification for contact updates", "description": "Required : no" }, { "key": "nsSuccess", "value": "Whether or not to receive a notification for successful nameserver updates", "description": "Required : no" }, { "key": "nsFailed", "value": "Whether or not to receive a notification for unsuccessful nameserver updates", "description": "Required : no" }, { "key": "domainUpdates", "value": "Whether or not to receive a notification for domain update", "description": "Required : no" }, { "key": "domainRenewals", "value": "Whether or not to receive a notification for domain renewals", "description": "Required : no" }, { "key": "domainTransfers", "value": "Whether or not to receive a notification for domain transfers", "description": "Required : no" }, { "key": "domainDeletes", "value": "Whether or not to receive a notification for domain deletions", "description": "Required : no" }, { "key": "domainCreates", "value": "Whether or not to receive a notification for domain creations", "description": "Required : no" } ] } }, "response": [] } ] }, { "name": "SubUser", "item": [ { "name": "Create SubUser", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/subuser?username=The username of the new subuser account&password=Password to use for the subuser account&name=The subusers name&email=The subusers email&company=The subusers company name&contactNumber=The subusers contact number&fax=The subusers fax number&address1=The subusers address line 1&address2=The subusers address line 2&address3=The subusers address line 3&city=The subusers city&province=The subusers province&postalCode=The subusers postal code&country=The subusers country", "host": [ "{{URL}}" ], "path": [ "subuser" ], "query": [ { "key": "username", "value": "The username of the new subuser account", "description": "Required : yes" }, { "key": "password", "value": "Password to use for the subuser account", "description": "Required : yes" }, { "key": "name", "value": "The subusers name", "description": "Required : yes" }, { "key": "email", "value": "The subusers email", "description": "Required : yes" }, { "key": "company", "value": "The subusers company name", "description": "Required : no" }, { "key": "contactNumber", "value": "The subusers contact number", "description": "Required : yes" }, { "key": "fax", "value": "The subusers fax number", "description": "Required : yes" }, { "key": "address1", "value": "The subusers address line 1", "description": "Required : yes" }, { "key": "address2", "value": "The subusers address line 2", "description": "Required : no" }, { "key": "address3", "value": "The subusers address line 3", "description": "Required : no" }, { "key": "city", "value": "The subusers city", "description": "Required : yes" }, { "key": "province", "value": "The subusers province", "description": "Required : yes" }, { "key": "postalCode", "value": "The subusers postal code", "description": "Required : yes" }, { "key": "country", "value": "The subusers country", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Update SubUser", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "PUT", "header": [], "url": { "raw": "{{URL}}/subuser?username=The username of the subuser account&password=Password to use for the subuser account&name=The subusers name&email=The subusers email&company=The subusers company name&contactNumber=The subusers contact number&fax=The subusers fax number&address1=The subusers address line 1&address2=The subusers address line 2&address3=The subusers address line 3&city=The subusers city&province=The subusers province&postalCode=The subusers postal code&country=The subusers country", "host": [ "{{URL}}" ], "path": [ "subuser" ], "query": [ { "key": "username", "value": "The username of the subuser account", "description": "Required : yes" }, { "key": "password", "value": "Password to use for the subuser account", "description": "Required : no" }, { "key": "name", "value": "The subusers name", "description": "Required : no" }, { "key": "email", "value": "The subusers email", "description": "Required : no" }, { "key": "company", "value": "The subusers company name", "description": "Required : no" }, { "key": "contactNumber", "value": "The subusers contact number", "description": "Required : no" }, { "key": "fax", "value": "The subusers fax number", "description": "Required : no" }, { "key": "address1", "value": "The subusers address line 1", "description": "Required : no" }, { "key": "address2", "value": "The subusers address line 2", "description": "Required : no" }, { "key": "address3", "value": "The subusers address line 3", "description": "Required : no" }, { "key": "city", "value": "The subusers city", "description": "Required : no" }, { "key": "province", "value": "The subusers province", "description": "Required : no" }, { "key": "postalCode", "value": "The subusers postal code", "description": "Required : no" }, { "key": "country", "value": "The subusers country", "description": "Required : no" } ] } }, "response": [] }, { "name": "List SubUsers", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/subuser?username=The username of the subuser to search for&search=The username or contact name to search for&includeDeleted=Whether or not to include deleted subusers in the returned result&sortBy=What field to sort the returned result by. Options are agreementSigned, strCompany, strName, strUsername and intTotalDomains&order=Order to sort by. Options are ascending or descending&startPoint=For pagination, the start point for the returned results&limit=For pagination, the amount of reseller accounts to return", "host": [ "{{URL}}" ], "path": [ "subuser" ], "query": [ { "key": "username", "value": "The username of the subuser to search for", "description": "Required : no" }, { "key": "search", "value": "The username or contact name to search for", "description": "Required : no" }, { "key": "includeDeleted", "value": "Whether or not to include deleted subusers in the returned result", "description": "Required : no" }, { "key": "sortBy", "value": "What field to sort the returned result by. Options are agreementSigned, strCompany, strName, strUsername and intTotalDomains", "description": "Required : no" }, { "key": "order", "value": "Order to sort by. Options are ascending or descending", "description": "Required : no" }, { "key": "startPoint", "value": "For pagination, the start point for the returned results", "description": "Required : no" }, { "key": "limit", "value": "For pagination, the amount of reseller accounts to return", "description": "Required : no" } ] } }, "response": [] }, { "name": "Delete SubUser", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/subuser?username=The username of the subuser to be deleted", "host": [ "{{URL}}" ], "path": [ "subuser" ], "query": [ { "key": "username", "value": "The username of the subuser to be deleted", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Suspend SubUser", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/subuser/suspend?username=The username of the subuser to be suspended", "host": [ "{{URL}}" ], "path": [ "subuser", "suspend" ], "query": [ { "key": "username", "value": "The username of the subuser to be suspended", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Unsuspend SubUser", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/subuser/unsuspend?username=The username of the subuser to be unsuspended", "host": [ "{{URL}}" ], "path": [ "subuser", "unsuspend" ], "query": [ { "key": "username", "value": "The username of the subuser to be unsuspended", "description": "Required : yes" } ] } }, "response": [] } ] }, { "name": "Template", "item": [ { "name": "List Contact Templates", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/template/contact?default=true to fetch default template only. Default is false&type=Which type of template to search for. Can be either registrant,admin,billing or tech. If omitted all types are returned&list=Whether a simple or full list should be returned. Defaults to simple&name=The template name to search for&templateId=The templateId to search for&search=The template name to search for&sortBy=What field to sort the returned result by. Options are name, type, contact, default and email&order=Order to sort by. Options are ascending or descending&startPoint=For pagination, the start point for the returned results&limit=For pagination, the amount of reseller accounts to return", "host": [ "{{URL}}" ], "path": [ "template", "contact" ], "query": [ { "key": "default", "value": "true to fetch default template only. Default is false", "description": "Required : no" }, { "key": "type", "value": "Which type of template to search for. Can be either registrant,admin,billing or tech. If omitted all types are returned", "description": "Required : no" }, { "key": "list", "value": "Whether a simple or full list should be returned. Defaults to simple", "description": "Required : no" }, { "key": "name", "value": "The template name to search for", "description": "Required : no" }, { "key": "templateId", "value": "The templateId to search for", "description": "Required : no" }, { "key": "search", "value": "The template name to search for", "description": "Required : no" }, { "key": "sortBy", "value": "What field to sort the returned result by. Options are name, type, contact, default and email", "description": "Required : no" }, { "key": "order", "value": "Order to sort by. Options are ascending or descending", "description": "Required : no" }, { "key": "startPoint", "value": "For pagination, the start point for the returned results", "description": "Required : no" }, { "key": "limit", "value": "For pagination, the amount of reseller accounts to return", "description": "Required : no" } ] } }, "response": [] }, { "name": "Create Contact Template", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/template/contact?templateName=true to fetch default template only. Default is false&type=Options are registrant,admin,billing,tech,all&default=Whether the template is to be set as the default template for this type. Default value is false&name=The contact persons name&company=The contact persons company name&email=The contact persons email address&country=The contact persons country in ISO 3166-1 alpha-2 code&province=The contact persons state or province&phone=The contact persons contact number&postalCode=The contact persons area or postal code&address1=The contact persons address line 1&address2=The contact persons address line 2&address3=The contact persons address line 3&city=The contact persons city", "host": [ "{{URL}}" ], "path": [ "template", "contact" ], "query": [ { "key": "templateName", "value": "true to fetch default template only. Default is false", "description": "Required : yes" }, { "key": "type", "value": "Options are registrant,admin,billing,tech,all", "description": "Required : yes" }, { "key": "default", "value": "Whether the template is to be set as the default template for this type. Default value is false", "description": "Required : no" }, { "key": "name", "value": "The contact persons name", "description": "Required : yes" }, { "key": "company", "value": "The contact persons company name", "description": "Required : yes" }, { "key": "email", "value": "The contact persons email address", "description": "Required : yes" }, { "key": "country", "value": "The contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : yes" }, { "key": "province", "value": "The contact persons state or province", "description": "Required : yes" }, { "key": "phone", "value": "The contact persons contact number", "description": "Required : yes" }, { "key": "postalCode", "value": "The contact persons area or postal code", "description": "Required : yes" }, { "key": "address1", "value": "The contact persons address line 1", "description": "Required : yes" }, { "key": "address2", "value": "The contact persons address line 2", "description": "Required : no" }, { "key": "address3", "value": "The contact persons address line 3", "description": "Required : no" }, { "key": "city", "value": "The contact persons city", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Update Contact Template", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/template/contact?templateId=The ID of the template to update&templateName=A name for the template to update&type=Options are registrant,admin,billing,tech,all&default=Whether the template is to be set as the default template for this type. Default value is false&name=The contact persons name&company=The contact persons company name&email=The contact persons email address&country=The contact persons country in ISO 3166-1 alpha-2 code&province=The contact persons state or province&phone=The contact persons contact number&postalCode=The contact persons area or postal code&address1=The contact persons address line 1&address2=The contact persons address line 2&address3=The contact persons address line 3&city=The contact persons city", "host": [ "{{URL}}" ], "path": [ "template", "contact" ], "query": [ { "key": "templateId", "value": "The ID of the template to update", "description": "Required : no" }, { "key": "templateName", "value": "A name for the template to update", "description": "Required : no" }, { "key": "type", "value": "Options are registrant,admin,billing,tech,all", "description": "Required : no" }, { "key": "default", "value": "Whether the template is to be set as the default template for this type. Default value is false", "description": "Required : no" }, { "key": "name", "value": "The contact persons name", "description": "Required : yes" }, { "key": "company", "value": "The contact persons company name", "description": "Required : yes" }, { "key": "email", "value": "The contact persons email address", "description": "Required : yes" }, { "key": "country", "value": "The contact persons country in ISO 3166-1 alpha-2 code", "description": "Required : yes" }, { "key": "province", "value": "The contact persons state or province", "description": "Required : yes" }, { "key": "phone", "value": "The contact persons contact number", "description": "Required : yes" }, { "key": "postalCode", "value": "The contact persons area or postal code", "description": "Required : yes" }, { "key": "address1", "value": "The contact persons address line 1", "description": "Required : yes" }, { "key": "address2", "value": "The contact persons address line 2", "description": "Required : no" }, { "key": "address3", "value": "The contact persons address line 3", "description": "Required : no" }, { "key": "city", "value": "The contact persons city", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Remove Contact Template", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/template/contact?templateId=The ID of the template to update&templateName=A name for the template to update&type=The template contact type", "host": [ "{{URL}}" ], "path": [ "template", "contact" ], "query": [ { "key": "templateId", "value": "The ID of the template to update", "description": "Required : no" }, { "key": "templateName", "value": "A name for the template to update", "description": "Required : no" }, { "key": "type", "value": "The template contact type", "description": "Required : no" } ] } }, "response": [] }, { "name": "List NS Templates", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{URL}}/template/ns?default=true to fetch default template only. Default is false&list=Whether a simple or full list should be returned. Defaults to simple&name=The template name to search for&templateId=The templateId to search for&search=The template name to search for&sortBy=What field to sort the returned result by. Options are name, date and default&order=Order to sort by. Options are ascending or descending&startPoint=For pagination, the start point for the returned results&limit=For pagination, the amount of reseller accounts to return", "host": [ "{{URL}}" ], "path": [ "template", "ns" ], "query": [ { "key": "default", "value": "true to fetch default template only. Default is false", "description": "Required : no" }, { "key": "list", "value": "Whether a simple or full list should be returned. Defaults to simple", "description": "Required : no" }, { "key": "name", "value": "The template name to search for", "description": "Required : no" }, { "key": "templateId", "value": "The templateId to search for", "description": "Required : no" }, { "key": "search", "value": "The template name to search for", "description": "Required : no" }, { "key": "sortBy", "value": "What field to sort the returned result by. Options are name, date and default", "description": "Required : no" }, { "key": "order", "value": "Order to sort by. Options are ascending or descending", "description": "Required : no" }, { "key": "startPoint", "value": "For pagination, the start point for the returned results", "description": "Required : no" }, { "key": "limit", "value": "For pagination, the amount of reseller accounts to return", "description": "Required : no" } ] } }, "response": [] }, { "name": "Create NS Template", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "POST", "header": [], "url": { "raw": "{{URL}}/template/ns?name=A unique name for the template&default=Whether the template is to be set as the default ns template. Default value is false&ns=An array of nameserver items", "host": [ "{{URL}}" ], "path": [ "template", "ns" ], "query": [ { "key": "name", "value": "A unique name for the template", "description": "Required : yes" }, { "key": "default", "value": "Whether the template is to be set as the default ns template. Default value is false", "description": "Required : no" }, { "key": "ns", "value": "An array of nameserver items", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Update NS Template", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "PUT", "header": [], "url": { "raw": "{{URL}}/template/ns?name=The unique name for the template&default=Whether the template is to be set as the default ns template. Default value is false&ns=An array of nameserver items", "host": [ "{{URL}}" ], "path": [ "template", "ns" ], "query": [ { "key": "name", "value": "The unique name for the template", "description": "Required : yes" }, { "key": "default", "value": "Whether the template is to be set as the default ns template. Default value is false", "description": "Required : no" }, { "key": "ns", "value": "An array of nameserver items", "description": "Required : yes" } ] } }, "response": [] }, { "name": "Remove NS Template", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "Your Token Here", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/template/ns?templateId=The ID of the template to update&templateName=A name for the template to update", "host": [ "{{URL}}" ], "path": [ "template", "ns" ], "query": [ { "key": "templateId", "value": "The ID of the template to update", "description": "Required : no" }, { "key": "templateName", "value": "A name for the template to update", "description": "Required : no" } ] } }, "response": [] }, { "name": "List DNS Templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{URL}}/template/dns?showRecords=true to include records linked to template. Default is false", "host": [ "{{URL}}" ], "path": [ "template", "dns" ], "query": [ { "key": "showRecords", "value": "true to include records linked to template. Default is false", "description": "Required : no" } ] } }, "response": [] }, { "name": "Create DNS Template", "request": { "method": "POST", "header": [], "url": { "raw": "{{URL}}/template/dns?name=A unique name for the template&default=Whether the template is to be set as the default dns template. Default value is false", "host": [ "{{URL}}" ], "path": [ "template", "dns" ], "query": [ { "key": "name", "value": "A unique name for the template", "description": "Required : yes" }, { "key": "default", "value": "Whether the template is to be set as the default dns template. Default value is false", "description": "Required : no" } ] } }, "response": [] }, { "name": "Update DNS Template", "request": { "method": "PUT", "header": [], "url": { "raw": "{{URL}}/template/dns?name=The unique name of the template:&default=Whether the template is to be set as the default dns template. Default value is false:&type1=Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV):&ttl1=Defaults the TTL to 3600:&name1=Name of the record. If the domain is not appended to the name, it will be done automatically:&content1=The value or destination of the DNS record:&prio1=Defaults to 0 (highest priority):&type999=Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV):&ttl999=Defaults the TTL to 3600:&name999=Name of the record. If the domain is not appended to the name, it will be done automatically:&content999=The value or destination of the DNS record:&prio999=Defaults to 0 (highest priority):", "host": [ "{{URL}}" ], "path": [ "template", "dns" ], "query": [ { "key": "name", "value": "The unique name of the template:", "description": "Required : yes" }, { "key": "default", "value": "Whether the template is to be set as the default dns template. Default value is false:", "description": "Required : no" }, { "key": "type1", "value": "Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV):", "description": "Required : yes" }, { "key": "ttl1", "value": "Defaults the TTL to 3600:", "description": "Required : no" }, { "key": "name1", "value": "Name of the record. If the domain is not appended to the name, it will be done automatically:", "description": "Required : no" }, { "key": "content1", "value": "The value or destination of the DNS record:", "description": "Required : yes" }, { "key": "prio1", "value": "Defaults to 0 (highest priority):", "description": "Required : no" }, { "key": "type999", "value": "Type of DNS record (A, AAA, AAAA,MX, SOA, TXT, CNAME, CAA, NS, PTR, SPF, SRV):", "description": "Required : no" }, { "key": "ttl999", "value": "Defaults the TTL to 3600:", "description": "Required : no" }, { "key": "name999", "value": "Name of the record. If the domain is not appended to the name, it will be done automatically:", "description": "Required : no" }, { "key": "content999", "value": "The value or destination of the DNS record:", "description": "Required : no" }, { "key": "prio999", "value": "Defaults to 0 (highest priority):", "description": "Required : no" } ] } }, "response": [] }, { "name": "Remove DNS Template", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{URL}}/template/dns?name=The name of the template to delete", "host": [ "{{URL}}" ], "path": [ "template", "dns" ], "query": [ { "key": "name", "value": "The name of the template to delete", "description": "Required : yes" } ] } }, "response": [] } ] } ] }