{"openapi":"3.0.0","info":{"description":"Domain registration","version":[{"name":"v4","value":"v4"}]},"servers":[{"description":"Domain registration","url":"https://api.apirails.com/name"}],"paths":{"/v4/domains/{domainName}/records":{"get":{"tags":["DNS"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the zone to list the records for;","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Get specific page","schema":{"type":"number","example":""}},{"name":"perPage","in":"query","description":"Number of items per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/dns#ListRecords","api_endpoint":"https://api.name.com/v4/domains/{domainName}/records"},"summary":"List all the domain records","description":"List all the records of a domain","security":[{"bearerAuth":[]}]},"post":{"tags":["DNS"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the zone that the record belongs to","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/dns#CreateRecord","api_endpoint":"https://api.name.com/v4/domains/{domainName}/records"},"summary":"Creates new record of the domain","description":"creates a new record of the domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","required":true,"enum":["Type is one of the following- A"]},"answer":{"type":"string","description":"Answer is either the IP address for A or AAAA records","required":true},"host":{"type":"string","description":"Host is the hostname relative to the zone"},"priority":{"type":"number","description":"Priority is only required for MX and SRV records"},"ttl":{"type":"number","description":"TTL is the time this record can be cached for in seconds"}}},"example":{"type":"","answer":"","host":"","priority":"","ttl":""}}}}}},"/v4/domains/{domainName}/records/{id}":{"get":{"tags":["DNS"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the zone the record exists in","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"ID is the server-assigned unique identifier for this record","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/dns#GetRecord","api_endpoint":"https://api.name.com/v4/domains/{domainName}/records/{id}"},"summary":"Get Individual record details","description":"Get details if an individual record","security":[{"bearerAuth":[]}]},"put":{"tags":["DNS"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the zone that the record belongs to","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"Unique record id. Value is ignored on Create; and must match the URI on Update","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/dns#UpdateRecord","api_endpoint":"https://api.name.com/v4/domains/{domainName}/records/{id}"},"summary":"Replace old record with new","description":"replaces the record of the with the new record that is passed","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","required":true,"enum":["Type is one of the following- A"]},"answer":{"type":"string","description":"Answer is either the IP address for A or AAAA records","required":true},"fqdn":{"type":"string","description":"FQDN is the Fully Qualified Domain Name"},"host":{"type":"string","description":"Host is the hostname relative to the zone"},"priority":{"type":"number","description":"Priority is only required for MX and SRV records"},"ttl":{"type":"number","description":"TTL is the time this record can be cached for in seconds"}}},"example":{"type":"","answer":"","fqdn":"","host":"","priority":"","ttl":""}}}}},"delete":{"tags":["DNS"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the zone that the record to be deleted exists in","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"ID is the server-assigned unique identifier for the Record to be deleted","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/dns#DeleteRecord","api_endpoint":"https://api.name.com/v4/domains/{domainName}/records/{id}"},"summary":"Delete domain record from zone","description":"deletes a record of the domain from the zone.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{domainName}/dnssec":{"get":{"tags":["DNSSEC"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain name to list keys for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/dnssecs#ListDNSSECs","api_endpoint":"https://api.name.com/v4/domains/{domainName}/dnssec"},"summary":"DNSSEC keys listed by registry","description":"lists all of the DNSSEC keys registered with the registry","security":[{"bearerAuth":[]}]}},"/v4/domains/dnssec/{digest}":{"get":{"tags":["DNSSEC"],"parameters":[{"name":"digest","in":"path","description":"Digest is the digest for the DNSKEY RR to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"domainName","in":"path","description":"DomainName is the domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/dnssecs#GetDNSSEC","api_endpoint":"https://api.name.com/v4/domains/dnssec/{digest}"},"summary":"Retrieve registered key details from registry","description":"get the details for a key registered with the registry.","security":[{"bearerAuth":[]}]},"delete":{"tags":["DNSSEC"],"parameters":[{"name":"digest","in":"path","description":"Digest is the digest for the DNSKEY RR to remove from the registry","required":true,"schema":{"type":"string","example":""}},{"name":"domainName","in":"path","description":"DomainName is the domain name the key is registered for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/dnssecs#DeleteDNSSEC","api_endpoint":"https://api.name.com/v4/domains/dnssec/{digest}"},"summary":"DNSSEC key removal from registry","description":"removes a DNSSEC key from the registry.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/dnssec":{"post":{"tags":["DNSSEC"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain name;","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/dnssecs#CreateDNSSEC","api_endpoint":"https://api.name.com/v4/domains/dnssec"},"summary":"DNSSEC key registration with registry","description":"registers a DNSSEC key with the registry.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"algorithm":{"type":"number","description":"Algorithm is an integer identifying the algorithm used for signing"},"digest":{"type":"string","description":"Digest is a digest of the DNSKEY RR that is registered with the registry."},"digestType":{"type":"number","description":"DigestType is an integer identifying the algorithm used to create the digest"},"keyTag":{"type":"number","description":"KeyTag contains the key tag value of the DNSKEY RR that validates this signature"}}},"example":{"algorithm":"","digest":"","digestType":"","keyTag":""}}}}}},"/v4/domains":{"post":{"tags":["Domain"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#CreateDomain","api_endpoint":"https://api.name.com/v4/domains"},"summary":"Buy a new domain","description":"Buy a new domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"object","required":true,"properties":{}},"purchasePrice":{"type":"number","required":true},"purchaseType":{"type":"string"},"years":{"type":"number","description":"Defaults to 1 and maximum 10 years"}}},"example":{"domain":{"domainName":"example.org"},"purchasePrice":"","purchaseType":"","years":""}}}}},"get":{"tags":["Domain"],"parameters":[{"name":"page","in":"query","description":"Get specific page","schema":{"type":"number","example":""}},{"name":"perPage","in":"query","description":"Number of items per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#ListDomains","api_endpoint":"https://api.name.com/v4/domains"},"summary":"User-owned domain list API","description":"List all the domain own by the user","security":[{"bearerAuth":[]}]}},"/v4/domains/checkAvailability":{"post":{"tags":["Domain"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#CheckAvailability","api_endpoint":"https://api.name.com/v4/domains:checkAvailability"},"summary":"Domain availability check for purchase","description":"Check if domain is available for purchase","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domainNames":{"type":"array","required":true,"items":{"type":"string"}}}},"example":{"domainNames":["example.org","examplexyz.com"]}}}}}},"/v4/domains/search":{"post":{"tags":["Domain"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#Search","api_endpoint":"https://api.name.com/v4/domains:search"},"summary":"Search domain name","description":"Search domain name","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"keyword":{"type":"string","description":"Keyword is the search term to search for. It can be just a word, or a whole domain name.","required":true},"promoCode":{"type":"string","description":"PromoCode is not implemented yet"},"timeout":{"type":"number","description":"Timeout in milliseconds (500-5000ms). Defaults to 1000ms."},"tldFilter":{"type":"array","description":"TLDFilter will limit results to only contain the specified TLDs","items":{"type":"string"}}}},"example":{"keyword":"example","promoCode":"","timeout":"","tldFilter":[]}}}}}},"/v4/domains/{domainName}/getPricing":{"get":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"Domain name","required":true,"schema":{"type":"string","example":""}},{"name":"years","in":"query","description":"Years","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#GetPricingForDomain","api_endpoint":"https://api.name.com/v4/domains/{domainName}:getPricing"},"summary":"Get price of the domain","description":"Get price of the domain","security":[{"bearerAuth":[]}]}},"/v4/domains/{domainName}":{"get":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"Domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#GetDomain","api_endpoint":"https://api.name.com/v4/domains/{domainName}"},"summary":"Get details about a specific domain","description":"Get details about a specific domain","security":[{"bearerAuth":[]}]}},"/v4/domains/{domainName}/enableWhoisPrivacy":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain name to enable whoisprivacy for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#EnableWhoisPrivacy","api_endpoint":"https://api.name.com/v4/domains/{domainName}:enableWhoisPrivacy"},"summary":"Enables the domain to be private","description":"Enables the domain to be private","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{domainName}/disableWhoisPrivacy":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain name to disable whoisprivacy for.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#DisableWhoisPrivacy","api_endpoint":"https://api.name.com/v4/domains/{domainName}:disableWhoisPrivacy"},"summary":"Disables domain privacy","description":"Disables domain privacy","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{domainName}/enableAutorenew":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain name to enable autorenew for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#EnableAutorenew","api_endpoint":"https://api.name.com/v4/domains/{domainName}:enableAutorenew"},"summary":"Automated domain renewal enabled","description":"Enables the domain to be automatically renewed","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{domainName}/disableAutorenew":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"domain name to disable autorenew for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#DisableAutorenew","api_endpoint":"https://api.name.com/v4/domains/{domainName}:disableAutorenew"},"summary":"Disables automatic renewals","description":"Disables automatic renewals","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{domainName}/renew":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"domain to renew","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#RenewDomain","api_endpoint":"https://api.name.com/v4/domains/{domainName}:renew"},"summary":"Renew a domain","description":"Renew a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"promoCode":{"type":"string","description":"PromoCode is not yet implemented"},"purchasePrice":{"type":"number","description":"PurchasePrice is the amount to pay for the domain renewal","required":true},"years":{"type":"number","description":"Years is for how many years to renew the domain for Defaults to 1 and maximum 10 year"}}},"example":{"promoCode":"","purchasePrice":"","years":""}}}}}},"/v4/domains/{domainName}/getAuthCode":{"get":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain name to retrieve the authorization code for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#GetAuthCodeForDomain","api_endpoint":"https://api.name.com/v4/domains/{domainName}:getAuthCode"},"summary":"Domain Transfer Authorization Code Retrieval","description":"Returns the Transfer Authorization Code for the domain","security":[{"bearerAuth":[]}]}},"/v4/domains/{domainName}/purchasePrivacy":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"domain to purchase Whois Privacy for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#PurchasePrivacy","api_endpoint":"https://api.name.com/v4/domains/{domainName}:purchasePrivacy"},"summary":"Add Privacy protection to a domain","description":"Add Privacy protection to a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"promoCode":{"type":"string","description":"PromoCode is not yet implemented"},"purchasePrice":{"type":"number","description":"PurchasePrice is the amount you expect to pay","required":true},"years":{"type":"number","description":"Years is the number of years you wish to purchase Whois Privacy for Defaults to 1"}}},"example":{"promoCode":"","purchasePrice":"","years":""}}}}}},"/v4/domains/{domainName}/setNameservers":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"domain name to set the nameservers","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#SetNameservers","api_endpoint":"https://api.name.com/v4/domains/{domainName}:setNameservers"},"summary":"Set the nameservers for the Domain","description":"Set the nameservers for the Domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"nameservers":{"type":"string","description":"Namesevers is a list of the nameservers to set"}}},"example":{"nameservers":""}}}}}},"/v4/domains/{domainName}/setContacts":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain name to set the contacts for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#SetContacts","api_endpoint":"https://api.name.com/v4/domains/{domainName}:setContacts"},"summary":"Set the contacts for the Domain","description":"Set the contacts for the Domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contacts":{"type":"string","description":"Contacts is the list of contacts to set","required":true}}},"example":{"contacts":""}}}}}},"/v4/domains/{domainName}/lock":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain name to lock","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#LockDomain","api_endpoint":"https://api.name.com/v4/domains/{domainName}:lock"},"summary":"Lock a domain","description":"Lock a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{domainName}/unlock":{"post":{"tags":["Domain"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain name to unlock","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#UnlockDomain","api_endpoint":"https://api.name.com/v4/domains/{domainName}:unlock"},"summary":"Unlock a domain","description":"Unlock a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/searchStream":{"post":{"tags":["Domain"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/domains#SearchStream","api_endpoint":"https://api.name.com/v4/domains:searchStream"},"summary":"Return JSON-encoded SearchResults from registry","description":"Return JSON encoded SearchResults as they are received from the registry.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"keyword":{"type":"string","description":"Keyword is the search term to search for. It can be just a word, or a whole domain name.","required":true},"promoCode":{"type":"string","description":"PromoCode is not implemented yet"},"timeout":{"type":"number","description":"Timeout in milliseconds (500-5000ms). Defaults to 1000ms."},"tldFilter":{"type":"array","description":"TLDFilter will limit results to only contain the specified TLDs","items":{"type":"string"}}}},"example":{"keyword":"","promoCode":"","timeout":"","tldFilter":[]}}}}}},"/v4/domains/email/forwarding":{"get":{"tags":["EmailForwarding"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain to list email forwarded boxes for","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"path","description":"Page is which page to return","required":true,"schema":{"type":"number","example":""}},{"name":"perPage","in":"path","description":"Per Page is the number of records to return per request.defaults to 1000","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/emailforwardings#ListEmailForwardings","api_endpoint":"https://api.name.com/v4/domains/email/forwarding"},"summary":"List paginated email forwarding entries","description":"ListEmailForwardings returns a paginated list of email forwarding entries for a domain.","security":[{"bearerAuth":[]}]}},"/v4/domains/email/forwarding/{emailBox}":{"get":{"tags":["EmailForwarding"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain to list email forwarded box for","required":true,"schema":{"type":"string","example":""}},{"name":"emailBox","in":"path","description":"EmailBox is which email box to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/emailforwardings#GetEmailForwarding","api_endpoint":"https://api.name.com/v4/domains/email/forwarding/{emailBox}"},"summary":"Email forwarding entry returned by GetEmailForwarding","description":"GetEmailForwarding returns an email forwarding entry.","security":[{"bearerAuth":[]}]}},"/v4/domains/{domainName}/email/forwarding":{"post":{"tags":["EmailForwarding"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain part of the email address to forward","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/emailforwardings#CreateEmailForwarding","api_endpoint":"https://api.name.com/v4/domains/{domainName}/email/forwarding"},"summary":"Creates an email forwarding entry","description":"CreateEmailForwarding creates an email forwarding entry","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emailBox":{"type":"string","description":"EmailBox is the user portion of the email address to forward"},"emailTo":{"type":"string","description":"EmailTo is the entire email address to forward email to"}}},"example":{"emailBox":"","emailTo":""}}}}}},"/v4/domains/{domainName}/email/forwarding/{emailBox}":{"put":{"tags":["EmailForwarding"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain part of the email address to forward","required":true,"schema":{"type":"string","example":""}},{"name":"emailBox","in":"path","description":"EmailBox is the user portion of the email address to forward.","required":true,"schema":{"type":"string","example":""}},{"name":"emailTo","in":"query","description":"EmailTo is the entire email address to forward email to","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/emailforwardings#UpdateEmailForwarding","api_endpoint":"https://api.name.com/v4/domains/{domainName}/email/forwarding/{emailBox}"},"summary":"UpdateEmailForwarding changes forwarded email address","description":"UpdateEmailForwarding updates which email address the email is being forwarded to.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["EmailForwarding"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain to delete the email forwarded box from","required":true,"schema":{"type":"string","example":""}},{"name":"emailBox","in":"path","description":"EmailBox is which email box to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/emailforwardings#DeleteEmailForwarding","api_endpoint":"https://api.name.com/v4/domains/{domainName}/email/forwarding/{emailBox}"},"summary":"Deletes email forwarding entry","description":"DeleteEmailForwarding deletes the email forwarding entry","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/hello":{"get":{"tags":["Hello"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/hello#HelloFunc","api_endpoint":"https://api.name.com/v4/hello"},"summary":"Returns some information about the API server","description":"HelloFunc returns some information about the API server.","security":[{"bearerAuth":[]}]}},"/v4/orders":{"get":{"tags":["Order"],"parameters":[{"name":"page","in":"query","description":"Page is which page to return","schema":{"type":"number","example":""}},{"name":"perPage","in":"query","description":"Per Page is the number of records to return per request defaults to 1000","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/orders#ListOrders","api_endpoint":"https://api.name.com/v4/orders"},"summary":"Retrieve account's orders with ListOrders","description":"ListOrders returns all orders in the account.","security":[{"bearerAuth":[]}]}},"/v4/orders/{orderId}":{"get":{"tags":["Order"],"parameters":[{"name":"orderId","in":"path","description":"OrderId is the unique identifier of the requested order;","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/orders#GetOrder","api_endpoint":"https://api.name.com/v4/orders/{orderId}"},"summary":"Order details retrieval using GetOrder","description":"GetOrder returns details about a specific order","security":[{"bearerAuth":[]}]}},"/v4/transfers":{"get":{"tags":["Transfer"],"parameters":[{"name":"page","in":"query","description":"Page is which page to return","schema":{"type":"number","example":""}},{"name":"perPage","in":"query","description":"Per Page is the number of records to return per request defaults to 1000","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/transfers#ListTransfers","api_endpoint":"https://api.name.com/v4/transfers"},"summary":"Pending transfer requests listed by ListTransfers","description":"ListTransfers lists all pending transfer in requests","security":[{"bearerAuth":[]}]},"post":{"tags":["Transfer"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/transfers#CreateTransfer","api_endpoint":"https://api.name.com/v4/transfers"},"summary":"Purchases a new domain transfer request","description":"CreateTransfer purchases a new domain transfer request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"authCode":{"type":"string","description":"AuthCode is the authorization code for the transfer"},"domainName":{"type":"string","description":"DomainName is the domain you want to transfer to Name.com"},"privacyEnabled":{"type":"boolean","description":"PrivacyEnabled is a flag on whether to purchase Whois Privacy with the transfer","enum":[true,false]},"promoCode":{"type":"string","description":"PromoCode is not implemented yet"},"purchasePrice":{"type":"number","description":"PurchasePrice is the amount to pay for the transfer of the domain"}}},"example":{"authCode":"","domainName":"","privacyEnabled":"","promoCode":"","purchasePrice":""}}}}}},"/v4/transfers/{domainName}":{"get":{"tags":["Transfer"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain you want to get the transfer information for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/transfers#GetTransfer","api_endpoint":"https://api.name.com/v4/transfers/{domainName}"},"summary":"GetTransfer gets details for a transfer request","description":"GetTransfer gets details for a transfer request.","security":[{"bearerAuth":[]}]}},"/v4/transfers/{domainName}/cancel":{"post":{"tags":["Transfer"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain to cancel the transfer for.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/transfers#CancelTransfer","api_endpoint":"https://api.name.com/v4/transfers/{domainName}:cancel"},"summary":"Refunds and cancels pending transfer","description":"CancelTransfer cancels a pending transfer request and refunds the amount to account credit","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{domainName}/url/forwarding":{"get":{"tags":["URLForwarding"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain to list URL forwarding entries for","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Page is which page to return","schema":{"type":"number","example":""}},{"name":"perPage","in":"query","description":"Per Page is the number of records to return per request defaults to 1000","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/urlforwardings#ListURLForwardings","api_endpoint":"https://api.name.com/v4/domains/{domainName}/url/forwarding"},"summary":"Paginated URL forwarding entries for domain","description":"ListURLForwardings returns a pagenated list of URL forwarding entries for a domain.","security":[{"bearerAuth":[]}]},"post":{"tags":["URLForwarding"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain part of the hostname to forward;","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/emailforwardings#CreateEmailForwarding","api_endpoint":"https://api.name.com/v4/domains/{domainName}/url/forwarding"},"summary":"Create URL Forwarding Entry","description":"CreateURLForwarding creates an URL forwarding entry","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"meta":{"type":"string","description":"Meta is the meta tags to add to the html page if the type is masked"},"type":{"type":"string","description":"Type is the type of forwarding Valid types are","enum":["Masked - This retains the original domain in the address bar and will not reveal or display the actual destination URL"]},"forwardsTo":{"type":"string","description":"ForwardsTo is the URL this host will be forwarded to","required":true},"host":{"type":"string","description":"Host is the entirety of the hostname","required":true},"title":{"type":"string","description":"Title is the title for the html page to use if the type is masked"}}},"example":{"meta":"","type":"","forwardsTo":"","host":"","title":""}}}}}},"/v4/domains/{domainName}/url/forwarding/{host}":{"get":{"tags":["URLForwarding"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain to list URL forwarding entry for","required":true,"schema":{"type":"string","example":""}},{"name":"host","in":"path","description":"Host is the part of the domain name before the domain","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/urlforwardings#GetURLForwarding","api_endpoint":"https://api.name.com/v4/domains/{domainName}/url/forwarding/{host}"},"summary":"Returns an URL forwarding entry","description":"GetURLForwarding returns an URL forwarding entry.","security":[{"bearerAuth":[]}]},"put":{"tags":["URLForwarding"],"parameters":[{"name":"domainName","in":"path","required":true,"schema":{"type":"string","example":""}},{"name":"host","in":"path","description":"Host is the entirety of the hostname","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/urlforwardings#UpdateURLForwarding","api_endpoint":"https://api.name.com/v4/domains/{domainName}/url/forwarding/{host}"},"summary":"Update URL Forwarding for Host","description":"UpdateURLForwarding updates which URL the host is being forwarded to.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"meta":{"type":"string","description":"Meta is the meta tags to add to the html page if the type is masked"},"type":{"type":"string","description":"Type is the type of forwarding Valid types are","enum":["Masked"]},"forwardsTo":{"type":"string","description":"ForwardsTo is the URL this host will be forwarded to","required":true},"title":{"type":"string","description":"Title is the title for the html page to use if the type is masked"}}},"example":{"meta":"","type":"","forwardsTo":"","title":""}}}}},"delete":{"tags":["URLForwarding"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain to delete the URL forwardind entry from","required":true,"schema":{"type":"string","example":""}},{"name":"host","in":"path","description":"Host is the part of the domain name before the domain","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/urlforwardings#DeleteURLForwarding","api_endpoint":"https://api.name.com/v4/domains/{domainName}/url/forwarding/{host}"},"summary":"Deletes the URL forwarding entry","description":"DeleteURLForwarding deletes the URL forwarding entry.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{domainName}/vanity_nameservers":{"get":{"tags":["VanityNameserver"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain to list the vanity nameservers for","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Page is which page to return.","schema":{"type":"number","example":""}},{"name":"perPage","in":"query","description":"Per Page is the number of records to return per request defaults to 1000","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/vanitynameservers#ListVanityNameservers","api_endpoint":"https://api.name.com/v4/domains/{domainName}/vanity_nameservers"},"summary":"List registered nameservers with the registry","description":"ListVanityNameservers lists all nameservers registered with the registry.","security":[{"bearerAuth":[]}]},"post":{"tags":["VanityNameserver"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain the nameserver is a subdomain of;","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/vanitynameservers#CreateVanityNameserver","api_endpoint":"https://api.name.com/v4/domains/{domainName}/vanity_nameservers"},"summary":"Register nameserver with the registry","description":"CreateVanityNameserver registers a nameserver with the registry.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"hostname":{"type":"string","description":"Hostname is the hostname of the nameserver","required":true},"ips":{"type":"string"}}},"example":{"hostname":"","ips":""}}}}}},"/v4/domains/{domainName}/vanity_nameservers/{hostname}":{"get":{"tags":["VanityNameserver"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain to for the vanity nameserver","required":true,"schema":{"type":"string","example":""}},{"name":"hostname","in":"path","description":"Hostname is the hostname for the vanity nameserver","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/vanitynameservers#GetVanityNameserver","api_endpoint":"https://api.name.com/v4/domains/{domainName}/vanity_nameservers/{hostname}"},"summary":"Retrieve details of registered vanity nameserver","description":"GetVanityNameserver gets the details for a vanity nameserver registered with the registry","security":[{"bearerAuth":[]}]},"put":{"tags":["VanityNameserver"],"parameters":[{"name":"domainName","in":"path","description":"DomainName is the domain the nameserver is a subdomain of","required":true,"schema":{"type":"string","example":""}},{"name":"hostname","in":"path","description":"Hostname is the hostname of the nameserver.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/vanitynameservers#UpdateVanityNameserver","api_endpoint":"https://api.name.com/v4/domains/{domainName}/vanity_nameservers/{hostname}"},"summary":"Update glue record IP addresses at the registry","description":"UpdateVanityNameserver allows you to update the glue record IP addresses at the registry","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ips":{"type":"string","description":"Ps is a list of IP addresses that are used for glue records for this nameserver"}}},"example":{"ips":""}}}}},"delete":{"tags":["VanityNameserver"],"parameters":[{"name":"domainName","in":"path","required":true,"schema":{"type":"string","example":""}},{"name":"hostname","in":"path","description":"Hostname is the hostname of the vanity nameserver to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.name.com/api-docs/vanitynameservers#DeleteVanityNameserver","api_endpoint":"https://api.name.com/v4/domains/{domainName}/vanity_nameservers/{hostname}"},"summary":"Unregister nameserver from registry","description":"DeleteVanityNameserver unregisteres the nameserver at the registry.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}