Create (or revive) a custom domain

Requires EDITOR.

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

Request Body^required

application/json

object

hostname

required

string

>= 3 characters <= 255 characters

displayName

required

string

>= 1 characters <= 200 characters

dnsProvider

string | null

>= 1 characters <= 50 characters

onboardingMode

string

Allowed values: cloudflare_custom_hostname ns_delegation

Responses

201

Created domain.

application/json

object

domain

object

string

projectId

string

hostname

string

displayName

string

hostnameStatusValue

string | null

hostnameStatusMessage

string | null

hostnameStatusUpdatedAt

string | null

onboardingMode

string

Allowed values: cloudflare_custom_hostname ns_delegation

dnsProvider

string | null

delegationStatus

string | null

cloudflareJson

route53Json

createdAt

string

updatedAt

string

key

additional properties

any

400

Invalid domain params or hostname format.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

409

Hostname already occupied/exists.

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

POST

/api/projects/{projectId}/domains

1
curl --request POST \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/domains \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "hostname": "<string>",
7
  "displayName": "<string>",
8
  "dnsProvider": "<string>",
9
  "onboardingMode": "cloudflare_custom_hostname"
10
}'

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/domains';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"hostname":"<string>","displayName":"<string>","dnsProvider":"<string>","onboardingMode":"cloudflare_custom_hostname"}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/projects/%3Cstring%3E/domains"
4

5
payload = {
6
    "hostname": "<string>",
7
    "displayName": "<string>",
8
    "dnsProvider": "<string>",
9
    "onboardingMode": "cloudflare_custom_hostname"
10
}
11
headers = {
12
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
13
    "Content-Type": "application/json"
14
}
15

16
response = requests.post(url, json=payload, headers=headers)
17

18
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/projects/%3Cstring%3E/domains"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"hostname\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"dnsProvider\": \"<string>\",\n  \"onboardingMode\": \"cloudflare_custom_hostname\"\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/projects/%3Cstring%3E/domains"
13

14
  payload := strings.NewReader("{\n  \"hostname\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"dnsProvider\": \"<string>\",\n  \"onboardingMode\": \"cloudflare_custom_hostname\"\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

201Created domain.

1
{
2
  "domain": {
3
    "onboardingMode": "cloudflare_custom_hostname"
4
  }
5
}

Create (or revive) a custom domain

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

201

400

Examplegenerated

403

Examplegenerated

409

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated