The Developer Hub

Welcome to the developer hub. You'll find comprehensive guides and documentation to help you start working with as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

Adding a Domain

This method adds a domain to your account

The instruction below shows how to add a domain to your account

2) Install prerequisites for requests.

pip install requests
npm install --save axios

Now everything is ready to run the following snippet. It will add a domain.

3) Create a file: .js/ .rb. Use the code snippet below.


Please, replace API_KEY and hostname with appropriate values.

import requests

url = ""

import json
payload = json.dumps({"hideReferer":False,"httpsLinks":False,"hostname":"","linkType":"random"})
headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'authorization': "API_KEY"

response = requests.request("POST", url, data=payload, headers=headers)

const axios = require('axios');

const data = {

const options = {
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    authorization: 'API_KEY'
};'', data, options)
.then(function (response) {
.catch(function (response) {
require 'uri'
require 'net/http'
require 'openssl'
require 'json'

url = URI("")

http =, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request =
request["accept"] = 'application/json'
request["content-type"] = 'application/json'
request["authorization"] = 'API_KEY'
request.body = JSON.generate({"hideReferer":false,"httpsLinks":false,"hostname":"","linkType":"random"})

response = http.request(request)
puts response.read_body

4) Launch the file.

node filename.js
ruby filename.rb

5) JSON Response (the domain will be added).

Once you run the code, you will see the response.

  linkType: 'random',
  state: 'configured',(or not_configured)
  cloaking: false,
  setupType: 'dns',
  httpsLinks: false,
  id: 91576,
  hostname: '',
  UserId: 9346,
  updatedAt: '2020-04-23T10:22:47.010Z',
  createdAt: '2020-04-23T10:22:46.649Z',
  provider: null,
  unicodeHostname: '',
  clientStorage: null

Updated 9 months ago

Adding a Domain

This method adds a domain to your account

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.