List custom domains

Requires EDITOR (no VIEWER-level read exists for domains).

Authorizations

SessionCookie

Parameters

Path Parameters

projectId

required

string

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

Responses

200

Domains.

application/json

object

domains

Array<object>

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

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
}

GET

/api/projects/{projectId}/domains

1
curl --request GET \
2
  --url https://retidal.com/api/projects/%3Cstring%3E/domains \
3
  --cookie trackly_session=%3CYOUR_API_KEY%3E

1
const url = 'https://retidal.com/api/projects/%3Cstring%3E/domains';
2
const options = {method: 'GET', headers: {cookie: 'trackly_session=%3CYOUR_API_KEY%3E'}};
3

4
try {
5
  const response = await fetch(url, options);
6
  const data = await response.json();
7
  console.log(data);
8
} catch (error) {
9
  console.error(error);
10
}

1
import requests
2

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

5
headers = {"cookie": "trackly_session=%3CYOUR_API_KEY%3E"}
6

7
response = requests.get(url, headers=headers)
8

9
print(response.json())

1
package main
2

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

9
func main() {
10

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

13
  req, _ := http.NewRequest("GET", url, nil)
14

15
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
16

17
  res, _ := http.DefaultClient.Do(req)
18

19
  defer res.Body.Close()
20
  body, _ := io.ReadAll(res.Body)
21

22
  fmt.Println(res)
23
  fmt.Println(string(body))
24

25
}

200Domains.

1
{
2
  "domains": [
3
    {
4
      "onboardingMode": "cloudflare_custom_hostname"
5
    }
6
  ]
7
}

List custom domains

Authorizations

Parameters

Path Parameters

Responses

200

403

Examplegenerated

Example^generated